lib/yang_wrappers.h

   1 /*
   2  * Copyright (C) 2018  NetDEF, Inc.
   3  *                     Renato Westphal
   4  *
   5  * This program is free software; you can redistribute it and/or modify it
   6  * under the terms of the GNU General Public License as published by the Free
   7  * Software Foundation; either version 2 of the License, or (at your option)
   8  * any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful, but WITHOUT
  11  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  12  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
  13  * more details.
  14  *
  15  * You should have received a copy of the GNU General Public License along
  16  * with this program; see the file COPYING; if not, write to the Free Software
  17  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
  18  */
  19
  20 #ifndef _FRR_NORTHBOUND_WRAPPERS_H_
  21 #define _FRR_NORTHBOUND_WRAPPERS_H_
  22
  23 #include "prefix.h"
  24
  25 #ifdef __cplusplus
  26 extern "C" {
  27 #endif
  28
  29 /* bool */
  30 extern bool yang_str2bool(const char *value);
  31 extern struct yang_data *yang_data_new_bool(const char *xpath, bool value);
  32 extern bool yang_dnode_get_bool(const struct lyd_node *dnode,
  33                                 const char *xpath_fmt, ...);
  34 extern bool yang_get_default_bool(const char *xpath_fmt, ...);
  35
  36 /* dec64 */
  37 extern double yang_str2dec64(const char *xpath, const char *value);
  38 extern struct yang_data *yang_data_new_dec64(const char *xpath, double value);
  39 extern double yang_dnode_get_dec64(const struct lyd_node *dnode,
  40                                    const char *xpath_fmt, ...);
  41 extern double yang_get_default_dec64(const char *xpath_fmt, ...);
  42
  43 /* enum */
  44 extern int yang_str2enum(const char *xpath, const char *value);
  45 extern struct yang_data *yang_data_new_enum(const char *xpath, int value);
  46 extern int yang_dnode_get_enum(const struct lyd_node *dnode,
  47                                const char *xpath_fmt, ...);
  48 extern int yang_get_default_enum(const char *xpath_fmt, ...);
  49
  50 /* int8 */
  51 extern int8_t yang_str2int8(const char *value);
  52 extern struct yang_data *yang_data_new_int8(const char *xpath, int8_t value);
  53 extern int8_t yang_dnode_get_int8(const struct lyd_node *dnode,
  54                                   const char *xpath_fmt, ...);
  55 extern int8_t yang_get_default_int8(const char *xpath_fmt, ...);
  56
  57 /* int16 */
  58 extern int16_t yang_str2int16(const char *value);
  59 extern struct yang_data *yang_data_new_int16(const char *xpath, int16_t value);
  60 extern int16_t yang_dnode_get_int16(const struct lyd_node *dnode,
  61                                     const char *xpath_fmt, ...);
  62 extern int16_t yang_get_default_int16(const char *xpath_fmt, ...);
  63
  64 /* int32 */
  65 extern int32_t yang_str2int32(const char *value);
  66 extern struct yang_data *yang_data_new_int32(const char *xpath, int32_t value);
  67 extern int32_t yang_dnode_get_int32(const struct lyd_node *dnode,
  68                                     const char *xpath_fmt, ...);
  69 extern int32_t yang_get_default_int32(const char *xpath_fmt, ...);
  70
  71 /* int64 */
  72 extern int64_t yang_str2int64(const char *value);
  73 extern struct yang_data *yang_data_new_int64(const char *xpath, int64_t value);
  74 extern int64_t yang_dnode_get_int64(const struct lyd_node *dnode,
  75                                     const char *xpath_fmt, ...);
  76 extern int64_t yang_get_default_int64(const char *xpath_fmt, ...);
  77
  78 /* uint8 */
  79 extern uint8_t yang_str2uint8(const char *value);
  80 extern struct yang_data *yang_data_new_uint8(const char *xpath, uint8_t value);
  81 extern uint8_t yang_dnode_get_uint8(const struct lyd_node *dnode,
  82                                     const char *xpath_fmt, ...);
  83 extern uint8_t yang_get_default_uint8(const char *xpath_fmt, ...);
  84
  85 /* uint16 */
  86 extern uint16_t yang_str2uint16(const char *value);
  87 extern struct yang_data *yang_data_new_uint16(const char *xpath,
  88                                               uint16_t value);
  89 extern uint16_t yang_dnode_get_uint16(const struct lyd_node *dnode,
  90                                       const char *xpath_fmt, ...);
  91 extern uint16_t yang_get_default_uint16(const char *xpath_fmt, ...);
  92
  93 /* uint32 */
  94 extern uint32_t yang_str2uint32(const char *value);
  95 extern struct yang_data *yang_data_new_uint32(const char *xpath,
  96                                               uint32_t value);
  97 extern uint32_t yang_dnode_get_uint32(const struct lyd_node *dnode,
  98                                       const char *xpath_fmt, ...);
  99 extern uint32_t yang_get_default_uint32(const char *xpath_fmt, ...);
 100
 101 /* uint64 */
 102 extern uint64_t yang_str2uint64(const char *value);
 103 extern struct yang_data *yang_data_new_uint64(const char *xpath,
 104                                               uint64_t value);
 105 extern uint64_t yang_dnode_get_uint64(const struct lyd_node *dnode,
 106                                       const char *xpath_fmt, ...);
 107 extern uint64_t yang_get_default_uint64(const char *xpath_fmt, ...);
 108
 109 /* string */
 110 extern struct yang_data *yang_data_new_string(const char *xpath,
 111                                               const char *value);
 112 extern const char *yang_dnode_get_string(const struct lyd_node *dnode,
 113                                          const char *xpath_fmt, ...);
 114 extern void yang_dnode_get_string_buf(char *buf, size_t size,
 115                                       const struct lyd_node *dnode,
 116                                       const char *xpath_fmt, ...);
 117 extern const char *yang_get_default_string(const char *xpath_fmt, ...);
 118 extern void yang_get_default_string_buf(char *buf, size_t size,
 119                                         const char *xpath_fmt, ...);
 120
 121 /* empty */
 122 extern struct yang_data *yang_data_new_empty(const char *xpath);
 123 extern bool yang_dnode_get_empty(const struct lyd_node *dnode,
 124                                  const char *xpath_fmt, ...);
 125
 126 /* ip prefix */
 127 extern void yang_str2prefix(const char *value, union prefixptr prefix);
 128 extern struct yang_data *yang_data_new_prefix(const char *xpath,
 129                                               union prefixconstptr prefix);
 130 extern void yang_dnode_get_prefix(struct prefix *prefix,
 131                                   const struct lyd_node *dnode,
 132                                   const char *xpath_fmt, ...);
 133 extern void yang_get_default_prefix(union prefixptr var, const char *xpath_fmt,
 134                                     ...);
 135
 136 /* ipv4 */
 137 extern void yang_str2ipv4(const char *value, struct in_addr *addr);
 138 extern struct yang_data *yang_data_new_ipv4(const char *xpath,
 139                                             const struct in_addr *addr);
 140 extern void yang_dnode_get_ipv4(struct in_addr *addr,
 141                                 const struct lyd_node *dnode,
 142                                 const char *xpath_fmt, ...);
 143 extern void yang_get_default_ipv4(struct in_addr *var, const char *xpath_fmt,
 144                                   ...);
 145
 146 /* ipv4p */
 147 extern void yang_str2ipv4p(const char *value, union prefixptr prefix);
 148 extern struct yang_data *yang_data_new_ipv4p(const char *xpath,
 149                                              union prefixconstptr prefix);
 150 extern void yang_dnode_get_ipv4p(union prefixptr prefix,
 151                                  const struct lyd_node *dnode,
 152                                  const char *xpath_fmt, ...);
 153 extern void yang_get_default_ipv4p(union prefixptr var, const char *xpath_fmt,
 154                                    ...);
 155
 156 /* ipv6 */
 157 extern void yang_str2ipv6(const char *value, struct in6_addr *addr);
 158 extern struct yang_data *yang_data_new_ipv6(const char *xpath,
 159                                             const struct in6_addr *addr);
 160 extern void yang_dnode_get_ipv6(struct in6_addr *addr,
 161                                 const struct lyd_node *dnode,
 162                                 const char *xpath_fmt, ...);
 163 extern void yang_get_default_ipv6(struct in6_addr *var, const char *xpath_fmt,
 164                                   ...);
 165
 166 /* ipv6p */
 167 extern void yang_str2ipv6p(const char *value, union prefixptr prefix);
 168 extern struct yang_data *yang_data_new_ipv6p(const char *xpath,
 169                                              union prefixconstptr prefix);
 170 extern void yang_dnode_get_ipv6p(union prefixptr prefix,
 171                                  const struct lyd_node *dnode,
 172                                  const char *xpath_fmt, ...);
 173 extern void yang_get_default_ipv6p(union prefixptr var, const char *xpath_fmt,
 174                                    ...);
 175
 176 /* ip */
 177 extern void yang_str2ip(const char *value, struct ipaddr *addr);
 178 extern struct yang_data *yang_data_new_ip(const char *xpath,
 179                                           const struct ipaddr *addr);
 180 extern void yang_dnode_get_ip(struct ipaddr *addr, const struct lyd_node *dnode,
 181                               const char *xpath_fmt, ...);
 182 extern void yang_get_default_ip(struct ipaddr *var, const char *xpath_fmt, ...);
 183
 184 /* mac */
 185 extern struct yang_data *yang_data_new_mac(const char *xpath,
 186                                            const struct ethaddr *mac);
 187 extern void yang_str2mac(const char *value, struct ethaddr *mac);
 188
 189 /*data-and-time */
 190 extern struct yang_data *yang_data_new_date_and_time(const char *xpath,
 191                                                      time_t time);
 192
 193 /* nexthop enum2str */
 194 extern const char *yang_nexthop_type2str(uint32_t ntype);
 195
 196 const char *yang_afi_safi_value2identity(afi_t afi, safi_t safi);
 197 void yang_afi_safi_identity2value(const char *key, afi_t *afi, safi_t *safi);
 198
 199 #ifdef __cplusplus
 200 }
 201 #endif
 202
 203 #endif /* _FRR_NORTHBOUND_WRAPPERS_H_ */