web服务器之mongoose：数据结构

Mongoose中有几个数据结构扮演着重要的角色，它们分别是：
struct mg_context：保存Mongoose的上下文，几乎每个函数都有mg_context参数
struct mg_connection：保存HTPP连接信息
struct mg_request_info：保存HTTP请求的信息，这个结构体传递给URL处理函数
 
我之所以现在这里介绍它，因为之后的分析工作中要用到它们，如果在读完本文后还不能很好的理解，请将问题带到后续文章中或代码分析中去，你会找到答案的。下面分别介绍它们。
本文的主要内容如下：
1、mg_context详解
2、mg_connection详解
3、mg_request_info详解
4、其他数据结构
5、总结
 
1、mg_context详解
 
mg_context结构体——表示Mongoose的上下文，也称为一个实例句柄。它的成员如下：
  1. struct mg_context {
  2.     int        stop_flag;    /* Should we stop event loop    */
  3.     SSL_CTX        *ssl_ctx;    /* SSL context            */
  5.     FILE        *access_log;    /* Opened access log        */
  6.     FILE        *error_log;    /* Opened error log        */
  8.     struct socket    listeners[MAX_LISTENING_SOCKETS];
  9.     int        num_listeners;
  11.     struct callback    callbacks[MAX_CALLBACKS];
  12.     int        num_callbacks;
  14.     char        *options[NUM_OPTIONS];    /* Configured opions    */
  15.     pthread_mutex_t    opt_mutex[NUM_OPTIONS];    /* Option protector    */
  17.     int        max_threads;    /* Maximum number of threads    */
  18.     int        num_threads;    /* Number of threads        */
  19.     int        num_idle;    /* Number of idle threads    */
  20.     pthread_mutex_t    thr_mutex;    /* Protects (max|num)_threads    */
  21.     pthread_cond_t    thr_cond;
  22.     pthread_mutex_t    bind_mutex;    /* Protects bind operations    */
  24.     struct socket    queue[20];    /* Accepted sockets        */
  25.     int        sq_head;    /* Head of the socket queue    */
  26.     int        sq_tail;    /* Tail of the socket queue    */
  27.     pthread_cond_t    empty_cond;    /* Socket queue empty condvar    */
  28.     pthread_cond_t    full_cond;    /* Socket queue full condvar    */
  30.     mg_spcb_t    ssl_password_callback;
  31.     mg_callback_t    log_callback;
  32. };
这个结构体在mg_start()中创建和初始化，其它函数大部分都会用它。因此mg_start()应该首先被调用。它非常重要，几乎所有的函数都要用到它。
 
1)、stop_flag表示是否应该停止的标记，它有三个可能的值0、1、2。 stop_flag=0表示 不应该停止，这是初始值；stop_flag=1表示停止，在mg_stop()函数中的一开始设置stop_flag=1，这会触发mg_fini()，且在mg_stop()中会一直等待mg_fini执行完成；stop_flag=2用于通知mg_stop()，mg_fini已经执行完成，stop_flag=2在mg_fini函数中的末尾设置。
 
2)、ssl_ctx是结构体ssl_ctx_st的实例，它来自OpenSSL开源项目，作者把它放到这里的原因是使其独立于OpenSSL的源码安装，这样只有系统上面安装有SSL库，mongoose+SSL就能编译通过。
 
3)、access_log、error_log很明显是指向访问日志文件、错误日志文件。
 
4)、listeners数组存储mongoose建立的多个web server，每个web server都是listeners数组中的一个元素。例如，一个服务器可以分别在端口8080、8888建立web server，这样8080端口的那个server是listerns数组中的一个元素，8888端口的那个server也是listeners数组中的一个元素。换句话说，listeners数组表示web server的socket地址。num_listeners表示listeners数组的元素个数。
 
5)、callbacks是结构体callback的数组，而callback本身是一个结构体，包含几个回调句柄。num_callbacks是callbacks数组元素的个数。
 
6)、options数组，是用于存储配置选项的，例如端口号、工作目录等等。opt_mutext对配置进行操作的互斥变量。
 
7)、max_threads表示允许的最大线程数量、num_threads表示当前的线程数量、num_idle表示空闲的线程数量。之所以会有空闲进程，是因为当创建一个线程处理连接请求之后，它会保持一段时间空闲而不是直接销毁。如果这里再用新的连接到来或等待队列中有需要处理的连接，空闲进程会被分配去处理。
 
8)、thr_mutex、thr_cond、bind_mutex是用于互斥信号量和条件变量。
 
9)、queue[20]队列数组存储client的连接请求，每个元素都是client的socket。sq_head、sq_tail分别是队列头、尾用于操作队列queue。empty_cond、full_cond分别表示队列是否为空、满的条件变量。
 
10)、ssl_password_callback和log_callback都是函数指针，分别指向SSL密码处理函数、log处理函数。他们原型是：
  1. /*
  2.  * Register SSL password handler.
  3.  * This is needed only if SSL certificate asks for a password. Instead of
  4.  * prompting for a password on a console a specified function will be called.
  5.  */
  6. typedef int (*mg_spcb_t)(char *buf, int num, int w, void *key);
  8. /*
  9.  * User-defined callback function prototype for URI handling, error handling,
  10.  * or logging server messages.
  11.  */
  12. typedef void (*mg_callback_t)(struct mg_connection *,
  13.         const struct mg_request_info *info, void *user_data);
