xref: /unit/src/nxt_runtime.h (revision 2646:b003301015ea)
1 
2 /*
3  * Copyright (C) Igor Sysoev
4  * Copyright (C) Valentin V. Bartenev
5  * Copyright (C) NGINX, Inc.
6  */
7 
8 #ifndef _NXT_RUNTIME_H_INCLUDED_
9 #define _NXT_RUNTIME_H_INCLUDED_
10 
11 
12 typedef void (*nxt_runtime_cont_t)(nxt_task_t *task, nxt_uint_t status);
13 
14 
15 struct nxt_runtime_s {
16     nxt_mp_t               *mem_pool;
17 
18     nxt_array_t            *inherited_sockets;  /* of nxt_listen_socket_t */
19     nxt_array_t            *listen_sockets;     /* of nxt_listen_socket_t */
20 
21     nxt_array_t            *services;           /* of nxt_service_t */
22     nxt_array_t            *languages;          /* of nxt_app_lang_module_t */
23     void                   *data;
24 
25     nxt_runtime_cont_t     start;
26 
27     nxt_str_t              hostname;
28 
29     nxt_file_name_t        *pid_file;
30 
31 #if (NXT_TLS)
32     const nxt_tls_lib_t    *tls;
33 #endif
34 
35     nxt_array_t            *thread_pools;       /* of nxt_thread_pool_t */
36     nxt_runtime_cont_t     continuation;
37 
38     nxt_process_t          *mprocess;
39     size_t                 nprocesses;
40     nxt_thread_mutex_t     processes_mutex;
41     nxt_lvlhsh_t           processes;           /* of nxt_process_t */
42 
43     nxt_port_t             *port_by_type[NXT_PROCESS_MAX];
44     nxt_lvlhsh_t           ports;               /* of nxt_port_t */
45 
46     nxt_list_t             *log_files;          /* of nxt_file_t */
47 
48     uint32_t               last_engine_id;
49 
50     nxt_process_type_t     type;
51 
52     nxt_timer_t            timer;
53 
54     uint8_t                daemon;
55     uint8_t                batch;
56     uint8_t                status;
57     uint8_t                is_pid_isolated;
58 
59     const char             *engine;
60     uint32_t               engine_connections;
61     uint32_t               auxiliary_threads;
62     nxt_credential_t       user_cred;
63     nxt_capabilities_t     capabilities;
64     const char             *group;
65     const char             *pid;
66     const char             *log;
67     const char             *modules;
68     const char             *state;
69     const char             *ver;
70     const char             *ver_tmp;
71     const char             *conf;
72     const char             *conf_tmp;
73     const char             *tmp;
74     const char             *control;
75 
76     mode_t                 control_mode;
77     const char             *control_user;
78     const char             *control_group;
79 
80     nxt_str_t              certs;
81     nxt_str_t              scripts;
82 
83     nxt_queue_t            engines;            /* of nxt_event_engine_t */
84 
85     nxt_sockaddr_t         *controller_listen;
86     nxt_listen_socket_t    *controller_socket;
87 };
88 
89 
90 
91 typedef nxt_int_t (*nxt_module_init_t)(nxt_thread_t *thr, nxt_runtime_t *rt);
92 
93 
94 nxt_int_t nxt_runtime_create(nxt_task_t *task);
95 void nxt_runtime_quit(nxt_task_t *task, nxt_uint_t status);
96 
97 void nxt_runtime_event_engine_free(nxt_runtime_t *rt);
98 
99 nxt_int_t nxt_runtime_thread_pool_create(nxt_thread_t *thr, nxt_runtime_t *rt,
100     nxt_uint_t max_threads, nxt_nsec_t timeout);
101 
102 
103 void nxt_runtime_process_add(nxt_task_t *task, nxt_process_t *process);
104 void nxt_runtime_process_remove(nxt_runtime_t *rt, nxt_process_t *process);
105 
106 nxt_process_t *nxt_runtime_process_find(nxt_runtime_t *rt, nxt_pid_t pid);
107 
108 nxt_process_t *nxt_runtime_process_first(nxt_runtime_t *rt,
109     nxt_lvlhsh_each_t *lhe);
110 
111 void nxt_runtime_process_release(nxt_runtime_t *rt, nxt_process_t *process);
112 
113 #define nxt_runtime_process_next(rt, lhe)                                     \
114     nxt_lvlhsh_each(&rt->processes, lhe)
115 
116 nxt_port_t *nxt_runtime_process_port_create(nxt_task_t *task, nxt_runtime_t *rt,
117     nxt_pid_t pid, nxt_port_id_t id, nxt_process_type_t type);
118 
119 void nxt_runtime_port_remove(nxt_task_t *task, nxt_port_t *port);
120 void nxt_runtime_stop_app_processes(nxt_task_t *task, nxt_runtime_t *rt);
121 
122 NXT_EXPORT nxt_port_t *nxt_runtime_port_find(nxt_runtime_t *rt, nxt_pid_t pid,
123     nxt_port_id_t port_id);
124 
125 
126 /* STUB */
127 nxt_int_t nxt_runtime_controller_socket(nxt_task_t *task, nxt_runtime_t *rt);
128 
129 nxt_str_t *nxt_current_directory(nxt_mp_t *mp);
130 
131 nxt_listen_socket_t *nxt_runtime_listen_socket_add(nxt_runtime_t *rt,
132     nxt_sockaddr_t *sa);
133 nxt_int_t nxt_runtime_listen_sockets_create(nxt_task_t *task,
134     nxt_runtime_t *rt);
135 nxt_int_t nxt_runtime_listen_sockets_enable(nxt_task_t *task,
136     nxt_runtime_t *rt);
137 nxt_file_t *nxt_runtime_log_file_add(nxt_runtime_t *rt, nxt_str_t *name);
138 
139 /* STUB */
140 void nxt_cdecl nxt_log_time_handler(nxt_uint_t level, nxt_log_t *log,
141     const char *fmt, ...);
142 
143 void nxt_stream_connection_init(nxt_task_t *task, void *obj, void *data);
144 
145 nxt_int_t nxt_http_register_variables(void);
146 #if (NXT_HAVE_NJS)
147 void nxt_http_register_js_proto(nxt_js_conf_t *jcf);
148 #endif
149 
150 
151 #define nxt_runtime_process_each(rt, process)                                 \
152     do {                                                                      \
153         nxt_lvlhsh_each_t  _lhe;                                              \
154         nxt_process_t      *_nxt;                                             \
155                                                                               \
156         for (process = nxt_runtime_process_first(rt, &_lhe);                  \
157              process != NULL;                                                 \
158              process = _nxt) {                                                \
159                                                                               \
160             _nxt = nxt_runtime_process_next(rt, &_lhe);                       \
161 
162 #define nxt_runtime_process_loop                                              \
163         }                                                                     \
164     } while(0)
165 
166 
167 extern nxt_module_init_t  nxt_init_modules[];
168 extern nxt_uint_t         nxt_init_modules_n;
169 
170 
171 #endif /* _NXT_RUNTIME_H_INCLIDED_ */
172