xref: /f-stack/lib/ff_msg.h (revision 2bfe3f2e)
1 /*
2  * Copyright (C) 2017 THL A29 Limited, a Tencent company.
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions are met:
7  *
8  * 1. Redistributions of source code must retain the above copyright notice, this
9  *   list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright notice,
11  *   this list of conditions and the following disclaimer in the documentation
12  *   and/or other materials provided with the distribution.
13  *
14  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
15  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
16  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
17  * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
18  * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
19  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
20  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
21  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
23  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
24  *
25  */
26 
27 #ifndef _FF_MSG_H_
28 #define _FF_MSG_H_
29 
30 #include <rte_memory.h>
31 
32 #define FF_MSG_RING_IN  "ff_msg_ring_in_"
33 #define FF_MSG_RING_OUT "ff_msg_ring_out_"
34 #define FF_MSG_POOL     "ff_msg_pool"
35 
36 /* MSG TYPE: sysctl, ioctl, etc.. */
37 enum FF_MSG_TYPE {
38     FF_UNKNOWN = 0,
39     FF_SYSCTL,
40     FF_IOCTL,
41     FF_ROUTE,
42     FF_TOP,
43     FF_NGCTL,
44     FF_IPFW_CTL,
45 };
46 
47 struct ff_sysctl_args {
48     int *name;
49     unsigned namelen;
50     void *old;
51     size_t *oldlenp;
52     void *new;
53     size_t newlen;
54 };
55 
56 struct ff_ioctl_args {
57     unsigned long cmd;
58     void *data;
59 };
60 
61 struct ff_route_args {
62     int fib;
63     unsigned len;
64     unsigned maxlen;
65     void *data;
66 };
67 
68 struct ff_top_args {
69     unsigned long loops;
70     unsigned long idle_tsc;
71     unsigned long work_tsc;
72     unsigned long sys_tsc;
73     unsigned long usr_tsc;
74 };
75 
76 struct ff_ngctl_args {
77     int cmd;
78     int ret;
79     void *data;
80 };
81 
82 enum FF_IPFW_CMD {
83     FF_IPFW_GET,
84     FF_IPFW_SET,
85 };
86 
87 struct ff_ipfw_args {
88     int cmd;
89     int level;
90     int optname;
91     void *optval;
92     socklen_t *optlen;
93 };
94 
95 #define MAX_MSG_BUF_SIZE 10240
96 
97 /* structure of ipc msg */
98 struct ff_msg {
99     enum FF_MSG_TYPE msg_type;
100     /* Result of msg processing */
101     int result;
102     /* Length of segment buffer. */
103     size_t buf_len;
104     /* Address of segment buffer. */
105     char *buf_addr;
106 
107     union {
108         struct ff_sysctl_args sysctl;
109         struct ff_ioctl_args ioctl;
110         struct ff_route_args route;
111         struct ff_top_args top;
112         struct ff_ngctl_args ngctl;
113         struct ff_ipfw_args ipfw;
114     };
115 } __attribute__((packed)) __rte_cache_aligned;
116 
117 #endif
118