標籤：

［PHP源碼分析］FastCGI協議淺析

09-03
［PHP源碼分析］FastCGI協議淺析

來自專欄猿論13 人贊了文章

順風車運營研發團隊 陳雷

FastCGI 是一種協議，它是建立在CGI/1.1基礎之上的，把CGI/1.1裡面的要傳遞的數據通過FastCGI協議定義的順序和格式進行傳遞。為了更好理解PHP-FPM的工作，下面具體闡述一下FastCGI協議的內容。

1. 消息類型

FastCGI協議分為了10種類型，具體定義如下：

typedef enum _fcgi_request_type { FCGI_BEGIN_REQUEST = 1, /* [in] */ FCGI_ABORT_REQUEST = 2, /* [in] (not supported) */ FCGI_END_REQUEST = 3, /* [out] */ FCGI_PARAMS = 4, /* [in] environment variables */ FCGI_STDIN = 5, /* [in] post data */ FCGI_STDOUT = 6, /* [out] response */ FCGI_STDERR = 7, /* [out] errors */ FCGI_DATA = 8, /* [in] filter data (not supported) */ FCGI_GET_VALUES = 9, /* [in] */ FCGI_GET_VALUES_RESULT = 10 /* [out] */} fcgi_request_type;

整個FastCGI是二進位連續傳遞的，定義了一個統一結構的消息頭，用來讀取每個消息的消息體，方便消息包的切割。一般情況下，最先發送的是FCGI_BEGIN_REQUEST類型的消息，然後是FCGI_PARAMS和FCGI_STDIN類型的消息，當FastCGI響應處理完後，將發送FCGI_STDOUT和FCGI_STDERR類型的消息，最後以FCGI_END_REQUEST表示請求的結束。FCGI_BEGIN_REQUEST和FCGI_END_REQUEST分別表示請求的開始和結束，與整個協議相關。

2. 消息頭

對於10種類型的消息，都是以一個消息頭開始的，其結構體定義如下：

typedef struct _fcgi_header { unsigned char version; unsigned char type; unsigned char requestIdB1; unsigned char requestIdB0; unsigned char contentLengthB1; unsigned char contentLengthB0; unsigned char paddingLength; unsigned char reserved;} fcgi_header;

其中，

  • version標識FastCGI協議版本
  • type 標識FastCGI記錄類型
  • requestId標識消息所屬的FastCGI請求

requestId計算方式如下：

(requestIdB1 << 8) + requestIdB0

所以requestId的範圍為0~2的16次方-1，也就是0~65535；

contentLength標識消息的contentData組件的位元組數，計算方式跟requestId類似，範圍同樣是0~65535：

(contentLengthB1 << 8) | contentLengthB0

paddingLength標識消息的paddingData組件的位元組數，範圍是0~255；協議通過paddingData提供給發送者填充發送的記錄的功能，並且方便接受者通過paddingLength快速的跳過paddingData。填充的目的是允許發送者為更有效地處理保持對齊的數據。如果內容的長度超過65535怎麼辦呢？答案是可以分成多個消息發送。

3. FCGI_BEGIN_REQUEST

FCGI_BEGIN_REQUEST 的結構體定義如下：

typedef struct _fcgi_begin_request { unsigned char roleB1; unsigned char roleB0; unsigned char flags; unsigned char reserved[5];} fcgi_begin_request;

其中role代表的是Web伺服器期望應用扮演的角色，計算方式是：

(roleB1 << 8) + roleB0

對於PHP7中，處理了三種角色，分別是FCGI_RESPONDER，FCGI_AUTHORIZER 和FCGI_FILTER。

flags & FCGI_KEEP_CONN：如果為0，則在對本次請求響應後關閉鏈接。如果非0，在對本次請求響應後不會關閉鏈接。

4. 名-值對

對於，type為FCGI_PARAMS類型，FastCGI協議中提供了名-值對來很好的滿足讀寫可變長度的name和value，格式如下：

nameLength+valueLength+name+value

為了節省空間，對於0~127長度的值，Length使用了一個char來表示，第一位為0，對於大於127的長度的值，Length使用了4個char來表示，第一位為1；如圖所示：

長度計算代碼如下：

if (UNEXPECTED(name_len >= 128)) { if (UNEXPECTED(p + 3 >= end)) return 0; name_len = ((name_len & 0x7f) << 24); name_len |= (*p++ << 16); name_len |= (*p++ << 8); name_len |= *p++;}

這樣最長可以表達0~2的31次方的長度。

5. 請求協議

FastCGI協議的定義結構體如下：

typedef struct _fcgi_begin_request_rec { fcgi_header hdr; fcgi_begin_request body;} fcgi_begin_request_rec;

分析完FastCGI的協議，我們整體掌握了請求的FastCGI消息的內容，我們通過訪問對應的介面，採用gdb抓取其中的內容：

首先我們修改php-fpm.conf的參數，保證只啟動一個worker：

pm.max_children = 1

