plugins_exts.h

Go to the documentation of this file.

#ifndef LY_PLUGINS_EXTS_H_
#define LY_PLUGINS_EXTS_H_

#include "log.h"
#include "parser_data.h"
#include "plugins.h"
#include "tree_data.h"
#include "tree_edit.h"
#include "tree_schema.h"

struct ly_ctx;
struct ly_in;
struct lyd_node;
struct lysc_ctx;
struct lysc_ext_substmt;
struct lysp_ctx;
struct lyspr_ctx;
struct lyspr_tree_ctx;

#ifdef __cplusplus
extern "C" {
#endif

#define LYPLG_EXT_API_VERSION 12

#define LY_STMT_OP_MASK (LY_STMT_ACTION | LY_STMT_RPC)

#define LY_STMT_DATA_NODE_MASK (LY_STMT_ANYDATA | LY_STMT_ANYXML | LY_STMT_CASE | LY_STMT_CHOICE | LY_STMT_CONTAINER |\
        LY_STMT_LEAF | LY_STMT_LEAF_LIST | LY_STMT_LIST)

#define LY_STMT_NODE_MASK 0xFFFF

enum ly_stmt {
    LY_STMT_NONE = 0,

    LY_STMT_NOTIFICATION = 0x0001,  
    LY_STMT_INPUT = 0x0002,     
    LY_STMT_OUTPUT = 0x0004,    
    LY_STMT_ACTION = 0x0008,    
    LY_STMT_RPC = 0x0010,       
    LY_STMT_ANYDATA = 0x0020,   
    LY_STMT_ANYXML = 0x0040,    
    LY_STMT_AUGMENT = 0x0080,   
    LY_STMT_CASE = 0x0100,      
    LY_STMT_CHOICE = 0x0200,    
    LY_STMT_CONTAINER = 0x0400, 
    LY_STMT_GROUPING = 0x0800,  
    LY_STMT_LEAF = 0x1000,      
    LY_STMT_LEAF_LIST = 0x2000, 
    LY_STMT_LIST = 0x4000,      
    LY_STMT_USES = 0x8000,      
    LY_STMT_ARGUMENT = 0x10000, 
    LY_STMT_BASE = 0x20000,     
    LY_STMT_BELONGS_TO = 0x30000,   
    LY_STMT_BIT = 0x40000,      
    LY_STMT_CONFIG = 0x50000,   
    LY_STMT_CONTACT = 0x60000,  
    LY_STMT_DEFAULT = 0x70000,  
    LY_STMT_DESCRIPTION = 0x80000,  
    LY_STMT_DEVIATE = 0x90000,  
    LY_STMT_DEVIATION = 0xA0000,    
    LY_STMT_ENUM = 0xB0000,     
    LY_STMT_ERROR_APP_TAG = 0xC0000,    
    LY_STMT_ERROR_MESSAGE = 0xD0000,    
    LY_STMT_EXTENSION = 0xE0000,    
    LY_STMT_EXTENSION_INSTANCE = 0xF0000,   
    LY_STMT_FEATURE = 0x100000, 
    LY_STMT_FRACTION_DIGITS = 0x110000, 
    LY_STMT_IDENTITY = 0x120000,    
    LY_STMT_IF_FEATURE = 0x130000,  
    LY_STMT_IMPORT = 0x140000,  
    LY_STMT_INCLUDE = 0x150000, 
    LY_STMT_KEY = 0x160000,     
    LY_STMT_LENGTH = 0x170000,  
    LY_STMT_MANDATORY = 0x180000,   
    LY_STMT_MAX_ELEMENTS = 0x190000,    
    LY_STMT_MIN_ELEMENTS = 0x1A0000,    
    LY_STMT_MODIFIER = 0x1B0000,    
    LY_STMT_MODULE = 0x1C0000,  
    LY_STMT_MUST = 0x1D0000,    
    LY_STMT_NAMESPACE = 0x1E0000,   
    LY_STMT_ORDERED_BY = 0x1F0000,  
    LY_STMT_ORGANIZATION = 0x200000,    
    LY_STMT_PATH = 0x210000,    
    LY_STMT_PATTERN = 0x220000, 
    LY_STMT_POSITION = 0x230000,    
    LY_STMT_PREFIX = 0x240000,  
    LY_STMT_PRESENCE = 0x250000,    
    LY_STMT_RANGE = 0x260000,   
    LY_STMT_REFERENCE = 0x270000,   
    LY_STMT_REFINE = 0x280000,  
    LY_STMT_REQUIRE_INSTANCE = 0x290000,    
    LY_STMT_REVISION = 0x2A0000,    
    LY_STMT_REVISION_DATE = 0x2B0000,   
    LY_STMT_STATUS = 0x2C0000,  
    LY_STMT_SUBMODULE = 0x2D0000,   
    LY_STMT_TYPE = 0x2E0000,    
    LY_STMT_TYPEDEF = 0x2F0000, 
    LY_STMT_UNIQUE = 0x300000,  
    LY_STMT_UNITS = 0x310000,   
    LY_STMT_VALUE = 0x320000,   
    LY_STMT_WHEN = 0x330000,    
    LY_STMT_YANG_VERSION = 0x340000,    
    LY_STMT_YIN_ELEMENT = 0x350000, 
    /* separated from the list of statements
     * the following tokens are part of the syntax and parsers have to work
     * with them, but they are not a standard YANG statements
     */
    LY_STMT_SYNTAX_SEMICOLON,
    LY_STMT_SYNTAX_LEFT_BRACE,
    LY_STMT_SYNTAX_RIGHT_BRACE,