是上面讲了那么多感觉挺乱的，下面用张图片来形象表示一下：
    
                                   图1 mg_context结构体
2、mg_connection详解
 
故名思意，这个结构体用户保存client的连接信息。它的成员如下：
  1. /*
  2.  * Client connection.
  3.  */
  4. struct mg_connection {
  5.     struct mg_request_info    request_info;
  6.     struct mg_context *ctx;        /* Mongoose context we belong to*/
  7.     SSL        *ssl;        /* SSL descriptor        */
  8.     struct socket    client;        /* Connected client        */
  9.     time_t        birth_time;    /* Time connection was accepted    */
  10.     bool_t        free_post_data;    /* post_data was malloc-ed    */
  11.     bool_t        embedded_auth;    /* Used for authorization    */
  12.     uint64_t    num_bytes_sent;    /* Total bytes sent to client    */
  13. };
上面的字段意思都很明显这里就不一一阐述了。可以看出， 每个连接都保存了一个Mongoose上下文（mg_context * ctx），这个很重要，对连接请求进行处理时都会用到。这里也可以看出mg_context相当于一个实例句柄。
 
结构体mg_request_info用于保存每个请求的信息，例如，当打开http://www.google.com的时候，会发出一个请求信息，包括请求的方法是POST还是GET等、uri即http://www.google.com、http版本、还有一些http头信息等等。关于结构体mg_request_info的详细信息参见下一小节。
mg_connection的图像表示如下：
                                 图2  mg_connection结构体的成员
3、mg_request_info详解
 
这个结构体保存每次client发送请求，即是一个HTTP请求报文信息。而我们知道HTTP的请求报文信息的格式如下：
    
 
                      图3 HTTP请求的格式
 
根据这个信息，可以更好地理解mg_request_info。mg_request_info结构定义如下：
  1. /*
  2.  * This structure contains full information about the HTTP request.
  3.  * It is passed to the user-specified callback function as a parameter.
  4.  */
  5. struct mg_request_info {
  6.     char    *request_method;    /* "GET", "POST", etc    */
  7.     char    *uri;            /* Normalized URI    */
  8.     char    *query_string;        /* \0 - terminated    */
  9.     char    *post_data;        /* POST data buffer    */
  10.     char    *remote_user;        /* Authenticated user    */
  11.     long    remote_ip;        /* Client's IP address    */
  12.     int    remote_port;        /* Client's port    */
  13.     int    post_data_len;        /* POST buffer length    */
  14.     int    http_version_major;
  15.     int    http_version_minor;
  16.     int    status_code;        /* HTTP status code    */
  17.     int    num_headers;        /* Number of headers    */
  18.     struct mg_header {
  19.         char    *name;        /* HTTP header name    */
  20.         char    *value;        /* HTTP header value    */
  21.     } http_headers[64];        /* Maximum 64 headers    */
  22. };
从字段都能够故名思意，这里就不再阐述了。
 
4、其他数据结构 
 
除了上面3个主要的数据结构，还有其它一些数据也默默地贡献着自己的一份力量。作为一个整体，少了它们Mongoose也只能沦为废物。下面我就列举几个：
  1. /*
  2.  * Structure used by mg_stat() function. Uses 64 bit file length.
  3.  */
  4. struct mgstat {
  5.     bool_t        is_directory;    /* Directory marker        */
  6.     uint64_t    size;        /* File size            */
  7.     time_t        mtime;        /* Modification time        */
  8. };
  10. struct mg_option {
  11.     const char    *name;
  12.     const char    *description;
  13.     const char    *default_value;
  14.     int        index;
  15.     bool_t (*setter)(struct mg_context *, const char *);
  16. };
  17. /*
  18.  * Structure used to describe listening socket, or socket which was
  19.  * accept()-ed by the master thread and queued for future handling
  20.  * by the worker thread.
  21.  */
  22. struct socket {
  23.     SOCKET        sock;        /* Listening socket        */
  24.     struct usa    lsa;        /* Local socket address        */
  25.     struct usa    rsa;        /* Remote socket address    */
  26.     bool_t        is_ssl;        /* Is socket SSL-ed        */
  27. };
  28. /*
  29.  * Unified socket address. For IPv6 support, add IPv6 address structure
  30.  * in the union u.
  31.  */
  32. struct usa {
  33.     socklen_t len;
  34.     union {
  35.         struct sockaddr    sa;
  36.         struct sockaddr_in sin;
  37.     } u;
  38. };
  40. /*
  41.  * Specifies a string (chunk of memory).
  42.  * Used to traverse comma separated lists of options.
  43.  */
  44. struct vec {
  45.     const char    *ptr;
  46.     size_t        len;
  47. };
  48. /*
  49.  * Dynamically loaded SSL functionality
  50.  */
  51. struct ssl_func {
  52.     const char    *name;        /* SSL function name    */
  53.     void        (*ptr)(void);    /* Function pointer    */
  54. };
5、总结
 
至此，我们介绍了Mongoose中使用的一些数据结构，搞清楚这些数据结构对整个项目的理解非常重要。它们遍布在项目的每个角落（虽然项目比较小）
posted @ 2017-09-05 15:04  苍月代表我  阅读(542)  评论(0)  编辑  收藏  举报