xref: /unit/src/nxt_port.h (revision 352)
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;
21320Smax.romanov@nginx.com 
22320Smax.romanov@nginx.com     /* File descriptor exchange. */
23320Smax.romanov@nginx.com     nxt_port_handler_t  change_file;
24320Smax.romanov@nginx.com     nxt_port_handler_t  new_port;
25320Smax.romanov@nginx.com     nxt_port_handler_t  mmap;
26320Smax.romanov@nginx.com 
27320Smax.romanov@nginx.com     /* New process ready. */
28320Smax.romanov@nginx.com     nxt_port_handler_t  process_ready;
29320Smax.romanov@nginx.com 
30320Smax.romanov@nginx.com     /* Process exit/crash notification. */
31320Smax.romanov@nginx.com     nxt_port_handler_t  remove_pid;
32320Smax.romanov@nginx.com 
33320Smax.romanov@nginx.com     /* Stop process command. */
34320Smax.romanov@nginx.com     nxt_port_handler_t  quit;
35320Smax.romanov@nginx.com 
36320Smax.romanov@nginx.com     /* Various data. */
37320Smax.romanov@nginx.com     nxt_port_handler_t  data;
38320Smax.romanov@nginx.com };
39320Smax.romanov@nginx.com 
40320Smax.romanov@nginx.com 
41320Smax.romanov@nginx.com #define nxt_port_handler_idx(name)                                            \
42320Smax.romanov@nginx.com     ( &((nxt_port_handlers_t *) 0)->name - (nxt_port_handler_t *) 0)
43320Smax.romanov@nginx.com 
44320Smax.romanov@nginx.com 
4542Smax.romanov@nginx.com typedef enum {
46189Smax.romanov@nginx.com     NXT_PORT_MSG_LAST           = 0x100,
47189Smax.romanov@nginx.com     NXT_PORT_MSG_CLOSE_FD       = 0x200,
48205Smax.romanov@nginx.com     NXT_PORT_MSG_SYNC           = 0x400,
49189Smax.romanov@nginx.com 
50189Smax.romanov@nginx.com     NXT_PORT_MSG_MASK           = 0xFF,
51189Smax.romanov@nginx.com 
52320Smax.romanov@nginx.com     _NXT_PORT_MSG_RPC_READY     = nxt_port_handler_idx(rpc_ready),
53320Smax.romanov@nginx.com     _NXT_PORT_MSG_RPC_ERROR     = nxt_port_handler_idx(rpc_error),
54320Smax.romanov@nginx.com 
55320Smax.romanov@nginx.com     _NXT_PORT_MSG_START_WORKER  = nxt_port_handler_idx(start_worker),
56320Smax.romanov@nginx.com     _NXT_PORT_MSG_SOCKET        = nxt_port_handler_idx(socket),
57320Smax.romanov@nginx.com     _NXT_PORT_MSG_MODULES       = nxt_port_handler_idx(modules),
58320Smax.romanov@nginx.com     _NXT_PORT_MSG_CONF_STORE    = nxt_port_handler_idx(conf_store),
59320Smax.romanov@nginx.com 
60320Smax.romanov@nginx.com     _NXT_PORT_MSG_CHANGE_FILE   = nxt_port_handler_idx(change_file),
61320Smax.romanov@nginx.com     _NXT_PORT_MSG_NEW_PORT      = nxt_port_handler_idx(new_port),
62320Smax.romanov@nginx.com     _NXT_PORT_MSG_MMAP          = nxt_port_handler_idx(mmap),
6342Smax.romanov@nginx.com 
64320Smax.romanov@nginx.com     _NXT_PORT_MSG_PROCESS_READY = nxt_port_handler_idx(process_ready),
65320Smax.romanov@nginx.com     _NXT_PORT_MSG_REMOVE_PID    = nxt_port_handler_idx(remove_pid),
66320Smax.romanov@nginx.com     _NXT_PORT_MSG_QUIT          = nxt_port_handler_idx(quit),
67320Smax.romanov@nginx.com 
68320Smax.romanov@nginx.com     _NXT_PORT_MSG_DATA          = nxt_port_handler_idx(data),
69189Smax.romanov@nginx.com 
70320Smax.romanov@nginx.com     NXT_PORT_MSG_MAX            = sizeof(nxt_port_handlers_t) /
71320Smax.romanov@nginx.com                                       sizeof(nxt_port_handler_t),
72320Smax.romanov@nginx.com 
73320Smax.romanov@nginx.com     NXT_PORT_MSG_RPC_READY      = _NXT_PORT_MSG_RPC_READY,
74320Smax.romanov@nginx.com     NXT_PORT_MSG_RPC_READY_LAST = _NXT_PORT_MSG_RPC_READY | NXT_PORT_MSG_LAST,
75320Smax.romanov@nginx.com     NXT_PORT_MSG_RPC_ERROR      = _NXT_PORT_MSG_RPC_ERROR | NXT_PORT_MSG_LAST,
76320Smax.romanov@nginx.com 
77192Smax.romanov@nginx.com     NXT_PORT_MSG_START_WORKER   = _NXT_PORT_MSG_START_WORKER |
78192Smax.romanov@nginx.com                                   NXT_PORT_MSG_LAST,
79198Sigor@sysoev.ru     NXT_PORT_MSG_SOCKET         = _NXT_PORT_MSG_SOCKET | NXT_PORT_MSG_LAST,
80216Sigor@sysoev.ru     NXT_PORT_MSG_MODULES        = _NXT_PORT_MSG_MODULES | NXT_PORT_MSG_LAST,
81314Svbart@nginx.com     NXT_PORT_MSG_CONF_STORE     = _NXT_PORT_MSG_CONF_STORE | NXT_PORT_MSG_LAST,
82320Smax.romanov@nginx.com 
83320Smax.romanov@nginx.com     NXT_PORT_MSG_CHANGE_FILE    = _NXT_PORT_MSG_CHANGE_FILE | NXT_PORT_MSG_LAST,
84320Smax.romanov@nginx.com     NXT_PORT_MSG_NEW_PORT       = _NXT_PORT_MSG_NEW_PORT | NXT_PORT_MSG_LAST,
85320Smax.romanov@nginx.com     NXT_PORT_MSG_MMAP           = _NXT_PORT_MSG_MMAP | NXT_PORT_MSG_LAST |
86320Smax.romanov@nginx.com                                   NXT_PORT_MSG_CLOSE_FD | NXT_PORT_MSG_SYNC,
87320Smax.romanov@nginx.com 
88320Smax.romanov@nginx.com     NXT_PORT_MSG_PROCESS_READY  = _NXT_PORT_MSG_PROCESS_READY |
89320Smax.romanov@nginx.com                                   NXT_PORT_MSG_LAST,
90320Smax.romanov@nginx.com     NXT_PORT_MSG_QUIT           = _NXT_PORT_MSG_QUIT | NXT_PORT_MSG_LAST,
91320Smax.romanov@nginx.com     NXT_PORT_MSG_REMOVE_PID     = _NXT_PORT_MSG_REMOVE_PID | NXT_PORT_MSG_LAST,
92320Smax.romanov@nginx.com 
93320Smax.romanov@nginx.com     NXT_PORT_MSG_DATA           = _NXT_PORT_MSG_DATA,
94320Smax.romanov@nginx.com     NXT_PORT_MSG_DATA_LAST      = _NXT_PORT_MSG_DATA | NXT_PORT_MSG_LAST,
95125Smax.romanov@nginx.com } nxt_port_msg_type_t;
9642Smax.romanov@nginx.com 
9714Sigor@sysoev.ru 
9842Smax.romanov@nginx.com /* Passed as a first iov chunk. */
9942Smax.romanov@nginx.com typedef struct {
10042Smax.romanov@nginx.com     uint32_t             stream;
10142Smax.romanov@nginx.com     nxt_pid_t            pid;
10242Smax.romanov@nginx.com     nxt_port_id_t        reply_port;
10342Smax.romanov@nginx.com 
104189Smax.romanov@nginx.com     uint8_t              type;
10542Smax.romanov@nginx.com     uint8_t              last;      /* 1 bit */
10642Smax.romanov@nginx.com 
10742Smax.romanov@nginx.com     /* Message data send using mmap, next chunk is a nxt_port_mmap_msg_t. */
10842Smax.romanov@nginx.com     uint8_t              mmap;      /* 1 bit */
109*352Smax.romanov@nginx.com 
110*352Smax.romanov@nginx.com     uint8_t              nf;
111*352Smax.romanov@nginx.com     uint8_t              mf;
112168Svbart@nginx.com } nxt_port_msg_t;
11314Sigor@sysoev.ru 
11414Sigor@sysoev.ru 
11514Sigor@sysoev.ru typedef struct {
11614Sigor@sysoev.ru     nxt_queue_link_t    link;
11714Sigor@sysoev.ru     nxt_buf_t           *buf;
11814Sigor@sysoev.ru     size_t              share;
11914Sigor@sysoev.ru     nxt_fd_t            fd;
120189Smax.romanov@nginx.com     nxt_bool_t          close_fd;
12114Sigor@sysoev.ru     nxt_port_msg_t      port_msg;
122122Smax.romanov@nginx.com 
123122Smax.romanov@nginx.com     nxt_work_t          work;
12414Sigor@sysoev.ru } nxt_port_send_msg_t;
12514Sigor@sysoev.ru 
12614Sigor@sysoev.ru 
12720Sigor@sysoev.ru struct nxt_port_recv_msg_s {
12814Sigor@sysoev.ru     nxt_fd_t            fd;
12914Sigor@sysoev.ru     nxt_buf_t           *buf;
13014Sigor@sysoev.ru     nxt_port_t          *port;
13142Smax.romanov@nginx.com     nxt_port_msg_t      port_msg;
13282Smax.romanov@nginx.com     size_t              size;
133347Smax.romanov@nginx.com     union {
134347Smax.romanov@nginx.com         nxt_port_t      *new_port;
135347Smax.romanov@nginx.com         nxt_pid_t       removed_pid;
136347Smax.romanov@nginx.com         void            *data;
137347Smax.romanov@nginx.com     } u;
13820Sigor@sysoev.ru };
13914Sigor@sysoev.ru 
140141Smax.romanov@nginx.com typedef struct nxt_app_s  nxt_app_t;
14114Sigor@sysoev.ru 
14214Sigor@sysoev.ru struct nxt_port_s {
14314Sigor@sysoev.ru     nxt_fd_event_t      socket;
14414Sigor@sysoev.ru 
145125Smax.romanov@nginx.com     nxt_queue_link_t    link;       /* for nxt_process_t.ports */
146141Smax.romanov@nginx.com     nxt_process_t       *process;
147141Smax.romanov@nginx.com 
148141Smax.romanov@nginx.com     nxt_queue_link_t    app_link;   /* for nxt_app_t.ports */
149141Smax.romanov@nginx.com     nxt_app_t           *app;
15042Smax.romanov@nginx.com 
15114Sigor@sysoev.ru     nxt_queue_t         messages;   /* of nxt_port_send_msg_t */
152343Smax.romanov@nginx.com     nxt_thread_mutex_t  write_mutex;
15314Sigor@sysoev.ru 
15414Sigor@sysoev.ru     /* Maximum size of message part. */
15514Sigor@sysoev.ru     uint32_t            max_size;
15614Sigor@sysoev.ru     /* Maximum interleave of message parts. */
15714Sigor@sysoev.ru     uint32_t            max_share;
158343Smax.romanov@nginx.com 
159343Smax.romanov@nginx.com     uint32_t            app_requests;
160343Smax.romanov@nginx.com     uint32_t            app_responses;
16114Sigor@sysoev.ru 
16214Sigor@sysoev.ru     nxt_port_handler_t  handler;
163141Smax.romanov@nginx.com     nxt_port_handler_t  *data;
16414Sigor@sysoev.ru 
16565Sigor@sysoev.ru     nxt_mp_t            *mem_pool;
166141Smax.romanov@nginx.com     nxt_event_engine_t  *engine;
167141Smax.romanov@nginx.com 
16814Sigor@sysoev.ru     nxt_buf_t           *free_bufs;
16914Sigor@sysoev.ru     nxt_socket_t        pair[2];
17014Sigor@sysoev.ru 
17142Smax.romanov@nginx.com     nxt_port_id_t       id;
17214Sigor@sysoev.ru     nxt_pid_t           pid;
17342Smax.romanov@nginx.com 
174190Smax.romanov@nginx.com     nxt_lvlhsh_t        rpc_streams; /* stream to nxt_port_rpc_reg_t */
175190Smax.romanov@nginx.com     nxt_lvlhsh_t        rpc_peers;   /* peer to queue of nxt_port_rpc_reg_t */
176190Smax.romanov@nginx.com 
177*352Smax.romanov@nginx.com     nxt_lvlhsh_t        frags;
178*352Smax.romanov@nginx.com 
179343Smax.romanov@nginx.com     nxt_atomic_t        use_count;
180343Smax.romanov@nginx.com 
181141Smax.romanov@nginx.com     nxt_process_type_t  type;
182197Smax.romanov@nginx.com 
183197Smax.romanov@nginx.com     struct iovec        *iov;
184197Smax.romanov@nginx.com     void                *mmsg_buf;
18514Sigor@sysoev.ru };
18614Sigor@sysoev.ru 
18714Sigor@sysoev.ru 
18811Sigor@sysoev.ru typedef struct {
18942Smax.romanov@nginx.com     nxt_port_id_t       id;
19014Sigor@sysoev.ru     nxt_pid_t           pid;
19114Sigor@sysoev.ru     size_t              max_size;
19214Sigor@sysoev.ru     size_t              max_share;
19342Smax.romanov@nginx.com     nxt_process_type_t  type:8;
194168Svbart@nginx.com } nxt_port_msg_new_port_t;
19511Sigor@sysoev.ru 
19611Sigor@sysoev.ru 
19711Sigor@sysoev.ru /*
19814Sigor@sysoev.ru  * nxt_port_data_t size is allocation size
19914Sigor@sysoev.ru  * which enables effective reuse of memory pool cache.
20011Sigor@sysoev.ru  */
20111Sigor@sysoev.ru typedef union {
20211Sigor@sysoev.ru     nxt_buf_t                buf;
20314Sigor@sysoev.ru     nxt_port_msg_new_port_t  new_port;
20414Sigor@sysoev.ru } nxt_port_data_t;
20511Sigor@sysoev.ru 
20611Sigor@sysoev.ru 
207343Smax.romanov@nginx.com typedef void (*nxt_port_post_handler_t)(nxt_task_t *task, nxt_port_t *port,
208343Smax.romanov@nginx.com     void *data);
209343Smax.romanov@nginx.com 
210197Smax.romanov@nginx.com nxt_port_t *nxt_port_new(nxt_task_t *task, nxt_port_id_t id, nxt_pid_t pid,
211163Smax.romanov@nginx.com     nxt_process_type_t type);
212163Smax.romanov@nginx.com 
213141Smax.romanov@nginx.com nxt_port_id_t nxt_port_get_next_id(void);
214141Smax.romanov@nginx.com void nxt_port_reset_next_id(void);
215141Smax.romanov@nginx.com 
21614Sigor@sysoev.ru nxt_int_t nxt_port_socket_init(nxt_task_t *task, nxt_port_t *port,
21714Sigor@sysoev.ru     size_t max_size);
21814Sigor@sysoev.ru void nxt_port_destroy(nxt_port_t *port);
219343Smax.romanov@nginx.com void nxt_port_close(nxt_task_t *task, nxt_port_t *port);
22014Sigor@sysoev.ru void nxt_port_write_enable(nxt_task_t *task, nxt_port_t *port);
22114Sigor@sysoev.ru void nxt_port_write_close(nxt_port_t *port);
22214Sigor@sysoev.ru void nxt_port_read_enable(nxt_task_t *task, nxt_port_t *port);
22314Sigor@sysoev.ru void nxt_port_read_close(nxt_port_t *port);
22414Sigor@sysoev.ru nxt_int_t nxt_port_socket_write(nxt_task_t *task, nxt_port_t *port,
22542Smax.romanov@nginx.com     nxt_uint_t type, nxt_fd_t fd, uint32_t stream, nxt_port_id_t reply_port,
22642Smax.romanov@nginx.com     nxt_buf_t *b);
22714Sigor@sysoev.ru 
228141Smax.romanov@nginx.com void nxt_port_enable(nxt_task_t *task, nxt_port_t *port,
229320Smax.romanov@nginx.com     nxt_port_handlers_t *handlers);
23020Sigor@sysoev.ru void nxt_port_send_new_port(nxt_task_t *task, nxt_runtime_t *rt,
231141Smax.romanov@nginx.com     nxt_port_t *port, uint32_t stream);
23281Smax.romanov@nginx.com nxt_int_t nxt_port_send_port(nxt_task_t *task, nxt_port_t *port,
233141Smax.romanov@nginx.com     nxt_port_t *new_port, uint32_t stream);
23420Sigor@sysoev.ru void nxt_port_change_log_file(nxt_task_t *task, nxt_runtime_t *rt,
23511Sigor@sysoev.ru     nxt_uint_t slot, nxt_fd_t fd);
23611Sigor@sysoev.ru 
23714Sigor@sysoev.ru void nxt_port_quit_handler(nxt_task_t *task, nxt_port_recv_msg_t *msg);
23814Sigor@sysoev.ru void nxt_port_new_port_handler(nxt_task_t *task, nxt_port_recv_msg_t *msg);
239320Smax.romanov@nginx.com void nxt_port_process_ready_handler(nxt_task_t *task, nxt_port_recv_msg_t *msg);
24014Sigor@sysoev.ru void nxt_port_change_log_file_handler(nxt_task_t *task,
24111Sigor@sysoev.ru     nxt_port_recv_msg_t *msg);
24242Smax.romanov@nginx.com void nxt_port_mmap_handler(nxt_task_t *task, nxt_port_recv_msg_t *msg);
24314Sigor@sysoev.ru void nxt_port_data_handler(nxt_task_t *task, nxt_port_recv_msg_t *msg);
244125Smax.romanov@nginx.com void nxt_port_remove_pid_handler(nxt_task_t *task, nxt_port_recv_msg_t *msg);
24514Sigor@sysoev.ru void nxt_port_empty_handler(nxt_task_t *task, nxt_port_recv_msg_t *msg);
24611Sigor@sysoev.ru 
247343Smax.romanov@nginx.com nxt_int_t nxt_port_post(nxt_task_t *task, nxt_port_t *port,
248343Smax.romanov@nginx.com     nxt_port_post_handler_t handler, void *data);
249343Smax.romanov@nginx.com void nxt_port_use(nxt_task_t *task, nxt_port_t *port, int i);
25011Sigor@sysoev.ru 
25111Sigor@sysoev.ru #endif /* _NXT_PORT_H_INCLUDED_ */
252