文章17 ngx_http_request_t结构体详解(转)
转载注明http://blog.csdn.net/yankai0219/article/details/8220621
由于本人能力有限，对于这些结构体的成员变量的解释，肯定有所差池，还请大家指出，大家共同学习
主要内容：
0.序
一、ngx_http_request_t结构体解释
二、ngx_http_request_body_t结构体
三ngx_http_headers_in_t结构体
四附录：里面用到的一些函数
五一些没有搞清楚的成员变量
0.序
在nginx中我们指的是 http请求，具体到nginx中的数据结构是 ngx_http_request_t。ngx_http_request_t是对一个http请求的封装。 我们知道，一个http请求，包含请求行、请求头、请求体、响应行、响应头、响应体。
nginx中http代表http请求的数据结构是ngx_http_request_t。
一个http请求，包含请求行、请求头、请求体、响应行、响应头、响应体。
http请求是典型的请求-响应类型的的网络协议，而http是文件协议，所以我们在分析请求行与请求头，以及输出响应行与响应头，往往是一行一行的进行处理。如果我们自己来写一个http服务器，通常在一个连接建立好后，客户端会发送请求过来。然后我们读取一行数据，分析出请求行中包含的method、uri、http_version信息。然后再一行一行处理请求头，并根据请求method与请求头的信息来决定是否有请求体以及请求体的长度，然后再去读取请求体。得到请求后，我们处理请求产生需要输出的数据，然后再生成响应行，响应头以及响应体。在将响应发送给客户端之后，一个完整的请求就处理完了。当然这是最简单的webserver的处理方式，其实nginx也是这样做的，只是有一些小小的区别，比如，当请求头读取完成后，就开始进行请求的处理了。nginx通过ngx_http_request_t来保存解析请求与输出响应相关的数据。
首先一个http请求包含请求消息与响应消息。请求消息包括请求行、请求头、请求体。响应消息包括响应行、响应头、响应体。
其次，在nginx中，ngx_http_request_t代表一个http请求，即ngx_http_request_t中包含了所有http请求的内容。
再次，关于message-body的存在与否，是与HTTP协议有关。
再次，关于message-body的存在与否，是与HTTP协议有关。
最后，得到请求后，我们处理请求产生需要输出的数据，再生成响应行、响应头、响应体。
另外，提到nginx的区别，当请求头读取完成后，就开始进行请求的处理。是因为nginx采用异步处理。在读取请求头后，就进行请求的处理，而对于message-body的处理则异步进行。、
http://hi.baidu.com/toughie/item/aa8990c1314a5d78cfd4f843
http://tengine.taobao.org/book/chapter_2.html#request
1 struct ngx_http_request_s { 2 uint32_t signature; /* "HTTP" */ 3 /* 4 与连接有关的内容 5 */ 6 ngx_connection_t * connection; 7 /* 8 以下四个保存的是模块所对应的上下文结构体的指针。 9 其中ctx对应于自定义的上下文结构体指针 10 main_conf对应于main的上下文结构体指针 11 loc_conf对应于loc的上下文结构体指针 12 src_conf对应于srv的上下文结构体指针 13 */ 14 15 void ** ctx; 16 void ** main_conf; 17 void ** srv_conf; 18 void ** loc_conf; 19 /*读写事件的函数指针*/ 20 ngx_http_event_handler_pt read_event_handler; 21 ngx_http_event_handler_pt write_event_handler; 22 23 #if (NGX_HTTP_CACHE) 24 ngx_http_cache_t * cache; 25 #endif 26 /* 27 与upstream模块相关的结构体 28 */ 29 ngx_http_upstream_t * upstream;/*用于upstream模块*/ 30 ngx_array_t * upstream_states;/*与upstream模块相关*/ 31 /* of ngx_http_upstream_state_t */ 32 33 ngx_pool_t * pool;/*内存池*/ 34 ngx_buf_t * header_in;// 会保存一些消息体的内容 35 36 ngx_http_headers_in_t headers_in;//代表请求头部 // 请求的header结构体 37 ngx_http_headers_out_t headers_out;//代表响应头部 38 39 ngx_http_request_body_t * request_body;//代表请求头部.r-> request_body-> bufs中存放的请求体中的数据 40 41 42 time_t lingering_time; /*unkown*/ 43 time_t start_sec;/*unkown*/ 44 ngx_msec_t start_msec; /*unkown*/ 45 46 /* 47 从method到http_protocol都是请求行中信息 48 */ 49 ngx_uint_t method; 50 ngx_uint_t http_version;//http版本 51 52 ngx_str_t request_line;//请求行 53 ngx_str_t uri; 54 ngx_str_t args; 55 ngx_str_t exten; 56 ngx_str_t unparsed_uri; 57 58 ngx_str_t method_name; 59 ngx_str_t http_protocol; 60 61 62 ngx_chain_t * out; /*unkown*//*这里要注意ngx_http_request_t中有一个out的chain，这个chain保存的是上一次还没有被发完的buf，这样每次我们接收到新的chain的话，就需要将新的chain连接到老的out chain上，然后再发出去*/ 63 /*接下来从main到posted_requests都是与主请求和子请求有关的内容/ 64 ngx_http_request_t * main;//这个表示主的request，也就是当前的request链中最上面的那个request，通过这个域我们就能判断当前的request是不是subrequest。 65 ngx_http_request_t * parent;//这个表示当前的request的父request。 66 //subrequest就是子请求，也就是在当前的一个请求中nginx再生成一个请求。 67 ngx_http_postponed_request_t * postponed;//先来看postponed，这个域用来缓存父request的数据（也就是将要发送数据的request) 68 ngx_http_post_subrequest_t * post_subrequest;//这个域保存了子请求的post request，它也就是保存了需要被发送的request. 69 ngx_http_posted_request_t * posted_requests;//这个保存了所有的需要处理的request链表，也就是说它即包含子请求也包含父请求 70 /* virtual hosts based on the address:port 71 r->virtual_names = addr_conf->virtual_names 72 */ 73 ngx_http_virtual_names_t * virtual_names; 74 75 ngx_int_t phase_handler; /*应该是在请求处理的多个阶段中，利用phase_handler依次执行多个阶段*/ 76 ngx_http_handler_pt content_handler; /*生成内容的处理函数 比如ngx_http_proxy_handler等*/ 77 ngx_uint_t access_code;/*unkown*/ 78 79 ngx_http_variable_value_t * variables;//variables 包含了所有的变量 80 81 #if (NGX_PCRE) 82 ngx_uint_t ncaptures; 83 int * captures; 84 u_char * captures_data; 85 #endif 86 87 size_t limit_rate;/*unkown*/ 88 /* 89 r->limit_rate，这个表示当前的request的发送限制速率，这个也是在nginx.conf中配置的，而一般就是通过这个值来设置c->write->delayed的。也就是说如果发送速率大于这个limit了的话，就设置delayed，然后这边的request就会延迟发送 90 */ 91 92 /* used to learn the Apache compatible response length without a header */ 93 size_t header_size;/*unkown*/ 94 95 off_t request_length;/*unkown*/ 96 97 ngx_uint_t err_status;/*unkown*/ 98 99 100 ngx_http_connection_t * http_connection;/*unkown*/ 101 102 ngx_http_log_handler_pt log_handler; /*unkown*/ 103 104 ngx_http_cleanup_t * cleanup; 105 106 unsigned subrequests:8; 107 unsigned count:8; 108 unsigned blocked:8; 109 110 unsigned aio:1; 111 112 unsigned http_state:4; 113 114 /* URI with "/." and on Win32 with "//" */ 115 unsigned complex_uri:1; 116 117 /* URI with "%" */ 118 unsigned quoted_uri:1; 119 120 /* URI with "+" */ 121 unsigned plus_in_uri:1; 122 123 /* URI with " " */ 124 unsigned space_in_uri:1; 125 126 unsigned invalid_header:1;// 一个标示位，标示header是否有效，不正常的结束视为无效 127 128 unsigned add_uri_to_alias:1; 129 unsigned valid_location:1; 130 unsigned valid_unparsed_uri:1; 131 unsigned uri_changed:1; 132 unsigned uri_changes:4; 133 /* 134 下面这两个参数就会设定为每个body都存放到临时文件里，并且这个临时文件在请求结束后不会被删除： 135 r->request_body_in_persistent_file = 1; 136 r->request_body_in_file_only = 1; 137 */ 138 unsigned request_body_in_single_buf:1; 139 unsigned request_body_in_file_only:1; 140 unsigned request_body_in_persistent_file:1; 141 unsigned request_body_in_clean_file:1; 142 unsigned request_body_file_group_access:1; 143 unsigned request_body_file_log_level:3; 144 145 unsigned subrequest_in_memory:1; 146 unsigned waited:1; 147 148 #if (NGX_HTTP_CACHE) 149 unsigned cached:1; 150 #endif 151 152 #if (NGX_HTTP_GZIP) 153 unsigned gzip_tested:1; 154 unsigned gzip_ok:1; 155 unsigned gzip_vary:1; 156 #endif 157 158 unsigned proxy:1; 159 unsigned bypass_cache:1; 160 unsigned no_cache:1; 161 162 /* 163 * instead of using the request context data in 164 * ngx_http_limit_conn_module and ngx_http_limit_req_module 165 * we use the single bits in the request structure 166 */ 167 unsigned limit_conn_set:1; 168 unsigned limit_req_set:1; 169 170 #if 0 171 unsigned cacheable:1; 172 #endif 173 174 unsigned pipeline:1; 175 unsigned plain_http:1; 176 unsigned chunked:1; 177 unsigned header_only:1; /*当请求方法为HEAD时，r->header_only=1 ，在ngx_http_header_filter函数中*/ 178 unsigned keepalive:1; 179 unsigned lingering_close:1; 180 unsigned discard_body:1; 181 unsigned internal:1; 182 unsigned error_page:1; 183 unsigned ignore_content_encoding:1; 184 unsigned filter_finalize:1; 185 unsigned post_action:1; 186 unsigned request_complete:1; 187 unsigned request_output:1; 188 unsigned header_sent:1; 189 unsigned expect_tested:1; 190 unsigned root_tested:1; 191 unsigned done:1; 192 unsigned logged:1; 193 194 unsigned buffered:4; 195 196 unsigned main_filter_need_in_memory:1; 197 unsigned filter_need_in_memory:1; 198 unsigned filter_need_temporary:1; 199 unsigned allow_ranges:1; 200 201 #if (NGX_STAT_STUB) 202 unsigned stat_reading:1; 203 unsigned stat_writing:1; 204 #endif 205 206 /* used to parse HTTP headers */ 207 /* 208 通过打印，不能获得header_name_start内容 209 通过打印，可以获得header_start内容：为cookie内容+空行，也就是header_start内容包含cookie，但不仅仅包含cookie。 210 */ 211 212 ngx_uint_t state; 213 214 ngx_uint_t header_hash; 215 ngx_uint_t lowcase_index; 216 u_char lowcase_header[NGX_HTTP_LC_HEADER_LEN]; 217 218 u_char * header_name_start; 219 u_char * header_name_end; 220 u_char * header_start; 221 u_char * header_end; 222 223 /* 224 * a memory that can be reused after parsing a request line 225 * via ngx_http_ephemeral_t 226 */ 227 /* used to parse HTTP 请求行的消息 228 ** 通过打印，可以知道接下来这部分内容都是关于HTTP请求行的，通过这些指针可以方便找到所需的请求行中的内容，比如 r-> method_end+1,r-> http_protocol .data-1 之间就是URI。 229 */ 230 231 u_char * uri_start; 232 u_char * uri_end; 233 u_char * uri_ext; 234 u_char * args_start; 235 u_char * request_start; 236 u_char * request_end; 237 u_char * method_end; 238 u_char * schema_start; 239 u_char * schema_end; 240 u_char * host_start; 241 u_char * host_end; 242 u_char * port_start; 243 u_char * port_end; 244 245 unsigned http_minor:16; 246 unsigned http_major:16; 247 };
1 测试中所添加函数内容： 2 3 #if 1 4 printf( "***ngx_http_upload_handler server :%s\t length is %d\n",out_headers_in.server. data,out_headers_in.server .len); 5 yk_print_ngx_str_t ("server is " ,r->headers_in. server.data ,r->headers_in. server.len ); 6 yk_print_ngx_str_t ("request_line is " ,r->request_line. data,r->request_line .len); 7 yk_print_ngx_str_t (" uri is ",r->uri .data,r-> uri.len ); 8 yk_print_ngx_str_t (" args is ",r->args .data,r-> args.len ); 9 yk_print_ngx_str_t ("method_name is " ,r->method_name. data,r->method_name .len); 10 yk_print_ngx_str_t ("unparsed_uri is " ,r->unparsed_uri. data,r->unparsed_uri .len); 11 12 yk_print_start2end( "r->uri_start",r->uri_start ,r->uri_end); 13 yk_print_start2end( "r->request_start",r->request_start ,r->request_end); 14 yk_print_start2end( "r->schema_start",r->schema_start ,r->schema_start); 15 yk_print_start2end( "r->host_start",r->host_start ,r->host_start); 16 // printf("uri_ext is %s \t method_end is %s \t ",r->uri_ext,r->method_end); 17 18 yk_print_start2end( "uri is",r-> method_end+1,r->http_protocol .data-1); /*这句话可以将 uri完整无错的打印出来*/ 19 yk_print_start2end( "method_name start-end is" ,r->method_name. data,r->method_end +1);/*这句话可以将method完整无错的打印出来*/ 20 //yk_print_start2end("header_name_start is",r->header_name_start,r->header_name_end); 21 yk_print_start2end( "header_start is",r->header_start ,r->header_end); 22 #endif
二、ngx_http_request_body_t结构体
|
typedef struct {
ngx_temp_file_t * temp_file ;
ngx_chain_t * bufs ;/*消息体都保存在这个chain里面*/
ngx_buf_t * buf ; /*用作临时存储的buf，在ngx_http_read_client_request_body和ngx_http_do_read_client_request_body中用得到 */
off_t rest ;
ngx_chain_t * to_write ;
ngx_http_client_body_handler_pt post_handler ;
} ngx_http_request_body_t ;
|
|
通过下面的语句可以打印bufs中内容。
/*below is edited by yankai*/
yankai_cl = r->request_body->bufs;
yankai_sum_rb_bufs = 0;
for (; yankai_cl; yankai_cl = yankai_cl->next){
yankai_sum_rb_bufs += (size_t)ngx_buf_size(yankai_cl->buf);
}
printf( "###yankai_sum_rb_bufs in ngx_http_upload_body_handler mm is %d\n" ,yankai_sum_rb_bufs);
|
三ngx_http_headers_in_t结构体
|
下面这段话来自于http://tengine.taobao.org/book/chapter_12.html
ngx_http_headers_in_t结构的headers字段为一个链表结构，它被用来保存所有请求头，初始为它分配了20个节点，每个节点的类型为ngx_table_elt_t，保存请求头的name/value值对，还可以看到ngx_http_headers_in_t结构有很多类型为ngx_table_elt_t*的指针成员，而且从它们的命名可以看出是一些常见的请求头名字，nginx对这些常用的请求头在ngx_http_headers_in_t结构里面保存了一份引用，后续需要使用的话，可以直接通过这些成员得到，另外也事先为cookie头分配了2个元素的数组空间，做完这些内存准备工作之后，该请求对应的读事件结构的处理函数被设置为ngx_http_process_request_headers，并随后马上调用了该函数。
typedef struct {
ngx_list_t headers ;
/*从host到keep_alive 均为常见的http头部字段*/
ngx_table_elt_t * host ;
ngx_table_elt_t * connection ;
ngx_table_elt_t * if_modified_since ;
ngx_table_elt_t * if_unmodified_since ;
ngx_table_elt_t * user_agent ;
ngx_table_elt_t * referer ;
ngx_table_elt_t * content_length ;
ngx_table_elt_t * content_type ;
ngx_table_elt_t * range ;
ngx_table_elt_t * if_range ;
ngx_table_elt_t * transfer_encoding ;
ngx_table_elt_t * expect ;
#if (NGX_HTTP_GZIP)
ngx_table_elt_t * accept_encoding ;
ngx_table_elt_t * via ;
#endif
ngx_table_elt_t * authorization ;
ngx_table_elt_t * keep_alive ;
#if (NGX_HTTP_X_FORWARDED_FOR)
ngx_table_elt_t * x_forwarded_for ;
#endif
#if (NGX_HTTP_REALIP)
ngx_table_elt_t *x_real_ip;
#endif
#if (NGX_HTTP_HEADERS)
ngx_table_elt_t *accept;
ngx_table_elt_t *accept_language;
#endif
#if (NGX_HTTP_DAV)
ngx_table_elt_t *depth;
ngx_table_elt_t *destination;
ngx_table_elt_t *overwrite;
ngx_table_elt_t *date;
#endif
ngx_str_t user ;/*unkown*/
ngx_str_t passwd ;/*unkown*/
ngx_array_t cookies ;
ngx_str_t server ;
off_t content_length_n ;/*unkown*/
time_t keep_alive_n ;/*unkown*/
unsigned connection_type :2;
unsigned msie :1;
unsigned msie6 :1;
unsigned opera :1;
unsigned gecko :1;
unsigned chrome :1;
unsigned safari :1;
unsigned konqueror :1;
} ngx_http_headers_in_t ;
|
|
| 说明：ngx_http_headers_in_t是包含请求头中所有内容， 1）ngx_table_elt_t 都是RFC2616中提到的请求头域的内容 2）user、passwd未知 3）cookie里面保存的是cookie的内容，可以通过下面的代码打印出来
|
四附录：里面用到的一些函数
|
/*
*函数功能：知道字符串的其实地址和中止地址，输出该字符串
*/
void yk_print_start2end( char * description, u_char * start, u_char *end)
{
printf ( "%s\t" ,description);
u_char * ptemp;
for (ptemp = start; ptemp != end; ptemp++)
printf ( "%c" ,*ptemp);
printf ( "\n" );
}
/*
*函数功能：知道字符串的其实地址和中止地址，输出该字符串
*/
void yk_print_ngx_str_t( char * description, u_char * data, int len)
{
printf ( "%s\t" ,description);
u_char * ptemp;
for (ptemp = data; ptemp != (data + len); ptemp++)
printf ( "%c" ,*ptemp);
printf ( "\n" );
}
打印cookie内容
#if 0
/*six line code source :http://lijinxing17.blog.163.com/blog/static/34977708201062710583500/*/
ngx_table_elt_t ** cookies = NULL;
ngx_uint_t i;
printf( "Cookie count: %d\n" , r->headers_in.cookies.nelts);
cookies = r->headers_in.cookies.elts;
for ( i = 0 ; i < r->headers_in.cookies.nelts; i++) {
printf( "Cookie line %d: %s\n" , i, cookies[i]->value.data);
}
#endif
|
五、一些没有搞清楚的成员变量
| ngx_http_headers_in_t结构体中user passwd headers ngx_connection_t *connection ngx_http_connection_t *http_connection |
posted on 2014-05-08 11:11 随心而动,随意而行 阅读( ...) 评论( ...) 编辑 收藏