mirror of
				https://git.proxmox.com/git/mirror_frr
				synced 2025-10-31 10:56:49 +00:00 
			
		
		
		
	 fa22080d22
			
		
	
	
		fa22080d22
		
	
	
	
	
		
			
			And also guard all scripting-related stuff with HAVE_SCRIPTING. Signed-off-by: Quentin Young <qlyoung@nvidia.com>
		
			
				
	
	
		
			174 lines
		
	
	
		
			4.0 KiB
		
	
	
	
		
			C
		
	
	
	
	
	
			
		
		
	
	
			174 lines
		
	
	
		
			4.0 KiB
		
	
	
	
		
			C
		
	
	
	
	
	
| /*
 | |
|  * Copyright (C) 2016-2019 Cumulus Networks, Inc.
 | |
|  * Donald Sharp, Quentin Young
 | |
|  *
 | |
|  * This program is free software; you can redistribute it and/or modify it
 | |
|  * under the terms of the GNU General Public License as published by the Free
 | |
|  * Software Foundation; either version 2 of the License, or (at your option)
 | |
|  * any later version.
 | |
|  *
 | |
|  * This program is distributed in the hope that it will be useful, but WITHOUT
 | |
|  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 | |
|  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
 | |
|  * more details.
 | |
|  *
 | |
|  * You should have received a copy of the GNU General Public License along
 | |
|  * with this program; see the file COPYING; if not, write to the Free Software
 | |
|  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
 | |
|  */
 | |
| #ifndef __FRRLUA_H__
 | |
| #define __FRRLUA_H__
 | |
| 
 | |
| #include <zebra.h>
 | |
| 
 | |
| #ifdef HAVE_SCRIPTING
 | |
| 
 | |
| #include <lua.h>
 | |
| #include <lualib.h>
 | |
| #include <lauxlib.h>
 | |
| 
 | |
| #include "prefix.h"
 | |
| #include "frrscript.h"
 | |
| 
 | |
| #ifdef __cplusplus
 | |
| extern "C" {
 | |
| #endif
 | |
| 
 | |
| /*
 | |
|  * Converts a prefix to a Lua value and pushes it on the stack.
 | |
|  */
 | |
| void lua_pushprefix(lua_State *L, const struct prefix *prefix);
 | |
| 
 | |
| /*
 | |
|  * Converts the Lua value at idx to a prefix.
 | |
|  *
 | |
|  * Returns:
 | |
|  *    struct prefix allocated with MTYPE_TMP
 | |
|  */
 | |
| void *lua_toprefix(lua_State *L, int idx);
 | |
| 
 | |
| /*
 | |
|  * Converts an interface to a Lua value and pushes it on the stack.
 | |
|  */
 | |
| void lua_pushinterface(lua_State *L, const struct interface *ifp);
 | |
| 
 | |
| /*
 | |
|  * Converts the Lua value at idx to an interface.
 | |
|  *
 | |
|  * Returns:
 | |
|  *    struct interface allocated with MTYPE_TMP. This interface is not hooked
 | |
|  *    to anything, nor is it inserted in the global interface tree.
 | |
|  */
 | |
| void *lua_tointerface(lua_State *L, int idx);
 | |
| 
 | |
| /*
 | |
|  * Converts an in_addr to a Lua value and pushes it on the stack.
 | |
|  */
 | |
| void lua_pushinaddr(lua_State *L, const struct in_addr *addr);
 | |
| 
 | |
| /*
 | |
|  * Converts the Lua value at idx to an in_addr.
 | |
|  *
 | |
|  * Returns:
 | |
|  *    struct in_addr allocated with MTYPE_TMP.
 | |
|  */
 | |
| void *lua_toinaddr(lua_State *L, int idx);
 | |
| 
 | |
| /*
 | |
|  * Converts an in6_addr to a Lua value and pushes it on the stack.
 | |
|  */
 | |
| void lua_pushin6addr(lua_State *L, const struct in6_addr *addr);
 | |
| 
 | |
| /*
 | |
|  * Converts the Lua value at idx to an in6_addr.
 | |
|  *
 | |
|  * Returns:
 | |
|  *    struct in6_addr allocated with MTYPE_TMP.
 | |
|  */
 | |
| void *lua_toin6addr(lua_State *L, int idx);
 | |
| 
 | |
| /*
 | |
|  * Converts a time_t to a Lua value and pushes it on the stack.
 | |
|  */
 | |
| void lua_pushtimet(lua_State *L, const time_t *time);
 | |
| 
 | |
| /*
 | |
|  * Converts the Lua value at idx to a time_t.
 | |
|  *
 | |
|  * Returns:
 | |
|  *    time_t allocated with MTYPE_TMP.
 | |
|  */
 | |
| void *lua_totimet(lua_State *L, int idx);
 | |
| 
 | |
| /*
 | |
|  * Converts a sockunion to a Lua value and pushes it on the stack.
 | |
|  */
 | |
| void lua_pushsockunion(lua_State *L, const union sockunion *su);
 | |
| 
 | |
| /*
 | |
|  * Converts the Lua value at idx to a sockunion.
 | |
|  *
 | |
|  * Returns:
 | |
|  *    sockunion allocated with MTYPE_TMP.
 | |
|  */
 | |
| void *lua_tosockunion(lua_State *L, int idx);
 | |
| 
 | |
| /*
 | |
|  * Converts an int to a Lua value and pushes it on the stack.
 | |
|  */
 | |
| void lua_pushintegerp(lua_State *L, const long long *num);
 | |
| 
 | |
| /*
 | |
|  * Converts the Lua value at idx to an int.
 | |
|  *
 | |
|  * Returns:
 | |
|  *    int allocated with MTYPE_TMP.
 | |
|  */
 | |
| void *lua_tointegerp(lua_State *L, int idx);
 | |
| 
 | |
| /*
 | |
|  * Pop string.
 | |
|  *
 | |
|  * Sets *string to a copy of the string at the top of the stack. The copy is
 | |
|  * allocated with MTYPE_TMP and the caller is responsible for freeing it.
 | |
|  */
 | |
| void *lua_tostringp(lua_State *L, int idx);
 | |
| 
 | |
| /*
 | |
|  * Retrieve an integer from table on the top of the stack.
 | |
|  *
 | |
|  * key
 | |
|  *    Key of string value in table
 | |
|  */
 | |
| int frrlua_table_get_integer(lua_State *L, const char *key);
 | |
| 
 | |
| /*
 | |
|  * Exports a new table containing bindings to FRR zlog functions into the
 | |
|  * global namespace.
 | |
|  *
 | |
|  * From Lua, these functions may be accessed as:
 | |
|  *
 | |
|  * - log.debug()
 | |
|  * - log.info()
 | |
|  * - log.warn()
 | |
|  * - log.error()
 | |
|  *
 | |
|  * They take a single string argument.
 | |
|  */
 | |
| void frrlua_export_logging(lua_State *L);
 | |
| 
 | |
| /*
 | |
|  * Dump Lua stack to a string.
 | |
|  *
 | |
|  * Return value must be freed with XFREE(MTYPE_TMP, ...);
 | |
|  */
 | |
| char *frrlua_stackdump(lua_State *L);
 | |
| 
 | |
| #ifdef __cplusplus
 | |
| }
 | |
| #endif
 | |
| 
 | |
| #endif /* HAVE_SCRIPTING */
 | |
| 
 | |
| #endif /* __FRRLUA_H__ */
 |