xref: /unit/src/nxt_port_memory.h (revision 1125:f92f3cd41257)
1 
2 /*
3  * Copyright (C) Max Romanov
4  * Copyright (C) NGINX, Inc.
5  */
6 
7 #ifndef _NXT_PORT_MEMORY_H_INCLUDED_
8 #define _NXT_PORT_MEMORY_H_INCLUDED_
9 
10 
11 #define PORT_MMAP_MIN_SIZE (3 * sizeof(uint32_t))
12 
13 typedef struct nxt_port_mmap_header_s nxt_port_mmap_header_t;
14 typedef struct nxt_port_mmap_handler_s nxt_port_mmap_handler_t;
15 
16 void nxt_port_mmaps_destroy(nxt_port_mmaps_t *port_mmaps, nxt_bool_t free_elts);
17 
18 typedef struct nxt_port_mmap_tracking_s nxt_port_mmap_tracking_t;
19 
20 struct nxt_port_mmap_tracking_s {
21     void                *mmap_handler;
22     nxt_atomic_t        *tracking;
23 };
24 
25 nxt_int_t
26 nxt_port_mmap_get_tracking(nxt_task_t *task, nxt_port_t *port,
27     nxt_port_mmap_tracking_t *tracking, uint32_t stream);
28 
29 nxt_bool_t
30 nxt_port_mmap_tracking_cancel(nxt_task_t *task,
31     nxt_port_mmap_tracking_t *tracking, uint32_t stream);
32 
33 nxt_int_t
34 nxt_port_mmap_tracking_write(uint32_t *buf, nxt_port_mmap_tracking_t *t);
35 
36 nxt_bool_t
37 nxt_port_mmap_tracking_read(nxt_task_t *task, nxt_port_recv_msg_t *msg);
38 
39 /*
40  * Allocates nxt_but_t structure from port's mem_pool, assigns this buf 'mem'
41  * pointers to first available shared mem bucket(s). 'size' used as a hint to
42  * acquire several successive buckets if possible.
43  *
44  * This function assumes that current thread operates the 'port' exclusively.
45  */
46 nxt_buf_t *
47 nxt_port_mmap_get_buf(nxt_task_t *task, nxt_port_t *port, size_t size);
48 
49 nxt_int_t nxt_port_mmap_increase_buf(nxt_task_t *task, nxt_buf_t *b,
50     size_t size, size_t min_size);
51 
52 nxt_port_mmap_handler_t *
53 nxt_port_incoming_port_mmap(nxt_task_t *task, nxt_process_t *process,
54     nxt_fd_t fd);
55 
56 void
57 nxt_port_mmap_write(nxt_task_t *task, nxt_port_t *port,
58     nxt_port_send_msg_t *msg, nxt_sendbuf_coalesce_t *sb, void *mmsg_buf);
59 
60 void
61 nxt_port_mmap_read(nxt_task_t *task, nxt_port_recv_msg_t *msg);
62 
63 enum nxt_port_method_e {
64     NXT_PORT_METHOD_ANY = 0,
65     NXT_PORT_METHOD_PLAIN,
66     NXT_PORT_METHOD_MMAP
67 };
68 
69 typedef enum nxt_port_method_e nxt_port_method_t;
70 
71 nxt_port_method_t
72 nxt_port_mmap_get_method(nxt_task_t *task, nxt_port_t *port, nxt_buf_t *b);
73 
74 
75 #endif /* _NXT_PORT_MEMORY_H_INCLUDED_ */
76