当前位置：首页 > PHP教程 > php高级应用 > 列表

PHP网络处理模块FPM源码分析

发布:smiling　来源: PHP粉丝网 　添加日期：2023-09-16 16:20:10　浏览: 评论：0　

一个请求从浏览器到达PHP脚本执行中间有个必要模块是网络处理模块，FPM是这个模块的一部分，配合fastcgi协议实现对请求的从监听到转发到PHP处理，并将结果返回这条流程。

FPM采用多进程模型，就是创建一个master进程，在master进程中创建并监听socket，然后fork多个子进程，然后子进程各自accept请求，子进程在启动后阻塞在accept上，有请求到达后开始读取请求 数据，读取完成后开始处理然后再返回，在这期间是不会接收其它请求的，也就是说fpm的子进程同时只能响应 一个请求，只有把这个请求处理完成后才会accept下一个请求，这是一种同步阻塞的模型。master进程负责管理子进程，监听子进程的状态，控制子进程的数量。master进程与worker进程之间通过共享变量同步信息。

从main函数开始

  1. int main(int argc, char *argv[]) 
  2. { 
  3.     zend_signal_startup(); 
  4.     // 将全局变量sapi_module设置为cgi_sapi_module 
  5.     sapi_startup(&cgi_sapi_module); 
  6.     fcgi_init(); 
  7.     // 获取命令行参数，其中php-fpm -D、-i等参数都是在这里被解析出来的 
  8.     // ... 
  9.     cgi_sapi_module.startup(&cgi_sapi_module); 
  10.     fpm_init(argc, argv, fpm_config ? fpm_config : CGIG(fpm_config), fpm_prefix, fpm_pid, test_conf, php_allow_to_run_as_root, force_daemon, force_stderr); 
  11.     // master进程会在这一步死循环,后面的流程都是子进程在执行。 
  12.     fcgi_fd = fpm_run(&max_requests); 
  13.     fcgi_fd = fpm_run(&max_requests); 
  14.     request = fpm_init_request(fcgi_fd); 
  15.     // accept请求 
  16.     // .... 
  17. } 

main()函数展现了这个fpm运行完整的框架,可见整个fpm主要分为三个部分：

1、运行前的fpm_init();

2、运行函数fpm_run();

3、子进程accept请求处理。

FPM中的事件监听机制

在详细了解fpm工作过程前，我们要先了解fpm中的事件机制。在fpm中事件的监听默认使用kqueue来实现，关于kqueue的介绍可以看看我之前整理的这篇文章kqueue用法简介。

  1. // fpm中的事件结构体 
  2. struct fpm_event_s { 
  3.     // 事件的句柄 
  4.     int fd; 
  5.     // 下一次触发的事件 
  6.     struct timeval timeout; 
  7.     // 频率:多久执行一次 
  8.     struct timeval frequency; 
  9.     // 事件触发时调用的函数 
  10.     void (*callback)(struct fpm_event_s *, short, void *); 
  11.     void *arg;                // 调用callback时的参数 
  12.     // FPM_EV_READ:读;FPM_EV_TIMEOUT:;FPM_EV_PERSIST:;FPM_EV_EDGE:; 
  13.     int flags; 
  14.     int index;                // 在fd句柄数组中的索引 
  15.     // 事件的类型 FPM_EV_READ:读;FPM_EV_TIMEOUT:计时器;FPM_EV_PERSIST:;FPM_EV_EDGE:; 
  16.     short which; 
  17. }; 
  18. // 事件队列 
  19. typedef struct fpm_event_queue_s { 
  20.     struct fpm_event_queue_s *prev; 
  21.     struct fpm_event_queue_s *next; 
  22.     struct fpm_event_s *ev; 
  23. } fpm_event_queue; 

