DEFUN宏函数学习

客官°小女子只卖身不卖艺 2022-10-05 01:52 116阅读 0赞

1，DEFUN宏函数说明

#define DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, attrs, dnum) \
      struct cmd_element cmdname = \
      { \
        .string = cmdstr, \
        .func = funcname, \
        .doc = helpstr, \
        .attr = attrs, \
        .daemon = dnum, \
      };
    
    #define DEFUN_CMD_FUNC_DECL(funcname) \
      static int funcname (struct cmd_element *, struct vty *, int, const char *[]);
    
    #define DEFUN_CMD_FUNC_TEXT(funcname) \
      static int funcname \
        (struct cmd_element *self __attribute__ ((unused)), \
         struct vty *vty __attribute__ ((unused)), \
         int argc __attribute__ ((unused)), \
         const char *argv[] __attribute__ ((unused)) )
    
    /* DEFUN for vty command interafce. Little bit hacky ;-). */
    #define DEFUN(funcname, cmdname, cmdstr, helpstr) \
      DEFUN_CMD_FUNC_DECL(funcname) \
      DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, 0, 0) \
      DEFUN_CMD_FUNC_TEXT(funcname)

参数说明：DEFUN函数第一个funcname是函数的名称，第二个cmdname是注册的命令的名字，第三个cmdstr是在vtysh终端下输入的命令字符串，第四个helpstr是帮助信息，当输入“?”时，显示出来。

结构体：

/* Structure of command element. */
    struct cmd_element 
    {
      const char *string;			/* Command specification by string. */
      int (*func) (struct cmd_element *, struct vty *, int, const char *[]);
      const char *doc;			/* Documentation of this command. */
      int daemon;                   /* Daemon to which this command belong. */
      vector strvec;		/* Pointing out each description vector. */
      unsigned int cmdsize;		/* Command index count. */
      char *config;			/* Configuration string */
      vector subconfig;		/* Sub configuration string */
      u_char attr;			/* Command attributes */
    };

举例说明：

DEFUN(product_mac_set,product_mac_set_cmd,
    	"product_mac_set(<0-7>,HH-HH-HH)",
    	"product\n"
    	"mac\n"
    	"set\n"
    	"mac<0-7>\n"
    	"mac_address\n")

product\_mac\_set是函数名,product\_mac\_set\_cmd是命令注册的名字，可以注册到install\_element，product\_mac\_set(<0-7>,HH-HH-HH)是可以在终端输入的，最后的是help函数提示；

安装函数：

install_element(CONFIG_NODE,&product_mac_set_cmd); 
    install_element(VIEW_NODE,&product_mac_display_cmd);

CONFIG\_MODE是设置命令行，VIEW\_MODE是视图命令行。

入参说明：入参分为常量和变量，变量类型有<0-7>,NUMBER(全部大写)，HH-HH-HH，多选一(100 | 200 |500 |1000 |on |off)等