天天看點

【Redis源碼分析】Server啟動過程

作者:滴水穿石K1

背景

  • 我們通過源碼來看看redis的server啟動的時候會初始化哪些參數或者對象,以及都做了哪些工作?

說明

源碼分析基于redis的6.2版本源碼分析主要是在server.h和server.c本次主要是分析啟動過程的流程,一些細節等後續分章節分析

流程圖

【Redis源碼分析】Server啟動過程

源碼解析

預備知識

redisServer

  • server.h中定義了一個redisServer全局變量,存儲 Redis 伺服器信.包括伺服器配置項和運作時資料:
    • 網絡連接配接資訊
    • 資料庫
    • redisDb
    • 指令表
    • 用戶端資訊
    • 從伺服器資訊
    • 統計資訊等資料

代碼啟動入口

  • Redis的Server執行個體啟動是從server.c這個檔案的main開始執行的
int main(int argc, char **argv) {
    struct timeval tv;
    int j;
    char config_from_stdin = 0;
    // 删除了代碼中的#ifdef
    
    // 設定時區
    setlocale(LC_COLLATE,"");
    tzset(); /* Populates 'timezone' global. */
    //Redis中對記憶體的管理功能由 zmalloc 完成,表示在記憶體不足(out of memory,縮寫oom)的時候所采取的操作
    zmalloc_set_oom_handler(redisOutOfMemoryHandler);
    //以getpid()為随機序列的種子,即将系統傳回的程序ID作為随機序列的種子
    srand(time(NULL)^getpid());
    srandom(time(NULL)^getpid());
    gettimeofday(&tv,NULL);
    init_genrand64(((long long) tv.tv_sec * 1000000 + tv.tv_usec) ^ getpid());
    crc64_init();

    umask(server.umask = umask(0777));
    // 設定随機種子
    uint8_t hashseed[16];
    getRandomBytes(hashseed,sizeof(hashseed));
    dictSetHashFunctionSeed(hashseed);
    // 檢查是否是哨兵模式
    server.sentinel_mode = checkForSentinelMode(argc,argv);
    // 初始服務端的預設配置
    initServerConfig();
    //ACL子系統必須盡快初始化,因為基本的網絡代碼和用戶端建立都依賴于它
    ACLInit();

    // 初始化子產品系統
    moduleInitModulesSystem();
    tlsInit();

    // 将可執行路徑和參數存儲在一個安全的地方,以便以後能夠重新啟動伺服器
    server.executable = getAbsolutePath(argv[0]);
    //儲存執行的參數配置設定記憶體
    server.exec_argv = zmalloc(sizeof(char*)*(argc+1));
    server.exec_argv[argc] = NULL;
    // 儲存執行的參數
    for (j = 0; j < argc; j++) server.exec_argv[j] = zstrdup(argv[j]);


    // 如果是哨兵模式,就初始化哨兵的配置以及哨兵模式的參數
    if (server.sentinel_mode) {
        initSentinelConfig();
        initSentinel();
    }

    /*
     * 檢查是否要執行 RDB 檢測或 AOF 檢查,這對應了實際運作的程式是 redis-check-rdb 或 redis-check-aof
     * */
    // 如果運作的是redis-check-rdb程式 調用redis_check_rdb_main
    if (strstr(argv[0],"redis-check-rdb") != NULL)
        redis_check_rdb_main(argc,argv,NULL);
        // 如果運作的是redis-check-aof程式 調用redis_check_aof_main
    else if (strstr(argv[0],"redis-check-aof") != NULL)
        redis_check_aof_main(argc,argv);

    if (argc >= 2) {
       
        /* 解析指令行的選項 */
        
        // 解析指令行參數  解析配置檔案
        loadServerConfig(server.configfile, config_from_stdin, options);
        if (server.sentinel_mode) loadSentinelConfigFromQueue();
        //釋放一個sds字元串
        sdsfree(options);
    }
    // 哨兵模式,檢查配置檔案
    if (server.sentinel_mode) sentinelCheckConfigFile();
    // 守護程序背景運作
    server.supervised = redisIsSupervised(server.supervised_mode);
    int background = server.daemonize && !server.supervised;
    if (background) daemonize();


    // 初始化服務端
    initServer();
    serverLog(LL_WARNING,"初始化");
    if (background || server.pidfile) createPidFile();
    if (server.set_proc_title) redisSetProcTitle(NULL);
    redisAsciiArt();
    checkTcpBacklogSettings();

    // 如果不是哨兵模式
    if (!server.sentinel_mode) {
    
        moduleInitModulesSystemLast();
        moduleLoadFromQueue();
        ACLLoadUsersAtStartup();
        InitServerLast();
        // 從磁盤上load AOF 或者是 RDB 檔案,以便恢複之前的資料。
        loadDataFromDisk();
     
    } 

    /* 警告可疑的max-memory設定. */
    if (server.maxmemory > 0 && server.maxmemory < 1024*1024) {
        serverLog(LL_WARNING,"WARNING: You specified a maxmemory value that is less than 1MB (current value is %llu bytes). Are you sure this is what you really want?", server.maxmemory);
    }

    redisSetCpuAffinity(server.server_cpulist);
    setOOMScoreAdj(-1);

    // 進入事件驅動架構,開始循環處理各種事件
    aeMain(server.el);
    aeDeleteEventLoop(server.el);
    return 0;
}
           

