summaryrefslogtreecommitdiff
path: root/include/socketengine.h
blob: 8c74ce04427ccfba1ab6651821eb55e22fe9c483 (plain)
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
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
/*       +------------------------------------+
 *       | Inspire Internet Relay Chat Daemon |
 *       +------------------------------------+
 *
 *  Inspire is copyright (C) 2002-2005 ChatSpike-Dev.
 *                       E-mail:
 *                <brain@chatspike.net>
 *                <Craig@chatspike.net>
 *
 * Written by Craig Edwards, Craig McLure, and others.
 * This program is free but copyrighted software; see
 *            the file COPYING for details.
 *
 * ---------------------------------------------------
 */

// Fill the engine with client file descriptors pending an action

#define epoll_fill      int i = epoll_wait(ep, event, 1, 5); \
                        if (i > 0) \
                        { \
                                log(DEBUG,"epoll_wait call: ep=%d, i=%d",ep,i); \
                                userrec* cu = fd_ref_table[event[0].data.fd];

#define kqueue_fill     ts.tv_sec = 0; \
                        ts.tv_nsec = 1000L; \
                        int i = kevent(kq, NULL, 0, &ke, 1, &ts); \
                        if (i > 0) \
                        { \
                                log(DEBUG,"kevent call: kq=%d, i=%d",kq,i); \
                                userrec* cu = fd_ref_table[ke.ident];

#define select_fill     tval.tv_sec = 0; \
                        tval.tv_usec = 1000L; \
                        selectResult2 = select(FD_SETSIZE, &sfd, NULL, NULL, &tval); \
                        if ((selectResult2 > 0) && (xcount != clientlist.end())) \
                        for (user_hash::iterator count2a = xcount; count2a != endingiter; count2a++) \
                        { \
                                if (count2a == clientlist.end()) \
                                        break; \
                                userrec* cu = count2a->second;

#ifdef USE_EPOLL
#define engine_fill epoll_fill
#endif
#ifdef USE_KQUEUE
#define engine_fill kqueue_fill
#endif
#ifdef USE_SELECT
#define engine_fill select_fill
#endif

// how to determine if a socket needs attention if further checks are needed

#define epoll_check    ((cu->fd != FD_MAGIC_NUMBER) && (cu->fd != -1))

#define kqueue_check   ((cu->fd != FD_MAGIC_NUMBER) && (cu->fd != -1))

#define select_check   ((cu->fd != FD_MAGIC_NUMBER) && (cu->fd != -1) && (FD_ISSET (cu->fd, &sfd)))

#ifdef USE_EPOLL
#define engine_check epoll_check
#endif
#ifdef USE_KQUEUE
#define engine_check kqueue_check
#endif
#ifdef USE_SELECT
#define engine_check select_check
#endif

// how to clean up an exiting client

#define epoll_cleanup                   log(DEBUG,"InspIRCd: Exited: %s",cu->nick); \
                                        kill_link(cu,"Client exited"); \
                                        log(DEBUG,"Bailing from client exit"); \
                                        goto label;

#define kqueue_cleanup                  log(DEBUG,"InspIRCd: Exited: %s",cu->nick); \
                                        kill_link(cu,"Client exited"); \
                                        log(DEBUG,"Bailing from client exit"); \
                                        goto label;

#define select_cleanup                  if (count2->second) \
                                        { \
                                                log(DEBUG,"InspIRCd: Exited: %s",cu->nick); \
                                                kill_link(cu,"Client exited"); \
                                                log(DEBUG,"Bailing from client exit"); \
                                                goto label; \
                                        }

#ifdef USE_EPOLL
#define engine_cleanup epoll_cleanup
#endif
#ifdef USE_KQUEUE
#define engine_cleanup kqueue_cleanup
#endif
#ifdef USE_SELECT
#define engine_cleanup select_cleanup
#endif


// how to scan the set for fd's requiring action

#define select_scanset          for (count = 0; count < boundPortCount; count++) \
			        { \
			                FD_SET (openSockfd[count], &selectFds); \
			        } \
			        tv.tv_usec = 30000L; \
			        selectResult = select(MAXSOCKS, &selectFds, NULL, NULL, &tv); \
			        if (selectResult > 0) \
			        { \
			                for (count = 0; count < boundPortCount; count++) \
		                { \
			                        if (FD_ISSET (openSockfd[count], &selectFds)) \
			                        {

#define kqueue_scanset          ts.tv_sec = 0; \
			        ts.tv_nsec = 30000L; \
			        i = kevent(lkq, NULL, 0, ke_list, 32, &ts); \
			        if (i > 0) for (j = 0; j < i; j++) \
			        { \
			                log(DEBUG,"kqueue: Listening socket event, i=%d, ke.ident=%d",i,ke_list[j].ident); \
			                for (count = 0; count < boundPortCount; count++) \
			                { \
			                        if ((unsigned)ke_list[j].ident == (unsigned)openSockfd[count]) \
			                        {

#define epoll_scanset           i = epoll_wait(lep, event, 32, EP_DELAY); \
			        if (i > 0) for (j = 0; j < i; j++) \
			        { \
			                log(DEBUG,"epoll: Listening socket event, i=%d,events[j].data.fd=%d",i,event[j].data.fd); \
			                for (count = 0; count < boundPortCount; count++) \
			                { \
			                        if ((unsigned)event[j].data.fd == (unsigned)openSockfd[count]) \
			                        {

#ifdef USE_EPOLL
#define engine_scanset epoll_scanset
#endif
#ifdef USE_KQUEUE
#define engine_scanset kqueue_scanset
#endif
#ifdef USE_SELECT
#define engine_scanset select_scanset
#endif

// how to populate the list with fds before asking for change notification

#define epoll_server_populate               i = epoll_wait(sep, event, 1, EP_DELAY); \
			                if (i > 0) \
			                { \
			                        log(DEBUG,"epoll: Listening server socket event, i=%d, event.data.fd=%d",i,event[0].data.fd); \
			                        for (int x = 0; x != SERVERportCount; x++) \
			                        { \
			                                if ((me[x]) && ((unsigned)event[0].data.fd == (unsigned)me[x]->fd)) \
			                                {
#define kqueue_server_populate              ts.tv_sec = 0; \
			                ts.tv_nsec = 30000L; \
			                i = kevent(skq, NULL, 0, &ke, 1, &ts); \
			                if (i > 0) \
			                { \
			                        log(DEBUG,"kqueue: Listening server socket event, i=%d, ke.ident=%d",i,ke.ident); \
			                        for (int x = 0; x != SERVERportCount; x++) \
			                        { \
	       		 	                        if ((me[x]) && ((unsigned)ke.ident == (unsigned)me[x]->fd)) \
			                                {

#define select_server_populate              FD_ZERO(&serverfds); \
			                for (int x = 0; x != SERVERportCount; x++) \
			                { \
			                        if (me[x]) \
			                                FD_SET(me[x]->fd, &serverfds); \
			                } \
			                tvs.tv_usec = 30000L; \
			                tvs.tv_sec = 0; \
			                int servresult = select(FD_SETSIZE, &serverfds, NULL, NULL, &tvs); \
			                if (servresult > 0) \
			                { \
			                        for (int x = 0; x != SERVERportCount; x++) \
			                        { \
			                                if ((me[x]) && (FD_ISSET (me[x]->fd, &serverfds))) \
			                                { 


#ifdef USE_EPOLL
#define engine_server_populate epoll_server_populate
#endif
#ifdef USE_KQUEUE
#define engine_server_populate kqueue_server_populate
#endif
#ifdef USE_SELECT
#define engine_server_populate select_server_populate
#endif

// a list of variables used specifically by this engine

#define kqueue_structs struct kevent ke; \
        struct kevent ke_list[33]; \
        struct timespec ts;

#define epoll_structs struct epoll_event event[33];

#define select_structs fd_set serverfds; \
        fd_set sfd;

#ifdef USE_EPOLL
#define engine_structs epoll_structs
#endif
#ifdef USE_KQUEUE
#define engine_structs kqueue_structs
#endif
#ifdef USE_SELECT
#define engine_structs select_structs
#endif

// how to initialise the engine before using it

#define select_init     while(0);

#define kqueue_init     kq = kqueue(); \
		        lkq = kqueue(); \
		        skq = kqueue(); \
		        if ((kq == -1) || (lkq == -1) || (skq == -1)) \
		        { \
		                log(DEFAULT,"main: kqueue() failed!"); \
		                printf("ERROR: could not initialise kqueue event system. Shutting down.\n"); \
		                Exit(ERROR); \
		        }

#define epoll_init      ep = epoll_create(MAXCLIENTS); \
		        lep = epoll_create(32); \
		        sep = epoll_create(128); \
		        if ((ep == -1) || (lep == -1) || (sep == -1)) \
		        { \
		                log(DEFAULT,"main: epoll_create() failed!"); \
		                printf("ERROR: could not initialise epoll event system. Shutting down.\n"); \
		                Exit(ERROR); \
		        }


#ifdef USE_EPOLL
#define engine_init epoll_init
#endif
#ifdef USE_KQUEUE
#define engine_init kqueue_init
#endif
#ifdef USE_SELECT
#define engine_init select_init
#endif

// how to fill the engine with a list of server fd's

#define	select_server_fill	log(DEFAULT,"Using standard select socket engine.");

#define epoll_server_fill        log(DEFAULT,"epoll socket engine is enabled. Filling listen list. boundPortcount=%d",boundPortCount); \
			        for (count = 0; count < boundPortCount; count++) \
			        { \
			                struct epoll_event ev; \
			                log(DEBUG,"epoll: Add listening socket to events, ep=%d socket=%d",lep,openSockfd[count]); \
			                ev.events = EPOLLIN | EPOLLET; \
			                ev.data.fd = openSockfd[count]; \
			                int i = epoll_ctl(lep, EPOLL_CTL_ADD, openSockfd[count], &ev); \
			                if (i < 0) \
			                { \
			                        log(DEFAULT,"main: add listen ports, epoll_ctl failed!"); \
			                        printf("ERROR: could not initialise listening sockets in epoll list. Shutting down.\n"); \
			                        Exit(ERROR); \
			                } \
			        } \
			        for (int t = 0; t != SERVERportCount; t++) \
			        { \
			                struct epoll_event ev; \
			                log(DEBUG,"epoll: Add listening server socket to events, ep=%d socket=%d",sep,me[t]->fd); \
			                ev.events = EPOLLIN | EPOLLET; \
			                ev.data.fd = me[t]->fd; \
			                int i = epoll_ctl(sep, EPOLL_CTL_ADD, me[t]->fd, &ev); \
			                if (i == -1) \
			                { \
			                        log(DEFAULT,"main: add server listen ports, epoll_ctl failed!"); \
			                        printf("ERROR: could not initialise server listening sockets in epoll list. Shutting down.\n"); \
			                        Exit(ERROR); \
			                } \
			        }

#define kqueue_server_fill        log(DEFAULT,"kqueue socket engine is enabled. Filling listen list."); \
        for (count = 0; count < boundPortCount; count++) \
        { \
                struct kevent ke; \
                log(DEBUG,"kqueue: Add listening socket to events, kq=%d socket=%d",lkq,openSockfd[count]); \
                EV_SET(&ke, openSockfd[count], EVFILT_READ, EV_ADD, 0, MaxConn, NULL); \
                int i = kevent(lkq, &ke, 1, 0, 0, NULL); \
                if (i == -1) \
                { \
                        log(DEFAULT,"main: add listen ports to kqueue failed!"); \
                        printf("ERROR: could not initialise listening sockets in kqueue. Shutting down.\n"); \
                        Exit(ERROR); \
                } \
        } \
        for (int t = 0; t != SERVERportCount; t++) \
        { \
                struct kevent ke; \
                if (me[t]) \
                { \
                        log(DEBUG,"kqueue: Add listening SERVER socket to events, kq=%d socket=%d",skq,me[t]->fd); \
                        EV_SET(&ke, me[t]->fd, EVFILT_READ, EV_ADD, 0, MaxConn, NULL); \
                        int i = kevent(skq, &ke, 1, 0, 0, NULL); \
                        if (i == -1) \
                        { \
                                log(DEFAULT,"main: add server listen ports to kqueue failed!"); \
                                printf("ERROR: could not initialise listening server sockets in kqueue. Shutting down.\n"); \
                                Exit(ERROR); \
                        } \
                } \
        }

#ifdef USE_EPOLL
#define engine_server_fill epoll_server_fill
#endif
#ifdef USE_KQUEUE
#define engine_server_fill kqueue_server_fill
#endif
#ifdef USE_SELECT
#define engine_server_fill select_server_fill
#endif

// how to delete a client fd from the engine

#define kqueue_delete_fd        struct kevent ke; \
		                EV_SET(&ke, user->fd, EVFILT_READ, EV_DELETE, 0, 0, NULL); \
		                int i = kevent(kq, &ke, 1, 0, 0, NULL); \
		                if (i == -1) \
		                { \
		                        log(DEBUG,"kqueue: Failed to remove user from queue!"); \
		                }

#define epoll_delete_fd         struct epoll_event ev; \
		                ev.events = EPOLLIN | EPOLLET; \
		                ev.data.fd = user->fd; \
		                int i = epoll_ctl(ep, EPOLL_CTL_DEL, user->fd, &ev); \
		                if (i < 0) \
		                { \
		                        log(DEBUG,"epoll: List deletion failure!"); \
		                }

#define select_delete_fd        while(0);


#ifdef USE_EPOLL
#define engine_delete_fd epoll_delete_fd
#endif
#ifdef USE_KQUEUE
#define engine_delete_fd kqueue_delete_fd
#endif
#ifdef USE_SELECT
#define engine_delete_fd select_delete_fd
#endif

// how to add a client fd to the engine

#define select_add_fd		while(0);

#define epoll_add_fd            struct epoll_event ev; \
			        log(DEBUG,"epoll: Adduser to events, ep=%d socket=%d",ep,socket); \
			        ev.events = EPOLLIN | EPOLLET; \
			        ev.data.fd = socket; \
			        int i = epoll_ctl(ep, EPOLL_CTL_ADD, socket, &ev); \
			        if (i < 0) \
			        { \
			                log(DEBUG,"epoll: List insertion failure!"); \
			        }

#define kqueue_add_fd           struct kevent ke; \
			        log(DEBUG,"kqueue: Add user to events, kq=%d socket=%d",kq,socket);\
			        EV_SET(&ke, socket, EVFILT_READ, EV_ADD, 0, 0, NULL); \
			        int i = kevent(kq, &ke, 1, 0, 0, NULL); \
			        if (i == -1) \
			        { \
			                log(DEBUG,"kqueue: List insertion failure!"); \
			        }

#ifdef USE_EPOLL
#define engine_add_fd epoll_add_fd
#endif
#ifdef USE_KQUEUE
#define engine_add_fd kqueue_add_fd
#endif
#ifdef USE_SELECT
#define engine_add_fd select_add_fd
#endif

// what is this engine called?

#ifdef USE_KQUEUE
#define engine_name "kqueue"
#endif
#ifdef USE_SELECT
#define engine_name "select"
#endif
#ifdef USE_EPOLL
#define engine_name "epoll"
#endif