One Level Up Top Level

src/core/ngx_module.h - nginx-1.31.9 nginx/ @ 2a3a19c6f

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. ‌#define NGX_MODULE_SIGNATURE_2   "0"

  34. #if (NGX_HAVE_FILE_AIO || NGX_COMPAT)
  35. ‌#define NGX_MODULE_SIGNATURE_3   "1"
  36. #else
  37. ‌#define NGX_MODULE_SIGNATURE_3   "0"
  38. #endif

  40. #if (NGX_HAVE_SENDFILE_NODISKIO || NGX_COMPAT)
  41. ‌#define NGX_MODULE_SIGNATURE_4   "1"
  42. #else
  43. ‌#define NGX_MODULE_SIGNATURE_4   "0"
  44. #endif

  46. #if (NGX_HAVE_EVENTFD)
  47. ‌#define NGX_MODULE_SIGNATURE_5   "1"
  48. #else
  49. ‌#define NGX_MODULE_SIGNATURE_5   "0"
  50. #endif

  52. #if (NGX_HAVE_EPOLL)
  53. ‌#define NGX_MODULE_SIGNATURE_6   "1"
  54. #else
  55. ‌#define NGX_MODULE_SIGNATURE_6   "0"
  56. #endif

  58. #if (NGX_HAVE_KEEPALIVE_TUNABLE)
  59. ‌#define NGX_MODULE_SIGNATURE_7   "1"
  60. #else
  61. ‌#define NGX_MODULE_SIGNATURE_7   "0"
  62. #endif

  64. #if (NGX_HAVE_INET6)
  65. ‌#define NGX_MODULE_SIGNATURE_8   "1"
  66. #else
  67. ‌#define NGX_MODULE_SIGNATURE_8   "0"
  68. #endif

  70. ‌#define NGX_MODULE_SIGNATURE_9   "1"
  71. ‌#define NGX_MODULE_SIGNATURE_10  "1"

  73. #if (NGX_HAVE_DEFERRED_ACCEPT && defined SO_ACCEPTFILTER)
  74. ‌#define NGX_MODULE_SIGNATURE_11  "1"
  75. #else
  76. ‌#define NGX_MODULE_SIGNATURE_11  "0"
  77. #endif

  79. ‌#define NGX_MODULE_SIGNATURE_12  "1"

  81. #if (NGX_HAVE_SETFIB)
  82. ‌#define NGX_MODULE_SIGNATURE_13  "1"
  83. #else
  84. ‌#define NGX_MODULE_SIGNATURE_13  "0"
  85. #endif

  87. #if (NGX_HAVE_TCP_FASTOPEN)
  88. ‌#define NGX_MODULE_SIGNATURE_14  "1"
  89. #else
  90. ‌#define NGX_MODULE_SIGNATURE_14  "0"
  91. #endif

  93. #if (NGX_HAVE_UNIX_DOMAIN)
  94. ‌#define NGX_MODULE_SIGNATURE_15  "1"
  95. #else
  96. ‌#define NGX_MODULE_SIGNATURE_15  "0"
  97. #endif

  99. #if (NGX_HAVE_VARIADIC_MACROS)
  100. ‌#define NGX_MODULE_SIGNATURE_16  "1"
  101. #else
  102. ‌#define NGX_MODULE_SIGNATURE_16  "0"
  103. #endif

  105. ‌#define NGX_MODULE_SIGNATURE_17  "0"

  107. #if (NGX_QUIC || NGX_COMPAT)
  108. ‌#define NGX_MODULE_SIGNATURE_18  "1"
  109. #else
  110. ‌#define NGX_MODULE_SIGNATURE_18  "0"
  111. #endif

  113. #if (NGX_HAVE_OPENAT)
  114. ‌#define NGX_MODULE_SIGNATURE_19  "1"
  115. #else
  116. ‌#define NGX_MODULE_SIGNATURE_19  "0"
  117. #endif

  119. #if (NGX_HAVE_ATOMIC_OPS)
  120. ‌#define NGX_MODULE_SIGNATURE_20  "1"
  121. #else
  122. ‌#define NGX_MODULE_SIGNATURE_20  "0"
  123. #endif

  125. #if (NGX_HAVE_POSIX_SEM)
  126. ‌#define NGX_MODULE_SIGNATURE_21  "1"
  127. #else
  128. ‌#define NGX_MODULE_SIGNATURE_21  "0"
  129. #endif

  131. #if (NGX_THREADS || NGX_COMPAT)
  132. ‌#define NGX_MODULE_SIGNATURE_22  "1"
  133. #else
  134. ‌#define NGX_MODULE_SIGNATURE_22  "0"
  135. #endif

  137. #if (NGX_PCRE)
  138. ‌#define NGX_MODULE_SIGNATURE_23  "1"
  139. #else
  140. ‌#define NGX_MODULE_SIGNATURE_23  "0"
  141. #endif

  143. #if (NGX_HTTP_SSL || NGX_COMPAT)
  144. ‌#define NGX_MODULE_SIGNATURE_24  "1"
  145. #else
  146. ‌#define NGX_MODULE_SIGNATURE_24  "0"
  147. #endif

  149. ‌#define NGX_MODULE_SIGNATURE_25  "1"

  151. #if (NGX_HTTP_GZIP)
  152. ‌#define NGX_MODULE_SIGNATURE_26  "1"
  153. #else
  154. ‌#define NGX_MODULE_SIGNATURE_26  "0"
  155. #endif

  157. ‌#define NGX_MODULE_SIGNATURE_27  "1"

  159. #if (NGX_HTTP_X_FORWARDED_FOR)
  160. ‌#define NGX_MODULE_SIGNATURE_28  "1"
  161. #else
  162. ‌#define NGX_MODULE_SIGNATURE_28  "0"
  163. #endif

  165. #if (NGX_HTTP_REALIP)
  166. ‌#define NGX_MODULE_SIGNATURE_29  "1"
  167. #else
  168. ‌#define NGX_MODULE_SIGNATURE_29  "0"
  169. #endif

  171. #if (NGX_HTTP_HEADERS)
  172. ‌#define NGX_MODULE_SIGNATURE_30  "1"
  173. #else
  174. ‌#define NGX_MODULE_SIGNATURE_30  "0"
  175. #endif

  177. #if (NGX_HTTP_DAV)
  178. ‌#define NGX_MODULE_SIGNATURE_31  "1"
  179. #else
  180. ‌#define NGX_MODULE_SIGNATURE_31  "0"
  181. #endif

  183. #if (NGX_HTTP_CACHE)
  184. ‌#define NGX_MODULE_SIGNATURE_32  "1"
  185. #else
  186. ‌#define NGX_MODULE_SIGNATURE_32  "0"
  187. #endif

  189. #if (NGX_HTTP_UPSTREAM_ZONE)
  190. ‌#define NGX_MODULE_SIGNATURE_33  "1"
  191. #else
  192. ‌#define NGX_MODULE_SIGNATURE_33  "0"
  193. #endif

  195. #if (NGX_COMPAT)
  196. ‌#define NGX_MODULE_SIGNATURE_34  "1"
  197. #else
  198. ‌#define NGX_MODULE_SIGNATURE_34  "0"
  199. #endif

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


  216. ‌#define NGX_MODULE_V1                                                         \
  217.     NGX_MODULE_UNSET_INDEX, NGX_MODULE_UNSET_INDEX,                           \
  218.     NULL, 0, 0, nginx_version, NGX_MODULE_SIGNATURE

  220. ‌#define NGX_MODULE_V1_PADDING  0, 0, 0, 0, 0, 0, 0, 0


  223. ‌struct ngx_module_s {
  224.     ngx_uint_t            ctx_index;
  225.     ngx_uint_t            index;

  227.     char                 *name;

  229.     ngx_uint_t            spare0;
  230.     ngx_uint_t            spare1;

  232.     ngx_uint_t            version;
  233.     const char           *signature;

  235.     void                 *ctx;
  236.     ngx_command_t        *commands;
  237.     ngx_uint_t            type;

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

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

  243.     ngx_int_t           (*init_process)(ngx_cycle_t *cycle);
  244.     ngx_int_t           (*init_thread)(ngx_cycle_t *cycle);
  245.     void                (*exit_thread)(ngx_cycle_t *cycle);
  246.     void                (*exit_process)(ngx_cycle_t *cycle);

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

  250.     uintptr_t             spare_hook0;
  251.     uintptr_t             spare_hook1;
  252.     uintptr_t             spare_hook2;
  253.     uintptr_t             spare_hook3;
  254.     uintptr_t             spare_hook4;
  255.     uintptr_t             spare_hook5;
  256.     uintptr_t             spare_hook6;
  257.     uintptr_t             spare_hook7;
  258. };


  261. ‌typedef struct {
  262.     ngx_str_t             name;
  263.     void               *(*create_conf)(ngx_cycle_t *cycle);
  264.     char               *(*init_conf)(ngx_cycle_t *cycle, void *conf);
  265. ‌} ngx_core_module_t;


  268. ngx_int_t ngx_preinit_modules(void);
  269. ngx_int_t ngx_cycle_modules(ngx_cycle_t *cycle);
  270. ngx_int_t ngx_init_modules(ngx_cycle_t *cycle);
  271. ngx_int_t ngx_count_modules(ngx_cycle_t *cycle, ngx_uint_t type);


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


  278. extern ngx_module_t  *ngx_modules[];
  279. extern ngx_uint_t     ngx_max_module;

  281. extern char          *ngx_module_names[];


  284. #endif /* _NGX_MODULE_H_INCLUDED_ */

One Level Up Top Level