proxmox-mirrors/mirror_frr
1
0
Fork 0
mirror of https://git.proxmox.com/git/mirror_frr synced 2025-08-10 05:05:26 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

lib: Comment functions

Browse Source 
Signed-off-by: Donald Lee <dlqs@gmx.com>
This commit is contained in:
Donald Lee 2021-07-18 06:20:20 +08:00
parent 62435f8ce1
commit 7472871eef
1 changed files with 30 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

47
lib/frrscript.h
View File

@ -76,9 +76,13 @@ struct frrscript_env {
}; };
/* /*
* Create new FRR script. * Create new struct frrscript for a Lua script.
* This will hold the states for the Lua functions in this script.
*
* scriptname
* Name of the Lua script file, without the .lua
*/ */
struct frrscript *frrscript_new(const char *name); struct frrscript *frrscript_new(const char *scriptname);
/* /*
* Load a function into frrscript, run callback if any * Load a function into frrscript, run callback if any
@ -87,7 +91,7 @@ int frrscript_load(struct frrscript *fs, const char *function_name,
int (*load_cb)(struct frrscript *)); int (*load_cb)(struct frrscript *));
/* /*
* Destroy FRR script. * Delete Lua function states and frrscript
*/ */
void frrscript_delete(struct frrscript *fs); void frrscript_delete(struct frrscript *fs);
@ -173,10 +177,12 @@ const struct prefix * : lua_decode_noop \
)(L, -1, value) )(L, -1, value)
/* /*
* Call script. * Call Lua function state (abstraction for a single Lua function)
* *
* fs * lfs
* The script to call; this is obtained from frrscript_load(). * The Lua function to call; this should have been loaded in by frrscript_load().
* nargs
* Number of arguments the function accepts
* *
* Returns: * Returns:
* 0 if the script ran successfully, nonzero otherwise. * 0 if the script ran successfully, nonzero otherwise.
@ -184,16 +190,17 @@ const struct prefix * : lua_decode_noop \
int _frrscript_call_lua(struct lua_function_state *lfs, int nargs); int _frrscript_call_lua(struct lua_function_state *lfs, int nargs);
/* /*
* Wrapper for call script. Maps values passed in to their encoder * Wrapper for calling Lua function state. Maps values passed in to their
* and decoder types. * encoder and decoder types.
* *
* fs * fs
* The script to call; this is obtained from frrscript_load(). * The struct frrscript in which the Lua fuction was loaded into
* f
* Name of the Lua function.
* *
* Returns: * Returns:
* 0 if the script ran successfully, nonzero otherwise. * 0 if the script ran successfully, nonzero otherwise.
*/ */
#define frrscript_call(fs, f, ...) \ #define frrscript_call(fs, f, ...) \
({ \ ({ \
struct lua_function_state lookup = {.name = f}; \ struct lua_function_state lookup = {.name = f}; \
@ -222,18 +229,24 @@ int _frrscript_call_lua(struct lua_function_state *lfs, int nargs);
}) })
/* /*
* Get result from finished script. * Get result from finished function
* *
* fs * fs
* The script. This script must have been run already. * The script. This script must have been run already.
* * function_name
* result * Name of the Lua function.
* The result to extract from the script. * name
* This reuses the frrscript_env type, but only the typename and name fields * Name of the result.
* need to be set. The value is returned directly. * This will be used as a string key to retrieve from the table that the
* Lua function returns.
* The name here should *not* appear in frrscript_call.
* lua_to
* Function pointer to a lua_to decoder function.
* This function should allocate and decode a value from the Lua state.
* *
* Returns: * Returns:
* The script result of the specified name and type, or NULL. * A pointer to the decoded value from the Lua state, or NULL if no such
* value.
*/ */
void *frrscript_get_result(struct frrscript *fs, const char *function_name, void *frrscript_get_result(struct frrscript *fs, const char *function_name,
const char *name, const char *name,