src/core/ngx_conf_file.h - nginx source code

Data types defined

Macros defined

Source code


  1. /*
  2. * Copyright (C) Igor Sysoev
  3. * Copyright (C) Nginx, Inc.
  4. */


  5. #ifndef _NGX_CONF_FILE_H_INCLUDED_
  6. #define _NGX_CONF_FILE_H_INCLUDED_


  7. #include <ngx_config.h>
  8. #include <ngx_core.h>


  9. /*
  10. *        AAAA  number of arguments
  11. *      FF      command flags
  12. *    TT        command type, i.e. HTTP "location" or "server" command
  13. */

  14. #define NGX_CONF_NOARGS      0x00000001
  15. #define NGX_CONF_TAKE1       0x00000002
  16. #define NGX_CONF_TAKE2       0x00000004
  17. #define NGX_CONF_TAKE3       0x00000008
  18. #define NGX_CONF_TAKE4       0x00000010
  19. #define NGX_CONF_TAKE5       0x00000020
  20. #define NGX_CONF_TAKE6       0x00000040
  21. #define NGX_CONF_TAKE7       0x00000080

  22. #define NGX_CONF_MAX_ARGS    8

  23. #define NGX_CONF_TAKE12      (NGX_CONF_TAKE1|NGX_CONF_TAKE2)
  24. #define NGX_CONF_TAKE13      (NGX_CONF_TAKE1|NGX_CONF_TAKE3)

  25. #define NGX_CONF_TAKE23      (NGX_CONF_TAKE2|NGX_CONF_TAKE3)

  26. #define NGX_CONF_TAKE123     (NGX_CONF_TAKE1|NGX_CONF_TAKE2|NGX_CONF_TAKE3)
  27. #define NGX_CONF_TAKE1234    (NGX_CONF_TAKE1|NGX_CONF_TAKE2|NGX_CONF_TAKE3   \
  28.                               |NGX_CONF_TAKE4)

  29. #define NGX_CONF_ARGS_NUMBER 0x000000ff
  30. #define NGX_CONF_BLOCK       0x00000100
  31. #define NGX_CONF_FLAG        0x00000200
  32. #define NGX_CONF_ANY         0x00000400
  33. #define NGX_CONF_1MORE       0x00000800
  34. #define NGX_CONF_2MORE       0x00001000

  35. #define NGX_DIRECT_CONF      0x00010000

  36. #define NGX_MAIN_CONF        0x01000000
  37. #define NGX_ANY_CONF         0xFF000000



  38. #define NGX_CONF_UNSET       -1
  39. #define NGX_CONF_UNSET_UINT  (ngx_uint_t) -1
  40. #define NGX_CONF_UNSET_PTR   (void *) -1
  41. #define NGX_CONF_UNSET_SIZE  (size_t) -1
  42. #define NGX_CONF_UNSET_MSEC  (ngx_msec_t) -1


  43. #define NGX_CONF_OK          NULL
  44. #define NGX_CONF_ERROR       (void *) -1

  45. #define NGX_CONF_BLOCK_START 1
  46. #define NGX_CONF_BLOCK_DONE  2
  47. #define NGX_CONF_FILE_DONE   3

  48. #define NGX_CORE_MODULE      0x45524F43  /* "CORE" */
  49. #define NGX_CONF_MODULE      0x464E4F43  /* "CONF" */


  50. #define NGX_MAX_CONF_ERRSTR  1024


  51. struct ngx_command_s {
  52.     ngx_str_t             name;
  53.     ngx_uint_t            type;
  54.     char               *(*set)(ngx_conf_t *cf, ngx_command_t *cmd, void *conf);
  55.     ngx_uint_t            conf;
  56.     ngx_uint_t            offset;
  57.     void                 *post;
  58. };

  59. #define ngx_null_command  { ngx_null_string, 0, NULL, 0, 0, NULL }


  60. struct ngx_open_file_s {
  61.     ngx_fd_t              fd;
  62.     ngx_str_t             name;

  63.     void                (*flush)(ngx_open_file_t *file, ngx_log_t *log);
  64.     void                 *data;
  65. };


  66. typedef struct {
  67.     ngx_file_t            file;
  68.     ngx_buf_t            *buffer;
  69.     ngx_buf_t            *dump;
  70.     ngx_uint_t            line;
  71. } ngx_conf_file_t;


  72. typedef struct {
  73.     ngx_str_t             name;
  74.     ngx_buf_t            *buffer;
  75. } ngx_conf_dump_t;


  76. typedef char *(*ngx_conf_handler_pt)(ngx_conf_t *cf,
  77.     ngx_command_t *dummy, void *conf);


  78. struct ngx_conf_s {
  79.     char                 *name;
  80.     ngx_array_t          *args;

  81.     ngx_cycle_t          *cycle;
  82.     ngx_pool_t           *pool;
  83.     ngx_pool_t           *temp_pool;
  84.     ngx_conf_file_t      *conf_file;
  85.     ngx_log_t            *log;

  86.     void                 *ctx;
  87.     ngx_uint_t            module_type;
  88.     ngx_uint_t            cmd_type;

  89.     ngx_conf_handler_pt   handler;
  90.     void                 *handler_conf;
  91. };


  92. typedef char *(*ngx_conf_post_handler_pt) (ngx_conf_t *cf,
  93.     void *data, void *conf);

  94. typedef struct {
  95.     ngx_conf_post_handler_pt  post_handler;
  96. } ngx_conf_post_t;


  97. typedef struct {
  98.     ngx_conf_post_handler_pt  post_handler;
  99.     char                     *old_name;
  100.     char                     *new_name;
  101. } ngx_conf_deprecated_t;


  102. typedef struct {
  103.     ngx_conf_post_handler_pt  post_handler;
  104.     ngx_int_t                 low;
  105.     ngx_int_t                 high;
  106. } ngx_conf_num_bounds_t;


  107. typedef struct {
  108.     ngx_str_t                 name;
  109.     ngx_uint_t                value;
  110. } ngx_conf_enum_t;


  111. #define NGX_CONF_BITMASK_SET  1

  112. typedef struct {
  113.     ngx_str_t                 name;
  114.     ngx_uint_t                mask;
  115. } ngx_conf_bitmask_t;



  116. char * ngx_conf_deprecated(ngx_conf_t *cf, void *post, void *data);
  117. char *ngx_conf_check_num_bounds(ngx_conf_t *cf, void *post, void *data);


  118. #define ngx_get_conf(conf_ctx, module)  conf_ctx[module.index]



  119. #define ngx_conf_init_value(conf, default)                                   \
  120.     if (conf == NGX_CONF_UNSET) {                                            \
  121.         conf = default;                                                      \
  122.     }

  123. #define ngx_conf_init_ptr_value(conf, default)                               \
  124.     if (conf == NGX_CONF_UNSET_PTR) {                                        \
  125.         conf = default;                                                      \
  126.     }

  127. #define ngx_conf_init_uint_value(conf, default)                              \
  128.     if (conf == NGX_CONF_UNSET_UINT) {                                       \
  129.         conf = default;                                                      \
  130.     }

  131. #define ngx_conf_init_size_value(conf, default)                              \
  132.     if (conf == NGX_CONF_UNSET_SIZE) {                                       \
  133.         conf = default;                                                      \
  134.     }

  135. #define ngx_conf_init_msec_value(conf, default)                              \
  136.     if (conf == NGX_CONF_UNSET_MSEC) {                                       \
  137.         conf = default;                                                      \
  138.     }

  139. #define ngx_conf_merge_value(conf, prev, default)                            \
  140.     if (conf == NGX_CONF_UNSET) {                                            \
  141.         conf = (prev == NGX_CONF_UNSET) ? default : prev;                    \
  142.     }

  143. #define ngx_conf_merge_ptr_value(conf, prev, default)                        \
  144.     if (conf == NGX_CONF_UNSET_PTR) {                                        \
  145.         conf = (prev == NGX_CONF_UNSET_PTR) ? default : prev;                \
  146.     }

  147. #define ngx_conf_merge_uint_value(conf, prev, default)                       \
  148.     if (conf == NGX_CONF_UNSET_UINT) {                                       \
  149.         conf = (prev == NGX_CONF_UNSET_UINT) ? default : prev;               \
  150.     }

  151. #define ngx_conf_merge_msec_value(conf, prev, default)                       \
  152.     if (conf == NGX_CONF_UNSET_MSEC) {                                       \
  153.         conf = (prev == NGX_CONF_UNSET_MSEC) ? default : prev;               \
  154.     }

  155. #define ngx_conf_merge_sec_value(conf, prev, default)                        \
  156.     if (conf == NGX_CONF_UNSET) {                                            \
  157.         conf = (prev == NGX_CONF_UNSET) ? default : prev;                    \
  158.     }

  159. #define ngx_conf_merge_size_value(conf, prev, default)                       \
  160.     if (conf == NGX_CONF_UNSET_SIZE) {                                       \
  161.         conf = (prev == NGX_CONF_UNSET_SIZE) ? default : prev;               \
  162.     }

  163. #define ngx_conf_merge_off_value(conf, prev, default)                        \
  164.     if (conf == NGX_CONF_UNSET) {                                            \
  165.         conf = (prev == NGX_CONF_UNSET) ? default : prev;                    \
  166.     }

  167. #define ngx_conf_merge_str_value(conf, prev, default)                        \
  168.     if (conf.data == NULL) {                                                 \
  169.         if (prev.data) {                                                     \
  170.             conf.len = prev.len;                                             \
  171.             conf.data = prev.data;                                           \
  172.         } else {                                                             \
  173.             conf.len = sizeof(default) - 1;                                  \
  174.             conf.data = (u_char *) default;                                  \
  175.         }                                                                    \
  176.     }

  177. #define ngx_conf_merge_bufs_value(conf, prev, default_num, default_size)     \
  178.     if (conf.num == 0) {                                                     \
  179.         if (prev.num) {                                                      \
  180.             conf.num = prev.num;                                             \
  181.             conf.size = prev.size;                                           \
  182.         } else {                                                             \
  183.             conf.num = default_num;                                          \
  184.             conf.size = default_size;                                        \
  185.         }                                                                    \
  186.     }

  187. #define ngx_conf_merge_bitmask_value(conf, prev, default)                    \
  188.     if (conf == 0) {                                                         \
  189.         conf = (prev == 0) ? default : prev;                                 \
  190.     }


  191. char *ngx_conf_param(ngx_conf_t *cf);
  192. char *ngx_conf_parse(ngx_conf_t *cf, ngx_str_t *filename);
  193. char *ngx_conf_include(ngx_conf_t *cf, ngx_command_t *cmd, void *conf);


  194. ngx_int_t ngx_conf_full_name(ngx_cycle_t *cycle, ngx_str_t *name,
  195.     ngx_uint_t conf_prefix);
  196. ngx_open_file_t *ngx_conf_open_file(ngx_cycle_t *cycle, ngx_str_t *name);
  197. void ngx_cdecl ngx_conf_log_error(ngx_uint_t level, ngx_conf_t *cf,
  198.     ngx_err_t err, const char *fmt, ...);


  199. char *ngx_conf_set_flag_slot(ngx_conf_t *cf, ngx_command_t *cmd, void *conf);
  200. char *ngx_conf_set_str_slot(ngx_conf_t *cf, ngx_command_t *cmd, void *conf);
  201. char *ngx_conf_set_str_array_slot(ngx_conf_t *cf, ngx_command_t *cmd,
  202.     void *conf);
  203. char *ngx_conf_set_keyval_slot(ngx_conf_t *cf, ngx_command_t *cmd, void *conf);
  204. char *ngx_conf_set_num_slot(ngx_conf_t *cf, ngx_command_t *cmd, void *conf);
  205. char *ngx_conf_set_size_slot(ngx_conf_t *cf, ngx_command_t *cmd, void *conf);
  206. char *ngx_conf_set_off_slot(ngx_conf_t *cf, ngx_command_t *cmd, void *conf);
  207. char *ngx_conf_set_msec_slot(ngx_conf_t *cf, ngx_command_t *cmd, void *conf);
  208. char *ngx_conf_set_sec_slot(ngx_conf_t *cf, ngx_command_t *cmd, void *conf);
  209. char *ngx_conf_set_bufs_slot(ngx_conf_t *cf, ngx_command_t *cmd, void *conf);
  210. char *ngx_conf_set_enum_slot(ngx_conf_t *cf, ngx_command_t *cmd, void *conf);
  211. char *ngx_conf_set_bitmask_slot(ngx_conf_t *cf, ngx_command_t *cmd, void *conf);


  212. #endif /* _NGX_CONF_FILE_H_INCLUDED_ */