forked from chronolaw/annotated_nginx
-
Notifications
You must be signed in to change notification settings - Fork 0
/
ngx_epoll_module.c
1394 lines (1078 loc) · 41 KB
/
ngx_epoll_module.c
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
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
// annotated by chrono since 2016
//
// * ngx_epoll_init
// * ngx_epoll_process_events
// * ngx_epoll_notify
// * ngx_epoll_add_event
// * ngx_epoll_del_event
// * ngx_epoll_add_connection
// * ngx_epoll_del_connection
/*
* Copyright (C) Igor Sysoev
* Copyright (C) Nginx, Inc.
*/
#include <ngx_config.h>
#include <ngx_core.h>
#include <ngx_event.h>
// 下面这段用于测试epoll功能
// 代码与linux的基本相同，可以参考
#if (NGX_TEST_BUILD_EPOLL)
/* epoll declarations */
#define EPOLLIN 0x001 //有读事件发生，即可读
#define EPOLLPRI 0x002
#define EPOLLOUT 0x004 //有写事件发生，即可写
#define EPOLLERR 0x008
#define EPOLLHUP 0x010
#define EPOLLRDNORM 0x040
#define EPOLLRDBAND 0x080
#define EPOLLWRNORM 0x100
#define EPOLLWRBAND 0x200
#define EPOLLMSG 0x400
// EPOLLRDHUP表示客户端关闭连接（断连），也当做读事件处理
// 这时recv返回0
#define EPOLLRDHUP 0x2000
#define EPOLLEXCLUSIVE 0x10000000
#define EPOLLONESHOT 0x40000000
#define EPOLLET 0x80000000 //ET模式，即边缘触发
#define EPOLL_CTL_ADD 1 //添加事件
#define EPOLL_CTL_DEL 2 //删除事件
#define EPOLL_CTL_MOD 3 //修改事件
// epoll系统调用使用的结构体
// nginx只使用ptr，存储连接对象的指针
// 指针最低位用做标志位，存储instance
typedef union epoll_data {
// union使用ptr成员，关联到连接对象
void *ptr;
int fd;
uint32_t u32;
uint64_t u64;
} epoll_data_t;
struct epoll_event {
uint32_t events;
epoll_data_t data;
};
// 初始化epoll，返回一个句柄，size无意义
int epoll_create(int size);
int epoll_create(int size)
{
return -1;
}
// 添加或删除事件，op=EPOLL_CTL_ADD/EPOLL_CTL_DEL/EPOLL_CTL_MOD
int epoll_ctl(int epfd, int op, int fd, struct epoll_event *event);
int epoll_ctl(int epfd, int op, int fd, struct epoll_event *event)
{
return -1;
}
// 等待注册的事件发生
// 内核把发生的事件拷贝到events数组里，返回值是数量
int epoll_wait(int epfd, struct epoll_event *events, int nevents, int timeout);
int epoll_wait(int epfd, struct epoll_event *events, int nevents, int timeout)
{
return -1;
}
#if (NGX_HAVE_EVENTFD)
#define SYS_eventfd 323
#endif
// aio暂不研究
#if (NGX_HAVE_FILE_AIO)
#define SYS_io_setup 245
#define SYS_io_destroy 246
#define SYS_io_getevents 247
typedef u_int aio_context_t;
struct io_event {
uint64_t data; /* the data field from the iocb */
uint64_t obj; /* what iocb this event came from */
int64_t res; /* result code for this event */
int64_t res2; /* secondary result */
};
#endif
#endif /* NGX_TEST_BUILD_EPOLL */
// epoll模块的配置结构体
typedef struct {
// epoll系统调用，获取事件的数组大小
// 对应指令epoll_events
ngx_uint_t events;
// aio暂不研究
ngx_uint_t aio_requests;
} ngx_epoll_conf_t;
// 调用epoll_create初始化epoll机制, timer无意义
// 参数size=cycle->connection_n / 2，但并无实际意义
// 设置全局变量，操作系统提供的底层数据收发接口
// 初始化全局的事件模块访问接口，指向epoll的函数
// 默认使用et模式，边缘触发，高速
static ngx_int_t ngx_epoll_init(ngx_cycle_t *cycle, ngx_msec_t timer);
#if (NGX_HAVE_EVENTFD)
// 调用系统函数eventfd，创建一个可以用于通知的描述符，用于实现notify
static ngx_int_t ngx_epoll_notify_init(ngx_log_t *log);
// 当发生通知事件时的回调函数，再回调真正的功能函数ev->data
static void ngx_epoll_notify_handler(ngx_event_t *ev);
#endif
#if (NGX_HAVE_EPOLLRDHUP)
static void ngx_epoll_test_rdhup(ngx_cycle_t *cycle);
#endif
// epoll模块结束工作，关闭epoll句柄和通知句柄，释放内存
static void ngx_epoll_done(ngx_cycle_t *cycle);
// epoll添加事件
// 检查事件关联的连接对象，决定是新添加还是修改
// 避免误删除了读写事件的关注
static ngx_int_t ngx_epoll_add_event(ngx_event_t *ev, ngx_int_t event,
ngx_uint_t flags);
// epoll删除事件
// 检查事件关联的连接对象，决定是完全删除还是修改
// 避免误删除了读写事件的关注
static ngx_int_t ngx_epoll_del_event(ngx_event_t *ev, ngx_int_t event,
ngx_uint_t flags);
// epoll关注连接的读写事件
// 添加事件成功，读写事件都是活跃的，即已经使用
static ngx_int_t ngx_epoll_add_connection(ngx_connection_t *c);
// epoll删除连接的读写事件
// 删除事件成功，读写事件都不活跃
static ngx_int_t ngx_epoll_del_connection(ngx_connection_t *c,
ngx_uint_t flags);
// 使用epoll模拟了事件通知机制
// 向文件里写一个数字，令文件可读，从而触发epoll事件
// 参数handler是真正的业务回调函数
#if (NGX_HAVE_EVENTFD)
static ngx_int_t ngx_epoll_notify(ngx_event_handler_pt handler);
#endif
// epoll模块核心功能，调用epoll_wait处理发生的事件
// 使用event_list和nevents获取内核返回的事件
// timer是无事件发生时最多等待的时间，即超时时间
// 函数可以分为两部分，一是用epoll获得事件，二是处理事件，加入延后队列
// 在ngx_process_events_and_timers里被调用
static ngx_int_t ngx_epoll_process_events(ngx_cycle_t *cycle, ngx_msec_t timer,
ngx_uint_t flags);
// aio暂不研究
#if (NGX_HAVE_FILE_AIO)
static void ngx_epoll_eventfd_handler(ngx_event_t *ev);
#endif
// 创建配置结构体
static void *ngx_epoll_create_conf(ngx_cycle_t *cycle);
// 初始化配置结构体
static char *ngx_epoll_init_conf(ngx_cycle_t *cycle, void *conf);
// 以下是epoll使用的变量
// epoll系统调用使用的句柄，由epoll_create()创建
static int ep = -1;
// epoll系统调用使用的数组，存储内核返回的事件
// 大小由nevents确定
// 相当于std::vector<epoll_event> event_list;
static struct epoll_event *event_list;
// event_list数组的大小
static ngx_uint_t nevents;
// notify使用的变量
#if (NGX_HAVE_EVENTFD)
// 用于多线程通知用的描述符，并不关联实际的socket或者文件
static int notify_fd = -1;
// 通知用的事件对象
static ngx_event_t notify_event;
// 通知用的连接对象，并不关联实际的连接
static ngx_connection_t notify_conn;
#endif
// aio暂不研究
// 方式与notify类似，也使用一个静态的event和conn
#if (NGX_HAVE_FILE_AIO)
int ngx_eventfd = -1;
aio_context_t ngx_aio_ctx = 0;
static ngx_event_t ngx_eventfd_event;
static ngx_connection_t ngx_eventfd_conn;
#endif
#if (NGX_HAVE_EPOLLRDHUP)
ngx_uint_t ngx_use_epoll_rdhup;
#endif
// epoll模块的名字
// 用在ngx_epoll_module_ctx里
static ngx_str_t epoll_name = ngx_string("epoll");
// epoll模块支持的指令，两个
static ngx_command_t ngx_epoll_commands[] = {
// event_list数组大小，存储内核返回的事件
{ ngx_string("epoll_events"),
NGX_EVENT_CONF|NGX_CONF_TAKE1,
ngx_conf_set_num_slot,
0,
offsetof(ngx_epoll_conf_t, events),
NULL },
// aio暂不研究
{ ngx_string("worker_aio_requests"),
NGX_EVENT_CONF|NGX_CONF_TAKE1,
ngx_conf_set_num_slot,
0,
offsetof(ngx_epoll_conf_t, aio_requests),
NULL },
ngx_null_command
};
// epoll模块的函数表
static ngx_event_module_t ngx_epoll_module_ctx = {
// epoll模块的名字"epoll"
&epoll_name,
// 创建配置结构体
ngx_epoll_create_conf, /* create configuration */
// 初始化配置结构体
ngx_epoll_init_conf, /* init configuration */
// epoll的事件模块访问接口，是一个函数表
{
// epoll添加事件
// 检查事件关联的连接对象，决定是新添加还是修改
// 避免误删除了读写事件的关注
ngx_epoll_add_event, /* add an event */
// epoll删除事件
// 检查事件关联的连接对象，决定是完全删除还是修改
// 避免误删除了读写事件的关注
ngx_epoll_del_event, /* delete an event */
ngx_epoll_add_event, /* enable an event */
ngx_epoll_del_event, /* disable an event */
// epoll关注连接的读写事件
// 添加事件成功，读写事件都是活跃的，即已经使用
ngx_epoll_add_connection, /* add an connection */
// epoll删除连接的读写事件
// 删除事件成功，读写事件都不活跃
ngx_epoll_del_connection, /* delete an connection */
#if (NGX_HAVE_EVENTFD)
// 使用epoll模拟了事件通知机制
// 向文件里写一个数字，令文件可读，从而触发epoll事件
// 参数handler是真正的业务回调函数
ngx_epoll_notify, /* trigger a notify */
#else
NULL, /* trigger a notify */
#endif
// epoll模块核心功能，调用epoll_wait处理发生的事件
// 使用event_list和nevents获取内核返回的事件
// timer是无事件发生时最多等待的时间，即超时时间
// 函数可以分为两部分，一是用epoll获得事件，二是处理事件，加入延后队列
// 函数里不处理定时器，因为定时器不属于epoll事件
ngx_epoll_process_events, /* process the events */
// 调用epoll_create初始化epoll机制, timer无意义
// 参数size=cycle->connection_n / 2，但并无实际意义
// 设置全局变量，操作系统提供的底层数据收发接口
// 初始化全局的事件模块访问接口，指向epoll的函数
// 默认使用et模式，边缘触发，高速
ngx_epoll_init, /* init the events */
// epoll模块结束工作，关闭epoll句柄和通知句柄，释放内存
ngx_epoll_done, /* done the events */
}
};
// epoll模块定义
ngx_module_t ngx_epoll_module = {
NGX_MODULE_V1,
&ngx_epoll_module_ctx, /* module context */
ngx_epoll_commands, /* module directives */
NGX_EVENT_MODULE, /* module type */
NULL, /* init master */
NULL, /* init module */
NULL, /* init process */
NULL, /* init thread */
NULL, /* exit thread */
NULL, /* exit process */
NULL, /* exit master */
NGX_MODULE_V1_PADDING
};
// aio暂不研究
#if (NGX_HAVE_FILE_AIO)
/*
* We call io_setup(), io_destroy() io_submit(), and io_getevents() directly
* as syscalls instead of libaio usage, because the library header file
* supports eventfd() since 0.3.107 version only.
*/
static int
io_setup(u_int nr_reqs, aio_context_t *ctx)
{
return syscall(SYS_io_setup, nr_reqs, ctx);
}
static int
io_destroy(aio_context_t ctx)
{
return syscall(SYS_io_destroy, ctx);
}
static int
io_getevents(aio_context_t ctx, long min_nr, long nr, struct io_event *events,
struct timespec *tmo)
{
return syscall(SYS_io_getevents, ctx, min_nr, nr, events, tmo);
}
static void
ngx_epoll_aio_init(ngx_cycle_t *cycle, ngx_epoll_conf_t *epcf)
{
int n;
struct epoll_event ee;
#if (NGX_HAVE_SYS_EVENTFD_H)
ngx_eventfd = eventfd(0, 0);
#else
ngx_eventfd = syscall(SYS_eventfd, 0);
#endif
if (ngx_eventfd == -1) {
ngx_log_error(NGX_LOG_EMERG, cycle->log, ngx_errno,
"eventfd() failed");
ngx_file_aio = 0;
return;
}
ngx_log_debug1(NGX_LOG_DEBUG_EVENT, cycle->log, 0,
"eventfd: %d", ngx_eventfd);
n = 1;
if (ioctl(ngx_eventfd, FIONBIO, &n) == -1) {
ngx_log_error(NGX_LOG_EMERG, cycle->log, ngx_errno,
"ioctl(eventfd, FIONBIO) failed");
goto failed;
}
if (io_setup(epcf->aio_requests, &ngx_aio_ctx) == -1) {
ngx_log_error(NGX_LOG_EMERG, cycle->log, ngx_errno,
"io_setup() failed");
goto failed;
}
ngx_eventfd_event.data = &ngx_eventfd_conn;
ngx_eventfd_event.handler = ngx_epoll_eventfd_handler;
ngx_eventfd_event.log = cycle->log;
ngx_eventfd_event.active = 1;
ngx_eventfd_conn.fd = ngx_eventfd;
ngx_eventfd_conn.read = &ngx_eventfd_event;
ngx_eventfd_conn.log = cycle->log;
ee.events = EPOLLIN|EPOLLET;
ee.data.ptr = &ngx_eventfd_conn;
if (epoll_ctl(ep, EPOLL_CTL_ADD, ngx_eventfd, &ee) != -1) {
return;
}
ngx_log_error(NGX_LOG_EMERG, cycle->log, ngx_errno,
"epoll_ctl(EPOLL_CTL_ADD, eventfd) failed");
if (io_destroy(ngx_aio_ctx) == -1) {
ngx_log_error(NGX_LOG_ALERT, cycle->log, ngx_errno,
"io_destroy() failed");
}
failed:
if (close(ngx_eventfd) == -1) {
ngx_log_error(NGX_LOG_ALERT, cycle->log, ngx_errno,
"eventfd close() failed");
}
ngx_eventfd = -1;
ngx_aio_ctx = 0;
ngx_file_aio = 0;
}
#endif
// 调用epoll_create初始化epoll机制, timer无意义
// 参数size=cycle->connection_n / 2，但并无实际意义
// 设置全局变量，操作系统提供的底层数据收发接口
// 初始化全局的事件模块访问接口，指向epoll的函数
// 默认使用et模式，边缘触发，高速
static ngx_int_t
ngx_epoll_init(ngx_cycle_t *cycle, ngx_msec_t timer)
{
ngx_epoll_conf_t *epcf;
// 获取epoll模块的配置
epcf = ngx_event_get_conf(cycle->conf_ctx, ngx_epoll_module);
// ep == -1表示还没有创建epoll句柄，需要初始化
if (ep == -1) {
// 创建epoll句柄
// 参数size=cycle->connection_n / 2，但并无实际意义
ep = epoll_create(cycle->connection_n / 2);
// epoll初始化失败
if (ep == -1) {
ngx_log_error(NGX_LOG_EMERG, cycle->log, ngx_errno,
"epoll_create() failed");
return NGX_ERROR;
}
#if (NGX_HAVE_EVENTFD)
// 初始化多线程通知用的描述符和事件/连接
if (ngx_epoll_notify_init(cycle->log) != NGX_OK) {
// 如果初始化失败，那么notify指针置空
ngx_epoll_module_ctx.actions.notify = NULL;
}
#endif
// aio暂不研究
#if (NGX_HAVE_FILE_AIO)
ngx_epoll_aio_init(cycle, epcf);
#endif
#if (NGX_HAVE_EPOLLRDHUP)
ngx_epoll_test_rdhup(cycle);
#endif
}
// 检查当前事件数组的大小，最开始nevents是0
if (nevents < epcf->events) {
// 如果是reload，那么就先释放，再重新分配内存
if (event_list) {
ngx_free(event_list);
}
// 相当于vector.resize(cf.events)
event_list = ngx_alloc(sizeof(struct epoll_event) * epcf->events,
cycle->log);
if (event_list == NULL) {
return NGX_ERROR;
}
}
// 设置正确的数组长度
nevents = epcf->events;
// 设置全局变量，操作系统提供的底层数据收发接口
// ngx_posix_init.c里初始化为linux的底层接口
ngx_io = ngx_os_io;
// 初始化全局的事件模块访问接口，指向epoll的函数
ngx_event_actions = ngx_epoll_module_ctx.actions;
#if (NGX_HAVE_CLEAR_EVENT)
// 默认使用et模式，边缘触发，高速
ngx_event_flags = NGX_USE_CLEAR_EVENT
#else
ngx_event_flags = NGX_USE_LEVEL_EVENT
#endif
|NGX_USE_GREEDY_EVENT
|NGX_USE_EPOLL_EVENT;
return NGX_OK;
}
#if (NGX_HAVE_EVENTFD)
// 调用系统函数eventfd，创建一个可以用于通知的描述符，用于实现notify
static ngx_int_t
ngx_epoll_notify_init(ngx_log_t *log)
{
struct epoll_event ee;
#if (NGX_HAVE_SYS_EVENTFD_H)
// 调用系统函数eventfd，创建一个可以用于通知的描述符，用于实现notify
// 当通知时写入一个数字，触发可读事件
notify_fd = eventfd(0, 0);
#else
notify_fd = syscall(SYS_eventfd, 0);
#endif
if (notify_fd == -1) {
ngx_log_error(NGX_LOG_EMERG, log, ngx_errno, "eventfd() failed");
return NGX_ERROR;
}
ngx_log_debug1(NGX_LOG_DEBUG_EVENT, log, 0,
"notify eventfd: %d", notify_fd);
// 设置通知用的事件对象回调函数
notify_event.handler = ngx_epoll_notify_handler;
notify_event.log = log;
notify_event.active = 1;
// 设置通知用的连接对象关联的描述符，不用于收发数据
notify_conn.fd = notify_fd;
//只有读事件，写事件无意义
notify_conn.read = ¬ify_event;
notify_conn.log = log;
// 设置epoll事件属性，可读，边缘触发
ee.events = EPOLLIN|EPOLLET;
// union使用ptr成员，关联到连接对象
ee.data.ptr = ¬ify_conn;
// 调用epoll_ctl/EPOLL_CTL_ADD，添加epoll事件
if (epoll_ctl(ep, EPOLL_CTL_ADD, notify_fd, &ee) == -1) {
ngx_log_error(NGX_LOG_EMERG, log, ngx_errno,
"epoll_ctl(EPOLL_CTL_ADD, eventfd) failed");
if (close(notify_fd) == -1) {
ngx_log_error(NGX_LOG_ALERT, log, ngx_errno,
"eventfd close() failed");
}
return NGX_ERROR;
}
return NGX_OK;
}
// 当发生通知事件时的回调函数，再回调真正的功能函数ev->data
static void
ngx_epoll_notify_handler(ngx_event_t *ev)
{
ssize_t n;
uint64_t count;
ngx_err_t err;
ngx_event_handler_pt handler;
// 检查event对象里的index，如果小于0xffffffff则不做任何处理
// 这样可以节约系统资源，避免多余的操作
// 注意有个++操作
if (++ev->index == NGX_MAX_UINT32_VALUE) {
ev->index = 0;
// 从描述符里读8个字节
n = read(notify_fd, &count, sizeof(uint64_t));
err = ngx_errno;
ngx_log_debug3(NGX_LOG_DEBUG_EVENT, ev->log, 0,
"read() eventfd %d: %z count:%uL", notify_fd, n, count);
// 简单地检查一下写入的数字是否正确，只比较长度，不关心内容
if ((size_t) n != sizeof(uint64_t)) {
ngx_log_error(NGX_LOG_ALERT, ev->log, err,
"read() eventfd %d failed", notify_fd);
}
}
// 获取event对象的data成员，转换为函数指针
// ngx_core.h:typedef void (*ngx_event_handler_pt)(ngx_event_t *ev);
handler = ev->data;
// 回调真正的功能函数
handler(ev);
}
#endif
#if (NGX_HAVE_EPOLLRDHUP)
static void
ngx_epoll_test_rdhup(ngx_cycle_t *cycle)
{
int s[2], events;
struct epoll_event ee;
if (socketpair(AF_UNIX, SOCK_STREAM, 0, s) == -1) {
ngx_log_error(NGX_LOG_ALERT, cycle->log, ngx_errno,
"socketpair() failed");
return;
}
ee.events = EPOLLET|EPOLLIN|EPOLLRDHUP;
if (epoll_ctl(ep, EPOLL_CTL_ADD, s[0], &ee) == -1) {
ngx_log_error(NGX_LOG_ALERT, cycle->log, ngx_errno,
"epoll_ctl() failed");
goto failed;
}
if (close(s[1]) == -1) {
ngx_log_error(NGX_LOG_ALERT, cycle->log, ngx_errno,
"close() failed");
s[1] = -1;
goto failed;
}
s[1] = -1;
events = epoll_wait(ep, &ee, 1, 5000);
if (events == -1) {
ngx_log_error(NGX_LOG_ALERT, cycle->log, ngx_errno,
"epoll_wait() failed");
goto failed;
}
if (events) {
ngx_use_epoll_rdhup = ee.events & EPOLLRDHUP;
} else {
ngx_log_error(NGX_LOG_ALERT, cycle->log, NGX_ETIMEDOUT,
"epoll_wait() timed out");
}
ngx_log_debug1(NGX_LOG_DEBUG_EVENT, cycle->log, 0,
"testing the EPOLLRDHUP flag: %s",
ngx_use_epoll_rdhup ? "success" : "fail");
failed:
if (s[1] != -1 && close(s[1]) == -1) {
ngx_log_error(NGX_LOG_ALERT, cycle->log, ngx_errno,
"close() failed");
}
if (close(s[0]) == -1) {
ngx_log_error(NGX_LOG_ALERT, cycle->log, ngx_errno,
"close() failed");
}
}
#endif
// epoll模块结束工作，关闭epoll句柄和通知句柄，释放内存
static void
ngx_epoll_done(ngx_cycle_t *cycle)
{
// 关闭epoll句柄
if (close(ep) == -1) {
ngx_log_error(NGX_LOG_ALERT, cycle->log, ngx_errno,
"epoll close() failed");
}
ep = -1;
#if (NGX_HAVE_EVENTFD)
// 关闭通知句柄
if (close(notify_fd) == -1) {
ngx_log_error(NGX_LOG_ALERT, cycle->log, ngx_errno,
"eventfd close() failed");
}
notify_fd = -1;
#endif
// aio暂不研究
#if (NGX_HAVE_FILE_AIO)
if (ngx_eventfd != -1) {
if (io_destroy(ngx_aio_ctx) == -1) {
ngx_log_error(NGX_LOG_ALERT, cycle->log, ngx_errno,
"io_destroy() failed");
}
if (close(ngx_eventfd) == -1) {
ngx_log_error(NGX_LOG_ALERT, cycle->log, ngx_errno,
"eventfd close() failed");
}
ngx_eventfd = -1;
}
ngx_aio_ctx = 0;
#endif
// 释放内存,vector.clear()
ngx_free(event_list);
// 置为空指针和0，安全
event_list = NULL;
nevents = 0;
}
// epoll添加事件
// 检查事件关联的连接对象，决定是新添加还是修改
// 避免误删除了读写事件的关注
static ngx_int_t
ngx_epoll_add_event(ngx_event_t *ev, ngx_int_t event, ngx_uint_t flags)
{
int op;
uint32_t events, prev;
ngx_event_t *e;
ngx_connection_t *c;
struct epoll_event ee;
// 获取事件关联的连接对象
c = ev->data;
// 计算epoll的标志位
events = (uint32_t) event;
// prev是对应事件的标志
// 添加读事件则查看写事件
if (event == NGX_READ_EVENT) {
e = c->write;
prev = EPOLLOUT;
// 读事件的epoll标志
#if (NGX_READ_EVENT != EPOLLIN|EPOLLRDHUP)
events = EPOLLIN|EPOLLRDHUP;
#endif
// 添加写事件则查看读事件
} else {
e = c->read;
prev = EPOLLIN|EPOLLRDHUP;
// 写事件的epoll标志
#if (NGX_WRITE_EVENT != EPOLLOUT)
events = EPOLLOUT;
#endif
}
// 如果另外的读写事件是活跃的那么就意味着已经加过了
// active的设置就在下面的代码里
// epoll的操作就是修改EPOLL_CTL_MOD
// 需要加上对应事件的读写标志，即prev
if (e->active) {
op = EPOLL_CTL_MOD;
events |= prev;
} else {
op = EPOLL_CTL_ADD;
}
#if (NGX_HAVE_EPOLLEXCLUSIVE && NGX_HAVE_EPOLLRDHUP)
if (flags & NGX_EXCLUSIVE_EVENT) {
events &= ~EPOLLRDHUP;
}
#endif
// 加上flags标志，里面有ET
ee.events = events | (uint32_t) flags;
// union的指针成员，关联到连接对象
// 因为目前的32位/64位的计算机指针地址低位都是0（字节对齐）
// 所以用最低位来存储instance标志，即一个bool值
// 在真正取出连接对象时需要把低位的信息去掉
ee.data.ptr = (void *) ((uintptr_t) c | ev->instance);
ngx_log_debug3(NGX_LOG_DEBUG_EVENT, ev->log, 0,
"epoll add event: fd:%d op:%d ev:%08XD",
c->fd, op, ee.events);
// 到这里，已经确定了是新添加还是修改epoll事件
// 执行系统调用，添加epoll关注事件
if (epoll_ctl(ep, op, c->fd, &ee) == -1) {
ngx_log_error(NGX_LOG_ALERT, ev->log, ngx_errno,
"epoll_ctl(%d, %d) failed", op, c->fd);
return NGX_ERROR;
}
// 添加事件成功，此事件就是活跃的，即已经使用
ev->active = 1;
#if 0
ev->oneshot = (flags & NGX_ONESHOT_EVENT) ? 1 : 0;
#endif
return NGX_OK;
}
// epoll删除事件
// 检查事件关联的连接对象，决定是完全删除还是修改
// 避免误删除了读写事件的关注
static ngx_int_t
ngx_epoll_del_event(ngx_event_t *ev, ngx_int_t event, ngx_uint_t flags)
{
int op;
uint32_t prev;
ngx_event_t *e;
ngx_connection_t *c;
struct epoll_event ee;
/*
* when the file descriptor is closed, the epoll automatically deletes
* it from its queue, so we do not need to delete explicitly the event
* before the closing the file descriptor
*/
// 是否是要求事件关闭
if (flags & NGX_CLOSE_EVENT) {
// 设置active成员
ev->active = 0;
return NGX_OK;
}
// 获取事件关联的连接对象
c = ev->data;
// prev是对应事件的标志
// 添加读事件则查看写事件
if (event == NGX_READ_EVENT) {
e = c->write;
prev = EPOLLOUT;
// 添加写事件则查看读事件
} else {
e = c->read;
prev = EPOLLIN|EPOLLRDHUP;
}
// 如果另外的读写事件是活跃的那么就意味着已经加过了
// active的设置就在下面的代码里
// epoll的操作就是修改EPOLL_CTL_MOD
// 需要加上对应事件的读写标志，即prev
if (e->active) {
op = EPOLL_CTL_MOD;
ee.events = prev | (uint32_t) flags;
// union的指针成员，关联到连接对象
// 因为目前的32位/64位的计算机指针地址低位都是0（字节对齐）
// 所以用最低位来存储instance标志，即一个bool值
// 在真正取出连接对象时需要把低位的信息去掉
ee.data.ptr = (void *) ((uintptr_t) c | ev->instance);
} else {
// 对应的读写事件没有，那么就可以删除整个事件
op = EPOLL_CTL_DEL;
ee.events = 0;
ee.data.ptr = NULL;
}
ngx_log_debug3(NGX_LOG_DEBUG_EVENT, ev->log, 0,
"epoll del event: fd:%d op:%d ev:%08XD",
c->fd, op, ee.events);
// 到这里，已经确定了是删除还是修改epoll事件
// 执行系统调用，删除epoll关注事件
if (epoll_ctl(ep, op, c->fd, &ee) == -1) {
ngx_log_error(NGX_LOG_ALERT, ev->log, ngx_errno,
"epoll_ctl(%d, %d) failed", op, c->fd);
return NGX_ERROR;
}
// 删除事件成功，此事件不活跃，即已停止关注
ev->active = 0;
return NGX_OK;
}
// epoll关注连接的读写事件
// 添加事件成功，读写事件都是活跃的，即已经使用
static ngx_int_t
ngx_epoll_add_connection(ngx_connection_t *c)
{
struct epoll_event ee;
// 不区分读写，添加全部标志位，使用et模式
ee.events = EPOLLIN|EPOLLOUT|EPOLLET|EPOLLRDHUP;
// union的指针成员，关联到连接对象
// 因为目前的32位/64位的计算机指针地址低位都是0（字节对齐）
// 所以用最低位来存储instance标志，即一个bool值
// 在真正取出连接对象时需要把低位的信息去掉
ee.data.ptr = (void *) ((uintptr_t) c | c->read->instance);
ngx_log_debug2(NGX_LOG_DEBUG_EVENT, c->log, 0,
"epoll add connection: fd:%d ev:%08XD", c->fd, ee.events);
// 执行系统调用，直接添加epoll关注事件
if (epoll_ctl(ep, EPOLL_CTL_ADD, c->fd, &ee) == -1) {
ngx_log_error(NGX_LOG_ALERT, c->log, ngx_errno,
"epoll_ctl(EPOLL_CTL_ADD, %d) failed", c->fd);
return NGX_ERROR;
}
// 添加事件成功，读写事件都是活跃的，即已经使用
c->read->active = 1;
c->write->active = 1;
return NGX_OK;
}
// epoll删除连接的读写事件
// 删除事件成功，读写事件都不活跃
static ngx_int_t
ngx_epoll_del_connection(ngx_connection_t *c, ngx_uint_t flags)
{
int op;
struct epoll_event ee;
/*
* when the file descriptor is closed the epoll automatically deletes
* it from its queue so we do not need to delete explicitly the event
* before the closing the file descriptor
*/
if (flags & NGX_CLOSE_EVENT) {
// 删除事件成功，读写事件都不活跃
c->read->active = 0;
c->write->active = 0;
return NGX_OK;
}
ngx_log_debug1(NGX_LOG_DEBUG_EVENT, c->log, 0,
"epoll del connection: fd:%d", c->fd);
// 直接删除所有的事件
op = EPOLL_CTL_DEL;
ee.events = 0;
ee.data.ptr = NULL;
// 执行系统调用，直接删除epoll关注事件
if (epoll_ctl(ep, op, c->fd, &ee) == -1) {
ngx_log_error(NGX_LOG_ALERT, c->log, ngx_errno,
"epoll_ctl(%d, %d) failed", op, c->fd);
return NGX_ERROR;
}
// 删除事件成功，读写事件都不活跃
c->read->active = 0;
c->write->active = 0;