zebra/table_manager.h

   1 /* zebra table Manager for routing table identifier management
   2  * Copyright (C) 2018 6WIND
   3  *
   4  * This program is free software; you can redistribute it and/or modify it
   5  * under the terms of the GNU General Public License as published by the Free
   6  * Software Foundation; either version 2 of the License, or (at your option)
   7  * any later version.
   8  *
   9  * This program is distributed in the hope that it will be useful, but WITHOUT
  10  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  11  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
  12  * more details.
  13  *
  14  * You should have received a copy of the GNU General Public License along
  15  * with this program; see the file COPYING; if not, write to the Free Software
  16  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
  17  */
  18
  19 #ifndef _TABLE_MANAGER_H
  20 #define _TABLE_MANAGER_H
  21
  22 #include <stdint.h>
  23
  24 #include "lib/linklist.h"
  25 #include "lib/thread.h"
  26 #include "lib/ns.h"
  27
  28 #include "zebra/zserv.h"
  29
  30 #ifdef __cplusplus
  31 extern "C" {
  32 #endif
  33
  34 /*
  35  * Table chunk struct
  36  * Client daemon which the chunk belongs to can be identified by either
  37  * proto (daemon protocol) + instance + VRF.
  38  * If the client then passes a non-empty value to keep field when it requests
  39  * for chunks, the chunks won't be garbage collected and the client will be
  40  * responsible of its release.
  41  * Otherwise, if the keep field is not set (value 0) for the chunk, it will be
  42  * automatically released when the client disconnects or when it reconnects
  43  * (in case it died unexpectedly, we can know it's the same because it will have
  44  * the same proto and instance values)
  45  */
  46 struct table_manager_chunk {
  47         vrf_id_t vrf_id;
  48         uint8_t proto;
  49         uint16_t instance;
  50         uint32_t start; /* First table RT ID of the chunk */
  51         uint32_t end;   /* Last table RT ID of the chunk */
  52 };
  53
  54 /*
  55  * Main table manager struct
  56  * Holds a linked list of table chunks.
  57  */
  58 struct table_manager {
  59         struct list *lc_list;
  60 };
  61
  62 void table_manager_enable(ns_id_t ns_id);
  63 struct table_manager_chunk *assign_table_chunk(uint8_t proto, uint16_t instance,
  64                                                uint32_t size);
  65 int release_table_chunk(uint8_t proto, uint16_t instance, uint32_t start,
  66                         uint32_t end);
  67 int release_daemon_table_chunks(struct zserv *client);
  68 void table_manager_disable(ns_id_t ns_id);
  69
  70 #ifdef __cplusplus
  71 }
  72 #endif
  73
  74 #endif /* _TABLE_MANAGER_H */