summaryrefslogtreecommitdiff
path: root/lib/frrscript.h
diff options
context:
space:
mode:
Diffstat (limited to 'lib/frrscript.h')
-rw-r--r--lib/frrscript.h84
1 files changed, 84 insertions, 0 deletions
diff --git a/lib/frrscript.h b/lib/frrscript.h
new file mode 100644
index 0000000000..2988d90aa8
--- /dev/null
+++ b/lib/frrscript.h
@@ -0,0 +1,84 @@
+/* Scripting foo
+ * Copyright (C) 2020 NVIDIA Corporation
+ * 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 __FRRSCRIPT_H__
+#define __FRRSCRIPT_H__
+
+#include "frrlua.h"
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+#define FRRSCRIPT_PATH "/etc/frr/scripts"
+
+struct frrscript {
+ /* Script name */
+ char *name;
+
+ /* Lua state */
+ struct lua_State *L;
+};
+
+
+/*
+ * Create new FRR script.
+ */
+struct frrscript *frrscript_load(const char *name,
+ int (*load_cb)(struct frrscript *));
+
+/*
+ * Destroy FRR script.
+ */
+void frrscript_unload(struct frrscript *fs);
+
+/*
+ * Register a Lua encoder for a type.
+ *
+ * tname
+ * Name of type; e.g., "peer", "ospf_interface", etc. Chosen at will.
+ *
+ * encoder
+ * Function pointer to encoder function. Encoder function should push a Lua
+ * table representing the passed argument - which will have the C type
+ * associated with the chosen 'tname' to the provided stack.
+ *
+ */
+void frrscript_register_type_encoder(const char *tname,
+ int (*encoder)(lua_State *, void *));
+
+/*
+ * Initialize scripting subsystem. Call this before anything else.
+ */
+void frrscript_init(void);
+
+/*
+ * Forward decl for frrscript_lua_call
+ */
+int frrscript_lua_call(struct frrscript *fs, ...);
+
+/*
+ * Call FRR script.
+ */
+#define frrscript_call(fs, ...) frrscript_lua_call((fs), __VA_ARGS__)
+
+#ifdef __cplusplus
+}
+#endif /* __cplusplus */
+
+#endif /* __FRRSCRIPT_H__ */