FD.io VPP  v21.01.1
Vector Packet Processing
pppoe_api.c
Go to the documentation of this file.
1 /*
2  *------------------------------------------------------------------
3  * pppoe_api.c - pppoe api
4  *
5  * Copyright (c) 2017 Intel and/or its affiliates.
6  * Licensed under the Apache License, Version 2.0 (the "License");
7  * you may not use this file except in compliance with the License.
8  * You may obtain a copy of the License at:
9  *
10  * http://www.apache.org/licenses/LICENSE-2.0
11  *
12  * Unless required by applicable law or agreed to in writing, software
13  * distributed under the License is distributed on an "AS IS" BASIS,
14  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15  * See the License for the specific language governing permissions and
16  * limitations under the License.
17  *------------------------------------------------------------------
18  */
19 
20 #include <vnet/interface.h>
21 #include <vnet/api_errno.h>
22 #include <vnet/feature/feature.h>
23 #include <vnet/fib/fib_table.h>
24 #include <vnet/ip/ip_types_api.h>
25 #include <vppinfra/byte_order.h>
26 #include <vlibmemory/api.h>
27 
28 
29 #include <pppoe/pppoe.h>
30 
31 #include <vnet/format_fns.h>
32 #include <pppoe/pppoe.api_enum.h>
33 #include <pppoe/pppoe.api_types.h>
34 
35 #define REPLY_MSG_ID_BASE pem->msg_id_base
37 
40 {
42  int rv = 0;
43  u32 decap_fib_index;
44  ip4_main_t *im = &ip4_main;
45  pppoe_main_t *pem = &pppoe_main;
46 
47  uword *p = hash_get (im->fib_index_by_table_id, ntohl (mp->decap_vrf_id));
48  if (!p)
49  {
50  rv = VNET_API_ERROR_NO_SUCH_INNER_FIB;
51  goto out;
52  }
53  decap_fib_index = p[0];
54 
56  .is_add = mp->is_add,
57  .decap_fib_index = decap_fib_index,
58  .session_id = ntohs (mp->session_id),
59  };
61  clib_memcpy (a.client_mac, mp->client_mac, 6);
62 
63  u32 sw_if_index = ~0;
64  rv = vnet_pppoe_add_del_session (&a, &sw_if_index);
65 
66 out:
67  /* *INDENT-OFF* */
68  REPLY_MACRO2(VL_API_PPPOE_ADD_DEL_SESSION_REPLY,
69  ({
70  rmp->sw_if_index = ntohl (sw_if_index);
71  }));
72  /* *INDENT-ON* */
73 }
74 
77 {
79  ip4_main_t *im4 = &ip4_main;
80  ip6_main_t *im6 = &ip6_main;
82 
83  rmp = vl_msg_api_alloc (sizeof (*rmp));
84  clib_memset (rmp, 0, sizeof (*rmp));
85  rmp->_vl_msg_id = ntohs (VL_API_PPPOE_SESSION_DETAILS);
87  &rmp->client_ip);
88 
89  if (is_ipv6)
90  {
91  rmp->decap_vrf_id = htonl (im6->fibs[t->decap_fib_index].ft_table_id);
92  }
93  else
94  {
95  rmp->decap_vrf_id = htonl (im4->fibs[t->decap_fib_index].ft_table_id);
96  }
97  rmp->session_id = htons (t->session_id);
98  rmp->encap_if_index = htonl (t->encap_if_index);
99  clib_memcpy (rmp->local_mac, t->local_mac, 6);
100  clib_memcpy (rmp->client_mac, t->client_mac, 6);
101  rmp->sw_if_index = htonl (t->sw_if_index);
102  rmp->context = context;
103 
104  vl_api_send_msg (reg, (u8 *) rmp);
105 }
106 
107 static void
109 {
111  pppoe_main_t *pem = &pppoe_main;
112  pppoe_session_t *t;
114 
116  if (!reg)
117  return;
118 
119  sw_if_index = ntohl (mp->sw_if_index);
120 
121  if (~0 == sw_if_index)
122  {
123  /* *INDENT-OFF* */
124  pool_foreach (t, pem->sessions)
125  {
126  send_pppoe_session_details(t, reg, mp->context);
127  }
128  /* *INDENT-ON* */
129  }
130  else
131  {
132  if ((sw_if_index >= vec_len (pem->session_index_by_sw_if_index)) ||
133  (~0 == pem->session_index_by_sw_if_index[sw_if_index]))
134  {
135  return;
136  }
138  send_pppoe_session_details (t, reg, mp->context);
139  }
140 }
141 
142 static void
144 {
146  i32 rv = 0;
147  pppoe_main_t *pem = &pppoe_main;
148 
149  rv = pppoe_add_del_cp (ntohl (mp->sw_if_index), mp->is_add);
150 
151  /* *INDENT-OFF* */
152  REPLY_MACRO(VL_API_PPPOE_ADD_DEL_CP_REPLY);
153  /* *INDENT-ON* */
154 }
155 
156 #include <pppoe/pppoe.api.c>
157 static clib_error_t *
159 {
160  pppoe_main_t *pem = &pppoe_main;
161 
163  return 0;
164 }
165 
167 
168 /*
169  * fd.io coding-style-patch-verification: ON
170  *
171  * Local Variables:
172  * eval: (c-set-style "gnu")
173  * End:
174  */
a
Definition: bitmap.h:544
#define ntohs(x)
Definition: af_xdp.bpf.c:29
vl_api_mac_address_t local_mac
Definition: pppoe.api:85
#define pool_foreach(VAR, POOL)
Iterate through pool.
Definition: pool.h:527
u32 encap_if_index
Definition: pppoe.h:61
u16 session_id
Definition: pppoe.h:55
#define REPLY_MACRO2(t, body)
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
u16 msg_id_base
Definition: pppoe.h:173
vl_api_interface_index_t sw_if_index
Definition: pppoe.api:80
int pppoe_add_del_cp(u32 cp_if_index, u8 is_add)
Definition: pppoe_cp.c:21
Set or delete an PPPOE session.
Definition: pppoe.api:30
vlib_main_t * vm
Definition: in2out_ed.c:1580
static u8 ip46_address_is_ip4(const ip46_address_t *ip46)
Definition: ip46_address.h:55
void * vl_msg_api_alloc(int nbytes)
unsigned char u8
Definition: types.h:56
#define clib_memcpy(d, s, n)
Definition: string.h:180
vl_api_address_t client_ip
Definition: pppoe.api:36
static clib_error_t * pppoe_api_hookup(vlib_main_t *vm)
Definition: pppoe_api.c:158
reply for create PPPOE control plane interface
Definition: pppoe.api:107
static void vl_api_pppoe_add_del_cp_t_handler(vl_api_pppoe_add_del_cp_t *mp)
Definition: pppoe_api.c:143
unsigned int u32
Definition: types.h:88
vl_api_interface_index_t encap_if_index
Definition: pppoe.api:83
vl_api_mac_address_t client_mac
Definition: pppoe.api:38
ip46_type_t ip_address_decode(const vl_api_address_t *in, ip46_address_t *out)
Decode/Encode for struct/union types.
Definition: ip_types_api.c:186
Dump PPPOE session.
Definition: pppoe.api:59
#define hash_get(h, key)
Definition: hash.h:249
vl_api_address_t client_ip
Definition: pppoe.api:82
uword * fib_index_by_table_id
Hash table mapping table id to fib index.
Definition: ip4.h:133
ip46_address_t client_ip
Definition: pppoe.h:58
#define REPLY_MACRO(t)
ip6_main_t ip6_main
Definition: ip6_forward.c:2785
vl_api_interface_index_t sw_if_index
Definition: pppoe.api:51
pppoe_main_t pppoe_main
Definition: pppoe.c:38
An API client registration, only in vpp/vlib.
Definition: api_common.h:47
Create PPPOE control plane interface.
Definition: pppoe.api:95
static void setup_message_id_table(api_main_t *am)
Definition: bfd_api.c:409
u32 ft_table_id
Table ID (hash key) for this FIB.
Definition: fib_table.h:92
static void send_pppoe_session_details(pppoe_session_t *t, vl_api_registration_t *reg, u32 context)
Definition: pppoe_api.c:76
static vl_api_registration_t * vl_api_client_index_to_registration(u32 index)
Definition: api.h:79
static void vl_api_pppoe_session_dump_t_handler(vl_api_pppoe_session_dump_t *mp)
Definition: pppoe_api.c:108
pppoe_session_t * sessions
Definition: pppoe.h:155
dump details of an PPPOE session
Definition: pppoe.api:77
signed int i32
Definition: types.h:77
IPv4 main type.
Definition: ip4.h:107
u32 sw_if_index
Definition: pppoe.h:70
u8 client_mac[6]
Definition: pppoe.h:67
u32 * session_index_by_sw_if_index
Definition: pppoe.h:167
int vnet_pppoe_add_del_session(vnet_pppoe_add_del_session_args_t *a, u32 *sw_if_indexp)
Definition: pppoe.c:288
vl_api_mac_address_t client_mac
Definition: pppoe.api:86
vl_api_interface_index_t sw_if_index
Definition: pppoe.api:63
#define vec_len(v)
Number of elements in vector (rvalue-only, NULL tolerant)
u32 decap_fib_index
FIB indices - inner IP packet lookup here.
Definition: pppoe.h:64
u64 uword
Definition: types.h:112
void ip_address_encode(const ip46_address_t *in, ip46_type_t type, vl_api_address_t *out)
Definition: ip_types_api.c:220
ip4_main_t ip4_main
Global ip4 main structure.
Definition: ip4_forward.c:1105
struct fib_table_t_ * fibs
Vector of FIBs.
Definition: ip4.h:112
bool is_ipv6
Definition: dhcp.api:202
u8 local_mac[6]
Definition: pppoe.h:66
reply for set or delete an PPPOE session
Definition: pppoe.api:47
VLIB_API_INIT_FUNCTION(pppoe_api_hookup)
struct fib_table_t_ * fibs
Definition: ip6.h:115
vl_api_interface_index_t sw_if_index
Definition: wireguard.api:34
vl_api_interface_index_t sw_if_index
Definition: pppoe.api:99
static void vl_api_pppoe_add_del_session_t_handler(vl_api_pppoe_add_del_session_t *mp)
Definition: pppoe_api.c:39