src/vlibapi/api_types_inlines.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 static inline int
  21 vl_api_to_api_string (u32 len, const char *buf, vl_api_string_t * str)
  22 {
  23   clib_memcpy_fast(str->buf, buf, len);
  24   str->length = htonl (len);
  25   return len + sizeof (u32);
  26 }
  27
  28 static inline int
  29 vl_api_vec_to_api_string (const u8 *vec, vl_api_string_t * str)
  30 {
  31   u32 len = vec_len(vec);
  32   clib_memcpy(str->buf, vec, len);
  33   str->length = htonl (len);
  34   return len + sizeof (u32);
  35 }
  36
  37 /* Return a pointer to the API string (not nul terminated */
  38 static inline u8 *
  39 vl_api_from_api_string (vl_api_string_t * astr)
  40 {
  41   return astr->buf;
  42 }
  43
  44 static inline u32
  45 vl_api_string_len (vl_api_string_t * astr)
  46 {
  47   return ntohl (astr->length);
  48 }
  49
  50 /*
  51  * Returns a new vector. Remember to free it after use.
  52  */
  53 static inline u8 *
  54 vl_api_from_api_to_vec (vl_api_string_t *astr)
  55 {
  56   u8 *v = 0;
  57   vec_add(v, astr->buf, ntohl(astr->length));
  58   return v;
  59 }