xref: /f-stack/lib/ff_msg.h (revision 8cf1d457)
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 };
44 
45 struct ff_sysctl_args {
46     int *name;
47     unsigned namelen;
48     void *old;
49     size_t *oldlenp;
50     void *new;
51     size_t newlen;
52 };
53 
54 struct ff_ioctl_args {
55     unsigned long cmd;
56     void *data;
57 };
58 
59 struct ff_route_args {
60     int fib;
61     unsigned len;
62     unsigned maxlen;
63     void *data;
64 };
65 
66 struct ff_top_args {
67     unsigned long loops;
68     unsigned long idle_tsc;
69     unsigned long work_tsc;
70     unsigned long sys_tsc;
71     unsigned long usr_tsc;
72 };
73 
74 #define MAX_MSG_BUF_SIZE 10240
75 
76 /* structure of ipc msg */
77 struct ff_msg {
78     enum FF_MSG_TYPE msg_type;
79     /* Result of msg processing */
80     int result;
81     /* Length of segment buffer. */
82     size_t buf_len;
83     /* Address of segment buffer. */
84     char *buf_addr;
85 
86     union {
87         struct ff_sysctl_args sysctl;
88         struct ff_ioctl_args ioctl;
89         struct ff_route_args route;
90         struct ff_top_args top;
91     };
92 } __attribute__((packed)) __rte_cache_aligned;
93 
94 #endif
95