xref: /f-stack/lib/ff_msg.h (revision 0f5432bb)
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_IOCTL6,
42     FF_ROUTE,
43     FF_TOP,
44     FF_NGCTL,
45     FF_IPFW_CTL,
46     FF_TRAFFIC,
47 
48     /*
49      * to add other msg type before FF_MSG_NUM
50      */
51     FF_MSG_NUM,
52 };
53 
54 struct ff_sysctl_args {
55     int *name;
56     unsigned namelen;
57     void *old;
58     size_t *oldlenp;
59     void *new;
60     size_t newlen;
61 };
62 
63 struct ff_ioctl_args {
64     unsigned long cmd;
65     void *data;
66 };
67 
68 struct ff_route_args {
69     int fib;
70     unsigned len;
71     unsigned maxlen;
72     void *data;
73 };
74 
75 struct ff_top_args {
76     unsigned long loops;
77     unsigned long idle_tsc;
78     unsigned long work_tsc;
79     unsigned long sys_tsc;
80     unsigned long usr_tsc;
81 };
82 
83 struct ff_ngctl_args {
84     int cmd;
85     int ret;
86     void *data;
87 };
88 
89 enum FF_IPFW_CMD {
90     FF_IPFW_GET,
91     FF_IPFW_SET,
92 };
93 
94 struct ff_ipfw_args {
95     int cmd;
96     int level;
97     int optname;
98     void *optval;
99     socklen_t *optlen;
100 };
101 
102 struct ff_traffic_args {
103     uint64_t rx_packets;
104     uint64_t rx_bytes;
105     uint64_t tx_packets;
106     uint64_t tx_bytes;
107 };
108 
109 #define MAX_MSG_BUF_SIZE 10240
110 
111 /* structure of ipc msg */
112 struct ff_msg {
113     enum FF_MSG_TYPE msg_type;
114     /* Result of msg processing */
115     int result;
116     /* Length of segment buffer. */
117     size_t buf_len;
118     /* Address of segment buffer. */
119     char *buf_addr;
120 
121     union {
122         struct ff_sysctl_args sysctl;
123         struct ff_ioctl_args ioctl;
124         struct ff_route_args route;
125         struct ff_top_args top;
126         struct ff_ngctl_args ngctl;
127         struct ff_ipfw_args ipfw;
128         struct ff_traffic_args traffic;
129     };
130 } __attribute__((packed)) __rte_cache_aligned;
131 
132 #endif
133