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