vrf.h 2.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596
  1. /*
  2. * VRF related header.
  3. * Copyright (C) 2014 6WIND S.A.
  4. *
  5. * This file is part of GNU Zebra.
  6. *
  7. * GNU Zebra is free software; you can redistribute it and/or modify
  8. * it under the terms of the GNU General Public License as published
  9. * by the Free Software Foundation; either version 2, or (at your
  10. * option) any later version.
  11. *
  12. * GNU Zebra is distributed in the hope that it will be useful, but
  13. * WITHOUT ANY WARRANTY; without even the implied warranty of
  14. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  15. * General Public License for more details.
  16. *
  17. * You should have received a copy of the GNU General Public License
  18. * along with GNU Zebra; see the file COPYING. If not, write to the
  19. * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  20. * Boston, MA 02111-1307, USA.
  21. */
  22. #ifndef _ZEBRA_VRF_H
  23. #define _ZEBRA_VRF_H
  24. /* The default VRF ID */
  25. #define VRF_DEFAULT 0
  26. /*
  27. * VRF hooks
  28. */
  29. #define VRF_NEW_HOOK 0 /* a new VRF is just created */
  30. #define VRF_DELETE_HOOK 1 /* a VRF is to be deleted */
  31. /*
  32. * Add a specific hook to VRF module.
  33. * @param1: hook type
  34. * @param2: the callback function
  35. * - param 1: the VRF ID
  36. * - param 2: the address of the user data pointer (the user data
  37. * can be stored in or freed from there)
  38. */
  39. extern void vrf_add_hook (int, int (*)(vrf_id_t, void **));
  40. /*
  41. * VRF iteration
  42. */
  43. typedef void * vrf_iter_t;
  44. #define VRF_ITER_INVALID NULL /* invalid value of the iterator */
  45. /*
  46. * VRF iteration utilities. Example for the usage:
  47. *
  48. * vrf_iter_t iter = vrf_first();
  49. * for (; iter != VRF_ITER_INVALID; iter = vrf_next (iter))
  50. *
  51. * or
  52. *
  53. * vrf_iter_t iter = vrf_iterator (<a given VRF ID>);
  54. * for (; iter != VRF_ITER_INVALID; iter = vrf_next (iter))
  55. */
  56. /* Return the iterator of the first VRF. */
  57. extern vrf_iter_t vrf_first (void);
  58. /* Return the next VRF iterator to the given iterator. */
  59. extern vrf_iter_t vrf_next (vrf_iter_t);
  60. /* Return the VRF iterator of the given VRF ID. If it does not exist,
  61. * the iterator of the next existing VRF is returned. */
  62. extern vrf_iter_t vrf_iterator (vrf_id_t);
  63. /*
  64. * VRF iterator to properties
  65. */
  66. extern vrf_id_t vrf_iter2id (vrf_iter_t);
  67. extern void *vrf_iter2info (vrf_iter_t);
  68. /*
  69. * Utilities to obtain the user data
  70. */
  71. /* Get the data pointer of the specified VRF. If not found, create one. */
  72. extern void *vrf_info_get (vrf_id_t);
  73. /* Look up the data pointer of the specified VRF. */
  74. extern void *vrf_info_lookup (vrf_id_t);
  75. /*
  76. * VRF initializer/destructor
  77. */
  78. /* Please add hooks before calling vrf_init(). */
  79. extern void vrf_init (void);
  80. extern void vrf_terminate (void);
  81. #endif /*_ZEBRA_VRF_H*/