xref: /unit/src/nxt_port.h (revision 189)
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 {
12*189Smax.romanov@nginx.com     NXT_PORT_MSG_LAST           = 0x100,
13*189Smax.romanov@nginx.com     NXT_PORT_MSG_CLOSE_FD       = 0x200,
14*189Smax.romanov@nginx.com 
15*189Smax.romanov@nginx.com     NXT_PORT_MSG_MASK           = 0xFF,
16*189Smax.romanov@nginx.com 
17*189Smax.romanov@nginx.com     _NXT_PORT_MSG_QUIT          = 0,
18*189Smax.romanov@nginx.com     _NXT_PORT_MSG_NEW_PORT,
19*189Smax.romanov@nginx.com     _NXT_PORT_MSG_CHANGE_FILE,
20*189Smax.romanov@nginx.com     _NXT_PORT_MSG_MMAP,
21*189Smax.romanov@nginx.com     _NXT_PORT_MSG_DATA,
22*189Smax.romanov@nginx.com     _NXT_PORT_MSG_REMOVE_PID,
23*189Smax.romanov@nginx.com     _NXT_PORT_MSG_READY,
2442Smax.romanov@nginx.com 
25125Smax.romanov@nginx.com     NXT_PORT_MSG_MAX,
26*189Smax.romanov@nginx.com 
27*189Smax.romanov@nginx.com     NXT_PORT_MSG_QUIT           = _NXT_PORT_MSG_QUIT | NXT_PORT_MSG_LAST,
28*189Smax.romanov@nginx.com     NXT_PORT_MSG_NEW_PORT       = _NXT_PORT_MSG_NEW_PORT | NXT_PORT_MSG_LAST,
29*189Smax.romanov@nginx.com     NXT_PORT_MSG_CHANGE_FILE    = _NXT_PORT_MSG_CHANGE_FILE | NXT_PORT_MSG_LAST,
30*189Smax.romanov@nginx.com     NXT_PORT_MSG_MMAP           = _NXT_PORT_MSG_MMAP | NXT_PORT_MSG_LAST |
31*189Smax.romanov@nginx.com                                   NXT_PORT_MSG_CLOSE_FD,
32*189Smax.romanov@nginx.com     NXT_PORT_MSG_DATA           = _NXT_PORT_MSG_DATA,
33*189Smax.romanov@nginx.com     NXT_PORT_MSG_DATA_LAST      = _NXT_PORT_MSG_DATA | NXT_PORT_MSG_LAST,
34*189Smax.romanov@nginx.com     NXT_PORT_MSG_REMOVE_PID     = _NXT_PORT_MSG_REMOVE_PID | NXT_PORT_MSG_LAST,
35*189Smax.romanov@nginx.com     NXT_PORT_MSG_READY          = _NXT_PORT_MSG_READY | NXT_PORT_MSG_LAST,
36125Smax.romanov@nginx.com } nxt_port_msg_type_t;
3742Smax.romanov@nginx.com 
3814Sigor@sysoev.ru 
3942Smax.romanov@nginx.com /* Passed as a first iov chunk. */
4042Smax.romanov@nginx.com typedef struct {
4142Smax.romanov@nginx.com     uint32_t             stream;
4242Smax.romanov@nginx.com     nxt_pid_t            pid;
4342Smax.romanov@nginx.com     nxt_port_id_t        reply_port;
4442Smax.romanov@nginx.com 
45*189Smax.romanov@nginx.com     uint8_t              type;
4642Smax.romanov@nginx.com     uint8_t              last;      /* 1 bit */
4742Smax.romanov@nginx.com 
4842Smax.romanov@nginx.com     /* Message data send using mmap, next chunk is a nxt_port_mmap_msg_t. */
4942Smax.romanov@nginx.com     uint8_t              mmap;      /* 1 bit */
50168Svbart@nginx.com } nxt_port_msg_t;
5114Sigor@sysoev.ru 
5214Sigor@sysoev.ru 
5314Sigor@sysoev.ru typedef struct {
5414Sigor@sysoev.ru     nxt_queue_link_t    link;
5514Sigor@sysoev.ru     nxt_buf_t           *buf;
5614Sigor@sysoev.ru     size_t              share;
5714Sigor@sysoev.ru     nxt_fd_t            fd;
58*189Smax.romanov@nginx.com     nxt_bool_t          close_fd;
5914Sigor@sysoev.ru     nxt_port_msg_t      port_msg;
60122Smax.romanov@nginx.com 
61122Smax.romanov@nginx.com     nxt_work_t          work;
62122Smax.romanov@nginx.com     nxt_event_engine_t  *engine;
63122Smax.romanov@nginx.com     nxt_mp_t            *mem_pool;
6414Sigor@sysoev.ru } nxt_port_send_msg_t;
6514Sigor@sysoev.ru 
6614Sigor@sysoev.ru 
6720Sigor@sysoev.ru struct nxt_port_recv_msg_s {
6814Sigor@sysoev.ru     nxt_fd_t            fd;
6914Sigor@sysoev.ru     nxt_buf_t           *buf;
7014Sigor@sysoev.ru     nxt_port_t          *port;
7142Smax.romanov@nginx.com     nxt_port_msg_t      port_msg;
7282Smax.romanov@nginx.com     size_t              size;
73141Smax.romanov@nginx.com     nxt_port_t          *new_port;
7420Sigor@sysoev.ru };
7514Sigor@sysoev.ru 
76141Smax.romanov@nginx.com typedef struct nxt_app_s  nxt_app_t;
7714Sigor@sysoev.ru 
7814Sigor@sysoev.ru struct nxt_port_s {
7914Sigor@sysoev.ru     nxt_fd_event_t      socket;
8014Sigor@sysoev.ru 
81125Smax.romanov@nginx.com     nxt_queue_link_t    link;       /* for nxt_process_t.ports */
82141Smax.romanov@nginx.com     nxt_process_t       *process;
83141Smax.romanov@nginx.com 
84141Smax.romanov@nginx.com     nxt_queue_link_t    app_link;   /* for nxt_app_t.ports */
85141Smax.romanov@nginx.com     nxt_app_t           *app;
8642Smax.romanov@nginx.com 
8714Sigor@sysoev.ru     nxt_queue_t         messages;   /* of nxt_port_send_msg_t */
8814Sigor@sysoev.ru 
8914Sigor@sysoev.ru     /* Maximum size of message part. */
9014Sigor@sysoev.ru     uint32_t            max_size;
9114Sigor@sysoev.ru     /* Maximum interleave of message parts. */
9214Sigor@sysoev.ru     uint32_t            max_share;
93167Smax.romanov@nginx.com     uint32_t            app_req_id;
9414Sigor@sysoev.ru 
9514Sigor@sysoev.ru     nxt_port_handler_t  handler;
96141Smax.romanov@nginx.com     nxt_port_handler_t  *data;
9714Sigor@sysoev.ru 
9865Sigor@sysoev.ru     nxt_mp_t            *mem_pool;
99141Smax.romanov@nginx.com     nxt_event_engine_t  *engine;
100141Smax.romanov@nginx.com 
10114Sigor@sysoev.ru     nxt_buf_t           *free_bufs;
10214Sigor@sysoev.ru     nxt_socket_t        pair[2];
10314Sigor@sysoev.ru 
10442Smax.romanov@nginx.com     nxt_port_id_t       id;
10514Sigor@sysoev.ru     nxt_pid_t           pid;
10642Smax.romanov@nginx.com 
107141Smax.romanov@nginx.com     nxt_process_type_t  type;
108163Smax.romanov@nginx.com     nxt_work_t          work;
10914Sigor@sysoev.ru };
11014Sigor@sysoev.ru 
11114Sigor@sysoev.ru 
11211Sigor@sysoev.ru typedef struct {
11342Smax.romanov@nginx.com     nxt_port_id_t       id;
11414Sigor@sysoev.ru     nxt_pid_t           pid;
11514Sigor@sysoev.ru     size_t              max_size;
11614Sigor@sysoev.ru     size_t              max_share;
11742Smax.romanov@nginx.com     nxt_process_type_t  type:8;
118168Svbart@nginx.com } nxt_port_msg_new_port_t;
11911Sigor@sysoev.ru 
12011Sigor@sysoev.ru 
12111Sigor@sysoev.ru /*
12214Sigor@sysoev.ru  * nxt_port_data_t size is allocation size
12314Sigor@sysoev.ru  * which enables effective reuse of memory pool cache.
12411Sigor@sysoev.ru  */
12511Sigor@sysoev.ru typedef union {
12611Sigor@sysoev.ru     nxt_buf_t                buf;
12714Sigor@sysoev.ru     nxt_port_msg_new_port_t  new_port;
12814Sigor@sysoev.ru } nxt_port_data_t;
12911Sigor@sysoev.ru 
13011Sigor@sysoev.ru 
131163Smax.romanov@nginx.com nxt_port_t *nxt_port_new(nxt_port_id_t id, nxt_pid_t pid,
132163Smax.romanov@nginx.com     nxt_process_type_t type);
133163Smax.romanov@nginx.com nxt_bool_t nxt_port_release(nxt_port_t *port);
134163Smax.romanov@nginx.com 
135141Smax.romanov@nginx.com nxt_port_id_t nxt_port_get_next_id(void);
136141Smax.romanov@nginx.com void nxt_port_reset_next_id(void);
137141Smax.romanov@nginx.com 
13814Sigor@sysoev.ru nxt_int_t nxt_port_socket_init(nxt_task_t *task, nxt_port_t *port,
13914Sigor@sysoev.ru     size_t max_size);
14014Sigor@sysoev.ru void nxt_port_destroy(nxt_port_t *port);
14114Sigor@sysoev.ru void nxt_port_write_enable(nxt_task_t *task, nxt_port_t *port);
14214Sigor@sysoev.ru void nxt_port_write_close(nxt_port_t *port);
14314Sigor@sysoev.ru void nxt_port_read_enable(nxt_task_t *task, nxt_port_t *port);
14414Sigor@sysoev.ru void nxt_port_read_close(nxt_port_t *port);
14514Sigor@sysoev.ru nxt_int_t nxt_port_socket_write(nxt_task_t *task, nxt_port_t *port,
14642Smax.romanov@nginx.com     nxt_uint_t type, nxt_fd_t fd, uint32_t stream, nxt_port_id_t reply_port,
14742Smax.romanov@nginx.com     nxt_buf_t *b);
14814Sigor@sysoev.ru 
149141Smax.romanov@nginx.com void nxt_port_enable(nxt_task_t *task, nxt_port_t *port,
15014Sigor@sysoev.ru     nxt_port_handler_t *handlers);
15120Sigor@sysoev.ru void nxt_port_write(nxt_task_t *task, nxt_runtime_t *rt, nxt_uint_t type,
15214Sigor@sysoev.ru     nxt_fd_t fd, uint32_t stream, nxt_buf_t *b);
15320Sigor@sysoev.ru void nxt_port_send_new_port(nxt_task_t *task, nxt_runtime_t *rt,
154141Smax.romanov@nginx.com     nxt_port_t *port, uint32_t stream);
15581Smax.romanov@nginx.com nxt_int_t nxt_port_send_port(nxt_task_t *task, nxt_port_t *port,
156141Smax.romanov@nginx.com     nxt_port_t *new_port, uint32_t stream);
15720Sigor@sysoev.ru void nxt_port_change_log_file(nxt_task_t *task, nxt_runtime_t *rt,
15811Sigor@sysoev.ru     nxt_uint_t slot, nxt_fd_t fd);
15911Sigor@sysoev.ru 
16014Sigor@sysoev.ru void nxt_port_quit_handler(nxt_task_t *task, nxt_port_recv_msg_t *msg);
16114Sigor@sysoev.ru void nxt_port_new_port_handler(nxt_task_t *task, nxt_port_recv_msg_t *msg);
162141Smax.romanov@nginx.com void nxt_port_ready_handler(nxt_task_t *task, nxt_port_recv_msg_t *msg);
16314Sigor@sysoev.ru void nxt_port_change_log_file_handler(nxt_task_t *task,
16411Sigor@sysoev.ru     nxt_port_recv_msg_t *msg);
16542Smax.romanov@nginx.com void nxt_port_mmap_handler(nxt_task_t *task, nxt_port_recv_msg_t *msg);
16614Sigor@sysoev.ru void nxt_port_data_handler(nxt_task_t *task, nxt_port_recv_msg_t *msg);
167125Smax.romanov@nginx.com void nxt_port_remove_pid_handler(nxt_task_t *task, nxt_port_recv_msg_t *msg);
16814Sigor@sysoev.ru void nxt_port_empty_handler(nxt_task_t *task, nxt_port_recv_msg_t *msg);
16911Sigor@sysoev.ru 
17011Sigor@sysoev.ru 
17111Sigor@sysoev.ru #endif /* _NXT_PORT_H_INCLUDED_ */
172