gunicorn Arbiter 源碼解析

　　如 前文所述，Arbiter是gunicorn master進程的核心。Arbiter主要負責管理worker進程，包括啟動、監控、殺掉Worker進程；同時，Arbiter在某些信號發生的時候還可以熱更新（reload）App應用，或者在線升級gunicorn。Arbiter的核心代碼在一個文件里面，代碼量也不大，源碼在此： https://github.com/benoitc/gunicorn。

　　

Arbiter主要有以下方法：

setup:

    處理配置項，最重要的是worker數量和worker工作模型

 

init_signal：

    注冊信號處理函數

 

handle_xxx:

    各個信號具體的處理函數

 

kill_worker，kill_workers:

    向worker進程發信號

 

spawn_worker, spawn_workers:

    fork出新的worker進程

 

murder_workers:

    殺掉一段時間內未響應的worker進程

 

manage_workers:

    根據配置文件的worker數量，以及當前active的worker數量，決定是要fork還是kill worker進程

 

reexec：

    接收到信號 SIGUSR2調用，在線升級gunicorn

 

reload：

    接收到信號 SIGHUP調用，會根據新的配置新啟動worker進程，並殺掉之前的worker進程

 

sleep：

    在沒有信號處理的時候，利用select的timeout進行sleep，可被喚醒

 

wakeup：

    通過向管道寫消息，喚醒進程

 

run：

    主循環

 

　　Arbiter真正被其他代碼（Application）調用的函數只有__init__和run方法，在一句代碼里：

    Arbiter(self).run()

　　上面代碼中的self即為Application實例，其中__init__調用setup進行配置項設置。下面是run方法偽代碼

def run()
    self.init_signal()
    self.LISTENERS = create_sockets(self.cfg, self.log)
    self.manage_workers()
    while True:
        if no signal in SIG_QUEUE
            self.sleep()
        else:
            handle_signal()

 

 關於fork子進程

　　fork子進程的代碼在 spawn_worker, 源碼如下：

　　

    def spawn_worker(self):
        self.worker_age += 1
        worker = self.worker_class(self.worker_age, self.pid, self.LISTENERS,
                                   self.app, self.timeout / 2.0,
                                   self.cfg, self.log)
        self.cfg.pre_fork(self, worker)
        pid = os.fork()
        if pid != 0:
            self.WORKERS[pid] = worker
            return pid

        # Process Child
        worker_pid = os.getpid()
        try:
            util._setproctitle("worker [%s]" % self.proc_name)
            self.log.info("Booting worker with pid: %s", worker_pid)
            self.cfg.post_fork(self, worker)
            worker.init_process()
            sys.exit(0)
        except SystemExit:
            raise
        except AppImportError as e:
            self.log.debug("Exception while loading the application",
                           exc_info=True)
            print("%s" % e, file=sys.stderr)
            sys.stderr.flush()
            sys.exit(self.APP_LOAD_ERROR)
        except:
            self.log.exception("Exception in worker process"),
            if not worker.booted:
                sys.exit(self.WORKER_BOOT_ERROR)
            sys.exit(-1)
        finally:
            self.log.info("Worker exiting (pid: %s)", worker_pid)
            try:
                worker.tmp.close()
                self.cfg.worker_exit(self, worker)
            except:
                self.log.warning("Exception during worker exit:\n%s",
                                  traceback.format_exc())

　　主要流程：

    （1）加載worker_class並實例化（默認為同步模型 SyncWorker）

    （2）父進程（master進程）fork之后return，之后的邏輯都在子進程中運行

    （3）調用worker.init_process 進入循環，worker的所有工作都在這個循環中

    （4）循環結束之后，調用sys.exit(0)

    （5）最后，在finally中，記錄worker進程的退出

    

    下面是我自己寫的一點代碼，把主要的fork流程簡化了一下

# prefork.py
import sys
import socket
import select
import os
import time
 
def do_sub_process():
    pid = os.fork()
    if pid < 0:
        print 'fork error'
        sys.exit(-1)
    elif pid > 0:
        print 'fork sub process %d'  % pid
        return
 
    # must be child process
    time.sleep(1)
    print 'sub process will exit', os.getpid(), os.getppid()
    sys.exit(0)
 
def main():
    sub_num = 2
    for i in range(sub_num):
        do_sub_process()
    time.sleep(10)
    print 'main process will exit', os.getpid()
 
if __name__ == '__main__':
    main()

在測試環境下輸出：

　　fork sub process 9601

　　fork sub process 9602

　　sub process will exit 9601 9600

　　sub process will exit 9602 9600

　　main process will exit 9600

 

　　需要注意的是第20行調用了 sys.exit, 保證子進程的結束，否則會繼續main函數中for循環，以及之后的邏輯。注釋掉第19行重新運行，看輸出就明白了。

 

關於kill子進程

　　master進程要kill worker進程就很簡單了，直接發信號，源碼如下:

　　

    def kill_worker(self, pid, sig):
        """\
        Kill a worker

        :attr pid: int, worker pid
        :attr sig: `signal.SIG*` value
         """
        try:
            os.kill(pid, sig)
        except OSError as e:
            if e.errno == errno.ESRCH:
                try:
                    worker = self.WORKERS.pop(pid)
                    worker.tmp.close()
                    self.cfg.worker_exit(self, worker)
                    return
                except (KeyError, OSError):
                    return
            raise

 

 

關於sleep與wakeup

　　我們再來看看Arbiter的sleep和wakeup。Arbiter在沒有信號需要處理的時候會"sleep"，當然，不是真正調用time.sleep，否則信號來了也不能第一時間處理。這里得實現比較巧妙，利用了管道和select的timeout。看代碼就知道了

        def sleep(self):
        """\
        Sleep until PIPE is readable or we timeout.
        A readable PIPE means a signal occurred.
        """
            ready = select.select([self.PIPE[0]], [], [], 1.0) # self.PIPE = os.pipe()
            if not ready[0]: 
                return
            while os.read(self.PIPE[0], 1):
                pass

　　代碼里面的注釋寫得非常清楚，要么PIPE可讀立即返回，要么等待超時。管道可讀是因為有信號發生。這里看看pipe函數

　　os. pipe()

Create a pipe. Return a pair of file descriptors (r,w) usable for reading and writing, respectively.

 

　　那我們看一下什么時候管道可讀：肯定是往管道寫入的東西，這就是wakeup函數的功能

        def wakeup(self):
            """
            Wake up the arbiter by writing to the PIPE
            """
            os.write(self.PIPE[1], b'.')

 

最后附上Arbiter的信號處理：

• QUIT, INT: Quick shutdown
• TERM: Graceful shutdown. Waits for workers to finish their current requests up to the graceful timeout.
• HUP: Reload the configuration, start the new worker processes with a new configuration and gracefully shutdown older workers. If the application is not preloaded (using the --preloadoption), Gunicorn will also load the new version.
• TTIN: Increment the number of processes by one
• TTOU: Decrement the number of processes by one
• USR1: Reopen the log files
• USR2: Upgrade the Gunicorn on the fly. A separate TERM signal should be used to kill the old process. This signal can also be used to use the new versions of pre-loaded applications.
• WINCH: Gracefully shutdown the worker processes when Gunicorn is daemonized.

 

 

reference：

http://docs.gunicorn.org/en/stable/

http://docs.gunicorn.org/en/stable/signals.html