xref: /unit/src/nxt_port.h (revision 42)
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 
11*42Smax.romanov@nginx.com typedef enum {
12*42Smax.romanov@nginx.com     NXT_PORT_MSG_QUIT = 0,
13*42Smax.romanov@nginx.com     NXT_PORT_MSG_NEW_PORT,
14*42Smax.romanov@nginx.com     NXT_PORT_MSG_CHANGE_FILE,
15*42Smax.romanov@nginx.com     NXT_PORT_MSG_MMAP,
16*42Smax.romanov@nginx.com     NXT_PORT_MSG_DATA,
17*42Smax.romanov@nginx.com } nxt_port_msg_type_t;
18*42Smax.romanov@nginx.com 
19*42Smax.romanov@nginx.com #define NXT_PORT_MSG_MAX  NXT_PORT_MSG_DATA
20*42Smax.romanov@nginx.com 
2114Sigor@sysoev.ru 
22*42Smax.romanov@nginx.com /* Passed as a first iov chunk. */
23*42Smax.romanov@nginx.com typedef struct {
24*42Smax.romanov@nginx.com     uint32_t             stream;
25*42Smax.romanov@nginx.com     nxt_pid_t            pid;
26*42Smax.romanov@nginx.com     nxt_port_id_t        reply_port;
27*42Smax.romanov@nginx.com 
28*42Smax.romanov@nginx.com     nxt_port_msg_type_t  type:8;
29*42Smax.romanov@nginx.com     uint8_t              last;      /* 1 bit */
30*42Smax.romanov@nginx.com 
31*42Smax.romanov@nginx.com     /* Message data send using mmap, next chunk is a nxt_port_mmap_msg_t. */
32*42Smax.romanov@nginx.com     uint8_t              mmap;      /* 1 bit */
3314Sigor@sysoev.ru } nxt_port_msg_t;
3414Sigor@sysoev.ru 
3514Sigor@sysoev.ru 
3614Sigor@sysoev.ru typedef struct {
3714Sigor@sysoev.ru     nxt_queue_link_t    link;
3814Sigor@sysoev.ru     nxt_buf_t           *buf;
3914Sigor@sysoev.ru     size_t              share;
4014Sigor@sysoev.ru     nxt_fd_t            fd;
4114Sigor@sysoev.ru     nxt_port_msg_t      port_msg;
4214Sigor@sysoev.ru } nxt_port_send_msg_t;
4314Sigor@sysoev.ru 
4414Sigor@sysoev.ru 
4520Sigor@sysoev.ru struct nxt_port_recv_msg_s {
4614Sigor@sysoev.ru     nxt_fd_t            fd;
4714Sigor@sysoev.ru     nxt_buf_t           *buf;
4814Sigor@sysoev.ru     nxt_port_t          *port;
49*42Smax.romanov@nginx.com     nxt_port_msg_t      port_msg;
5020Sigor@sysoev.ru };
5114Sigor@sysoev.ru 
5214Sigor@sysoev.ru 
5314Sigor@sysoev.ru struct nxt_port_s {
5414Sigor@sysoev.ru     /* Must be the first field. */
5514Sigor@sysoev.ru     nxt_fd_event_t      socket;
5614Sigor@sysoev.ru 
57*42Smax.romanov@nginx.com     nxt_queue_link_t    link;
58*42Smax.romanov@nginx.com 
5914Sigor@sysoev.ru     nxt_queue_t         messages;   /* of nxt_port_send_msg_t */
6014Sigor@sysoev.ru 
6114Sigor@sysoev.ru     /* Maximum size of message part. */
6214Sigor@sysoev.ru     uint32_t            max_size;
6314Sigor@sysoev.ru     /* Maximum interleave of message parts. */
6414Sigor@sysoev.ru     uint32_t            max_share;
6514Sigor@sysoev.ru 
6614Sigor@sysoev.ru     nxt_port_handler_t  handler;
6714Sigor@sysoev.ru     void                *data;
6814Sigor@sysoev.ru 
6914Sigor@sysoev.ru     nxt_mem_pool_t      *mem_pool;
7014Sigor@sysoev.ru     nxt_buf_t           *free_bufs;
7114Sigor@sysoev.ru     nxt_socket_t        pair[2];
7214Sigor@sysoev.ru 
73*42Smax.romanov@nginx.com     nxt_port_id_t       id;
7414Sigor@sysoev.ru     nxt_pid_t           pid;
7514Sigor@sysoev.ru     uint32_t            engine;
76*42Smax.romanov@nginx.com 
77*42Smax.romanov@nginx.com     nxt_process_type_t  type:8;
78*42Smax.romanov@nginx.com     nxt_process_t       *process;
7914Sigor@sysoev.ru };
8014Sigor@sysoev.ru 
8114Sigor@sysoev.ru 
8211Sigor@sysoev.ru typedef struct {
83*42Smax.romanov@nginx.com     nxt_port_id_t       id;
8414Sigor@sysoev.ru     nxt_pid_t           pid;
8514Sigor@sysoev.ru     uint32_t            engine;
8614Sigor@sysoev.ru     size_t              max_size;
8714Sigor@sysoev.ru     size_t              max_share;
88*42Smax.romanov@nginx.com     nxt_process_type_t  type:8;
8914Sigor@sysoev.ru } nxt_port_msg_new_port_t;
9011Sigor@sysoev.ru 
9111Sigor@sysoev.ru 
9211Sigor@sysoev.ru /*
9314Sigor@sysoev.ru  * nxt_port_data_t size is allocation size
9414Sigor@sysoev.ru  * which enables effective reuse of memory pool cache.
9511Sigor@sysoev.ru  */
9611Sigor@sysoev.ru typedef union {
9711Sigor@sysoev.ru     nxt_buf_t                buf;
9814Sigor@sysoev.ru     nxt_port_msg_new_port_t  new_port;
9914Sigor@sysoev.ru } nxt_port_data_t;
10011Sigor@sysoev.ru 
10111Sigor@sysoev.ru 
10214Sigor@sysoev.ru nxt_int_t nxt_port_socket_init(nxt_task_t *task, nxt_port_t *port,
10314Sigor@sysoev.ru     size_t max_size);
10414Sigor@sysoev.ru void nxt_port_destroy(nxt_port_t *port);
10514Sigor@sysoev.ru void nxt_port_write_enable(nxt_task_t *task, nxt_port_t *port);
10614Sigor@sysoev.ru void nxt_port_write_close(nxt_port_t *port);
10714Sigor@sysoev.ru void nxt_port_read_enable(nxt_task_t *task, nxt_port_t *port);
10814Sigor@sysoev.ru void nxt_port_read_close(nxt_port_t *port);
10914Sigor@sysoev.ru nxt_int_t nxt_port_socket_write(nxt_task_t *task, nxt_port_t *port,
110*42Smax.romanov@nginx.com     nxt_uint_t type, nxt_fd_t fd, uint32_t stream, nxt_port_id_t reply_port,
111*42Smax.romanov@nginx.com     nxt_buf_t *b);
11214Sigor@sysoev.ru 
11314Sigor@sysoev.ru void nxt_port_create(nxt_thread_t *thread, nxt_port_t *port,
11414Sigor@sysoev.ru     nxt_port_handler_t *handlers);
11520Sigor@sysoev.ru void nxt_port_write(nxt_task_t *task, nxt_runtime_t *rt, nxt_uint_t type,
11614Sigor@sysoev.ru     nxt_fd_t fd, uint32_t stream, nxt_buf_t *b);
11720Sigor@sysoev.ru void nxt_port_send_new_port(nxt_task_t *task, nxt_runtime_t *rt,
11814Sigor@sysoev.ru     nxt_port_t *port);
11920Sigor@sysoev.ru void nxt_port_change_log_file(nxt_task_t *task, nxt_runtime_t *rt,
12011Sigor@sysoev.ru     nxt_uint_t slot, nxt_fd_t fd);
12111Sigor@sysoev.ru 
12214Sigor@sysoev.ru void nxt_port_quit_handler(nxt_task_t *task, nxt_port_recv_msg_t *msg);
12314Sigor@sysoev.ru void nxt_port_new_port_handler(nxt_task_t *task, nxt_port_recv_msg_t *msg);
12414Sigor@sysoev.ru void nxt_port_change_log_file_handler(nxt_task_t *task,
12511Sigor@sysoev.ru     nxt_port_recv_msg_t *msg);
126*42Smax.romanov@nginx.com void nxt_port_mmap_handler(nxt_task_t *task, nxt_port_recv_msg_t *msg);
12714Sigor@sysoev.ru void nxt_port_data_handler(nxt_task_t *task, nxt_port_recv_msg_t *msg);
12814Sigor@sysoev.ru void nxt_port_empty_handler(nxt_task_t *task, nxt_port_recv_msg_t *msg);
12911Sigor@sysoev.ru 
13011Sigor@sysoev.ru 
13111Sigor@sysoev.ru #endif /* _NXT_PORT_H_INCLUDED_ */
132