    /*
     * YIN-specific tokens, still they are part of the syntax, but not the standard statements
     */
    LY_STMT_ARG_TEXT,
    LY_STMT_ARG_VALUE
};

struct lysp_stmt {
    const char *stmt;                
    const char *arg;                 
    LY_VALUE_FORMAT format;          
    void *prefix_data;               
    struct lysp_stmt *next;          
    struct lysp_stmt *child;         
    uint16_t flags;                  
    enum ly_stmt kw;                 
};

struct lysp_ext_substmt {
    enum ly_stmt stmt;  
    void **storage_p;   
};

struct lysp_ext_instance {
    const char *name;                       
    const char *argument;                   
    LY_VALUE_FORMAT format;                 
    void *prefix_data;                      
    uintptr_t plugin_ref;                   
    void *parent;                           
    enum ly_stmt parent_stmt;               
    LY_ARRAY_COUNT_TYPE parent_stmt_index;  
    uint16_t flags;                         
    struct lysp_ext_substmt *substmts;      
    void *parsed;                           
    struct lysp_stmt *child;                
    struct lysp_ext_instance *exts;         
};

struct lysc_ext_substmt {
    enum ly_stmt stmt;  
    void **storage_p;   
};

struct lysc_ext_instance {
    struct lysc_ext *def;               
    const char *argument;               
    struct lys_module *module;          
    struct lysc_ext_instance *exts;     
    void *parent;                       
    enum ly_stmt parent_stmt;           
    LY_ARRAY_COUNT_TYPE parent_stmt_index;  
    struct lysc_ext_substmt *substmts;  
    void *compiled;                     
};

#define LYPLG_EXTENSIONS \
    uint32_t plugins_extensions_apiver__ = LYPLG_EXT_API_VERSION; \
    const struct lyplg_ext_record plugins_extensions__[]

typedef LY_ERR (*lyplg_ext_parse_clb)(struct lysp_ctx *pctx, struct lysp_ext_instance *ext);

LIBYANG_API_DECL void lyplg_ext_parse_log(const struct lysp_ctx *pctx, const struct lysp_ext_instance *ext,
        LY_LOG_LEVEL level, LY_ERR err, const char *format, ...);

LIBYANG_API_DECL const struct lysp_module *lyplg_ext_parse_get_cur_pmod(const struct lysp_ctx *pctx);

LIBYANG_API_DECL LY_ERR lyplg_ext_parse_extension_instance(struct lysp_ctx *pctx, struct lysp_ext_instance *ext);

#define LYS_COMPILE_GROUPING        0x01            
#define LYS_COMPILE_DISABLED        0x02            
#define LYS_COMPILE_NO_CONFIG       0x04            
#define LYS_COMPILE_NO_DISABLED     0x08            
#define LYS_COMPILE_RPC_INPUT       (LYS_IS_INPUT | LYS_COMPILE_NO_CONFIG)  
#define LYS_COMPILE_RPC_OUTPUT      (LYS_IS_OUTPUT | LYS_COMPILE_NO_CONFIG) 
#define LYS_COMPILE_NOTIFICATION    (LYS_IS_NOTIF | LYS_COMPILE_NO_CONFIG)  
typedef LY_ERR (*lyplg_ext_compile_clb)(struct lysc_ctx *cctx, const struct lysp_ext_instance *extp,
        struct lysc_ext_instance *ext);