然後重新啟動php-fpm：

./sbin/php-fpm -y etc/php-fpm.conf

然後對worker進行gdb：

ps aux | grep php-fpmroot 30014 0.0 0.0 142308 4724 ? Ss Nov26 0:03 php-fpm: master process (etc/php-fpm.conf)chenlei 30015 0.0 0.0 142508 5500 ? S Nov26 0:00 php-fpm: pool wwwgdb –p 30015(gdb) b fcgi_read_request

然後通過瀏覽器訪問nginx，nginx轉發到php-fpm的worker上，根據gdb可以列印出FastCGI消息的內容：

(gdb) b fcgi_read_request

對於第一個消息，內容如圖：

其中type對應的是FCGI_BEGIN_REQUEST，requestid為1，長度為8， 恰好是fcgi_begin_request結構體的大小，內容如圖：

role對應的是FCGI_RESPONDER。繼續往下讀，得到的消息內容如圖：

其中type對應的是FCGI_PARAMS，requestid為1，長度為：

(contentLengthB1 << 8) | contentLengthB0 == 987

paddingLength=5，而987+5=992，恰好是8的倍數。根據contentLength+ paddingLength向後讀取992長度的位元組流，我們列印一下：

(gdb) p *p@987$1 = "17TSCRIPT_FILENAME/home/xiaoju/webroot/beatles/application/mis/mis/src/index.php/admin/operation/indexf16QUERY_STRINGactivity_id=891603REQUEST_METHODGETf00CONTENT_TYPE1600CONTENT_LENGTHv SCRIPT_NAME/index.php/admin/operation/indexv%REQUEST_URI/admin/operation/index?activity_id=89f DOCUMENT_URI/index.php/admin/operation/index
4DOCUMENT_ROOT/home/xiaoju/webroot/beatles/application/mis/mis/src17SERVER_PROTOCOLHTTP/1.121aGATEWAY_INTERFACECGI/1.117vSERVER_SOFTWAREnginx/1.2.5v
REMOTE_ADDR172.22.32.131v05REMOTE_PORT50973vfSERVER_ADDR10.94.98.116v04SERVER_PORT8085v00SERVER_NAME1703REDIRECT_STATUS200 21HTTP_HOST10.94.98.116:808517
HTTP_CONNECTIONkeep-alive17xHTTP_USER_AGENTMozilla/5.0 (Macintosh; Intel Mac OS X 10_11_6) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/62.0.3202.94 Safari/537.363601HTTP_UPGRADE_INSECURE_REQUESTS1vUHTTP_ACCEPTtext/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.824
HTTP_ACCEPT_ENCODINGgzip, deflate2427HTTP_ACCEPT_LANGUAGEzh-CN,zh;q=0.9,en;q=0.8"

根據上一節我們講到的名-值對的長度規則，我們可以看出，Fastcgi協議中封裝了類似於http協議裡面的鍵值對。讀取完畢後，繼續跟蹤消息，列印可以得出，得到的消息如圖所示。

其中type對應的是FCGI_PARAMS，requestid為1，長度為0，此時完成了FastCGI協議消息的讀取過程。下面說一下處理完請求後返回給nginx的FastCGI協議的消息。

6. 響應協議

在fcgi_finish_request中調用fcgi_flush，fcgi_flush中封裝一個FCGI_END_REQUEST消息體，再通過safe_write寫入 socket 連接的客戶端描述符。

int fcgi_flush(fcgi_request *req, int close){ int len; close_packet(req); len = (int)(req->out_pos - req->out_buf); if (close) { fcgi_end_request_rec *rec = (fcgi_end_request_rec*)(req->out_pos); //創建FCGI_END_REQUEST的頭 fcgi_make_header(&rec->hdr, FCGI_END_REQUEST, req->id, sizeof(fcgi_end_request)); //寫入appStatus rec->body.appStatusB3 = 0; rec->body.appStatusB2 = 0; rec->body.appStatusB1 = 0; rec->body.appStatusB0 = 0; //修改protocolStatus為FCGI_REQUEST_COMPLETE; rec->body.protocolStatus = FCGI_REQUEST_COMPLETE; len += sizeof(fcgi_end_request_rec); } if (safe_write(req, req->out_buf, len) != len) { req->keep = 0; req->out_pos = req->out_buf; return 0; } req->out_pos = req->out_buf; return 1;}

到此我們就完全掌握了FastCGI的協議。

作者：陳雷_順風車

鏈接：imooc.com/article/45163

來源：慕課網

本文原創發佈於慕課網 ，轉載請註明出處，謝謝合作

推薦閱讀：

【官方】手記欄目認證作者招募，長期有效，隨時報名！_慕課手記

有獎徵文006期 | 聊聊面試那些事兒？

Jenkins+Ansible+Gitlab自動化部署三劍客

PWA，現代前端必會的黑科技

淺析特定場景下取代if-else和switch的方案


推薦閱讀：

TAG:PHP | PHP開發 | 源碼 |