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 <vppinfra/types.h>
  24
  25 /* VPP API string type */
  26 typedef struct
  27 {
  28   u32 length;
  29   u8 buf[0];
  30 } __attribute__ ((packed)) vl_api_string_t;
  31
  32 static inline int
  33 vl_api_to_api_string (u32 len, const char *buf, vl_api_string_t * str)
  34 {
  35   if (strncpy_s ((char *) str->buf, len, buf, len - 1) != 0)
  36     len = 0;
  37   str->length = clib_host_to_net_u32 (len);
  38   return len + sizeof (u32);
  39 }
  40
  41 /* Return a C string from API string */
  42 static inline u8 *
  43 vl_api_from_api_string (vl_api_string_t * astr)
  44 {
  45   return astr->buf;
  46 }
  47
  48 static inline u32
  49 vl_api_string_len (vl_api_string_t * astr)
  50 {
  51   return clib_net_to_host_u32 (astr->length);
  52 }
  53
  54 #endif