FD.io VPP  v19.01.3-6-g70449b9b9
Vector Packet Processing
api_types.h
Go to the documentation of this file.
1 /*
2  *------------------------------------------------------------------
3  * api_types.h
4  *
5  * Copyright (c) 2018 Cisco 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 #ifndef included_api_types_h
21 #define included_api_types_h
22 
23 #include <vppinfra/types.h>
24 #include <arpa/inet.h>
25 #include <string.h>
26 
27 /* VPP API string type */
28 typedef struct
29 {
31  u8 buf[0];
32 } __attribute__ ((packed)) vl_api_string_t;
33 
34 static inline int
35 vl_api_to_api_string (u32 len, const char *buf, vl_api_string_t * str)
36 {
37  memcpy(str->buf, buf, len);
38  str->length = htonl (len);
39  return len + sizeof (u32);
40 }
41 
42 /* Return a pointer to the API string (not nul terminated */
43 static inline u8 *
45 {
46  return astr->buf;
47 }
48 
49 static inline u32
51 {
52  return ntohl (astr->length);
53 }
54 
55 static inline char *
57 {
58  return strndup((char *)astr->buf, ntohl (astr->length));
59 }
60 
61 #endif
static char * vl_api_from_api_string_c(vl_api_string_t *astr)
Definition: api_types.h:56
Optimized string handling code, including c11-compliant "safe C library" variants.
static int vl_api_to_api_string(u32 len, const char *buf, vl_api_string_t *str)
Definition: api_types.h:35
unsigned char u8
Definition: types.h:56
unsigned int u32
Definition: types.h:88
u8 len
Definition: ip_types.api:49
static u32 vl_api_string_len(vl_api_string_t *astr)
Definition: api_types.h:50
static u8 * vl_api_from_api_string(vl_api_string_t *astr)
Definition: api_types.h:44