LIBYANG_API_DECL void lyplg_ext_compile_log(const struct lysc_ctx *cctx, const struct lysc_ext_instance *ext,
        LY_LOG_LEVEL level, LY_ERR err, const char *format, ...);

LIBYANG_API_DECL void lyplg_ext_compile_log_path(const char *path, const struct lysc_ext_instance *ext,
        LY_LOG_LEVEL level, LY_ERR err, const char *format, ...);

LIBYANG_API_DEF void lyplg_ext_compile_log_err(const struct ly_err_item *eitem, const struct lysc_ext_instance *ext);

LIBYANG_API_DECL struct ly_ctx *lyplg_ext_compile_get_ctx(const struct lysc_ctx *ctx);

LIBYANG_API_DECL uint32_t *lyplg_ext_compile_get_options(const struct lysc_ctx *ctx);

LIBYANG_API_DECL const struct lys_module *lyplg_ext_compile_get_cur_mod(const struct lysc_ctx *ctx);

LIBYANG_API_DECL struct lysp_module *lyplg_ext_compile_get_pmod(const struct lysc_ctx *ctx);

LIBYANG_API_DECL LY_ERR lyplg_ext_compile_extension_instance(struct lysc_ctx *ctx, const struct lysp_ext_instance *extp,
        struct lysc_ext_instance *ext, struct lysc_node *parent);

LIBYANG_API_DECL LY_ERR lyplg_ext_compiled_node_augments(struct lysc_ctx *ctx, struct lysc_ext_instance *ext,
        struct lysc_node *node);

typedef LY_ERR (*lyplg_ext_sprinter_info_clb)(struct lyspr_ctx *ctx, struct lysc_ext_instance *ext, ly_bool *flag);

LIBYANG_API_DECL struct ly_out **lyplg_ext_print_get_out(const struct lyspr_ctx *ctx);

LIBYANG_API_DECL uint32_t *lyplg_ext_print_get_options(const struct lyspr_ctx *ctx);

LIBYANG_API_DECL uint16_t *lyplg_ext_print_get_level(const struct lyspr_ctx *ctx);

LIBYANG_API_DECL void lyplg_ext_print_info_extension_instance(struct lyspr_ctx *ctx, const struct lysc_ext_instance *ext,
        ly_bool *flag);

/*
 * node xpath
 */

typedef void (*lyplg_ext_node_xpath_clb)(struct lysc_ext_instance *ext, const struct lyd_node *cur_node,
        const struct lyd_node **node);

/*
 * snode xpath
 */

typedef LY_ERR (*lyplg_ext_snode_xpath_clb)(struct lysc_ext_instance *ext, const char *prefix, uint32_t prefix_len,
        LY_VALUE_FORMAT format, void *prefix_data, const char *name, uint32_t name_len, const struct lysc_node **snode);

/*
 * data snode
 */

typedef LY_ERR (*lyplg_ext_data_snode_clb)(struct lysc_ext_instance *ext, const struct lyd_node *parent,
        const struct lysc_node *sparent, const char *prefix, uint32_t prefix_len, LY_VALUE_FORMAT format, void *prefix_data,
        const char *name, uint32_t name_len, const struct lysc_node **snode);

/*
 * data validate
 */

typedef LY_ERR (*lyplg_ext_data_validate_clb)(struct lysc_ext_instance *ext, struct lyd_node *node,
        const struct lyd_node *dep_tree, enum lyd_type data_type, uint32_t val_opts, struct lyd_node **diff);

/*
 * parse free
 */

typedef void (*lyplg_ext_parse_free_clb)(const struct ly_ctx *ctx, struct lysp_ext_instance *ext);

LIBYANG_API_DECL void lyplg_ext_pfree_instance_substatements(const struct ly_ctx *ctx, struct lysp_ext_substmt *substmts);

/*
 * compile free
 */

typedef void (*lyplg_ext_compile_free_clb)(const struct ly_ctx *ctx, struct lysc_ext_instance *ext);

LIBYANG_API_DECL void lyplg_ext_cfree_instance_substatements(const struct ly_ctx *ctx, struct lysc_ext_substmt *substmts);

