lib/frrlua.h

   1 /*
   2  * Copyright (C) 2016-2019 Cumulus Networks, Inc.
   3  * Donald Sharp, Quentin Young
   4  *
   5  * This program is free software; you can redistribute it and/or modify it
   6  * under the terms of the GNU General Public License as published by the Free
   7  * Software Foundation; either version 2 of the License, or (at your option)
   8  * any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful, but WITHOUT
  11  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  12  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
  13  * more details.
  14  *
  15  * You should have received a copy of the GNU General Public License along
  16  * with this program; see the file COPYING; if not, write to the Free Software
  17  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
  18  */
  19 #ifndef __FRRLUA_H__
  20 #define __FRRLUA_H__
  21
  22 #include <zebra.h>
  23
  24 #ifdef HAVE_SCRIPTING
  25
  26 #include <lua.h>
  27 #include <lualib.h>
  28 #include <lauxlib.h>
  29
  30 #include "prefix.h"
  31 #include "frrscript.h"
  32
  33 #ifdef __cplusplus
  34 extern "C" {
  35 #endif
  36
  37 DECLARE_MTYPE(SCRIPT_RES);
  38
  39 /*
  40  * gcc-10 is complaining about the wrapper function
  41  * not being compatible with lua_pushstring returning
  42  * a char *.  Let's wrapper it here to make our life
  43  * easier
  44  */
  45 static inline void lua_pushstring_wrapper(lua_State *L, const char *str)
  46 {
  47         (void)lua_pushstring(L, str);
  48 }
  49
  50 /*
  51  * Converts a prefix to a Lua value and pushes it on the stack.
  52  */
  53 void lua_pushprefix(lua_State *L, const struct prefix *prefix);
  54
  55 void lua_decode_prefix(lua_State *L, int idx, struct prefix *prefix);
  56
  57 /*
  58  * Converts the Lua value at idx to a prefix.
  59  *
  60  * Returns:
  61  *    struct prefix allocated with MTYPE_TMP
  62  */
  63 void *lua_toprefix(lua_State *L, int idx);
  64
  65 /*
  66  * Converts an interface to a Lua value and pushes it on the stack.
  67  */
  68 void lua_pushinterface(lua_State *L, const struct interface *ifp);
  69
  70 void lua_decode_interface(lua_State *L, int idx, struct interface *ifp);
  71
  72 /*
  73  * Converts the Lua value at idx to an interface.
  74  *
  75  * Returns:
  76  *    struct interface allocated with MTYPE_TMP. This interface is not hooked
  77  *    to anything, nor is it inserted in the global interface tree.
  78  */
  79 void *lua_tointerface(lua_State *L, int idx);
  80
  81 /*
  82  * Converts an in_addr to a Lua value and pushes it on the stack.
  83  */
  84 void lua_pushinaddr(lua_State *L, const struct in_addr *addr);
  85
  86 void lua_decode_inaddr(lua_State *L, int idx, struct in_addr *addr);
  87
  88 /*
  89  * Converts the Lua value at idx to an in_addr.
  90  *
  91  * Returns:
  92  *    struct in_addr allocated with MTYPE_TMP.
  93  */
  94 void *lua_toinaddr(lua_State *L, int idx);
  95
  96 /*
  97  * Converts an in6_addr to a Lua value and pushes it on the stack.
  98  */
  99 void lua_pushin6addr(lua_State *L, const struct in6_addr *addr);
 100
 101 void lua_decode_in6addr(lua_State *L, int idx, struct in6_addr *addr);
 102
 103 void lua_pushipaddr(lua_State *L, const struct ipaddr *addr);
 104
 105 void lua_pushethaddr(lua_State *L, const struct ethaddr *addr);
 106
 107 /*
 108  * Converts the Lua value at idx to an in6_addr.
 109  *
 110  * Returns:
 111  *    struct in6_addr allocated with MTYPE_TMP.
 112  */
 113 void *lua_toin6addr(lua_State *L, int idx);
 114
 115 /*
 116  * Converts a time_t to a Lua value and pushes it on the stack.
 117  */
 118 void lua_pushtimet(lua_State *L, const time_t *time);
 119
 120 void lua_decode_timet(lua_State *L, int idx, time_t *time);
 121
 122 /*
 123  * Converts the Lua value at idx to a time_t.
 124  *
 125  * Returns:
 126  *    time_t allocated with MTYPE_TMP.
 127  */
 128 void *lua_totimet(lua_State *L, int idx);
 129
 130 /*
 131  * Converts a sockunion to a Lua value and pushes it on the stack.
 132  */
 133 void lua_pushsockunion(lua_State *L, const union sockunion *su);
 134
 135 void lua_decode_sockunion(lua_State *L, int idx, union sockunion *su);
 136
 137 /*
 138  * Converts the Lua value at idx to a sockunion.
 139  *
 140  * Returns:
 141  *    sockunion allocated with MTYPE_TMP.
 142  */
 143 void *lua_tosockunion(lua_State *L, int idx);
 144
 145 void lua_pushnexthop_group(lua_State *L, const struct nexthop_group *ng);
 146
 147 void lua_pushnexthop(lua_State *L, const struct nexthop *nexthop);
 148
 149 /*
 150  * Converts an int to a Lua value and pushes it on the stack.
 151  */
 152 void lua_pushintegerp(lua_State *L, const long long *num);
 153
 154 void lua_decode_integerp(lua_State *L, int idx, long long *num);
 155
 156 /*
 157  * Converts the Lua value at idx to an int.
 158  *
 159  * Returns:
 160  *    int allocated with MTYPE_TMP.
 161  */
 162 void *lua_tointegerp(lua_State *L, int idx);
 163
 164 void lua_decode_stringp(lua_State *L, int idx, char *str);
 165
 166 /*
 167  * Pop string.
 168  *
 169  * Sets *string to a copy of the string at the top of the stack. The copy is
 170  * allocated with MTYPE_TMP and the caller is responsible for freeing it.
 171  */
 172 void *lua_tostringp(lua_State *L, int idx);
 173
 174 /*
 175  * No-op decoders
 176  */
 177 void lua_decode_noop(lua_State *L, int idx, const void *ptr);
 178
 179 void lua_decode_integer_noop(lua_State *L, int idx, int i);
 180
 181 /*
 182  * Retrieve an integer from table on the top of the stack.
 183  *
 184  * key
 185  *    Key of string value in table
 186  */
 187 int frrlua_table_get_integer(lua_State *L, const char *key);
 188
 189 /*
 190  * Exports a new table containing bindings to FRR zlog functions into the
 191  * global namespace.
 192  *
 193  * From Lua, these functions may be accessed as:
 194  *
 195  * - log.debug()
 196  * - log.info()
 197  * - log.warn()
 198  * - log.error()
 199  *
 200  * They take a single string argument.
 201  */
 202 void frrlua_export_logging(lua_State *L);
 203
 204 /*
 205  * Dump Lua stack to a string.
 206  *
 207  * Return value must be freed with XFREE(MTYPE_TMP, ...);
 208  */
 209 char *frrlua_stackdump(lua_State *L);
 210
 211 #ifdef __cplusplus
 212 }
 213 #endif
 214
 215 #endif /* HAVE_SCRIPTING */
 216
 217 #endif /* __FRRLUA_H__ */