以fpm_run()中master进程注册的一个sp[0]的可读事件为例：

  1. void fpm_event_loop(int err) 
  2. { 
  3.     static struct fpm_event_s signal_fd_event; 
  4.     // 创建一个事件:管道sp[0]可读时触发 
  5.     fpm_event_set(&signal_fd_event, fpm_signals_get_fd(), FPM_EV_READ, &fpm_got_signal, NULL); 
  6.     // 将事件添加进queue 
  7.     fpm_event_add(&signal_fd_event, 0); 
  8.     // 处理定时器等逻辑 
  9.     // 以阻塞的方式获取事件 
  10.     // module->wait()是一个接口定义的方法签名，下面展示kqueue的实现 
  11.     ret = module->wait(fpm_event_queue_fd, timeout); 
  12. } 
  13. int fpm_event_add(struct fpm_event_s *ev, unsigned long int frequency) 
  14. { 
  15.     // ... 
  16.     // 如果事件是触发事件则之间添加进queue中 
  17.     // 对于定时器事件先根据事件的frequency设置事件的触发频率和下一次触发的事件 
  18.     if (fpm_event_queue_add(&fpm_event_queue_timer, ev) != 0) { 
  19.         return -1; 
  20.     } 
  21.     return 0; 
  22. } 
  23. static int fpm_event_queue_add(struct fpm_event_queue_s **queue, struct fpm_event_s *ev) 
  24. { 
  25.     // ... 
  26.     // 构建并将当前事件插入事件队列queue中 
  27.     if (*queue == fpm_event_queue_fd && module->add) { 
  28.         // module->add(ev)是一个接口定义的方法签名，下面展示kqueue的实现 
  29.         module->add(ev); 
  30.     } 
  31.     return 0; 
  32. } 
  33. // kqueue关于添加事件到kqueue的实现 
  34. static int fpm_event_kqueue_add(struct fpm_event_s *ev) /* {{{ */ 
  35. { 
  36.     struct kevent k; 
  37.     int flags = EV_ADD; 
  38.     if (ev->flags & FPM_EV_EDGE) { 
  39.             flags = flags | EV_CLEAR; 
  40.     } 
  41.     EV_SET(&k, ev->fd, EVFILT_READ, flags, 0, 0, (void *)ev); 
  42.     if (kevent(kfd, &k, 1, NULL, 0, NULL) < 0) { 
  43.         zlog(ZLOG_ERROR, "kevent: unable to add event"); 
  44.         return -1; 
  45.     } 
  46.     /* mark the event as registered */ 
  47.     ev->index = ev->fd; 
  48.     return 0; 
  49. } 

FPM中关于kqueue的实现

  1. // kqueue关于从kqueue中监听事件的实现 
  2. static int fpm_event_kqueue_wait(struct fpm_event_queue_s *queue, unsigned long int timeout) /* {{{ */ 
  3. { 
  4.     struct timespec t; 
  5.     int ret, i; 
  6.     /* ensure we have a clean kevents before calling kevent() */ 
  7.     memset(kevents, 0, sizeof(struct kevent) * nkevents); 
  8.     /* convert ms to timespec struct */ 
  9.     t.tv_sec = timeout / 1000; 
  10.     t.tv_nsec = (timeout % 1000) * 1000 * 1000; 
  11.     /* wait for incoming event or timeout */ 
  12.     ret = kevent(kfd, NULL, 0, kevents, nkevents, &t); 
  13.     if (ret == -1) { 
  14.         /* trigger error unless signal interrupt */ 
  15.         if (errno != EINTR) { 
  16.             zlog(ZLOG_WARNING, "epoll_wait() returns %d", errno); 
  17.             return -1; 
  18.         } 
  19.     } 
  20.     /* fire triggered events */ 
  21.     for (i = 0; i < ret; i++) { 
  22.         if (kevents[i].udata) { 
  23.             struct fpm_event_s *ev = (struct fpm_event_s *)kevents[i].udata; 
  24.             fpm_event_fire(ev); 
  25.             /* sanity check */ 
  26.             if (fpm_globals.parent_pid != getpid()) { 
  27.                 return -2; 
  28.             } 
  29.         } 
  30.     } 
  31.     return ret; 
  32. } 

fpm_init

fpm_init()负责启动前的初始化工作，包括注册各个模块的销毁时用于清理变量的callback。下面只介绍几个重要的init。

fpm_conf_init_main

负责解析php-fpm.conf配置文件，分配worker pool内存结构并保存到全局变量fpm_worker_all_pools中，各worker pool配置解析到 fpm_worker_pool_s->config 中。

所谓worker pool 是fpm可以同时监听多个端口，每个端口对应一个worker pool。

fpm_scoreboard_init_main

