src/vlibapi/api_types.h

   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 <stdbool.h>
  24
  25 #include <vppinfra/types.h>
  26 #include <arpa/inet.h>
  27 #include <string.h>
  28
  29 /* VPP API string type */
  30 typedef struct
  31 {
  32   u32 length;
  33   u8 buf[0];
  34 } __attribute__ ((packed)) vl_api_string_t;
  35
  36 static inline int
  37 vl_api_to_api_string (u32 len, const char *buf, vl_api_string_t * str)
  38 {
  39   memcpy(str->buf, buf, len);
  40   str->length = htonl (len);
  41   return len + sizeof (u32);
  42 }
  43
  44 /* Return a pointer to the API string (not nul terminated) */
  45 static inline u8 *
  46 vl_api_from_api_string (vl_api_string_t * astr)
  47 {
  48   return astr->buf;
  49 }
  50
  51 static inline u32
  52 vl_api_string_len (vl_api_string_t * astr)
  53 {
  54   return ntohl (astr->length);
  55 }
  56
  57 static inline char *
  58 vl_api_from_api_string_c (vl_api_string_t *astr)
  59 {
  60   return strndup((char *)astr->buf, ntohl (astr->length));
  61 }
  62
  63 #endif