xref: /unit/src/nxt_port.h (revision 314)
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,
27216Sigor@sysoev.ru     _NXT_PORT_MSG_MODULES,
28*314Svbart@nginx.com     _NXT_PORT_MSG_CONF_STORE,
29190Smax.romanov@nginx.com     _NXT_PORT_MSG_RPC_READY,
30190Smax.romanov@nginx.com     _NXT_PORT_MSG_RPC_ERROR,
3142Smax.romanov@nginx.com 
32125Smax.romanov@nginx.com     NXT_PORT_MSG_MAX,
33189Smax.romanov@nginx.com 
34189Smax.romanov@nginx.com     NXT_PORT_MSG_QUIT           = _NXT_PORT_MSG_QUIT | NXT_PORT_MSG_LAST,
35189Smax.romanov@nginx.com     NXT_PORT_MSG_NEW_PORT       = _NXT_PORT_MSG_NEW_PORT | NXT_PORT_MSG_LAST,
36189Smax.romanov@nginx.com     NXT_PORT_MSG_CHANGE_FILE    = _NXT_PORT_MSG_CHANGE_FILE | NXT_PORT_MSG_LAST,
37189Smax.romanov@nginx.com     NXT_PORT_MSG_MMAP           = _NXT_PORT_MSG_MMAP | NXT_PORT_MSG_LAST |
38205Smax.romanov@nginx.com                                   NXT_PORT_MSG_CLOSE_FD | NXT_PORT_MSG_SYNC,
39189Smax.romanov@nginx.com     NXT_PORT_MSG_DATA           = _NXT_PORT_MSG_DATA,
40189Smax.romanov@nginx.com     NXT_PORT_MSG_DATA_LAST      = _NXT_PORT_MSG_DATA | NXT_PORT_MSG_LAST,
41189Smax.romanov@nginx.com     NXT_PORT_MSG_REMOVE_PID     = _NXT_PORT_MSG_REMOVE_PID | NXT_PORT_MSG_LAST,
42189Smax.romanov@nginx.com     NXT_PORT_MSG_READY          = _NXT_PORT_MSG_READY | NXT_PORT_MSG_LAST,
43192Smax.romanov@nginx.com     NXT_PORT_MSG_START_WORKER   = _NXT_PORT_MSG_START_WORKER |
44192Smax.romanov@nginx.com                                   NXT_PORT_MSG_LAST,
45198Sigor@sysoev.ru     NXT_PORT_MSG_SOCKET         = _NXT_PORT_MSG_SOCKET | NXT_PORT_MSG_LAST,
46216Sigor@sysoev.ru     NXT_PORT_MSG_MODULES        = _NXT_PORT_MSG_MODULES | NXT_PORT_MSG_LAST,
47*314Svbart@nginx.com     NXT_PORT_MSG_CONF_STORE     = _NXT_PORT_MSG_CONF_STORE | NXT_PORT_MSG_LAST,
48190Smax.romanov@nginx.com     NXT_PORT_MSG_RPC_READY      = _NXT_PORT_MSG_RPC_READY,
49190Smax.romanov@nginx.com     NXT_PORT_MSG_RPC_READY_LAST = _NXT_PORT_MSG_RPC_READY | NXT_PORT_MSG_LAST,
50190Smax.romanov@nginx.com     NXT_PORT_MSG_RPC_ERROR      = _NXT_PORT_MSG_RPC_ERROR | NXT_PORT_MSG_LAST,
51125Smax.romanov@nginx.com } nxt_port_msg_type_t;
5242Smax.romanov@nginx.com 
5314Sigor@sysoev.ru 
5442Smax.romanov@nginx.com /* Passed as a first iov chunk. */
5542Smax.romanov@nginx.com typedef struct {
5642Smax.romanov@nginx.com     uint32_t             stream;
5742Smax.romanov@nginx.com     nxt_pid_t            pid;
5842Smax.romanov@nginx.com     nxt_port_id_t        reply_port;
5942Smax.romanov@nginx.com 
60189Smax.romanov@nginx.com     uint8_t              type;
6142Smax.romanov@nginx.com     uint8_t              last;      /* 1 bit */
6242Smax.romanov@nginx.com 
6342Smax.romanov@nginx.com     /* Message data send using mmap, next chunk is a nxt_port_mmap_msg_t. */
6442Smax.romanov@nginx.com     uint8_t              mmap;      /* 1 bit */
65168Svbart@nginx.com } nxt_port_msg_t;
6614Sigor@sysoev.ru 
6714Sigor@sysoev.ru 
6814Sigor@sysoev.ru typedef struct {
6914Sigor@sysoev.ru     nxt_queue_link_t    link;
7014Sigor@sysoev.ru     nxt_buf_t           *buf;
7114Sigor@sysoev.ru     size_t              share;
7214Sigor@sysoev.ru     nxt_fd_t            fd;
73189Smax.romanov@nginx.com     nxt_bool_t          close_fd;
74205Smax.romanov@nginx.com     nxt_bool_t          opened;
7514Sigor@sysoev.ru     nxt_port_msg_t      port_msg;
76122Smax.romanov@nginx.com 
77122Smax.romanov@nginx.com     nxt_work_t          work;
78122Smax.romanov@nginx.com     nxt_event_engine_t  *engine;
79122Smax.romanov@nginx.com     nxt_mp_t            *mem_pool;
8014Sigor@sysoev.ru } nxt_port_send_msg_t;
8114Sigor@sysoev.ru 
8214Sigor@sysoev.ru 
8320Sigor@sysoev.ru struct nxt_port_recv_msg_s {
8414Sigor@sysoev.ru     nxt_fd_t            fd;
8514Sigor@sysoev.ru     nxt_buf_t           *buf;
8614Sigor@sysoev.ru     nxt_port_t          *port;
8742Smax.romanov@nginx.com     nxt_port_msg_t      port_msg;
8882Smax.romanov@nginx.com     size_t              size;
89141Smax.romanov@nginx.com     nxt_port_t          *new_port;
9020Sigor@sysoev.ru };
9114Sigor@sysoev.ru 
92141Smax.romanov@nginx.com typedef struct nxt_app_s  nxt_app_t;
9314Sigor@sysoev.ru 
9414Sigor@sysoev.ru struct nxt_port_s {
9514Sigor@sysoev.ru     nxt_fd_event_t      socket;
9614Sigor@sysoev.ru 
97125Smax.romanov@nginx.com     nxt_queue_link_t    link;       /* for nxt_process_t.ports */
98141Smax.romanov@nginx.com     nxt_process_t       *process;
99141Smax.romanov@nginx.com 
100141Smax.romanov@nginx.com     nxt_queue_link_t    app_link;   /* for nxt_app_t.ports */
101141Smax.romanov@nginx.com     nxt_app_t           *app;
10242Smax.romanov@nginx.com 
10314Sigor@sysoev.ru     nxt_queue_t         messages;   /* of nxt_port_send_msg_t */
10414Sigor@sysoev.ru 
10514Sigor@sysoev.ru     /* Maximum size of message part. */
10614Sigor@sysoev.ru     uint32_t            max_size;
10714Sigor@sysoev.ru     /* Maximum interleave of message parts. */
10814Sigor@sysoev.ru     uint32_t            max_share;
109167Smax.romanov@nginx.com     uint32_t            app_req_id;
11014Sigor@sysoev.ru 
11114Sigor@sysoev.ru     nxt_port_handler_t  handler;
112141Smax.romanov@nginx.com     nxt_port_handler_t  *data;
11314Sigor@sysoev.ru 
11465Sigor@sysoev.ru     nxt_mp_t            *mem_pool;
115141Smax.romanov@nginx.com     nxt_event_engine_t  *engine;
116141Smax.romanov@nginx.com 
11714Sigor@sysoev.ru     nxt_buf_t           *free_bufs;
11814Sigor@sysoev.ru     nxt_socket_t        pair[2];
11914Sigor@sysoev.ru 
12042Smax.romanov@nginx.com     nxt_port_id_t       id;
12114Sigor@sysoev.ru     nxt_pid_t           pid;
12242Smax.romanov@nginx.com 
123190Smax.romanov@nginx.com     nxt_lvlhsh_t        rpc_streams; /* stream to nxt_port_rpc_reg_t */
124190Smax.romanov@nginx.com     nxt_lvlhsh_t        rpc_peers;   /* peer to queue of nxt_port_rpc_reg_t */
125190Smax.romanov@nginx.com     uint32_t            next_stream;
126190Smax.romanov@nginx.com 
127141Smax.romanov@nginx.com     nxt_process_type_t  type;
128163Smax.romanov@nginx.com     nxt_work_t          work;
129197Smax.romanov@nginx.com 
130197Smax.romanov@nginx.com     struct iovec        *iov;
131197Smax.romanov@nginx.com     void                *mmsg_buf;
13214Sigor@sysoev.ru };
13314Sigor@sysoev.ru 
13414Sigor@sysoev.ru 
13511Sigor@sysoev.ru typedef struct {
13642Smax.romanov@nginx.com     nxt_port_id_t       id;
13714Sigor@sysoev.ru     nxt_pid_t           pid;
13814Sigor@sysoev.ru     size_t              max_size;
13914Sigor@sysoev.ru     size_t              max_share;
14042Smax.romanov@nginx.com     nxt_process_type_t  type:8;
141168Svbart@nginx.com } nxt_port_msg_new_port_t;
14211Sigor@sysoev.ru 
14311Sigor@sysoev.ru 
14411Sigor@sysoev.ru /*
14514Sigor@sysoev.ru  * nxt_port_data_t size is allocation size
14614Sigor@sysoev.ru  * which enables effective reuse of memory pool cache.
14711Sigor@sysoev.ru  */
14811Sigor@sysoev.ru typedef union {
14911Sigor@sysoev.ru     nxt_buf_t                buf;
15014Sigor@sysoev.ru     nxt_port_msg_new_port_t  new_port;
15114Sigor@sysoev.ru } nxt_port_data_t;
15211Sigor@sysoev.ru 
15311Sigor@sysoev.ru 
154197Smax.romanov@nginx.com nxt_port_t *nxt_port_new(nxt_task_t *task, nxt_port_id_t id, nxt_pid_t pid,
155163Smax.romanov@nginx.com     nxt_process_type_t type);
156163Smax.romanov@nginx.com nxt_bool_t nxt_port_release(nxt_port_t *port);
157163Smax.romanov@nginx.com 
158141Smax.romanov@nginx.com nxt_port_id_t nxt_port_get_next_id(void);
159141Smax.romanov@nginx.com void nxt_port_reset_next_id(void);
160141Smax.romanov@nginx.com 
16114Sigor@sysoev.ru nxt_int_t nxt_port_socket_init(nxt_task_t *task, nxt_port_t *port,
16214Sigor@sysoev.ru     size_t max_size);
16314Sigor@sysoev.ru void nxt_port_destroy(nxt_port_t *port);
16414Sigor@sysoev.ru void nxt_port_write_enable(nxt_task_t *task, nxt_port_t *port);
16514Sigor@sysoev.ru void nxt_port_write_close(nxt_port_t *port);
16614Sigor@sysoev.ru void nxt_port_read_enable(nxt_task_t *task, nxt_port_t *port);
16714Sigor@sysoev.ru void nxt_port_read_close(nxt_port_t *port);
16814Sigor@sysoev.ru nxt_int_t nxt_port_socket_write(nxt_task_t *task, nxt_port_t *port,
16942Smax.romanov@nginx.com     nxt_uint_t type, nxt_fd_t fd, uint32_t stream, nxt_port_id_t reply_port,
17042Smax.romanov@nginx.com     nxt_buf_t *b);
17114Sigor@sysoev.ru 
172141Smax.romanov@nginx.com void nxt_port_enable(nxt_task_t *task, nxt_port_t *port,
17314Sigor@sysoev.ru     nxt_port_handler_t *handlers);
17420Sigor@sysoev.ru void nxt_port_send_new_port(nxt_task_t *task, nxt_runtime_t *rt,
175141Smax.romanov@nginx.com     nxt_port_t *port, uint32_t stream);
17681Smax.romanov@nginx.com nxt_int_t nxt_port_send_port(nxt_task_t *task, nxt_port_t *port,
177141Smax.romanov@nginx.com     nxt_port_t *new_port, uint32_t stream);
17820Sigor@sysoev.ru void nxt_port_change_log_file(nxt_task_t *task, nxt_runtime_t *rt,
17911Sigor@sysoev.ru     nxt_uint_t slot, nxt_fd_t fd);
18011Sigor@sysoev.ru 
18114Sigor@sysoev.ru void nxt_port_quit_handler(nxt_task_t *task, nxt_port_recv_msg_t *msg);
18214Sigor@sysoev.ru void nxt_port_new_port_handler(nxt_task_t *task, nxt_port_recv_msg_t *msg);
183141Smax.romanov@nginx.com void nxt_port_ready_handler(nxt_task_t *task, nxt_port_recv_msg_t *msg);
18414Sigor@sysoev.ru void nxt_port_change_log_file_handler(nxt_task_t *task,
18511Sigor@sysoev.ru     nxt_port_recv_msg_t *msg);
18642Smax.romanov@nginx.com void nxt_port_mmap_handler(nxt_task_t *task, nxt_port_recv_msg_t *msg);
18714Sigor@sysoev.ru void nxt_port_data_handler(nxt_task_t *task, nxt_port_recv_msg_t *msg);
188125Smax.romanov@nginx.com void nxt_port_remove_pid_handler(nxt_task_t *task, nxt_port_recv_msg_t *msg);
18914Sigor@sysoev.ru void nxt_port_empty_handler(nxt_task_t *task, nxt_port_recv_msg_t *msg);
19011Sigor@sysoev.ru 
19111Sigor@sysoev.ru 
19211Sigor@sysoev.ru #endif /* _NXT_PORT_H_INCLUDED_ */
193