xref: /unit/src/nxt_port.h (revision 630)
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*630Svbart@nginx.com     nxt_port_handler_t  access_log;
22320Smax.romanov@nginx.com 
23320Smax.romanov@nginx.com     /* File descriptor exchange. */
24320Smax.romanov@nginx.com     nxt_port_handler_t  change_file;
25320Smax.romanov@nginx.com     nxt_port_handler_t  new_port;
26320Smax.romanov@nginx.com     nxt_port_handler_t  mmap;
27320Smax.romanov@nginx.com 
28320Smax.romanov@nginx.com     /* New process ready. */
29320Smax.romanov@nginx.com     nxt_port_handler_t  process_ready;
30320Smax.romanov@nginx.com 
31320Smax.romanov@nginx.com     /* Process exit/crash notification. */
32320Smax.romanov@nginx.com     nxt_port_handler_t  remove_pid;
33320Smax.romanov@nginx.com 
34320Smax.romanov@nginx.com     /* Stop process command. */
35320Smax.romanov@nginx.com     nxt_port_handler_t  quit;
36320Smax.romanov@nginx.com 
37320Smax.romanov@nginx.com     /* Various data. */
38320Smax.romanov@nginx.com     nxt_port_handler_t  data;
39320Smax.romanov@nginx.com };
40320Smax.romanov@nginx.com 
41320Smax.romanov@nginx.com 
42320Smax.romanov@nginx.com #define nxt_port_handler_idx(name)                                            \
43389Smax.romanov@nginx.com     ( offsetof(nxt_port_handlers_t, name) / sizeof(nxt_port_handler_t) )
44320Smax.romanov@nginx.com 
45320Smax.romanov@nginx.com 
4642Smax.romanov@nginx.com typedef enum {
47189Smax.romanov@nginx.com     NXT_PORT_MSG_LAST           = 0x100,
48189Smax.romanov@nginx.com     NXT_PORT_MSG_CLOSE_FD       = 0x200,
49205Smax.romanov@nginx.com     NXT_PORT_MSG_SYNC           = 0x400,
50189Smax.romanov@nginx.com 
51189Smax.romanov@nginx.com     NXT_PORT_MSG_MASK           = 0xFF,
52189Smax.romanov@nginx.com 
53320Smax.romanov@nginx.com     _NXT_PORT_MSG_RPC_READY     = nxt_port_handler_idx(rpc_ready),
54320Smax.romanov@nginx.com     _NXT_PORT_MSG_RPC_ERROR     = nxt_port_handler_idx(rpc_error),
55320Smax.romanov@nginx.com 
56320Smax.romanov@nginx.com     _NXT_PORT_MSG_START_WORKER  = nxt_port_handler_idx(start_worker),
57320Smax.romanov@nginx.com     _NXT_PORT_MSG_SOCKET        = nxt_port_handler_idx(socket),
58320Smax.romanov@nginx.com     _NXT_PORT_MSG_MODULES       = nxt_port_handler_idx(modules),
59320Smax.romanov@nginx.com     _NXT_PORT_MSG_CONF_STORE    = nxt_port_handler_idx(conf_store),
60*630Svbart@nginx.com     _NXT_PORT_MSG_ACCESS_LOG    = nxt_port_handler_idx(access_log),
61320Smax.romanov@nginx.com 
62320Smax.romanov@nginx.com     _NXT_PORT_MSG_CHANGE_FILE   = nxt_port_handler_idx(change_file),
63320Smax.romanov@nginx.com     _NXT_PORT_MSG_NEW_PORT      = nxt_port_handler_idx(new_port),
64320Smax.romanov@nginx.com     _NXT_PORT_MSG_MMAP          = nxt_port_handler_idx(mmap),
6542Smax.romanov@nginx.com 
66320Smax.romanov@nginx.com     _NXT_PORT_MSG_PROCESS_READY = nxt_port_handler_idx(process_ready),
67320Smax.romanov@nginx.com     _NXT_PORT_MSG_REMOVE_PID    = nxt_port_handler_idx(remove_pid),
68320Smax.romanov@nginx.com     _NXT_PORT_MSG_QUIT          = nxt_port_handler_idx(quit),
69320Smax.romanov@nginx.com 
70320Smax.romanov@nginx.com     _NXT_PORT_MSG_DATA          = nxt_port_handler_idx(data),
71189Smax.romanov@nginx.com 
72613Svbart@nginx.com     NXT_PORT_MSG_MAX            = sizeof(nxt_port_handlers_t)
73613Svbart@nginx.com                                   / sizeof(nxt_port_handler_t),
74320Smax.romanov@nginx.com 
75320Smax.romanov@nginx.com     NXT_PORT_MSG_RPC_READY      = _NXT_PORT_MSG_RPC_READY,
76320Smax.romanov@nginx.com     NXT_PORT_MSG_RPC_READY_LAST = _NXT_PORT_MSG_RPC_READY | NXT_PORT_MSG_LAST,
77320Smax.romanov@nginx.com     NXT_PORT_MSG_RPC_ERROR      = _NXT_PORT_MSG_RPC_ERROR | NXT_PORT_MSG_LAST,
78320Smax.romanov@nginx.com 
79613Svbart@nginx.com     NXT_PORT_MSG_START_WORKER   = _NXT_PORT_MSG_START_WORKER
80613Svbart@nginx.com                                   | NXT_PORT_MSG_LAST,
81198Sigor@sysoev.ru     NXT_PORT_MSG_SOCKET         = _NXT_PORT_MSG_SOCKET | NXT_PORT_MSG_LAST,
82216Sigor@sysoev.ru     NXT_PORT_MSG_MODULES        = _NXT_PORT_MSG_MODULES | NXT_PORT_MSG_LAST,
83314Svbart@nginx.com     NXT_PORT_MSG_CONF_STORE     = _NXT_PORT_MSG_CONF_STORE | NXT_PORT_MSG_LAST,
84*630Svbart@nginx.com     NXT_PORT_MSG_ACCESS_LOG     = _NXT_PORT_MSG_ACCESS_LOG | NXT_PORT_MSG_LAST,
85320Smax.romanov@nginx.com 
86320Smax.romanov@nginx.com     NXT_PORT_MSG_CHANGE_FILE    = _NXT_PORT_MSG_CHANGE_FILE | NXT_PORT_MSG_LAST,
87320Smax.romanov@nginx.com     NXT_PORT_MSG_NEW_PORT       = _NXT_PORT_MSG_NEW_PORT | NXT_PORT_MSG_LAST,
88613Svbart@nginx.com     NXT_PORT_MSG_MMAP           = _NXT_PORT_MSG_MMAP | NXT_PORT_MSG_LAST
89613Svbart@nginx.com                                   | NXT_PORT_MSG_CLOSE_FD | NXT_PORT_MSG_SYNC,
90320Smax.romanov@nginx.com 
91613Svbart@nginx.com     NXT_PORT_MSG_PROCESS_READY  = _NXT_PORT_MSG_PROCESS_READY
92613Svbart@nginx.com                                   | NXT_PORT_MSG_LAST,
93320Smax.romanov@nginx.com     NXT_PORT_MSG_QUIT           = _NXT_PORT_MSG_QUIT | NXT_PORT_MSG_LAST,
94320Smax.romanov@nginx.com     NXT_PORT_MSG_REMOVE_PID     = _NXT_PORT_MSG_REMOVE_PID | NXT_PORT_MSG_LAST,
95320Smax.romanov@nginx.com 
96320Smax.romanov@nginx.com     NXT_PORT_MSG_DATA           = _NXT_PORT_MSG_DATA,
97320Smax.romanov@nginx.com     NXT_PORT_MSG_DATA_LAST      = _NXT_PORT_MSG_DATA | NXT_PORT_MSG_LAST,
98125Smax.romanov@nginx.com } nxt_port_msg_type_t;
9942Smax.romanov@nginx.com 
10014Sigor@sysoev.ru 
10142Smax.romanov@nginx.com /* Passed as a first iov chunk. */
10242Smax.romanov@nginx.com typedef struct {
10342Smax.romanov@nginx.com     uint32_t             stream;
10442Smax.romanov@nginx.com     nxt_pid_t            pid;
10542Smax.romanov@nginx.com     nxt_port_id_t        reply_port;
10642Smax.romanov@nginx.com 
107189Smax.romanov@nginx.com     uint8_t              type;
108423Smax.romanov@nginx.com 
109423Smax.romanov@nginx.com     /* Last message for this stream. */
11042Smax.romanov@nginx.com     uint8_t              last;      /* 1 bit */
11142Smax.romanov@nginx.com 
11242Smax.romanov@nginx.com     /* Message data send using mmap, next chunk is a nxt_port_mmap_msg_t. */
11342Smax.romanov@nginx.com     uint8_t              mmap;      /* 1 bit */
114352Smax.romanov@nginx.com 
115423Smax.romanov@nginx.com     /* Non-First fragment in fragmented message sequence. */
116423Smax.romanov@nginx.com     uint8_t              nf;        /* 1 bit */
117423Smax.romanov@nginx.com 
118423Smax.romanov@nginx.com     /* More Fragments followed. */
119423Smax.romanov@nginx.com     uint8_t              mf;        /* 1 bit */
120423Smax.romanov@nginx.com 
121423Smax.romanov@nginx.com     /* Message delivery tracking enabled, next chunk is tracking msg. */
122423Smax.romanov@nginx.com     uint8_t              tracking;  /* 1 bit */
123168Svbart@nginx.com } nxt_port_msg_t;
12414Sigor@sysoev.ru 
12514Sigor@sysoev.ru 
12614Sigor@sysoev.ru typedef struct {
12714Sigor@sysoev.ru     nxt_queue_link_t    link;
12814Sigor@sysoev.ru     nxt_buf_t           *buf;
12914Sigor@sysoev.ru     size_t              share;
13014Sigor@sysoev.ru     nxt_fd_t            fd;
131189Smax.romanov@nginx.com     nxt_bool_t          close_fd;
13214Sigor@sysoev.ru     nxt_port_msg_t      port_msg;
133423Smax.romanov@nginx.com     uint32_t            tracking_msg[2];
134122Smax.romanov@nginx.com 
135122Smax.romanov@nginx.com     nxt_work_t          work;
13614Sigor@sysoev.ru } nxt_port_send_msg_t;
13714Sigor@sysoev.ru 
13814Sigor@sysoev.ru 
13920Sigor@sysoev.ru struct nxt_port_recv_msg_s {
14014Sigor@sysoev.ru     nxt_fd_t            fd;
14114Sigor@sysoev.ru     nxt_buf_t           *buf;
14214Sigor@sysoev.ru     nxt_port_t          *port;
14342Smax.romanov@nginx.com     nxt_port_msg_t      port_msg;
14482Smax.romanov@nginx.com     size_t              size;
145423Smax.romanov@nginx.com     nxt_bool_t          cancelled;
146347Smax.romanov@nginx.com     union {
147347Smax.romanov@nginx.com         nxt_port_t      *new_port;
148347Smax.romanov@nginx.com         nxt_pid_t       removed_pid;
149347Smax.romanov@nginx.com         void            *data;
150347Smax.romanov@nginx.com     } u;
15120Sigor@sysoev.ru };
15214Sigor@sysoev.ru 
153141Smax.romanov@nginx.com typedef struct nxt_app_s  nxt_app_t;
15414Sigor@sysoev.ru 
15514Sigor@sysoev.ru struct nxt_port_s {
15614Sigor@sysoev.ru     nxt_fd_event_t      socket;
15714Sigor@sysoev.ru 
158125Smax.romanov@nginx.com     nxt_queue_link_t    link;       /* for nxt_process_t.ports */
159141Smax.romanov@nginx.com     nxt_process_t       *process;
160141Smax.romanov@nginx.com 
161141Smax.romanov@nginx.com     nxt_queue_link_t    app_link;   /* for nxt_app_t.ports */
162141Smax.romanov@nginx.com     nxt_app_t           *app;
16342Smax.romanov@nginx.com 
164507Smax.romanov@nginx.com     nxt_queue_link_t    idle_link;  /* for nxt_app_t.idle_ports */
165507Smax.romanov@nginx.com     nxt_msec_t          idle_start;
166507Smax.romanov@nginx.com 
16714Sigor@sysoev.ru     nxt_queue_t         messages;   /* of nxt_port_send_msg_t */
168343Smax.romanov@nginx.com     nxt_thread_mutex_t  write_mutex;
16914Sigor@sysoev.ru 
17014Sigor@sysoev.ru     /* Maximum size of message part. */
17114Sigor@sysoev.ru     uint32_t            max_size;
17214Sigor@sysoev.ru     /* Maximum interleave of message parts. */
17314Sigor@sysoev.ru     uint32_t            max_share;
174343Smax.romanov@nginx.com 
175424Smax.romanov@nginx.com     uint32_t            app_pending_responses;
176343Smax.romanov@nginx.com     uint32_t            app_responses;
177425Smax.romanov@nginx.com     nxt_queue_t         pending_requests;
17814Sigor@sysoev.ru 
17914Sigor@sysoev.ru     nxt_port_handler_t  handler;
180141Smax.romanov@nginx.com     nxt_port_handler_t  *data;
18114Sigor@sysoev.ru 
18265Sigor@sysoev.ru     nxt_mp_t            *mem_pool;
183141Smax.romanov@nginx.com     nxt_event_engine_t  *engine;
184141Smax.romanov@nginx.com 
18514Sigor@sysoev.ru     nxt_buf_t           *free_bufs;
18614Sigor@sysoev.ru     nxt_socket_t        pair[2];
18714Sigor@sysoev.ru 
18842Smax.romanov@nginx.com     nxt_port_id_t       id;
18914Sigor@sysoev.ru     nxt_pid_t           pid;
19042Smax.romanov@nginx.com 
191190Smax.romanov@nginx.com     nxt_lvlhsh_t        rpc_streams; /* stream to nxt_port_rpc_reg_t */
192190Smax.romanov@nginx.com     nxt_lvlhsh_t        rpc_peers;   /* peer to queue of nxt_port_rpc_reg_t */
193190Smax.romanov@nginx.com 
194352Smax.romanov@nginx.com     nxt_lvlhsh_t        frags;
195352Smax.romanov@nginx.com 
196343Smax.romanov@nginx.com     nxt_atomic_t        use_count;
197343Smax.romanov@nginx.com 
198141Smax.romanov@nginx.com     nxt_process_type_t  type;
199197Smax.romanov@nginx.com 
200197Smax.romanov@nginx.com     struct iovec        *iov;
201197Smax.romanov@nginx.com     void                *mmsg_buf;
20214Sigor@sysoev.ru };
20314Sigor@sysoev.ru 
20414Sigor@sysoev.ru 
20511Sigor@sysoev.ru typedef struct {
20642Smax.romanov@nginx.com     nxt_port_id_t       id;
20714Sigor@sysoev.ru     nxt_pid_t           pid;
20814Sigor@sysoev.ru     size_t              max_size;
20914Sigor@sysoev.ru     size_t              max_share;
21042Smax.romanov@nginx.com     nxt_process_type_t  type:8;
211168Svbart@nginx.com } nxt_port_msg_new_port_t;
21211Sigor@sysoev.ru 
21311Sigor@sysoev.ru 
21411Sigor@sysoev.ru /*
21514Sigor@sysoev.ru  * nxt_port_data_t size is allocation size
21614Sigor@sysoev.ru  * which enables effective reuse of memory pool cache.
21711Sigor@sysoev.ru  */
21811Sigor@sysoev.ru typedef union {
21911Sigor@sysoev.ru     nxt_buf_t                buf;
22014Sigor@sysoev.ru     nxt_port_msg_new_port_t  new_port;
22114Sigor@sysoev.ru } nxt_port_data_t;
22211Sigor@sysoev.ru 
22311Sigor@sysoev.ru 
224343Smax.romanov@nginx.com typedef void (*nxt_port_post_handler_t)(nxt_task_t *task, nxt_port_t *port,
225343Smax.romanov@nginx.com     void *data);
226343Smax.romanov@nginx.com 
227197Smax.romanov@nginx.com nxt_port_t *nxt_port_new(nxt_task_t *task, nxt_port_id_t id, nxt_pid_t pid,
228163Smax.romanov@nginx.com     nxt_process_type_t type);
229163Smax.romanov@nginx.com 
230141Smax.romanov@nginx.com nxt_port_id_t nxt_port_get_next_id(void);
231141Smax.romanov@nginx.com void nxt_port_reset_next_id(void);
232141Smax.romanov@nginx.com 
23314Sigor@sysoev.ru nxt_int_t nxt_port_socket_init(nxt_task_t *task, nxt_port_t *port,
23414Sigor@sysoev.ru     size_t max_size);
23514Sigor@sysoev.ru void nxt_port_destroy(nxt_port_t *port);
236343Smax.romanov@nginx.com void nxt_port_close(nxt_task_t *task, nxt_port_t *port);
23714Sigor@sysoev.ru void nxt_port_write_enable(nxt_task_t *task, nxt_port_t *port);
23814Sigor@sysoev.ru void nxt_port_write_close(nxt_port_t *port);
23914Sigor@sysoev.ru void nxt_port_read_enable(nxt_task_t *task, nxt_port_t *port);
24014Sigor@sysoev.ru void nxt_port_read_close(nxt_port_t *port);
241423Smax.romanov@nginx.com nxt_int_t nxt_port_socket_twrite(nxt_task_t *task, nxt_port_t *port,
24242Smax.romanov@nginx.com     nxt_uint_t type, nxt_fd_t fd, uint32_t stream, nxt_port_id_t reply_port,
243423Smax.romanov@nginx.com     nxt_buf_t *b, void *tracking);
244423Smax.romanov@nginx.com 
245423Smax.romanov@nginx.com nxt_inline nxt_int_t
246423Smax.romanov@nginx.com nxt_port_socket_write(nxt_task_t *task, nxt_port_t *port,
247423Smax.romanov@nginx.com     nxt_uint_t type, nxt_fd_t fd, uint32_t stream, nxt_port_id_t reply_port,
248423Smax.romanov@nginx.com     nxt_buf_t *b)
249423Smax.romanov@nginx.com {
250423Smax.romanov@nginx.com     return nxt_port_socket_twrite(task, port, type, fd, stream, reply_port, b,
251423Smax.romanov@nginx.com                                   NULL);
252423Smax.romanov@nginx.com }
25314Sigor@sysoev.ru 
254141Smax.romanov@nginx.com void nxt_port_enable(nxt_task_t *task, nxt_port_t *port,
255320Smax.romanov@nginx.com     nxt_port_handlers_t *handlers);
25681Smax.romanov@nginx.com nxt_int_t nxt_port_send_port(nxt_task_t *task, nxt_port_t *port,
257141Smax.romanov@nginx.com     nxt_port_t *new_port, uint32_t stream);
25820Sigor@sysoev.ru void nxt_port_change_log_file(nxt_task_t *task, nxt_runtime_t *rt,
25911Sigor@sysoev.ru     nxt_uint_t slot, nxt_fd_t fd);
26011Sigor@sysoev.ru 
26114Sigor@sysoev.ru void nxt_port_quit_handler(nxt_task_t *task, nxt_port_recv_msg_t *msg);
26214Sigor@sysoev.ru void nxt_port_new_port_handler(nxt_task_t *task, nxt_port_recv_msg_t *msg);
263320Smax.romanov@nginx.com void nxt_port_process_ready_handler(nxt_task_t *task, nxt_port_recv_msg_t *msg);
26414Sigor@sysoev.ru void nxt_port_change_log_file_handler(nxt_task_t *task,
26511Sigor@sysoev.ru     nxt_port_recv_msg_t *msg);
26642Smax.romanov@nginx.com void nxt_port_mmap_handler(nxt_task_t *task, nxt_port_recv_msg_t *msg);
26714Sigor@sysoev.ru void nxt_port_data_handler(nxt_task_t *task, nxt_port_recv_msg_t *msg);
268125Smax.romanov@nginx.com void nxt_port_remove_pid_handler(nxt_task_t *task, nxt_port_recv_msg_t *msg);
26914Sigor@sysoev.ru void nxt_port_empty_handler(nxt_task_t *task, nxt_port_recv_msg_t *msg);
27011Sigor@sysoev.ru 
271343Smax.romanov@nginx.com nxt_int_t nxt_port_post(nxt_task_t *task, nxt_port_t *port,
272343Smax.romanov@nginx.com     nxt_port_post_handler_t handler, void *data);
273343Smax.romanov@nginx.com void nxt_port_use(nxt_task_t *task, nxt_port_t *port, int i);
27411Sigor@sysoev.ru 
275425Smax.romanov@nginx.com nxt_inline void nxt_port_inc_use(nxt_port_t *port)
276425Smax.romanov@nginx.com {
277425Smax.romanov@nginx.com     nxt_atomic_fetch_add(&port->use_count, 1);
278425Smax.romanov@nginx.com }
279425Smax.romanov@nginx.com 
28011Sigor@sysoev.ru #endif /* _NXT_PORT_H_INCLUDED_ */
281