family.c 6.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285
  1. /*
  2. * lib/genl/family.c Generic Netlink Family
  3. *
  4. * This library is free software; you can redistribute it and/or
  5. * modify it under the terms of the GNU Lesser General Public
  6. * License as published by the Free Software Foundation version 2.1
  7. * of the License.
  8. *
  9. * Copyright (c) 2003-2006 Thomas Graf <tgraf@suug.ch>
  10. */
  11. /**
  12. * @ingroup genl
  13. * @defgroup genl_family Generic Netlink Family
  14. * @brief
  15. *
  16. * @{
  17. */
  18. #include <netlink-generic.h>
  19. #include <netlink/netlink.h>
  20. #include <netlink/genl/genl.h>
  21. #include <netlink/genl/family.h>
  22. #include <netlink/utils.h>
  23. /** @cond SKIP */
  24. #define FAMILY_ATTR_ID 0x01
  25. #define FAMILY_ATTR_NAME 0x02
  26. #define FAMILY_ATTR_VERSION 0x04
  27. #define FAMILY_ATTR_HDRSIZE 0x08
  28. #define FAMILY_ATTR_MAXATTR 0x10
  29. #define FAMILY_ATTR_OPS 0x20
  30. struct nl_object_ops genl_family_ops;
  31. /** @endcond */
  32. static void family_constructor(struct nl_object *c)
  33. {
  34. struct genl_family *family = (struct genl_family *) c;
  35. nl_init_list_head(&family->gf_ops);
  36. }
  37. static void family_free_data(struct nl_object *c)
  38. {
  39. struct genl_family *family = (struct genl_family *) c;
  40. struct genl_family_op *ops, *tmp;
  41. if (family == NULL)
  42. return;
  43. nl_list_for_each_entry_safe(ops, tmp, &family->gf_ops, o_list) {
  44. nl_list_del(&ops->o_list);
  45. free(ops);
  46. }
  47. }
  48. static int family_clone(struct nl_object *_dst, struct nl_object *_src)
  49. {
  50. struct genl_family *dst = nl_object_priv(_dst);
  51. struct genl_family *src = nl_object_priv(_src);
  52. struct genl_family_op *ops;
  53. int err;
  54. nl_list_for_each_entry(ops, &src->gf_ops, o_list) {
  55. err = genl_family_add_op(dst, ops->o_id, ops->o_flags);
  56. if (err < 0)
  57. return err;
  58. }
  59. return 0;
  60. }
  61. static int family_dump_brief(struct nl_object *obj, struct nl_dump_params *p)
  62. {
  63. struct genl_family *family = (struct genl_family *) obj;
  64. dp_dump(p, "0x%04x %s version %u\n",
  65. family->gf_id, family->gf_name, family->gf_version);
  66. return 1;
  67. }
  68. static struct trans_tbl ops_flags[] = {
  69. __ADD(GENL_ADMIN_PERM, admin-perm)
  70. __ADD(GENL_CMD_CAP_DO, has-doit)
  71. __ADD(GENL_CMD_CAP_DUMP, has-dump)
  72. __ADD(GENL_CMD_CAP_HASPOL, has-policy)
  73. };
  74. static char *ops_flags2str(int flags, char *buf, size_t len)
  75. {
  76. return __flags2str(flags, buf, len, ops_flags, ARRAY_SIZE(ops_flags));
  77. }
  78. static int family_dump_full(struct nl_object *obj, struct nl_dump_params *p)
  79. {
  80. struct genl_family *family = (struct genl_family *) obj;
  81. int line;
  82. line = family_dump_brief(obj, p);
  83. dp_dump_line(p, line++, " hdrsize %u maxattr %u\n",
  84. family->gf_hdrsize, family->gf_maxattr);
  85. if (family->ce_mask & FAMILY_ATTR_OPS) {
  86. struct genl_family_op *op;
  87. char buf[64];
  88. nl_list_for_each_entry(op, &family->gf_ops, o_list) {
  89. ops_flags2str(op->o_flags, buf, sizeof(buf));
  90. genl_op2name(family->gf_id, op->o_id, buf, sizeof(buf));
  91. dp_dump_line(p, line++, " op %s (0x%02x)",
  92. buf, op->o_id);
  93. if (op->o_flags)
  94. dp_dump(p, " <%s>",
  95. ops_flags2str(op->o_flags, buf,
  96. sizeof(buf)));
  97. dp_dump(p, "\n");
  98. }
  99. }
  100. return line;
  101. }
  102. static int family_dump_stats(struct nl_object *obj, struct nl_dump_params *p)
  103. {
  104. return family_dump_full(obj, p);
  105. }
  106. static int family_compare(struct nl_object *_a, struct nl_object *_b,
  107. uint32_t attrs, int flags)
  108. {
  109. struct genl_family *a = (struct genl_family *) _a;
  110. struct genl_family *b = (struct genl_family *) _b;
  111. int diff = 0;
  112. #define FAM_DIFF(ATTR, EXPR) ATTR_DIFF(attrs, FAMILY_ATTR_##ATTR, a, b, EXPR)
  113. diff |= FAM_DIFF(ID, a->gf_id != b->gf_id);
  114. diff |= FAM_DIFF(VERSION, a->gf_version != b->gf_version);
  115. diff |= FAM_DIFF(HDRSIZE, a->gf_hdrsize != b->gf_hdrsize);
  116. diff |= FAM_DIFF(MAXATTR, a->gf_maxattr != b->gf_maxattr);
  117. diff |= FAM_DIFF(NAME, strcmp(a->gf_name, b->gf_name));
  118. #undef FAM_DIFF
  119. return diff;
  120. }
  121. /**
  122. * @name Family Object
  123. * @{
  124. */
  125. struct genl_family *genl_family_alloc(void)
  126. {
  127. return (struct genl_family *) nl_object_alloc(&genl_family_ops);
  128. }
  129. void genl_family_put(struct genl_family *family)
  130. {
  131. nl_object_put((struct nl_object *) family);
  132. }
  133. /** @} */
  134. /**
  135. * @name Attributes
  136. * @{
  137. */
  138. unsigned int genl_family_get_id(struct genl_family *family)
  139. {
  140. if (family->ce_mask & FAMILY_ATTR_ID)
  141. return family->gf_id;
  142. else
  143. return GENL_ID_GENERATE;
  144. }
  145. void genl_family_set_id(struct genl_family *family, unsigned int id)
  146. {
  147. family->gf_id = id;
  148. family->ce_mask |= FAMILY_ATTR_ID;
  149. }
  150. char *genl_family_get_name(struct genl_family *family)
  151. {
  152. if (family->ce_mask & FAMILY_ATTR_NAME)
  153. return family->gf_name;
  154. else
  155. return NULL;
  156. }
  157. void genl_family_set_name(struct genl_family *family, const char *name)
  158. {
  159. strncpy(family->gf_name, name, GENL_NAMSIZ-1);
  160. family->ce_mask |= FAMILY_ATTR_NAME;
  161. }
  162. uint8_t genl_family_get_version(struct genl_family *family)
  163. {
  164. if (family->ce_mask & FAMILY_ATTR_VERSION)
  165. return family->gf_version;
  166. else
  167. return 0;
  168. }
  169. void genl_family_set_version(struct genl_family *family, uint8_t version)
  170. {
  171. family->gf_version = version;
  172. family->ce_mask |= FAMILY_ATTR_VERSION;
  173. }
  174. uint32_t genl_family_get_hdrsize(struct genl_family *family)
  175. {
  176. if (family->ce_mask & FAMILY_ATTR_HDRSIZE)
  177. return family->gf_hdrsize;
  178. else
  179. return 0;
  180. }
  181. void genl_family_set_hdrsize(struct genl_family *family, uint32_t hdrsize)
  182. {
  183. family->gf_hdrsize = hdrsize;
  184. family->ce_mask |= FAMILY_ATTR_HDRSIZE;
  185. }
  186. uint32_t genl_family_get_maxattr(struct genl_family *family)
  187. {
  188. if (family->ce_mask & FAMILY_ATTR_MAXATTR)
  189. return family->gf_maxattr;
  190. else
  191. return family->gf_maxattr;
  192. }
  193. void genl_family_set_maxattr(struct genl_family *family, uint32_t maxattr)
  194. {
  195. family->gf_maxattr = maxattr;
  196. family->ce_mask |= FAMILY_ATTR_MAXATTR;
  197. }
  198. int genl_family_add_op(struct genl_family *family, int id, int flags)
  199. {
  200. struct genl_family_op *op;
  201. op = calloc(1, sizeof(*op));
  202. if (op == NULL)
  203. return nl_errno(ENOMEM);
  204. op->o_id = id;
  205. op->o_flags = flags;
  206. nl_list_add_tail(&op->o_list, &family->gf_ops);
  207. family->ce_mask |= FAMILY_ATTR_OPS;
  208. return 0;
  209. }
  210. /** @} */
  211. /** @cond SKIP */
  212. struct nl_object_ops genl_family_ops = {
  213. .oo_name = "genl/family",
  214. .oo_size = sizeof(struct genl_family),
  215. .oo_constructor = family_constructor,
  216. .oo_free_data = family_free_data,
  217. .oo_clone = family_clone,
  218. .oo_dump[NL_DUMP_BRIEF] = family_dump_brief,
  219. .oo_dump[NL_DUMP_FULL] = family_dump_full,
  220. .oo_dump[NL_DUMP_STATS] = family_dump_stats,
  221. #if 0
  222. .oo_dump[NL_DUMP_XML] = addr_dump_xml,
  223. .oo_dump[NL_DUMP_ENV] = addr_dump_env,
  224. #endif
  225. .oo_compare = family_compare,
  226. .oo_id_attrs = FAMILY_ATTR_ID,
  227. };
  228. /** @endcond */
  229. /** @} */