为每个worker pool分配一个fpm_scoreboard_s结构的内存空间scoreboard，用于记录worker进程运行信息。

  1. // fpm_scoreboard_s 结构 
  2. struct fpm_scoreboard_s { 
  3.     union { 
  4.         atomic_t lock; 
  5.         char dummy[16]; 
  6.     }; 
  7.     char pool[32]; 
  8.     int pm;                    // 进程的管理方式 static、dynamic、ondemand 
  9.     time_t start_epoch; 
  10.     int idle;                // 空闲的worker进程数 
  11.     int active;                // 繁忙的worker进程数 
  12.     int active_max;            // 最大繁忙进程数 
  13.     unsigned long int requests; 
  14.     unsigned int max_children_reached; 
  15.     int lq; 
  16.     int lq_max; 
  17.     unsigned int lq_len; 
  18.     unsigned int nprocs; 
  19.     int free_proc; 
  20.     unsigned long int slow_rq; 
  21.     struct fpm_scoreboard_proc_s *procs[]; 
  22. }; 

fpm_signals_init_main

fpm注册自己的信号量，并设置监听函数的处理逻辑。

  1. int fpm_signals_init_main() /* {{{ */ 
  2. { 
  3.     struct sigaction act; 
  4.     // 创建一个全双工套接字 
  5.     // 全双工的套接字是一个可以读、写的socket通道[0]和[1]，每个进程固定一个管道。 
  6.     // 写数据时：管道不满不会被阻塞；读数据时：管道里没有数据会阻塞(可设置) 
  7.     // 向sp[0]写入数据时，sp[0]的读取将会被阻塞,sp[1]的写管道会被阻塞，sp[1]中此时读取sp[0]的数据 
  8.     if (0 > socketpair(AF_UNIX, SOCK_STREAM, 0, sp)) { 
  9.         zlog(ZLOG_SYSERROR, "failed to init signals: socketpair()"); 
  10.         return -1; 
  11.     } 
  12.     if (0 > fd_set_blocked(sp[0], 0) || 0 > fd_set_blocked(sp[1], 0)) { 
  13.         zlog(ZLOG_SYSERROR, "failed to init signals: fd_set_blocked()"); 
  14.         return -1; 
  15.     } 
  16.     if (0 > fcntl(sp[0], F_SETFD, FD_CLOEXEC) || 0 > fcntl(sp[1], F_SETFD, FD_CLOEXEC)) { 
  17.         zlog(ZLOG_SYSERROR, "falied to init signals: fcntl(F_SETFD, FD_CLOEXEC)"); 
  18.         return -1; 
  19.     } 
  20.     memset(&act, 0, sizeof(act)); 
  21.     act.sa_handler = sig_handler;       // 监听到信号调用这个函数 
  22.     sigfillset(&act.sa_mask); 
  23.     if (0 > sigaction(SIGTERM,  &act, 0) || 
  24.         0 > sigaction(SIGINT,   &act, 0) || 
  25.         0 > sigaction(SIGUSR1,  &act, 0) || 
  26.         0 > sigaction(SIGUSR2,  &act, 0) || 
  27.         0 > sigaction(SIGCHLD,  &act, 0) || 
  28.         0 > sigaction(SIGQUIT,  &act, 0)) { 
  29.         zlog(ZLOG_SYSERROR, "failed to init signals: sigaction()"); 
  30.         return -1; 
  31.     } 
  32.     return 0; 
  33. } 
  34. // 所有信号共用同一个处理函数 
  35. static void sig_handler(int signo) /* {{{ */ 
  36. { 
  37.     static const char sig_chars[NSIG + 1] = { 
  38.         [SIGTERM] = 'T', 
  39.         [SIGINT]  = 'I', 
  40.         [SIGUSR1] = '1', 
  41.         [SIGUSR2] = '2', 
  42.         [SIGQUIT] = 'Q', 
  43.         [SIGCHLD] = 'C' 
  44.     }; 
  45.     char s; 
  46.     int saved_errno; 
  47.     if (fpm_globals.parent_pid != getpid()) { 
  48.         return; 
  49.     } 
  50.     saved_errno = errno; 
  51.     s = sig_chars[signo]; 
  52.     zend_quiet_write(sp[1], &s, sizeof(s)); // 将信息对应的字节写进管道sp[1]端，此时sp[1]端的读数据会阻塞;数据可以从sp[0]端读取 
  53.     errno = saved_errno; 
  54. } 

fpm_sockets_init_main

每个worker pool 开启一个socket套接字。

fpm_event_init_main

