xref: /unit/src/nxt_port.h (revision 216)
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,
14205Smax.romanov@nginx.com     NXT_PORT_MSG_SYNC           = 0x400,
15189Smax.romanov@nginx.com 
16189Smax.romanov@nginx.com     NXT_PORT_MSG_MASK           = 0xFF,
17189Smax.romanov@nginx.com 
18189Smax.romanov@nginx.com     _NXT_PORT_MSG_QUIT          = 0,
19189Smax.romanov@nginx.com     _NXT_PORT_MSG_NEW_PORT,
20189Smax.romanov@nginx.com     _NXT_PORT_MSG_CHANGE_FILE,
21189Smax.romanov@nginx.com     _NXT_PORT_MSG_MMAP,
22189Smax.romanov@nginx.com     _NXT_PORT_MSG_DATA,
23189Smax.romanov@nginx.com     _NXT_PORT_MSG_REMOVE_PID,
24189Smax.romanov@nginx.com     _NXT_PORT_MSG_READY,
25192Smax.romanov@nginx.com     _NXT_PORT_MSG_START_WORKER,
26198Sigor@sysoev.ru     _NXT_PORT_MSG_SOCKET,
27*216Sigor@sysoev.ru     _NXT_PORT_MSG_MODULES,
28190Smax.romanov@nginx.com     _NXT_PORT_MSG_RPC_READY,
29190Smax.romanov@nginx.com     _NXT_PORT_MSG_RPC_ERROR,
3042Smax.romanov@nginx.com 
31125Smax.romanov@nginx.com     NXT_PORT_MSG_MAX,
32189Smax.romanov@nginx.com 
33189Smax.romanov@nginx.com     NXT_PORT_MSG_QUIT           = _NXT_PORT_MSG_QUIT | NXT_PORT_MSG_LAST,
34189Smax.romanov@nginx.com     NXT_PORT_MSG_NEW_PORT       = _NXT_PORT_MSG_NEW_PORT | NXT_PORT_MSG_LAST,
35189Smax.romanov@nginx.com     NXT_PORT_MSG_CHANGE_FILE    = _NXT_PORT_MSG_CHANGE_FILE | NXT_PORT_MSG_LAST,
36189Smax.romanov@nginx.com     NXT_PORT_MSG_MMAP           = _NXT_PORT_MSG_MMAP | NXT_PORT_MSG_LAST |
37205Smax.romanov@nginx.com                                   NXT_PORT_MSG_CLOSE_FD | NXT_PORT_MSG_SYNC,
38189Smax.romanov@nginx.com     NXT_PORT_MSG_DATA           = _NXT_PORT_MSG_DATA,
39189Smax.romanov@nginx.com     NXT_PORT_MSG_DATA_LAST      = _NXT_PORT_MSG_DATA | NXT_PORT_MSG_LAST,
40189Smax.romanov@nginx.com     NXT_PORT_MSG_REMOVE_PID     = _NXT_PORT_MSG_REMOVE_PID | NXT_PORT_MSG_LAST,
41189Smax.romanov@nginx.com     NXT_PORT_MSG_READY          = _NXT_PORT_MSG_READY | NXT_PORT_MSG_LAST,
42192Smax.romanov@nginx.com     NXT_PORT_MSG_START_WORKER   = _NXT_PORT_MSG_START_WORKER |
43192Smax.romanov@nginx.com                                   NXT_PORT_MSG_LAST,
44198Sigor@sysoev.ru     NXT_PORT_MSG_SOCKET         = _NXT_PORT_MSG_SOCKET | NXT_PORT_MSG_LAST,
45*216Sigor@sysoev.ru     NXT_PORT_MSG_MODULES        = _NXT_PORT_MSG_MODULES | NXT_PORT_MSG_LAST,
46190Smax.romanov@nginx.com     NXT_PORT_MSG_RPC_READY      = _NXT_PORT_MSG_RPC_READY,
47190Smax.romanov@nginx.com     NXT_PORT_MSG_RPC_READY_LAST = _NXT_PORT_MSG_RPC_READY | NXT_PORT_MSG_LAST,
48190Smax.romanov@nginx.com     NXT_PORT_MSG_RPC_ERROR      = _NXT_PORT_MSG_RPC_ERROR | NXT_PORT_MSG_LAST,
49125Smax.romanov@nginx.com } nxt_port_msg_type_t;
5042Smax.romanov@nginx.com 
5114Sigor@sysoev.ru 
5242Smax.romanov@nginx.com /* Passed as a first iov chunk. */
5342Smax.romanov@nginx.com typedef struct {
5442Smax.romanov@nginx.com     uint32_t             stream;
5542Smax.romanov@nginx.com     nxt_pid_t            pid;
5642Smax.romanov@nginx.com     nxt_port_id_t        reply_port;
5742Smax.romanov@nginx.com 
58189Smax.romanov@nginx.com     uint8_t              type;
5942Smax.romanov@nginx.com     uint8_t              last;      /* 1 bit */
6042Smax.romanov@nginx.com 
6142Smax.romanov@nginx.com     /* Message data send using mmap, next chunk is a nxt_port_mmap_msg_t. */
6242Smax.romanov@nginx.com     uint8_t              mmap;      /* 1 bit */
63168Svbart@nginx.com } nxt_port_msg_t;
6414Sigor@sysoev.ru 
6514Sigor@sysoev.ru 
6614Sigor@sysoev.ru typedef struct {
6714Sigor@sysoev.ru     nxt_queue_link_t    link;
6814Sigor@sysoev.ru     nxt_buf_t           *buf;
6914Sigor@sysoev.ru     size_t              share;
7014Sigor@sysoev.ru     nxt_fd_t            fd;
71189Smax.romanov@nginx.com     nxt_bool_t          close_fd;
72205Smax.romanov@nginx.com     nxt_bool_t          opened;
7314Sigor@sysoev.ru     nxt_port_msg_t      port_msg;
74122Smax.romanov@nginx.com 
75122Smax.romanov@nginx.com     nxt_work_t          work;
76122Smax.romanov@nginx.com     nxt_event_engine_t  *engine;
77122Smax.romanov@nginx.com     nxt_mp_t            *mem_pool;
7814Sigor@sysoev.ru } nxt_port_send_msg_t;
7914Sigor@sysoev.ru 
8014Sigor@sysoev.ru 
8120Sigor@sysoev.ru struct nxt_port_recv_msg_s {
8214Sigor@sysoev.ru     nxt_fd_t            fd;
8314Sigor@sysoev.ru     nxt_buf_t           *buf;
8414Sigor@sysoev.ru     nxt_port_t          *port;
8542Smax.romanov@nginx.com     nxt_port_msg_t      port_msg;
8682Smax.romanov@nginx.com     size_t              size;
87141Smax.romanov@nginx.com     nxt_port_t          *new_port;
8820Sigor@sysoev.ru };
8914Sigor@sysoev.ru 
90141Smax.romanov@nginx.com typedef struct nxt_app_s  nxt_app_t;
9114Sigor@sysoev.ru 
9214Sigor@sysoev.ru struct nxt_port_s {
9314Sigor@sysoev.ru     nxt_fd_event_t      socket;
9414Sigor@sysoev.ru 
95125Smax.romanov@nginx.com     nxt_queue_link_t    link;       /* for nxt_process_t.ports */
96141Smax.romanov@nginx.com     nxt_process_t       *process;
97141Smax.romanov@nginx.com 
98141Smax.romanov@nginx.com     nxt_queue_link_t    app_link;   /* for nxt_app_t.ports */
99141Smax.romanov@nginx.com     nxt_app_t           *app;
10042Smax.romanov@nginx.com 
10114Sigor@sysoev.ru     nxt_queue_t         messages;   /* of nxt_port_send_msg_t */
10214Sigor@sysoev.ru 
10314Sigor@sysoev.ru     /* Maximum size of message part. */
10414Sigor@sysoev.ru     uint32_t            max_size;
10514Sigor@sysoev.ru     /* Maximum interleave of message parts. */
10614Sigor@sysoev.ru     uint32_t            max_share;
107167Smax.romanov@nginx.com     uint32_t            app_req_id;
10814Sigor@sysoev.ru 
10914Sigor@sysoev.ru     nxt_port_handler_t  handler;
110141Smax.romanov@nginx.com     nxt_port_handler_t  *data;
11114Sigor@sysoev.ru 
11265Sigor@sysoev.ru     nxt_mp_t            *mem_pool;
113141Smax.romanov@nginx.com     nxt_event_engine_t  *engine;
114141Smax.romanov@nginx.com 
11514Sigor@sysoev.ru     nxt_buf_t           *free_bufs;
11614Sigor@sysoev.ru     nxt_socket_t        pair[2];
11714Sigor@sysoev.ru 
11842Smax.romanov@nginx.com     nxt_port_id_t       id;
11914Sigor@sysoev.ru     nxt_pid_t           pid;
12042Smax.romanov@nginx.com 
121190Smax.romanov@nginx.com     nxt_lvlhsh_t        rpc_streams; /* stream to nxt_port_rpc_reg_t */
122190Smax.romanov@nginx.com     nxt_lvlhsh_t        rpc_peers;   /* peer to queue of nxt_port_rpc_reg_t */
123190Smax.romanov@nginx.com     uint32_t            next_stream;
124190Smax.romanov@nginx.com 
125141Smax.romanov@nginx.com     nxt_process_type_t  type;
126163Smax.romanov@nginx.com     nxt_work_t          work;
127197Smax.romanov@nginx.com 
128197Smax.romanov@nginx.com     struct iovec        *iov;
129197Smax.romanov@nginx.com     void                *mmsg_buf;
13014Sigor@sysoev.ru };
13114Sigor@sysoev.ru 
13214Sigor@sysoev.ru 
13311Sigor@sysoev.ru typedef struct {
13442Smax.romanov@nginx.com     nxt_port_id_t       id;
13514Sigor@sysoev.ru     nxt_pid_t           pid;
13614Sigor@sysoev.ru     size_t              max_size;
13714Sigor@sysoev.ru     size_t              max_share;
13842Smax.romanov@nginx.com     nxt_process_type_t  type:8;
139168Svbart@nginx.com } nxt_port_msg_new_port_t;
14011Sigor@sysoev.ru 
14111Sigor@sysoev.ru 
14211Sigor@sysoev.ru /*
14314Sigor@sysoev.ru  * nxt_port_data_t size is allocation size
14414Sigor@sysoev.ru  * which enables effective reuse of memory pool cache.
14511Sigor@sysoev.ru  */
14611Sigor@sysoev.ru typedef union {
14711Sigor@sysoev.ru     nxt_buf_t                buf;
14814Sigor@sysoev.ru     nxt_port_msg_new_port_t  new_port;
14914Sigor@sysoev.ru } nxt_port_data_t;
15011Sigor@sysoev.ru 
15111Sigor@sysoev.ru 
152197Smax.romanov@nginx.com nxt_port_t *nxt_port_new(nxt_task_t *task, nxt_port_id_t id, nxt_pid_t pid,
153163Smax.romanov@nginx.com     nxt_process_type_t type);
154163Smax.romanov@nginx.com nxt_bool_t nxt_port_release(nxt_port_t *port);
155163Smax.romanov@nginx.com 
156141Smax.romanov@nginx.com nxt_port_id_t nxt_port_get_next_id(void);
157141Smax.romanov@nginx.com void nxt_port_reset_next_id(void);
158141Smax.romanov@nginx.com 
15914Sigor@sysoev.ru nxt_int_t nxt_port_socket_init(nxt_task_t *task, nxt_port_t *port,
16014Sigor@sysoev.ru     size_t max_size);
16114Sigor@sysoev.ru void nxt_port_destroy(nxt_port_t *port);
16214Sigor@sysoev.ru void nxt_port_write_enable(nxt_task_t *task, nxt_port_t *port);
16314Sigor@sysoev.ru void nxt_port_write_close(nxt_port_t *port);
16414Sigor@sysoev.ru void nxt_port_read_enable(nxt_task_t *task, nxt_port_t *port);
16514Sigor@sysoev.ru void nxt_port_read_close(nxt_port_t *port);
16614Sigor@sysoev.ru nxt_int_t nxt_port_socket_write(nxt_task_t *task, nxt_port_t *port,
16742Smax.romanov@nginx.com     nxt_uint_t type, nxt_fd_t fd, uint32_t stream, nxt_port_id_t reply_port,
16842Smax.romanov@nginx.com     nxt_buf_t *b);
16914Sigor@sysoev.ru 
170141Smax.romanov@nginx.com void nxt_port_enable(nxt_task_t *task, nxt_port_t *port,
17114Sigor@sysoev.ru     nxt_port_handler_t *handlers);
17220Sigor@sysoev.ru void nxt_port_send_new_port(nxt_task_t *task, nxt_runtime_t *rt,
173141Smax.romanov@nginx.com     nxt_port_t *port, uint32_t stream);
17481Smax.romanov@nginx.com nxt_int_t nxt_port_send_port(nxt_task_t *task, nxt_port_t *port,
175141Smax.romanov@nginx.com     nxt_port_t *new_port, uint32_t stream);
17620Sigor@sysoev.ru void nxt_port_change_log_file(nxt_task_t *task, nxt_runtime_t *rt,
17711Sigor@sysoev.ru     nxt_uint_t slot, nxt_fd_t fd);
17811Sigor@sysoev.ru 
17914Sigor@sysoev.ru void nxt_port_quit_handler(nxt_task_t *task, nxt_port_recv_msg_t *msg);
18014Sigor@sysoev.ru void nxt_port_new_port_handler(nxt_task_t *task, nxt_port_recv_msg_t *msg);
181141Smax.romanov@nginx.com void nxt_port_ready_handler(nxt_task_t *task, nxt_port_recv_msg_t *msg);
18214Sigor@sysoev.ru void nxt_port_change_log_file_handler(nxt_task_t *task,
18311Sigor@sysoev.ru     nxt_port_recv_msg_t *msg);
18442Smax.romanov@nginx.com void nxt_port_mmap_handler(nxt_task_t *task, nxt_port_recv_msg_t *msg);
18514Sigor@sysoev.ru void nxt_port_data_handler(nxt_task_t *task, nxt_port_recv_msg_t *msg);
186125Smax.romanov@nginx.com void nxt_port_remove_pid_handler(nxt_task_t *task, nxt_port_recv_msg_t *msg);
18714Sigor@sysoev.ru void nxt_port_empty_handler(nxt_task_t *task, nxt_port_recv_msg_t *msg);
18811Sigor@sysoev.ru 
18911Sigor@sysoev.ru 
19011Sigor@sysoev.ru #endif /* _NXT_PORT_H_INCLUDED_ */
191