/*
 * compiled size
 */

#define LY_CTXP_MEM_ALIGN 8

#define LY_CTXP_MEM_SIZE(SIZE) ((SIZE) + ((~(SIZE) + 1) & (LY_CTXP_MEM_ALIGN - 1)))

typedef int (*lyplg_ext_compiled_size_clb)(const struct lysc_ext_instance *ext, struct ly_ht *addr_ht);

LIBYANG_API_DECL int lyplg_ext_compiled_stmts_storage_size(const struct lysc_ext_substmt *substmts, struct ly_ht *addr_ht);

/*
 * compiled print
 */

typedef LY_ERR (*lyplg_ext_compiled_print_clb)(const struct lysc_ext_instance *orig_ext, struct lysc_ext_instance *ext,
        struct ly_ht *addr_ht, struct ly_set *ptr_set, void **mem);

LIBYANG_API_DECL LY_ERR lyplg_ext_compiled_stmts_storage_print(const struct lysc_ext_substmt *orig_substmts,
        struct lysc_ext_substmt *substmts, struct ly_ht *addr_ht, struct ly_set *ptr_set, void **mem);

LIBYANG_API_DECL void *lyplg_ext_compiled_print_get_addr(const struct ly_ht *addr_ht, const void *addr);

LIBYANG_API_DECL LY_ERR lyplg_ext_compiled_print_add_addr(struct ly_ht *addr_ht, const void *orig_addr,
        const void *addr);

struct lyplg_ext {
    const char *id;                         
    lyplg_ext_parse_clb parse;              
    lyplg_ext_compile_clb compile;          
    lyplg_ext_sprinter_info_clb printer_info;   
    lyplg_ext_node_xpath_clb node_xpath;    
    lyplg_ext_snode_xpath_clb snode_xpath;  
    lyplg_ext_data_snode_clb snode;         
    lyplg_ext_data_validate_clb validate;   
    lyplg_ext_parse_free_clb pfree;         
    lyplg_ext_compile_free_clb cfree;       
    lyplg_ext_compiled_size_clb compiled_size;  
    lyplg_ext_compiled_print_clb compiled_print;    
};

struct lyplg_ext_record {
    /* plugin identification */
    const char *module;          
    const char *revision;        
    const char *name;            
    /* runtime data */
    struct lyplg_ext plugin;     
};

LIBYANG_API_DECL const char *lyplg_ext_stmt2str(enum ly_stmt stmt);

LIBYANG_API_DECL enum ly_stmt lyplg_ext_nodetype2stmt(uint16_t nodetype);

LIBYANG_API_DECL LY_ERR lyplg_ext_get_storage(const struct lysc_ext_instance *ext, int stmt, uint32_t storage_size,
        const void **storage);

LIBYANG_API_DECL LY_ERR lyplg_ext_parsed_get_storage(const struct lysc_ext_instance *ext, int stmt,
        uint32_t storage_size, const void **storage);

LIBYANG_API_DECL LY_ERR lyplg_ext_get_data(const struct ly_ctx *ctx, const struct lysc_ext_instance *ext,
        const struct lyd_node *parent, void **ext_data, ly_bool *ext_data_free);

LIBYANG_API_DECL LY_ERR lyplg_ext_set_parent_ctx(struct ly_ctx *ctx, const struct ly_ctx *parent_ctx);

LIBYANG_API_DECL LY_ERR lyplg_ext_schema_mount_get_parent_ref(const struct lysc_ext_instance *ext,
        const struct lyd_node *parent, struct ly_set **refs);

LIBYANG_API_DECL LY_ERR lyplg_ext_schema_mount_create_context(const struct lysc_ext_instance *ext,
        const struct lyd_node *parent, struct ly_ctx **ctx);

LIBYANG_API_DECL LY_ERR lyplg_ext_schema_mount_create_shared_context(struct lysc_ext_instance *ext,
        const struct lyd_node *ext_data);

LIBYANG_API_DECL void lyplg_ext_schema_mount_destroy_shared_contexts(struct lysc_ext_instance *ext);

LIBYANG_API_DECL void lyplg_ext_schema_mount_destroy_inline_contexts(struct lysc_ext_instance *ext);

#ifdef __cplusplus
}
#endif

#endif /* LY_PLUGINS_EXTS_H_ */