这里启动master的事件管理器。用于管理IO、定时事件，其中IO事件通过kqueue、epoll、 poll、select等管理，定时事件就是定时器，一定时间后触发某个事件。同样，我们以kqueue的实现为例看下源码。

  1. int fpm_event_init_main() 
  2. { 
  3.     // ... 
  4.     if (module->init(max) < 0) { 
  5.         zlog(ZLOG_ERROR, "Unable to initialize the event module %s", module->name); 
  6.         return -1; 
  7.     } 
  8.     // ... 
  9. } 
  10. // max用于指定kqueue事件数组的大小 
  11. static int fpm_event_kqueue_init(int max) /* {{{ */ 
  12. { 
  13.     if (max < 1) { 
  14.         return 0; 
  15.     } 
  16.     kfd = kqueue(); 
  17.     if (kfd < 0) { 
  18.         zlog(ZLOG_ERROR, "kqueue: unable to initialize"); 
  19.         return -1; 
  20.     } 
  21.     kevents = malloc(sizeof(struct kevent) * max); 
  22.     if (!kevents) { 
  23.         zlog(ZLOG_ERROR, "epoll: unable to allocate %d events", max); 
  24.         return -1; 
  25.     } 
  26.     memset(kevents, 0, sizeof(struct kevent) * max); 
  27.     nkevents = max; 
  28.     return 0; 
  29. } 

fpm_run

fpm_init到此结束，下面进入fpm_run阶段，在这个阶段master进程会根据配置fork出多个子进程然后master进程会进入fpm_event_loop(0)函数，并在这个函数内部死循环，也就是说master进程将不再执行后面的代码，后面的逻辑全部是子进程执行的操作。

master进程在fpm_event_loop里通过管道sp来监听子进程的各个事件，同时也要处理自身产生的一些事件、定时器等任务，来响应的管理子进程。内部的逻辑在介绍事件监听机制时已经详细说过。

  1. int fpm_run(int *max_requests) /* {{{ */ 
  2. { 
  3.     struct fpm_worker_pool_s *wp; 
  4.     /* create initial children in all pools */ 
  5.     for (wp = fpm_worker_all_pools; wp; wp = wp->next) { 
  6.         int is_parent; 
  7.         is_parent = fpm_children_create_initial(wp); 
  8.         if (!is_parent) { 
  9.             goto run_child; 
  10.         } 
  11.     } 
  12.     /* run event loop forever */ 
  13.     fpm_event_loop(0); 
  14. run_child: /* only workers reach this point */ 
  15.     fpm_cleanups_run(FPM_CLEANUP_CHILD); 
  16.     *max_requests = fpm_globals.max_requests; 
  17.     return fpm_globals.listening_socket; 
  18. } 

子进程处理请求

回到main函数，fpm_run后面的逻辑都是子进程在运行。首先会初始化一个fpm的request结构的变量，然后子进程会阻塞在fcgi_accept_request(request)函数上等待请求。关于fcgi_accept_request函数就是死循环一个socket编程的accept函数来接收请求，并将请求数据全部取出。

  1. ... 
  2. // 初始化request 
  3. request = fpm_init_request(fcgi_fd); 
  4. zend_first_try { 
  5.     // accept接收请求 
  6.     while (EXPECTED(fcgi_accept_request(request) >= 0)) { 
  7.         init_request_info(); 
  8.         fpm_request_info(); 
  9.         if (UNEXPECTED(php_request_startup() == FAILURE)) { 
  10.             // ... 
  11.         } 
  12.         if (UNEXPECTED(fpm_status_handle_request())) { 
  13.             goto fastcgi_request_done; 
  14.         } 
  15.         ... 
  16.         // 打开配置文件中DOCUMENT_ROOT设置的脚本 
  17.         if (UNEXPECTED(php_fopen_primary_script(&file_handle) == FAILURE)) { 
  18.             ... 
  19.         } 
  20.         fpm_request_executing(); 
  21.         // 执行脚本 
  22.         php_execute_script(&file_handle); 
  23.         ... 
  24.     } 
  25.     // 销毁请求request 
  26.     fcgi_destroy_request(request); 
  27.     // fcgi退出 
  28.     fcgi_shutdown(); 
  29.     if (cgi_sapi_module.php_ini_path_override) { 
  30.         free(cgi_sapi_module.php_ini_path_override); 
  31.     } 
  32.     if (cgi_sapi_module.ini_entries) { 
  33.         free(cgi_sapi_module.ini_entries); 
  34.     } 
  35. } zend_catch { 
  36.     ... 
  37. } zend_end_try();

Tags: PHP网络处理模块 FPM源码分析

分享到：

推荐文章

热门文章

最新评论文章