One Level Up Top Level

src/core/ngx_module.h - nginx source code

Data types defined

Macros defined

Source code


  2. /*
  3. * Copyright (C) Igor Sysoev
  4. * Copyright (C) Maxim Dounin
  5. * Copyright (C) Nginx, Inc.
  6. */


  9. #ifndef _NGX_MODULE_H_INCLUDED_
  10. ‌#define _NGX_MODULE_H_INCLUDED_


  13. #include <ngx_config.h>
  14. #include <ngx_core.h>
  15. #include <nginx.h>


  18. ‌#define NGX_MODULE_UNSET_INDEX  (ngx_uint_t) -1


  21. ‌#define NGX_MODULE_SIGNATURE_0                                                \
  22.     ngx_value(NGX_PTR_SIZE) ","                                               \
  23.     ngx_value(NGX_SIG_ATOMIC_T_SIZE) ","                                      \
  24.     ngx_value(NGX_TIME_T_SIZE) ","

  26. #if (NGX_HAVE_KQUEUE)
  27. ‌#define NGX_MODULE_SIGNATURE_1   "1"
  28. #else
  29. ‌#define NGX_MODULE_SIGNATURE_1   "0"
  30. #endif

  32. #if (NGX_HAVE_IOCP)
  33. ‌#define NGX_MODULE_SIGNATURE_2   "1"
  34. #else
  35. ‌#define NGX_MODULE_SIGNATURE_2   "0"
  36. #endif

  38. #if (NGX_HAVE_FILE_AIO || NGX_COMPAT)
  39. ‌#define NGX_MODULE_SIGNATURE_3   "1"
  40. #else
  41. ‌#define NGX_MODULE_SIGNATURE_3   "0"
  42. #endif

  44. #if (NGX_HAVE_SENDFILE_NODISKIO || NGX_COMPAT)
  45. ‌#define NGX_MODULE_SIGNATURE_4   "1"
  46. #else
  47. ‌#define NGX_MODULE_SIGNATURE_4   "0"
  48. #endif

  50. #if (NGX_HAVE_EVENTFD)
  51. ‌#define NGX_MODULE_SIGNATURE_5   "1"
  52. #else
  53. ‌#define NGX_MODULE_SIGNATURE_5   "0"
  54. #endif

  56. #if (NGX_HAVE_EPOLL)
  57. ‌#define NGX_MODULE_SIGNATURE_6   "1"
  58. #else
  59. ‌#define NGX_MODULE_SIGNATURE_6   "0"
  60. #endif

  62. #if (NGX_HAVE_KEEPALIVE_TUNABLE)
  63. ‌#define NGX_MODULE_SIGNATURE_7   "1"
  64. #else
  65. ‌#define NGX_MODULE_SIGNATURE_7   "0"
  66. #endif

  68. #if (NGX_HAVE_INET6)
  69. ‌#define NGX_MODULE_SIGNATURE_8   "1"
  70. #else
  71. ‌#define NGX_MODULE_SIGNATURE_8   "0"
  72. #endif

  74. ‌#define NGX_MODULE_SIGNATURE_9   "1"
  75. ‌#define NGX_MODULE_SIGNATURE_10  "1"

  77. #if (NGX_HAVE_DEFERRED_ACCEPT && defined SO_ACCEPTFILTER)
  78. ‌#define NGX_MODULE_SIGNATURE_11  "1"
  79. #else
  80. ‌#define NGX_MODULE_SIGNATURE_11  "0"
  81. #endif

  83. ‌#define NGX_MODULE_SIGNATURE_12  "1"

  85. #if (NGX_HAVE_SETFIB)
  86. ‌#define NGX_MODULE_SIGNATURE_13  "1"
  87. #else
  88. ‌#define NGX_MODULE_SIGNATURE_13  "0"
  89. #endif

  91. #if (NGX_HAVE_TCP_FASTOPEN)
  92. ‌#define NGX_MODULE_SIGNATURE_14  "1"
  93. #else
  94. ‌#define NGX_MODULE_SIGNATURE_14  "0"
  95. #endif

  97. #if (NGX_HAVE_UNIX_DOMAIN)
  98. ‌#define NGX_MODULE_SIGNATURE_15  "1"
  99. #else
  100. ‌#define NGX_MODULE_SIGNATURE_15  "0"
  101. #endif

  103. #if (NGX_HAVE_VARIADIC_MACROS)
  104. ‌#define NGX_MODULE_SIGNATURE_16  "1"
  105. #else
  106. ‌#define NGX_MODULE_SIGNATURE_16  "0"
  107. #endif

  109. ‌#define NGX_MODULE_SIGNATURE_17  "0"

  111. #if (NGX_QUIC || NGX_COMPAT)
  112. ‌#define NGX_MODULE_SIGNATURE_18  "1"
  113. #else
  114. ‌#define NGX_MODULE_SIGNATURE_18  "0"
  115. #endif

  117. #if (NGX_HAVE_OPENAT)
  118. ‌#define NGX_MODULE_SIGNATURE_19  "1"
  119. #else
  120. ‌#define NGX_MODULE_SIGNATURE_19  "0"
  121. #endif

  123. #if (NGX_HAVE_ATOMIC_OPS)
  124. ‌#define NGX_MODULE_SIGNATURE_20  "1"
  125. #else
  126. ‌#define NGX_MODULE_SIGNATURE_20  "0"
  127. #endif

  129. #if (NGX_HAVE_POSIX_SEM)
  130. ‌#define NGX_MODULE_SIGNATURE_21  "1"
  131. #else
  132. ‌#define NGX_MODULE_SIGNATURE_21  "0"
  133. #endif

  135. #if (NGX_THREADS || NGX_COMPAT)
  136. ‌#define NGX_MODULE_SIGNATURE_22  "1"
  137. #else
  138. ‌#define NGX_MODULE_SIGNATURE_22  "0"
  139. #endif

  141. #if (NGX_PCRE)
  142. ‌#define NGX_MODULE_SIGNATURE_23  "1"
  143. #else
  144. ‌#define NGX_MODULE_SIGNATURE_23  "0"
  145. #endif

  147. #if (NGX_HTTP_SSL || NGX_COMPAT)
  148. ‌#define NGX_MODULE_SIGNATURE_24  "1"
  149. #else
  150. ‌#define NGX_MODULE_SIGNATURE_24  "0"
  151. #endif

  153. ‌#define NGX_MODULE_SIGNATURE_25  "1"

  155. #if (NGX_HTTP_GZIP)
  156. ‌#define NGX_MODULE_SIGNATURE_26  "1"
  157. #else
  158. ‌#define NGX_MODULE_SIGNATURE_26  "0"
  159. #endif

  161. ‌#define NGX_MODULE_SIGNATURE_27  "1"

  163. #if (NGX_HTTP_X_FORWARDED_FOR)
  164. ‌#define NGX_MODULE_SIGNATURE_28  "1"
  165. #else
  166. ‌#define NGX_MODULE_SIGNATURE_28  "0"
  167. #endif

  169. #if (NGX_HTTP_REALIP)
  170. ‌#define NGX_MODULE_SIGNATURE_29  "1"
  171. #else
  172. ‌#define NGX_MODULE_SIGNATURE_29  "0"
  173. #endif

  175. #if (NGX_HTTP_HEADERS)
  176. ‌#define NGX_MODULE_SIGNATURE_30  "1"
  177. #else
  178. ‌#define NGX_MODULE_SIGNATURE_30  "0"
  179. #endif

  181. #if (NGX_HTTP_DAV)
  182. ‌#define NGX_MODULE_SIGNATURE_31  "1"
  183. #else
  184. ‌#define NGX_MODULE_SIGNATURE_31  "0"
  185. #endif

  187. #if (NGX_HTTP_CACHE)
  188. ‌#define NGX_MODULE_SIGNATURE_32  "1"
  189. #else
  190. ‌#define NGX_MODULE_SIGNATURE_32  "0"
  191. #endif

  193. #if (NGX_HTTP_UPSTREAM_ZONE)
  194. ‌#define NGX_MODULE_SIGNATURE_33  "1"
  195. #else
  196. ‌#define NGX_MODULE_SIGNATURE_33  "0"
  197. #endif

  199. #if (NGX_COMPAT)
  200. ‌#define NGX_MODULE_SIGNATURE_34  "1"
  201. #else
  202. ‌#define NGX_MODULE_SIGNATURE_34  "0"
  203. #endif

  205. ‌#define NGX_MODULE_SIGNATURE                                                  \
  206.     NGX_MODULE_SIGNATURE_0 NGX_MODULE_SIGNATURE_1 NGX_MODULE_SIGNATURE_2      \
  207.     NGX_MODULE_SIGNATURE_3 NGX_MODULE_SIGNATURE_4 NGX_MODULE_SIGNATURE_5      \
  208.     NGX_MODULE_SIGNATURE_6 NGX_MODULE_SIGNATURE_7 NGX_MODULE_SIGNATURE_8      \
  209.     NGX_MODULE_SIGNATURE_9 NGX_MODULE_SIGNATURE_10 NGX_MODULE_SIGNATURE_11    \
  210.     NGX_MODULE_SIGNATURE_12 NGX_MODULE_SIGNATURE_13 NGX_MODULE_SIGNATURE_14   \
  211.     NGX_MODULE_SIGNATURE_15 NGX_MODULE_SIGNATURE_16 NGX_MODULE_SIGNATURE_17   \
  212.     NGX_MODULE_SIGNATURE_18 NGX_MODULE_SIGNATURE_19 NGX_MODULE_SIGNATURE_20   \
  213.     NGX_MODULE_SIGNATURE_21 NGX_MODULE_SIGNATURE_22 NGX_MODULE_SIGNATURE_23   \
  214.     NGX_MODULE_SIGNATURE_24 NGX_MODULE_SIGNATURE_25 NGX_MODULE_SIGNATURE_26   \
  215.     NGX_MODULE_SIGNATURE_27 NGX_MODULE_SIGNATURE_28 NGX_MODULE_SIGNATURE_29   \
  216.     NGX_MODULE_SIGNATURE_30 NGX_MODULE_SIGNATURE_31 NGX_MODULE_SIGNATURE_32   \
  217.     NGX_MODULE_SIGNATURE_33 NGX_MODULE_SIGNATURE_34


  220. ‌#define NGX_MODULE_V1                                                         \
  221.     NGX_MODULE_UNSET_INDEX, NGX_MODULE_UNSET_INDEX,                           \
  222.     NULL, 0, 0, nginx_version, NGX_MODULE_SIGNATURE

  224. ‌#define NGX_MODULE_V1_PADDING  0, 0, 0, 0, 0, 0, 0, 0


  227. ‌struct ngx_module_s {
  228.     ngx_uint_t            ctx_index;
  229.     ngx_uint_t            index;

  231.     char                 *name;

  233.     ngx_uint_t            spare0;
  234.     ngx_uint_t            spare1;

  236.     ngx_uint_t            version;
  237.     const char           *signature;

  239.     void                 *ctx;
  240.     ngx_command_t        *commands;
  241.     ngx_uint_t            type;

  243.     ngx_int_t           (*init_master)(ngx_log_t *log);

  245.     ngx_int_t           (*init_module)(ngx_cycle_t *cycle);

  247.     ngx_int_t           (*init_process)(ngx_cycle_t *cycle);
  248.     ngx_int_t           (*init_thread)(ngx_cycle_t *cycle);
  249.     void                (*exit_thread)(ngx_cycle_t *cycle);
  250.     void                (*exit_process)(ngx_cycle_t *cycle);

  252.     void                (*exit_master)(ngx_cycle_t *cycle);

  254.     uintptr_t             spare_hook0;
  255.     uintptr_t             spare_hook1;
  256.     uintptr_t             spare_hook2;
  257.     uintptr_t             spare_hook3;
  258.     uintptr_t             spare_hook4;
  259.     uintptr_t             spare_hook5;
  260.     uintptr_t             spare_hook6;
  261.     uintptr_t             spare_hook7;
  262. };


  265. ‌typedef struct {
  266.     ngx_str_t             name;
  267.     void               *(*create_conf)(ngx_cycle_t *cycle);
  268.     char               *(*init_conf)(ngx_cycle_t *cycle, void *conf);
  269. ‌} ngx_core_module_t;


  272. ngx_int_t ngx_preinit_modules(void);
  273. ngx_int_t ngx_cycle_modules(ngx_cycle_t *cycle);
  274. ngx_int_t ngx_init_modules(ngx_cycle_t *cycle);
  275. ngx_int_t ngx_count_modules(ngx_cycle_t *cycle, ngx_uint_t type);


  278. ngx_int_t ngx_add_module(ngx_conf_t *cf, ngx_str_t *file,
  279.     ngx_module_t *module, char **order);


  282. extern ngx_module_t  *ngx_modules[];
  283. extern ngx_uint_t     ngx_max_module;

  285. extern char          *ngx_module_names[];


  288. #endif /* _NGX_MODULE_H_INCLUDED_ */

One Level Up Top Level