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
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
|
/*
* 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
/*
* Status enum for Lua routemap processing results
*/
enum frrlua_rm_status {
/*
* Script function run failure. This will translate into a
* deny
*/
LUA_RM_FAILURE = 0,
/*
* No Match was found for the route map function
*/
LUA_RM_NOMATCH,
/*
* Match was found but no changes were made to the
* incoming data.
*/
LUA_RM_MATCH,
/*
* Match was found and data was modified, so
* figure out what changed
*/
LUA_RM_MATCH_AND_CHANGE,
};
/*
* Creates a new Lua state, loads all libraries, and if a script is provided,
* runs it.
*
* Returns:
* The new Lua state.
*/
lua_State *frrlua_initialize(const char *file);
/*
* 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);
/*
* Runs a routemap rule or something
*/
enum frrlua_rm_status frrlua_run_rm_rule(lua_State *L, const char *rule);
/*
* 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);
#ifdef __cplusplus
}
#endif
#endif /* HAVE_LUA */
#endif /* __FRRLUA_H__ */
|
