lib: add Lua stack dumper

[mirror_frr.git] / lib / frrlua.h

/*
 * 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__

#if defined(HAVE_LUA)

#include "lua.h"
#include "lualib.h"
#include "lauxlib.h"

#include "prefix.h"

#ifdef __cplusplus
extern "C" {
#endif

/*
 * Pushes a new table containing relevant fields from a prefix structure.
 *
 * Additionally sets the global variable "prefix" to point at this table.
 */
void frrlua_newtable_prefix(lua_State *L, const struct prefix *prefix);

/*
 * Pushes a new table containing relevant fields from an interface structure.
 */
void frrlua_newtable_interface(lua_State *L, const struct interface *ifp);

/*
 * Retrieve a string from table on the top of the stack.
 *
 * key
 *    Key of string value in table
 */
const char *frrlua_table_get_string(lua_State *L, const char *key);

/*
 * 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_LUA */
#endif /* __FRRLUA_H__ */