1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
|
/*
Mosh: the mobile shell
Copyright 2012 Keith Winstein
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
In addition, as a special exception, the copyright holders give
permission to link the code of portions of this program with the
OpenSSL library under certain conditions as described in each
individual source file, and distribute linked combinations including
the two.
You must obey the GNU General Public License in all respects for all
of the code used other than OpenSSL. If you modify file(s) with this
exception, you may extend this exception to your version of the
file(s), but you are not obligated to do so. If you do not wish to do
so, delete this exception statement from your version. If you delete
this exception statement from all source files in the program, then
also delete it here.
*/
#ifndef SELECT_HPP
#define SELECT_HPP
#include <string.h>
#include <errno.h>
#include <signal.h>
#include <sys/select.h>
#include <assert.h>
#include "src/util/fatal_assert.h"
#include "src/util/timestamp.h"
/* Convenience wrapper for pselect(2).
Any signals blocked by calling sigprocmask() outside this code will still be
received during Select::select(). So don't do that. */
class Select {
public:
static Select &get_instance( void ) {
/* COFU may or may not be thread-safe, depending on compiler */
static Select instance;
return instance;
}
private:
Select()
: max_fd( -1 )
/* These initializations are not used; they are just
here to appease -Weffc++. */
, all_fds( dummy_fd_set )
, read_fds( dummy_fd_set )
, empty_sigset( dummy_sigset )
, consecutive_polls( 0 )
{
FD_ZERO( &all_fds );
FD_ZERO( &read_fds );
clear_got_signal();
fatal_assert( 0 == sigemptyset( &empty_sigset ) );
}
void clear_got_signal( void )
{
for ( volatile sig_atomic_t *p = got_signal;
p < got_signal + sizeof( got_signal ) / sizeof( *got_signal );
p++ ) {
*p = 0;
}
}
/* not implemented */
Select( const Select & );
Select &operator=( const Select & );
public:
void add_fd( int fd )
{
if ( fd > max_fd ) {
max_fd = fd;
}
FD_SET( fd, &all_fds );
}
void clear_fds( void )
{
FD_ZERO( &all_fds );
}
static void add_signal( int signum )
{
fatal_assert( signum >= 0 );
fatal_assert( signum <= MAX_SIGNAL_NUMBER );
/* Block the signal so we don't get it outside of pselect(). */
sigset_t to_block;
fatal_assert( 0 == sigemptyset( &to_block ) );
fatal_assert( 0 == sigaddset( &to_block, signum ) );
fatal_assert( 0 == sigprocmask( SIG_BLOCK, &to_block, NULL ) );
/* Register a handler, which will only be called when pselect()
is interrupted by a (possibly queued) signal. */
struct sigaction sa;
sa.sa_flags = 0;
sa.sa_handler = &handle_signal;
fatal_assert( 0 == sigfillset( &sa.sa_mask ) );
fatal_assert( 0 == sigaction( signum, &sa, NULL ) );
}
/* timeout unit: milliseconds; negative timeout means wait forever */
int select( int timeout )
{
memcpy( &read_fds, &all_fds, sizeof( read_fds ) );
clear_got_signal();
/* Rate-limit and warn about polls. */
if ( verbose > 1 && timeout == 0 ) {
fprintf( stderr, "%s: got poll (timeout 0)\n", __func__ );
}
if ( timeout == 0 && ++consecutive_polls >= MAX_POLLS ) {
if ( verbose > 1 && consecutive_polls == MAX_POLLS ) {
fprintf( stderr, "%s: got %d polls, rate limiting.\n", __func__, MAX_POLLS );
}
timeout = 1;
} else if ( timeout != 0 && consecutive_polls ) {
if ( verbose > 1 && consecutive_polls >= MAX_POLLS ) {
fprintf( stderr, "%s: got %d consecutive polls\n", __func__, consecutive_polls );
}
consecutive_polls = 0;
}
#ifdef HAVE_PSELECT
struct timespec ts;
struct timespec *tsp = NULL;
if ( timeout >= 0 ) {
ts.tv_sec = timeout / 1000;
ts.tv_nsec = 1000000 * (long( timeout ) % 1000);
tsp = &ts;
}
int ret = ::pselect( max_fd + 1, &read_fds, NULL, NULL, tsp, &empty_sigset );
#else
struct timeval tv;
struct timeval *tvp = NULL;
sigset_t old_sigset;
if ( timeout >= 0 ) {
tv.tv_sec = timeout / 1000;
tv.tv_usec = 1000 * (long( timeout ) % 1000);
tvp = &tv;
}
int ret = sigprocmask( SIG_SETMASK, &empty_sigset, &old_sigset );
if ( ret != -1 ) {
ret = ::select( max_fd + 1, &read_fds, NULL, NULL, tvp );
sigprocmask( SIG_SETMASK, &old_sigset, NULL );
}
#endif
if ( ret == 0 || ( ret == -1 && errno == EINTR ) ) {
/* Look for and report Cygwin select() bug. */
if ( ret == 0 ) {
for ( int fd = 0; fd <= max_fd; fd++ ) {
if ( FD_ISSET( fd, &read_fds ) ) {
fprintf( stderr, "select(): nfds = 0 but read fd %d is set\n", fd );
}
}
}
/* The user should process events as usual. */
FD_ZERO( &read_fds );
ret = 0;
}
freeze_timestamp();
return ret;
}
bool read( int fd )
#if FD_ISSET_IS_CONST
const
#endif
{
assert( FD_ISSET( fd, &all_fds ) );
return FD_ISSET( fd, &read_fds );
}
/* This method consumes a signal notification. */
bool signal( int signum )
{
fatal_assert( signum >= 0 );
fatal_assert( signum <= MAX_SIGNAL_NUMBER );
/* XXX This requires a guard against concurrent signals. */
bool rv = got_signal[ signum ];
got_signal[ signum ] = 0;
return rv;
}
/* This method does not consume signal notifications. */
bool any_signal( void ) const
{
bool rv = false;
for (int i = 0; i < MAX_SIGNAL_NUMBER; i++) {
rv |= got_signal[ i ];
}
return rv;
}
static void set_verbose( unsigned int s_verbose ) { verbose = s_verbose; }
private:
static const int MAX_SIGNAL_NUMBER = 64;
/* Number of 0-timeout selects after which we begin to think
* something's wrong. */
static const int MAX_POLLS = 10;
static void handle_signal( int signum );
int max_fd;
/* We assume writes to got_signal are atomic, though we also try to mask out
concurrent signal handlers. */
volatile sig_atomic_t got_signal[ MAX_SIGNAL_NUMBER + 1 ];
fd_set all_fds, read_fds;
sigset_t empty_sigset;
static fd_set dummy_fd_set;
static sigset_t dummy_sigset;
int consecutive_polls;
static unsigned int verbose;
};
#endif
|