xref: /unit/src/nxt_port.h (revision 192)
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 
1142Smax.romanov@nginx.com typedef enum {
12189Smax.romanov@nginx.com     NXT_PORT_MSG_LAST           = 0x100,
13189Smax.romanov@nginx.com     NXT_PORT_MSG_CLOSE_FD       = 0x200,
14189Smax.romanov@nginx.com 
15189Smax.romanov@nginx.com     NXT_PORT_MSG_MASK           = 0xFF,
16189Smax.romanov@nginx.com 
17189Smax.romanov@nginx.com     _NXT_PORT_MSG_QUIT          = 0,
18189Smax.romanov@nginx.com     _NXT_PORT_MSG_NEW_PORT,
19189Smax.romanov@nginx.com     _NXT_PORT_MSG_CHANGE_FILE,
20189Smax.romanov@nginx.com     _NXT_PORT_MSG_MMAP,
21189Smax.romanov@nginx.com     _NXT_PORT_MSG_DATA,
22189Smax.romanov@nginx.com     _NXT_PORT_MSG_REMOVE_PID,
23189Smax.romanov@nginx.com     _NXT_PORT_MSG_READY,
24*192Smax.romanov@nginx.com     _NXT_PORT_MSG_START_WORKER,
25190Smax.romanov@nginx.com     _NXT_PORT_MSG_RPC_READY,
26190Smax.romanov@nginx.com     _NXT_PORT_MSG_RPC_ERROR,
2742Smax.romanov@nginx.com 
28125Smax.romanov@nginx.com     NXT_PORT_MSG_MAX,
29189Smax.romanov@nginx.com 
30189Smax.romanov@nginx.com     NXT_PORT_MSG_QUIT           = _NXT_PORT_MSG_QUIT | NXT_PORT_MSG_LAST,
31189Smax.romanov@nginx.com     NXT_PORT_MSG_NEW_PORT       = _NXT_PORT_MSG_NEW_PORT | NXT_PORT_MSG_LAST,
32189Smax.romanov@nginx.com     NXT_PORT_MSG_CHANGE_FILE    = _NXT_PORT_MSG_CHANGE_FILE | NXT_PORT_MSG_LAST,
33189Smax.romanov@nginx.com     NXT_PORT_MSG_MMAP           = _NXT_PORT_MSG_MMAP | NXT_PORT_MSG_LAST |
34189Smax.romanov@nginx.com                                   NXT_PORT_MSG_CLOSE_FD,
35189Smax.romanov@nginx.com     NXT_PORT_MSG_DATA           = _NXT_PORT_MSG_DATA,
36189Smax.romanov@nginx.com     NXT_PORT_MSG_DATA_LAST      = _NXT_PORT_MSG_DATA | NXT_PORT_MSG_LAST,
37189Smax.romanov@nginx.com     NXT_PORT_MSG_REMOVE_PID     = _NXT_PORT_MSG_REMOVE_PID | NXT_PORT_MSG_LAST,
38189Smax.romanov@nginx.com     NXT_PORT_MSG_READY          = _NXT_PORT_MSG_READY | NXT_PORT_MSG_LAST,
39*192Smax.romanov@nginx.com     NXT_PORT_MSG_START_WORKER   = _NXT_PORT_MSG_START_WORKER |
40*192Smax.romanov@nginx.com                                   NXT_PORT_MSG_LAST,
41190Smax.romanov@nginx.com     NXT_PORT_MSG_RPC_READY      = _NXT_PORT_MSG_RPC_READY,
42190Smax.romanov@nginx.com     NXT_PORT_MSG_RPC_READY_LAST = _NXT_PORT_MSG_RPC_READY | NXT_PORT_MSG_LAST,
43190Smax.romanov@nginx.com     NXT_PORT_MSG_RPC_ERROR      = _NXT_PORT_MSG_RPC_ERROR | NXT_PORT_MSG_LAST,
44125Smax.romanov@nginx.com } nxt_port_msg_type_t;
4542Smax.romanov@nginx.com 
4614Sigor@sysoev.ru 
4742Smax.romanov@nginx.com /* Passed as a first iov chunk. */
4842Smax.romanov@nginx.com typedef struct {
4942Smax.romanov@nginx.com     uint32_t             stream;
5042Smax.romanov@nginx.com     nxt_pid_t            pid;
5142Smax.romanov@nginx.com     nxt_port_id_t        reply_port;
5242Smax.romanov@nginx.com 
53189Smax.romanov@nginx.com     uint8_t              type;
5442Smax.romanov@nginx.com     uint8_t              last;      /* 1 bit */
5542Smax.romanov@nginx.com 
5642Smax.romanov@nginx.com     /* Message data send using mmap, next chunk is a nxt_port_mmap_msg_t. */
5742Smax.romanov@nginx.com     uint8_t              mmap;      /* 1 bit */
58168Svbart@nginx.com } nxt_port_msg_t;
5914Sigor@sysoev.ru 
6014Sigor@sysoev.ru 
6114Sigor@sysoev.ru typedef struct {
6214Sigor@sysoev.ru     nxt_queue_link_t    link;
6314Sigor@sysoev.ru     nxt_buf_t           *buf;
6414Sigor@sysoev.ru     size_t              share;
6514Sigor@sysoev.ru     nxt_fd_t            fd;
66189Smax.romanov@nginx.com     nxt_bool_t          close_fd;
6714Sigor@sysoev.ru     nxt_port_msg_t      port_msg;
68122Smax.romanov@nginx.com 
69122Smax.romanov@nginx.com     nxt_work_t          work;
70122Smax.romanov@nginx.com     nxt_event_engine_t  *engine;
71122Smax.romanov@nginx.com     nxt_mp_t            *mem_pool;
7214Sigor@sysoev.ru } nxt_port_send_msg_t;
7314Sigor@sysoev.ru 
7414Sigor@sysoev.ru 
7520Sigor@sysoev.ru struct nxt_port_recv_msg_s {
7614Sigor@sysoev.ru     nxt_fd_t            fd;
7714Sigor@sysoev.ru     nxt_buf_t           *buf;
7814Sigor@sysoev.ru     nxt_port_t          *port;
7942Smax.romanov@nginx.com     nxt_port_msg_t      port_msg;
8082Smax.romanov@nginx.com     size_t              size;
81141Smax.romanov@nginx.com     nxt_port_t          *new_port;
8220Sigor@sysoev.ru };
8314Sigor@sysoev.ru 
84141Smax.romanov@nginx.com typedef struct nxt_app_s  nxt_app_t;
8514Sigor@sysoev.ru 
8614Sigor@sysoev.ru struct nxt_port_s {
8714Sigor@sysoev.ru     nxt_fd_event_t      socket;
8814Sigor@sysoev.ru 
89125Smax.romanov@nginx.com     nxt_queue_link_t    link;       /* for nxt_process_t.ports */
90141Smax.romanov@nginx.com     nxt_process_t       *process;
91141Smax.romanov@nginx.com 
92141Smax.romanov@nginx.com     nxt_queue_link_t    app_link;   /* for nxt_app_t.ports */
93141Smax.romanov@nginx.com     nxt_app_t           *app;
9442Smax.romanov@nginx.com 
9514Sigor@sysoev.ru     nxt_queue_t         messages;   /* of nxt_port_send_msg_t */
9614Sigor@sysoev.ru 
9714Sigor@sysoev.ru     /* Maximum size of message part. */
9814Sigor@sysoev.ru     uint32_t            max_size;
9914Sigor@sysoev.ru     /* Maximum interleave of message parts. */
10014Sigor@sysoev.ru     uint32_t            max_share;
101167Smax.romanov@nginx.com     uint32_t            app_req_id;
10214Sigor@sysoev.ru 
10314Sigor@sysoev.ru     nxt_port_handler_t  handler;
104141Smax.romanov@nginx.com     nxt_port_handler_t  *data;
10514Sigor@sysoev.ru 
10665Sigor@sysoev.ru     nxt_mp_t            *mem_pool;
107141Smax.romanov@nginx.com     nxt_event_engine_t  *engine;
108141Smax.romanov@nginx.com 
10914Sigor@sysoev.ru     nxt_buf_t           *free_bufs;
11014Sigor@sysoev.ru     nxt_socket_t        pair[2];
11114Sigor@sysoev.ru 
11242Smax.romanov@nginx.com     nxt_port_id_t       id;
11314Sigor@sysoev.ru     nxt_pid_t           pid;
11442Smax.romanov@nginx.com 
115190Smax.romanov@nginx.com     nxt_lvlhsh_t        rpc_streams; /* stream to nxt_port_rpc_reg_t */
116190Smax.romanov@nginx.com     nxt_lvlhsh_t        rpc_peers;   /* peer to queue of nxt_port_rpc_reg_t */
117190Smax.romanov@nginx.com     uint32_t            next_stream;
118190Smax.romanov@nginx.com 
119141Smax.romanov@nginx.com     nxt_process_type_t  type;
120163Smax.romanov@nginx.com     nxt_work_t          work;
12114Sigor@sysoev.ru };
12214Sigor@sysoev.ru 
12314Sigor@sysoev.ru 
12411Sigor@sysoev.ru typedef struct {
12542Smax.romanov@nginx.com     nxt_port_id_t       id;
12614Sigor@sysoev.ru     nxt_pid_t           pid;
12714Sigor@sysoev.ru     size_t              max_size;
12814Sigor@sysoev.ru     size_t              max_share;
12942Smax.romanov@nginx.com     nxt_process_type_t  type:8;
130168Svbart@nginx.com } nxt_port_msg_new_port_t;
13111Sigor@sysoev.ru 
13211Sigor@sysoev.ru 
13311Sigor@sysoev.ru /*
13414Sigor@sysoev.ru  * nxt_port_data_t size is allocation size
13514Sigor@sysoev.ru  * which enables effective reuse of memory pool cache.
13611Sigor@sysoev.ru  */
13711Sigor@sysoev.ru typedef union {
13811Sigor@sysoev.ru     nxt_buf_t                buf;
13914Sigor@sysoev.ru     nxt_port_msg_new_port_t  new_port;
14014Sigor@sysoev.ru } nxt_port_data_t;
14111Sigor@sysoev.ru 
14211Sigor@sysoev.ru 
143163Smax.romanov@nginx.com nxt_port_t *nxt_port_new(nxt_port_id_t id, nxt_pid_t pid,
144163Smax.romanov@nginx.com     nxt_process_type_t type);
145163Smax.romanov@nginx.com nxt_bool_t nxt_port_release(nxt_port_t *port);
146163Smax.romanov@nginx.com 
147141Smax.romanov@nginx.com nxt_port_id_t nxt_port_get_next_id(void);
148141Smax.romanov@nginx.com void nxt_port_reset_next_id(void);
149141Smax.romanov@nginx.com 
15014Sigor@sysoev.ru nxt_int_t nxt_port_socket_init(nxt_task_t *task, nxt_port_t *port,
15114Sigor@sysoev.ru     size_t max_size);
15214Sigor@sysoev.ru void nxt_port_destroy(nxt_port_t *port);
15314Sigor@sysoev.ru void nxt_port_write_enable(nxt_task_t *task, nxt_port_t *port);
15414Sigor@sysoev.ru void nxt_port_write_close(nxt_port_t *port);
15514Sigor@sysoev.ru void nxt_port_read_enable(nxt_task_t *task, nxt_port_t *port);
15614Sigor@sysoev.ru void nxt_port_read_close(nxt_port_t *port);
15714Sigor@sysoev.ru nxt_int_t nxt_port_socket_write(nxt_task_t *task, nxt_port_t *port,
15842Smax.romanov@nginx.com     nxt_uint_t type, nxt_fd_t fd, uint32_t stream, nxt_port_id_t reply_port,
15942Smax.romanov@nginx.com     nxt_buf_t *b);
16014Sigor@sysoev.ru 
161141Smax.romanov@nginx.com void nxt_port_enable(nxt_task_t *task, nxt_port_t *port,
16214Sigor@sysoev.ru     nxt_port_handler_t *handlers);
16320Sigor@sysoev.ru void nxt_port_write(nxt_task_t *task, nxt_runtime_t *rt, nxt_uint_t type,
16414Sigor@sysoev.ru     nxt_fd_t fd, uint32_t stream, nxt_buf_t *b);
16520Sigor@sysoev.ru void nxt_port_send_new_port(nxt_task_t *task, nxt_runtime_t *rt,
166141Smax.romanov@nginx.com     nxt_port_t *port, uint32_t stream);
16781Smax.romanov@nginx.com nxt_int_t nxt_port_send_port(nxt_task_t *task, nxt_port_t *port,
168141Smax.romanov@nginx.com     nxt_port_t *new_port, uint32_t stream);
16920Sigor@sysoev.ru void nxt_port_change_log_file(nxt_task_t *task, nxt_runtime_t *rt,
17011Sigor@sysoev.ru     nxt_uint_t slot, nxt_fd_t fd);
17111Sigor@sysoev.ru 
17214Sigor@sysoev.ru void nxt_port_quit_handler(nxt_task_t *task, nxt_port_recv_msg_t *msg);
17314Sigor@sysoev.ru void nxt_port_new_port_handler(nxt_task_t *task, nxt_port_recv_msg_t *msg);
174141Smax.romanov@nginx.com void nxt_port_ready_handler(nxt_task_t *task, nxt_port_recv_msg_t *msg);
17514Sigor@sysoev.ru void nxt_port_change_log_file_handler(nxt_task_t *task,
17611Sigor@sysoev.ru     nxt_port_recv_msg_t *msg);
17742Smax.romanov@nginx.com void nxt_port_mmap_handler(nxt_task_t *task, nxt_port_recv_msg_t *msg);
17814Sigor@sysoev.ru void nxt_port_data_handler(nxt_task_t *task, nxt_port_recv_msg_t *msg);
179125Smax.romanov@nginx.com void nxt_port_remove_pid_handler(nxt_task_t *task, nxt_port_recv_msg_t *msg);
18014Sigor@sysoev.ru void nxt_port_empty_handler(nxt_task_t *task, nxt_port_recv_msg_t *msg);
18111Sigor@sysoev.ru 
18211Sigor@sysoev.ru 
18311Sigor@sysoev.ru #endif /* _NXT_PORT_H_INCLUDED_ */
184