FD.io VPP  v20.01-27-g58d2ba355
Vector Packet Processing
stn_api.c
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2017 Cisco and/or its affiliates.
3  * Licensed under the Apache License, Version 2.0 (the "License");
4  * you may not use this file except in compliance with the License.
5  * You may obtain a copy of the License at:
6  *
7  * http://www.apache.org/licenses/LICENSE-2.0
8  *
9  * Unless required by applicable law or agreed to in writing, software
10  * distributed under the License is distributed on an "AS IS" BASIS,
11  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12  * See the License for the specific language governing permissions and
13  * limitations under the License.
14  */
15 
16 #include <vlibapi/api.h>
17 #include <vlibmemory/api.h>
18 
19 #include <plugins/stn/stn.h>
20 #include <vnet/ip/format.h>
21 #include <vnet/format_fns.h>
22 #include <vnet/ip/ip_types_api.h>
23 #include <vppinfra/byte_order.h>
24 
25 /* define message IDs */
26 #include <stn/stn.api_enum.h>
27 #include <stn/stn.api_types.h>
28 
29 #define REPLY_MSG_ID_BASE stn_main.msg_id_base
31 
32 #define vl_print(handle, ...) vlib_cli_output (handle, __VA_ARGS__)
33 /* Macro to finish up custom dump fns */
34 #define FINISH \
35  vec_add1 (s, 0); \
36  vl_print (handle, (char *)s); \
37  vec_free (s); \
38  return handle;
39 
40 /**
41  * @brief API message custom-dump function
42  * @param mp vl_api_stn_add_del_rule_t * mp the api message
43  * @param handle void * print function handle
44  * @returns u8 * output string
45  */
47  (vl_api_stn_add_del_rule_t * mp, void *handle)
48 {
49  u8 *s;
50 
51  s = format (0, "SCRIPT: stn_add_del_rule ");
52  s = format (s, "address %U ", format_ip46_address, mp->ip_address);
53  s = format (s, "sw_if_index %d is_add %d", mp->sw_if_index, mp->is_add);
54 
55  FINISH;
56 }
57 
58 static void
60 {
62  vl_api_stn_add_del_rule_reply_t *rmp;
63  int rv = 0;
64 
65  ip_address_decode (&mp->ip_address, &args.address);
66  args.sw_if_index = clib_net_to_host_u32 (mp->sw_if_index);
67  args.del = !mp->is_add;
68 
69  rv = stn_rule_add_del (&args);
70 
71  REPLY_MACRO (VL_API_STN_ADD_DEL_RULE_REPLY);
72 }
73 
74 static void
76  u32 context)
77 {
79 
80  rmp = vl_msg_api_alloc (sizeof (*rmp));
81  clib_memset (rmp, 0, sizeof (*rmp));
82  rmp->_vl_msg_id =
83  clib_host_to_net_u16 (VL_API_STN_RULES_DETAILS + stn_main.msg_id_base);
84 
87  IP46_TYPE_IP6, &rmp->ip_address);
88  rmp->context = context;
89  rmp->sw_if_index = clib_host_to_net_u32 (r->sw_if_index);
90 
91  vl_api_send_msg (reg, (u8 *) rmp);
92 }
93 
94 static void
96 {
98  stn_main_t *stn = &stn_main;
99  stn_rule_t *r;
100 
102  if (reg == 0)
103  return;
104 
105  /* *INDENT-OFF* */
106  pool_foreach (r, stn->rules,({
107  send_stn_rules_details (r, reg, mp->context);
108  }));
109  /* *INDENT-ON* */
110 }
111 
112 #include <stn/stn.api.c>
113 clib_error_t *
115 {
116  /* Ask for a correctly-sized block of API message decode slots */
118 
119  return 0;
120 }
121 
122 /*
123  * fd.io coding-style-patch-verification: ON
124  *
125  * Local Variables:
126  * eval: (c-set-style "gnu")
127  * End:
128  */
Definition: stn.h:24
clib_memset(h->entries, 0, sizeof(h->entries[0]) *entries)
static void vl_api_send_msg(vl_api_registration_t *rp, u8 *elem)
Definition: api.h:35
Definition: stn.h:30
u32 sw_if_index
TX interface to send packets to.
Definition: stn.h:50
int stn_rule_add_del(stn_rule_add_del_args_t *args)
Add or delete an stn rule.
Definition: stn.c:286
u8 * format(u8 *s, const char *fmt,...)
Definition: format.c:424
static u8 ip46_address_is_ip4(const ip46_address_t *ip46)
Definition: ip46_address.h:55
stn_main_t stn_main
Definition: stn.c:25
void * vl_msg_api_alloc(int nbytes)
Dump STN rules.
Definition: stn.api:45
unsigned char u8
Definition: types.h:56
ip46_address_t address
Destination address of intercepted packets.
Definition: stn.h:48
Add/del STN rules.
Definition: stn.api:33
stn_rule_t * rules
Definition: stn.h:32
#define pool_foreach(VAR, POOL, BODY)
Iterate through pool.
Definition: pool.h:498
u8 del
Whether to delete the rule.
Definition: stn.h:52
unsigned int u32
Definition: types.h:88
ip46_type_t ip_address_decode(const vl_api_address_t *in, ip46_address_t *out)
Definition: ip_types_api.c:161
vl_api_interface_index_t sw_if_index
Definition: stn.api:59
vl_api_interface_index_t sw_if_index
Definition: stn.api:37
static void vl_api_stn_add_del_rule_t_handler(vl_api_stn_add_del_rule_t *mp)
Definition: stn_api.c:59
STN response to rules request.
Definition: stn.api:56
static void vl_api_stn_rules_dump_t_handler(vl_api_stn_rules_dump_t *mp)
Definition: stn_api.c:95
#define REPLY_MACRO(t)
vlib_main_t * vm
Definition: in2out_ed.c:1810
vl_api_address_t ip_address
Definition: stn.api:36
format_function_t format_ip46_address
Definition: ip46_address.h:50
An API client registration, only in vpp/vlib.
Definition: api_common.h:46
vl_api_address_t ip_address
Definition: stn.api:58
static vl_api_registration_t * vl_api_client_index_to_registration(u32 index)
Definition: api.h:57
static void * vl_api_stn_add_del_rule_t_print(vl_api_stn_add_del_rule_t *mp, void *handle)
API message custom-dump function.
Definition: stn_api.c:47
u16 msg_id_base
Definition: stn.h:43
u32 sw_if_index
Definition: stn.h:27
void ip_address_encode(const ip46_address_t *in, ip46_type_t type, vl_api_address_t *out)
Definition: ip_types_api.c:178
clib_error_t * stn_api_init(vlib_main_t *vm, stn_main_t *sm)
Definition: stn_api.c:114
#define FINISH
Definition: stn_api.c:34
ip46_address_t address
Definition: stn.h:25
static void setup_message_id_table(snat_main_t *sm, api_main_t *am)
Definition: nat_api.c:3410
static void send_stn_rules_details(stn_rule_t *r, vl_api_registration_t *reg, u32 context)
Definition: stn_api.c:75