關鍵的代碼

  • 初始服務端的預設配置 initServerConfig();
  • 初始化服務端 initServer();
  • 進入事件驅動架構,開始循環處理各種觸發的事件 aeMain(server.el);

重點分析initServer函數

void initServer(void) {
    int j;

    //開啟了 Unix 系統日志,則調用 openlog()與 Unix 系統日志建立輸出連接配接,以便輸出系統日志
    if (server.syslog_enabled) {
        openlog(server.syslog_ident, LOG_PID | LOG_NDELAY | LOG_NOWAIT,
            server.syslog_facility);
    }


    // 建立共享對象集合,這些資料可在各場景中共享使用,
    // 如小數字 0~9999、常用字元串+OK\r\n(指令處理成功響應字元串)、+PONG\r\n(ping 指令響應字元串)
    createSharedObjects();
    // 嘗試修改環境變量,提高系統允許打開的檔案描述符上限,避免由于大量用戶端連接配接(Socket 檔案描述符)導緻錯誤。
    adjustOpenFilesLimit();
    const char *clk_msg = monotonicInit();
    serverLog(LL_NOTICE, "monotonic clock: %s", clk_msg);
    // 建立事件驅動架構
    server.el = aeCreateEventLoop(server.maxclients+CONFIG_FDSET_INCR);
    if (server.el == NULL) {
        serverLog(LL_WARNING,
            "Failed creating the event loop. Error message: '%s'",
            strerror(errno));
        exit(1);
    }
    // 配置設定db記憶體
    server.db = zmalloc(sizeof(redisDb)*server.dbnum);

    /* 監聽端口 */
    if (server.port != 0 &&
        listenToPort(server.port,&server.ipfd) == C_ERR) {
        serverLog(LL_WARNING, "Failed listening on port %u (TCP), aborting.", server.port);
        exit(1);
    }
    /* 配置了 server.tls_ port,則開啟 TLS Socket 服務,Redis 6.0 開始支援 TLS 連接配接. */
    if (server.tls_port != 0 &&
        listenToPort(server.tls_port,&server.tlsfd) == C_ERR) {
        serverLog(LL_WARNING, "Failed listening on port %u (TLS), aborting.", server.tls_port);
        exit(1);
    }

    /* 配置了 server.unixsocket,則開啟 UNIX Socket 服務. */
    if (server.unixsocket != NULL) {
        unlink(server.unixsocket); /* don't care if this fails */
        server.sofd = anetUnixServer(server.neterr,server.unixsocket,
            server.unixsocketperm, server.tcp_backlog);
        if (server.sofd == ANET_ERR) {
            serverLog(LL_WARNING, "Opening Unix socket: %s", server.neterr);
            exit(1);
        }
        anetNonBlock(NULL,server.sofd);
        anetCloexec(server.sofd);
    }

    /* 如果根本沒有監聽套接字,則中止. */
    if (server.ipfd.count == 0 && server.tlsfd.count == 0 && server.sofd < 0) {
        serverLog(LL_WARNING, "Configured to not listen anywhere, exiting.");
        exit(1);
    }

    /* 建立Redis資料庫,初始化其他内部狀态。 */
    for (j = 0; j < server.dbnum; j++) {
        // 建立全局哈希表
        server.db[j].dict = dictCreate(&dbDictType,NULL);
        //建立過期key的資訊表
        server.db[j].expires = dictCreate(&dbExpiresDictType,NULL);
        //為被BLPOP阻塞的key建立資訊表
        server.db[j].expires_cursor = 0;
        //為被BLPOP阻塞的key建立資訊表
        server.db[j].blocking_keys = dictCreate(&keylistDictType,NULL);
        //為将執行PUSH的阻塞key建立資訊表
        server.db[j].ready_keys = dictCreate(&objectKeyPointerValueDictType,NULL);
        //為被MULTI/WATCH操作監聽的key建立資訊表
        server.db[j].watched_keys = dictCreate(&keylistDictType,NULL);
        server.db[j].id = j;
        server.db[j].avg_ttl = 0;
        server.db[j].defrag_later = listCreate();
        listSetFreeMethod(server.db[j].defrag_later,(void (*)(void*))sdsfree);
    }
    //初始化LRU 池
    evictionPoolAlloc(); /* Initialize the LRU keys pool. */
    

    /* 建立一個時間事件,執行函數為 serverCron,
     * 這是我們增量處理許多背景操作的方法,比如用戶端逾時,清除未通路的過期鍵等等. */
    if (aeCreateTimeEvent(server.el, 1, serverCron, NULL, NULL) == AE_ERR) {
        serverPanic("Can't create event loop timers.");
        exit(1);
    }

    /* 建立一個事件處理程式,用于接受TCP和Unix域套接字中的新連接配接. */
    if (createSocketAcceptHandler(&server.ipfd, acceptTcpHandler) != C_OK) {
        serverPanic("Unrecoverable error creating TCP socket accept handler.");
    }

    if (createSocketAcceptHandler(&server.tlsfd, acceptTLSHandler) != C_OK) {
        serverPanic("Unrecoverable error creating TLS socket accept handler.");
    }

    //建立檔案事件,并注冊相應的事件處理函數
    if (server.sofd > 0 && aeCreateFileEvent(server.el,server.sofd,AE_READABLE,
        acceptUnixHandler,NULL) == AE_ERR) serverPanic("Unrecoverable error creating server.sofd file event.");

    /*  注冊一個可讀事件,用于在子產品中阻塞的用戶端需要注意時喚醒事件循環。*/
    if (aeCreateFileEvent(server.el, server.module_blocked_pipe[0], AE_READABLE,
        moduleBlockedClientPipeReadable,NULL) == AE_ERR) {
            serverPanic(
                "Error registering the readable event for the module "
                "blocked clients subsystem.");
    }

    /* 注冊事件驅動架構的鈎子函數,事件循環器在每次阻塞前後都會調用鈎子函數*/
    aeSetBeforeSleepProc(server.el,beforeSleep);
    aeSetAfterSleepProc(server.el,afterSleep);

    /* 如果需要,打開AOF檔案. */
    if (server.aof_state == AOF_ON) {
        server.aof_fd = open(server.aof_filename,
                               O_WRONLY|O_APPEND|O_CREAT,0644);
        if (server.aof_fd == -1) {
          
            exit(1);
        }
    }

    /* 如果 Redis 運作在 32 位作業系統上,由于 32 位作業系統記憶體空間限制為 4GB,是以将 Redis 使用記憶體限制為 3GB,避免 Redis 伺服器因記憶體不足而崩潰。. */
    if (server.arch_bits == 32 && server.maxmemory == 0) {
        serverLog(LL_WARNING,"Warning: 32 bit instance detected but no memory limit set. Setting 3 GB maxmemory limit with 'noeviction' policy now.");
        server.maxmemory = 3072LL*(1024*1024); /* 3 GB */
        server.maxmemory_policy = MAXMEMORY_NO_EVICTION;
    }
    // 如果是Cluster 模式啟動則初始化叢集相關的
    if (server.cluster_enabled) clusterInit();
    replicationScriptCacheInit();
    // 初始化LUA機制
    scriptingInit(1);
    // 初始化慢日志機制
    slowlogInit();
    //初始化延遲監控機制
    latencyMonitorInit();
    
    ACLUpdateDefaultUserPassword(server.requirepass);
}
           

總結

  • RedisServer的整體啟動流程:初始化預設配置解析啟動指令初始化server啟動事件驅動架構循環處理各種事件
  • RedisServer結構體存儲服務端配置項、運作時資料

參考文獻

  • 極客時間-Redis源碼剖析與實戰
  • Redis啟動過程源碼分析

繼續閱讀