aboutsummaryrefslogtreecommitdiffstats
path: root/ctrl/sysrepo-plugins/hicn-plugin/plugin/hicn_vpp_comm.h
blob: cb5eefcbe1ed30e5f2b32a1d172b94e0c8e0151a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
/*
 * Copyright (c) 2021 Cisco and/or its affiliates.
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at:
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

/**
 * @file hicn_vpp_comm.h
 * @brief This file contains binary api to connect to the VPP.
 */

#ifndef __HICN_VPP_COMMM_H__
#define __HICN_VPP_COMMM_H__
#include <sysrepo.h>
#include <sysrepo/values.h>
#include <vapi/vapi.h>

#ifndef HICN_THIS_FUNC
#ifdef __FUNCTION__
#define HICN_THIS_FUNC __FUNCTION__
#else
#define HICN_THIS_FUNC __func__
#endif
#endif

/**
 * @brief This is the context to connect to the vpp
 */

extern vapi_ctx_t g_vapi_ctx_instance;

/**
 * @brief This macro is interface.c to communicate with vpp
 */
#define VPP_INTFC_NAME_LEN 64
#define VPP_MAC_ADDRESS_LEN 8
#define VPP_IP6_ADDRESS_LEN 16

/**
 * @brief This macro checks the arg is NULL or not, if the arg is NULL it
 * returns retval
 */
#define ARG_CHECK(retval, arg)                \
  do {                                        \
    if (NULL == (arg)) {                      \
      SRP_LOG_DBGMSG("NULL pointer passed."); \
      return (retval);                        \
    }                                         \
  } while (0)

/**
 * @brief Please check ARG_CHECK
 */
#define ARG_CHECK2(retval, arg1, arg2) \
  ARG_CHECK(retval, arg1);             \
  ARG_CHECK(retval, arg2)

/**
 * @brief This Macro is the multiple check of ARG_CHECK
 */
#define ARG_CHECK5(retval, arg1, arg2, arg3, arg4, arg5) \
  ARG_CHECK(retval, arg1);                               \
  ARG_CHECK(retval, arg2);                               \
  ARG_CHECK(retval, arg3);                               \
  ARG_CHECK(retval, arg4);                               \
  ARG_CHECK(retval, arg5)

/**
 * @brief This function is used to connect to the vpp
 */
int hicn_connect_vpp();
/**
 * @brief This function is used to close the connection of the vpp
 */
int hicn_disconnect_vpp();

#endif  //__HICN_VPP_COMMM_H__