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 /*
 104  * Converts the Lua value at idx to an in6_addr.
 105  *
 106  * Returns:
 107  *    struct in6_addr allocated with MTYPE_TMP.
 108  */
 109 void *lua_toin6addr(lua_State *L, int idx);
 110
 111 /*
 112  * Converts a time_t to a Lua value and pushes it on the stack.
 113  */
 114 void lua_pushtimet(lua_State *L, const time_t *time);
 115
 116 void lua_decode_timet(lua_State *L, int idx, time_t *time);
 117
 118 /*
 119  * Converts the Lua value at idx to a time_t.
 120  *
 121  * Returns:
 122  *    time_t allocated with MTYPE_TMP.
 123  */
 124 void *lua_totimet(lua_State *L, int idx);
 125
 126 /*
 127  * Converts a sockunion to a Lua value and pushes it on the stack.
 128  */
 129 void lua_pushsockunion(lua_State *L, const union sockunion *su);
 130
 131 void lua_decode_sockunion(lua_State *L, int idx, union sockunion *su);
 132
 133 /*
 134  * Converts the Lua value at idx to a sockunion.
 135  *
 136  * Returns:
 137  *    sockunion allocated with MTYPE_TMP.
 138  */
 139 void *lua_tosockunion(lua_State *L, int idx);
 140
 141 /*
 142  * Converts an int to a Lua value and pushes it on the stack.
 143  */
 144 void lua_pushintegerp(lua_State *L, const long long *num);
 145
 146 void lua_decode_integerp(lua_State *L, int idx, long long *num);
 147
 148 /*
 149  * Converts the Lua value at idx to an int.
 150  *
 151  * Returns:
 152  *    int allocated with MTYPE_TMP.
 153  */
 154 void *lua_tointegerp(lua_State *L, int idx);
 155
 156 void lua_decode_stringp(lua_State *L, int idx, char *str);
 157
 158 /*
 159  * Pop string.
 160  *
 161  * Sets *string to a copy of the string at the top of the stack. The copy is
 162  * allocated with MTYPE_TMP and the caller is responsible for freeing it.
 163  */
 164 void *lua_tostringp(lua_State *L, int idx);
 165
 166 /*
 167  * No-op decoders
 168  */
 169 void lua_decode_noop(lua_State *L, int idx, const void *ptr);
 170
 171 void lua_decode_integer_noop(lua_State *L, int idx, int i);
 172
 173 /*
 174  * Retrieve an integer from table on the top of the stack.
 175  *
 176  * key
 177  *    Key of string value in table
 178  */
 179 int frrlua_table_get_integer(lua_State *L, const char *key);
 180
 181 /*
 182  * Exports a new table containing bindings to FRR zlog functions into the
 183  * global namespace.
 184  *
 185  * From Lua, these functions may be accessed as:
 186  *
 187  * - log.debug()
 188  * - log.info()
 189  * - log.warn()
 190  * - log.error()
 191  *
 192  * They take a single string argument.
 193  */
 194 void frrlua_export_logging(lua_State *L);
 195
 196 /*
 197  * Dump Lua stack to a string.
 198  *
 199  * Return value must be freed with XFREE(MTYPE_TMP, ...);
 200  */
 201 char *frrlua_stackdump(lua_State *L);
 202
 203 #ifdef __cplusplus
 204 }
 205 #endif
 206
 207 #endif /* HAVE_SCRIPTING */
 208
 209 #endif /* __FRRLUA_H__ */