xref: /unit/src/nxt_port.h (revision 774)
111Sigor@sysoev.ru 
211Sigor@sysoev.ru /*
311Sigor@sysoev.ru  * Copyright (C) Igor Sysoev
411Sigor@sysoev.ru  * Copyright (C) NGINX, Inc.
511Sigor@sysoev.ru  */
611Sigor@sysoev.ru 
711Sigor@sysoev.ru #ifndef _NXT_PORT_H_INCLUDED_
811Sigor@sysoev.ru #define _NXT_PORT_H_INCLUDED_
911Sigor@sysoev.ru 
1011Sigor@sysoev.ru 
11320Smax.romanov@nginx.com struct nxt_port_handlers_s {
12320Smax.romanov@nginx.com     /* RPC responses. */
13320Smax.romanov@nginx.com     nxt_port_handler_t  rpc_ready;
14320Smax.romanov@nginx.com     nxt_port_handler_t  rpc_error;
15320Smax.romanov@nginx.com 
16320Smax.romanov@nginx.com     /* Main process RPC requests. */
17320Smax.romanov@nginx.com     nxt_port_handler_t  start_worker;
18320Smax.romanov@nginx.com     nxt_port_handler_t  socket;
19320Smax.romanov@nginx.com     nxt_port_handler_t  modules;
20320Smax.romanov@nginx.com     nxt_port_handler_t  conf_store;
21*774Svbart@nginx.com     nxt_port_handler_t  cert_get;
22*774Svbart@nginx.com     nxt_port_handler_t  cert_delete;
23630Svbart@nginx.com     nxt_port_handler_t  access_log;
24320Smax.romanov@nginx.com 
25320Smax.romanov@nginx.com     /* File descriptor exchange. */
26320Smax.romanov@nginx.com     nxt_port_handler_t  change_file;
27320Smax.romanov@nginx.com     nxt_port_handler_t  new_port;
28320Smax.romanov@nginx.com     nxt_port_handler_t  mmap;
29320Smax.romanov@nginx.com 
30320Smax.romanov@nginx.com     /* New process ready. */
31320Smax.romanov@nginx.com     nxt_port_handler_t  process_ready;
32320Smax.romanov@nginx.com 
33320Smax.romanov@nginx.com     /* Process exit/crash notification. */
34320Smax.romanov@nginx.com     nxt_port_handler_t  remove_pid;
35320Smax.romanov@nginx.com 
36320Smax.romanov@nginx.com     /* Stop process command. */
37320Smax.romanov@nginx.com     nxt_port_handler_t  quit;
38320Smax.romanov@nginx.com 
39320Smax.romanov@nginx.com     /* Various data. */
40320Smax.romanov@nginx.com     nxt_port_handler_t  data;
41320Smax.romanov@nginx.com };
42320Smax.romanov@nginx.com 
43320Smax.romanov@nginx.com 
44320Smax.romanov@nginx.com #define nxt_port_handler_idx(name)                                            \
45389Smax.romanov@nginx.com     ( offsetof(nxt_port_handlers_t, name) / sizeof(nxt_port_handler_t) )
46320Smax.romanov@nginx.com 
47320Smax.romanov@nginx.com 
4842Smax.romanov@nginx.com typedef enum {
49189Smax.romanov@nginx.com     NXT_PORT_MSG_LAST           = 0x100,
50189Smax.romanov@nginx.com     NXT_PORT_MSG_CLOSE_FD       = 0x200,
51205Smax.romanov@nginx.com     NXT_PORT_MSG_SYNC           = 0x400,
52189Smax.romanov@nginx.com 
53189Smax.romanov@nginx.com     NXT_PORT_MSG_MASK           = 0xFF,
54189Smax.romanov@nginx.com 
55320Smax.romanov@nginx.com     _NXT_PORT_MSG_RPC_READY     = nxt_port_handler_idx(rpc_ready),
56320Smax.romanov@nginx.com     _NXT_PORT_MSG_RPC_ERROR     = nxt_port_handler_idx(rpc_error),
57320Smax.romanov@nginx.com 
58320Smax.romanov@nginx.com     _NXT_PORT_MSG_START_WORKER  = nxt_port_handler_idx(start_worker),
59320Smax.romanov@nginx.com     _NXT_PORT_MSG_SOCKET        = nxt_port_handler_idx(socket),
60320Smax.romanov@nginx.com     _NXT_PORT_MSG_MODULES       = nxt_port_handler_idx(modules),
61320Smax.romanov@nginx.com     _NXT_PORT_MSG_CONF_STORE    = nxt_port_handler_idx(conf_store),
62*774Svbart@nginx.com     _NXT_PORT_MSG_CERT_GET      = nxt_port_handler_idx(cert_get),
63*774Svbart@nginx.com     _NXT_PORT_MSG_CERT_DELETE   = nxt_port_handler_idx(cert_delete),
64630Svbart@nginx.com     _NXT_PORT_MSG_ACCESS_LOG    = nxt_port_handler_idx(access_log),
65320Smax.romanov@nginx.com 
66320Smax.romanov@nginx.com     _NXT_PORT_MSG_CHANGE_FILE   = nxt_port_handler_idx(change_file),
67320Smax.romanov@nginx.com     _NXT_PORT_MSG_NEW_PORT      = nxt_port_handler_idx(new_port),
68320Smax.romanov@nginx.com     _NXT_PORT_MSG_MMAP          = nxt_port_handler_idx(mmap),
6942Smax.romanov@nginx.com 
70320Smax.romanov@nginx.com     _NXT_PORT_MSG_PROCESS_READY = nxt_port_handler_idx(process_ready),
71320Smax.romanov@nginx.com     _NXT_PORT_MSG_REMOVE_PID    = nxt_port_handler_idx(remove_pid),
72320Smax.romanov@nginx.com     _NXT_PORT_MSG_QUIT          = nxt_port_handler_idx(quit),
73320Smax.romanov@nginx.com 
74320Smax.romanov@nginx.com     _NXT_PORT_MSG_DATA          = nxt_port_handler_idx(data),
75189Smax.romanov@nginx.com 
76613Svbart@nginx.com     NXT_PORT_MSG_MAX            = sizeof(nxt_port_handlers_t)
77613Svbart@nginx.com                                   / sizeof(nxt_port_handler_t),
78320Smax.romanov@nginx.com 
79320Smax.romanov@nginx.com     NXT_PORT_MSG_RPC_READY      = _NXT_PORT_MSG_RPC_READY,
80320Smax.romanov@nginx.com     NXT_PORT_MSG_RPC_READY_LAST = _NXT_PORT_MSG_RPC_READY | NXT_PORT_MSG_LAST,
81320Smax.romanov@nginx.com     NXT_PORT_MSG_RPC_ERROR      = _NXT_PORT_MSG_RPC_ERROR | NXT_PORT_MSG_LAST,
82320Smax.romanov@nginx.com 
83613Svbart@nginx.com     NXT_PORT_MSG_START_WORKER   = _NXT_PORT_MSG_START_WORKER
84613Svbart@nginx.com                                   | NXT_PORT_MSG_LAST,
85198Sigor@sysoev.ru     NXT_PORT_MSG_SOCKET         = _NXT_PORT_MSG_SOCKET | NXT_PORT_MSG_LAST,
86216Sigor@sysoev.ru     NXT_PORT_MSG_MODULES        = _NXT_PORT_MSG_MODULES | NXT_PORT_MSG_LAST,
87314Svbart@nginx.com     NXT_PORT_MSG_CONF_STORE     = _NXT_PORT_MSG_CONF_STORE | NXT_PORT_MSG_LAST,
88*774Svbart@nginx.com     NXT_PORT_MSG_CERT_GET       = _NXT_PORT_MSG_CERT_GET | NXT_PORT_MSG_LAST,
89*774Svbart@nginx.com     NXT_PORT_MSG_CERT_DELETE    = _NXT_PORT_MSG_CERT_DELETE | NXT_PORT_MSG_LAST,
90630Svbart@nginx.com     NXT_PORT_MSG_ACCESS_LOG     = _NXT_PORT_MSG_ACCESS_LOG | NXT_PORT_MSG_LAST,
91320Smax.romanov@nginx.com 
92320Smax.romanov@nginx.com     NXT_PORT_MSG_CHANGE_FILE    = _NXT_PORT_MSG_CHANGE_FILE | NXT_PORT_MSG_LAST,
93320Smax.romanov@nginx.com     NXT_PORT_MSG_NEW_PORT       = _NXT_PORT_MSG_NEW_PORT | NXT_PORT_MSG_LAST,
94613Svbart@nginx.com     NXT_PORT_MSG_MMAP           = _NXT_PORT_MSG_MMAP | NXT_PORT_MSG_LAST
95613Svbart@nginx.com                                   | NXT_PORT_MSG_CLOSE_FD | NXT_PORT_MSG_SYNC,
96320Smax.romanov@nginx.com 
97613Svbart@nginx.com     NXT_PORT_MSG_PROCESS_READY  = _NXT_PORT_MSG_PROCESS_READY
98613Svbart@nginx.com                                   | NXT_PORT_MSG_LAST,
99320Smax.romanov@nginx.com     NXT_PORT_MSG_QUIT           = _NXT_PORT_MSG_QUIT | NXT_PORT_MSG_LAST,
100320Smax.romanov@nginx.com     NXT_PORT_MSG_REMOVE_PID     = _NXT_PORT_MSG_REMOVE_PID | NXT_PORT_MSG_LAST,
101320Smax.romanov@nginx.com 
102320Smax.romanov@nginx.com     NXT_PORT_MSG_DATA           = _NXT_PORT_MSG_DATA,
103320Smax.romanov@nginx.com     NXT_PORT_MSG_DATA_LAST      = _NXT_PORT_MSG_DATA | NXT_PORT_MSG_LAST,
104125Smax.romanov@nginx.com } nxt_port_msg_type_t;
10542Smax.romanov@nginx.com 
10614Sigor@sysoev.ru 
10742Smax.romanov@nginx.com /* Passed as a first iov chunk. */
10842Smax.romanov@nginx.com typedef struct {
10942Smax.romanov@nginx.com     uint32_t             stream;
11042Smax.romanov@nginx.com     nxt_pid_t            pid;
11142Smax.romanov@nginx.com     nxt_port_id_t        reply_port;
11242Smax.romanov@nginx.com 
113189Smax.romanov@nginx.com     uint8_t              type;
114423Smax.romanov@nginx.com 
115423Smax.romanov@nginx.com     /* Last message for this stream. */
11642Smax.romanov@nginx.com     uint8_t              last;      /* 1 bit */
11742Smax.romanov@nginx.com 
11842Smax.romanov@nginx.com     /* Message data send using mmap, next chunk is a nxt_port_mmap_msg_t. */
11942Smax.romanov@nginx.com     uint8_t              mmap;      /* 1 bit */
120352Smax.romanov@nginx.com 
121423Smax.romanov@nginx.com     /* Non-First fragment in fragmented message sequence. */
122423Smax.romanov@nginx.com     uint8_t              nf;        /* 1 bit */
123423Smax.romanov@nginx.com 
124423Smax.romanov@nginx.com     /* More Fragments followed. */
125423Smax.romanov@nginx.com     uint8_t              mf;        /* 1 bit */
126423Smax.romanov@nginx.com 
127423Smax.romanov@nginx.com     /* Message delivery tracking enabled, next chunk is tracking msg. */
128423Smax.romanov@nginx.com     uint8_t              tracking;  /* 1 bit */
129168Svbart@nginx.com } nxt_port_msg_t;
13014Sigor@sysoev.ru 
13114Sigor@sysoev.ru 
13214Sigor@sysoev.ru typedef struct {
13314Sigor@sysoev.ru     nxt_queue_link_t    link;
13414Sigor@sysoev.ru     nxt_buf_t           *buf;
13514Sigor@sysoev.ru     size_t              share;
13614Sigor@sysoev.ru     nxt_fd_t            fd;
137189Smax.romanov@nginx.com     nxt_bool_t          close_fd;
13814Sigor@sysoev.ru     nxt_port_msg_t      port_msg;
139423Smax.romanov@nginx.com     uint32_t            tracking_msg[2];
140122Smax.romanov@nginx.com 
141122Smax.romanov@nginx.com     nxt_work_t          work;
14214Sigor@sysoev.ru } nxt_port_send_msg_t;
14314Sigor@sysoev.ru 
14414Sigor@sysoev.ru 
14520Sigor@sysoev.ru struct nxt_port_recv_msg_s {
14614Sigor@sysoev.ru     nxt_fd_t            fd;
14714Sigor@sysoev.ru     nxt_buf_t           *buf;
14814Sigor@sysoev.ru     nxt_port_t          *port;
14942Smax.romanov@nginx.com     nxt_port_msg_t      port_msg;
15082Smax.romanov@nginx.com     size_t              size;
151423Smax.romanov@nginx.com     nxt_bool_t          cancelled;
152347Smax.romanov@nginx.com     union {
153347Smax.romanov@nginx.com         nxt_port_t      *new_port;
154347Smax.romanov@nginx.com         nxt_pid_t       removed_pid;
155347Smax.romanov@nginx.com         void            *data;
156347Smax.romanov@nginx.com     } u;
15720Sigor@sysoev.ru };
15814Sigor@sysoev.ru 
159141Smax.romanov@nginx.com typedef struct nxt_app_s  nxt_app_t;
16014Sigor@sysoev.ru 
16114Sigor@sysoev.ru struct nxt_port_s {
16214Sigor@sysoev.ru     nxt_fd_event_t      socket;
16314Sigor@sysoev.ru 
164125Smax.romanov@nginx.com     nxt_queue_link_t    link;       /* for nxt_process_t.ports */
165141Smax.romanov@nginx.com     nxt_process_t       *process;
166141Smax.romanov@nginx.com 
167141Smax.romanov@nginx.com     nxt_queue_link_t    app_link;   /* for nxt_app_t.ports */
168141Smax.romanov@nginx.com     nxt_app_t           *app;
16942Smax.romanov@nginx.com 
170507Smax.romanov@nginx.com     nxt_queue_link_t    idle_link;  /* for nxt_app_t.idle_ports */
171507Smax.romanov@nginx.com     nxt_msec_t          idle_start;
172507Smax.romanov@nginx.com 
17314Sigor@sysoev.ru     nxt_queue_t         messages;   /* of nxt_port_send_msg_t */
174343Smax.romanov@nginx.com     nxt_thread_mutex_t  write_mutex;
17514Sigor@sysoev.ru 
17614Sigor@sysoev.ru     /* Maximum size of message part. */
17714Sigor@sysoev.ru     uint32_t            max_size;
17814Sigor@sysoev.ru     /* Maximum interleave of message parts. */
17914Sigor@sysoev.ru     uint32_t            max_share;
180343Smax.romanov@nginx.com 
181424Smax.romanov@nginx.com     uint32_t            app_pending_responses;
182343Smax.romanov@nginx.com     uint32_t            app_responses;
183425Smax.romanov@nginx.com     nxt_queue_t         pending_requests;
18414Sigor@sysoev.ru 
18514Sigor@sysoev.ru     nxt_port_handler_t  handler;
186141Smax.romanov@nginx.com     nxt_port_handler_t  *data;
18714Sigor@sysoev.ru 
18865Sigor@sysoev.ru     nxt_mp_t            *mem_pool;
189141Smax.romanov@nginx.com     nxt_event_engine_t  *engine;
190141Smax.romanov@nginx.com 
19114Sigor@sysoev.ru     nxt_buf_t           *free_bufs;
19214Sigor@sysoev.ru     nxt_socket_t        pair[2];
19314Sigor@sysoev.ru 
19442Smax.romanov@nginx.com     nxt_port_id_t       id;
19514Sigor@sysoev.ru     nxt_pid_t           pid;
19642Smax.romanov@nginx.com 
197190Smax.romanov@nginx.com     nxt_lvlhsh_t        rpc_streams; /* stream to nxt_port_rpc_reg_t */
198190Smax.romanov@nginx.com     nxt_lvlhsh_t        rpc_peers;   /* peer to queue of nxt_port_rpc_reg_t */
199190Smax.romanov@nginx.com 
200352Smax.romanov@nginx.com     nxt_lvlhsh_t        frags;
201352Smax.romanov@nginx.com 
202343Smax.romanov@nginx.com     nxt_atomic_t        use_count;
203343Smax.romanov@nginx.com 
204141Smax.romanov@nginx.com     nxt_process_type_t  type;
205197Smax.romanov@nginx.com 
206197Smax.romanov@nginx.com     struct iovec        *iov;
207197Smax.romanov@nginx.com     void                *mmsg_buf;
20814Sigor@sysoev.ru };
20914Sigor@sysoev.ru 
21014Sigor@sysoev.ru 
21111Sigor@sysoev.ru typedef struct {
21242Smax.romanov@nginx.com     nxt_port_id_t       id;
21314Sigor@sysoev.ru     nxt_pid_t           pid;
21414Sigor@sysoev.ru     size_t              max_size;
21514Sigor@sysoev.ru     size_t              max_share;
21642Smax.romanov@nginx.com     nxt_process_type_t  type:8;
217168Svbart@nginx.com } nxt_port_msg_new_port_t;
21811Sigor@sysoev.ru 
21911Sigor@sysoev.ru 
22011Sigor@sysoev.ru /*
22114Sigor@sysoev.ru  * nxt_port_data_t size is allocation size
22214Sigor@sysoev.ru  * which enables effective reuse of memory pool cache.
22311Sigor@sysoev.ru  */
22411Sigor@sysoev.ru typedef union {
22511Sigor@sysoev.ru     nxt_buf_t                buf;
22614Sigor@sysoev.ru     nxt_port_msg_new_port_t  new_port;
22714Sigor@sysoev.ru } nxt_port_data_t;
22811Sigor@sysoev.ru 
22911Sigor@sysoev.ru 
230343Smax.romanov@nginx.com typedef void (*nxt_port_post_handler_t)(nxt_task_t *task, nxt_port_t *port,
231343Smax.romanov@nginx.com     void *data);
232343Smax.romanov@nginx.com 
233197Smax.romanov@nginx.com nxt_port_t *nxt_port_new(nxt_task_t *task, nxt_port_id_t id, nxt_pid_t pid,
234163Smax.romanov@nginx.com     nxt_process_type_t type);
235163Smax.romanov@nginx.com 
236141Smax.romanov@nginx.com nxt_port_id_t nxt_port_get_next_id(void);
237141Smax.romanov@nginx.com void nxt_port_reset_next_id(void);
238141Smax.romanov@nginx.com 
23914Sigor@sysoev.ru nxt_int_t nxt_port_socket_init(nxt_task_t *task, nxt_port_t *port,
24014Sigor@sysoev.ru     size_t max_size);
24114Sigor@sysoev.ru void nxt_port_destroy(nxt_port_t *port);
242343Smax.romanov@nginx.com void nxt_port_close(nxt_task_t *task, nxt_port_t *port);
24314Sigor@sysoev.ru void nxt_port_write_enable(nxt_task_t *task, nxt_port_t *port);
24414Sigor@sysoev.ru void nxt_port_write_close(nxt_port_t *port);
24514Sigor@sysoev.ru void nxt_port_read_enable(nxt_task_t *task, nxt_port_t *port);
24614Sigor@sysoev.ru void nxt_port_read_close(nxt_port_t *port);
247423Smax.romanov@nginx.com nxt_int_t nxt_port_socket_twrite(nxt_task_t *task, nxt_port_t *port,
24842Smax.romanov@nginx.com     nxt_uint_t type, nxt_fd_t fd, uint32_t stream, nxt_port_id_t reply_port,
249423Smax.romanov@nginx.com     nxt_buf_t *b, void *tracking);
250423Smax.romanov@nginx.com 
251423Smax.romanov@nginx.com nxt_inline nxt_int_t
252423Smax.romanov@nginx.com nxt_port_socket_write(nxt_task_t *task, nxt_port_t *port,
253423Smax.romanov@nginx.com     nxt_uint_t type, nxt_fd_t fd, uint32_t stream, nxt_port_id_t reply_port,
254423Smax.romanov@nginx.com     nxt_buf_t *b)
255423Smax.romanov@nginx.com {
256423Smax.romanov@nginx.com     return nxt_port_socket_twrite(task, port, type, fd, stream, reply_port, b,
257423Smax.romanov@nginx.com                                   NULL);
258423Smax.romanov@nginx.com }
25914Sigor@sysoev.ru 
260141Smax.romanov@nginx.com void nxt_port_enable(nxt_task_t *task, nxt_port_t *port,
261320Smax.romanov@nginx.com     nxt_port_handlers_t *handlers);
26281Smax.romanov@nginx.com nxt_int_t nxt_port_send_port(nxt_task_t *task, nxt_port_t *port,
263141Smax.romanov@nginx.com     nxt_port_t *new_port, uint32_t stream);
26420Sigor@sysoev.ru void nxt_port_change_log_file(nxt_task_t *task, nxt_runtime_t *rt,
26511Sigor@sysoev.ru     nxt_uint_t slot, nxt_fd_t fd);
26611Sigor@sysoev.ru 
26714Sigor@sysoev.ru void nxt_port_quit_handler(nxt_task_t *task, nxt_port_recv_msg_t *msg);
26814Sigor@sysoev.ru void nxt_port_new_port_handler(nxt_task_t *task, nxt_port_recv_msg_t *msg);
269320Smax.romanov@nginx.com void nxt_port_process_ready_handler(nxt_task_t *task, nxt_port_recv_msg_t *msg);
27014Sigor@sysoev.ru void nxt_port_change_log_file_handler(nxt_task_t *task,
27111Sigor@sysoev.ru     nxt_port_recv_msg_t *msg);
27242Smax.romanov@nginx.com void nxt_port_mmap_handler(nxt_task_t *task, nxt_port_recv_msg_t *msg);
27314Sigor@sysoev.ru void nxt_port_data_handler(nxt_task_t *task, nxt_port_recv_msg_t *msg);
274125Smax.romanov@nginx.com void nxt_port_remove_pid_handler(nxt_task_t *task, nxt_port_recv_msg_t *msg);
27514Sigor@sysoev.ru void nxt_port_empty_handler(nxt_task_t *task, nxt_port_recv_msg_t *msg);
27611Sigor@sysoev.ru 
277343Smax.romanov@nginx.com nxt_int_t nxt_port_post(nxt_task_t *task, nxt_port_t *port,
278343Smax.romanov@nginx.com     nxt_port_post_handler_t handler, void *data);
279343Smax.romanov@nginx.com void nxt_port_use(nxt_task_t *task, nxt_port_t *port, int i);
28011Sigor@sysoev.ru 
281425Smax.romanov@nginx.com nxt_inline void nxt_port_inc_use(nxt_port_t *port)
282425Smax.romanov@nginx.com {
283425Smax.romanov@nginx.com     nxt_atomic_fetch_add(&port->use_count, 1);
284425Smax.romanov@nginx.com }
285425Smax.romanov@nginx.com 
28611Sigor@sysoev.ru #endif /* _NXT_PORT_H_INCLUDED_ */
287