isisd/isis_tx_queue.c

   1 /*
   2  * IS-IS Rout(e)ing protocol - LSP TX Queuing logic
   3  *
   4  * Copyright (C) 2018 Christian Franke
   5  *
   6  * This file is part of FreeRangeRouting (FRR)
   7  *
   8  * FRR is free software; you can redistribute it and/or modify it
   9  * under the terms of the GNU General Public License as published by the
  10  * Free Software Foundation; either version 2, or (at your option) any
  11  * later version.
  12  *
  13  * FRR is distributed in the hope that it will be useful, but
  14  * WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  16  * General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU General Public License along
  19  * with this program; see the file COPYING; if not, write to the Free Software
  20  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
  21  */
  22 #include <zebra.h>
  23
  24 #include "hash.h"
  25 #include "jhash.h"
  26
  27 #include "isisd/isisd.h"
  28 #include "isisd/isis_memory.h"
  29 #include "isisd/isis_flags.h"
  30 #include "dict.h"
  31 #include "isisd/isis_circuit.h"
  32 #include "isisd/isis_lsp.h"
  33 #include "isisd/isis_misc.h"
  34 #include "isisd/isis_tx_queue.h"
  35
  36 DEFINE_MTYPE_STATIC(ISISD, TX_QUEUE, "ISIS TX Queue")
  37 DEFINE_MTYPE_STATIC(ISISD, TX_QUEUE_ENTRY, "ISIS TX Queue Entry")
  38
  39 struct isis_tx_queue {
  40         struct isis_circuit *circuit;
  41         void (*send_event)(struct isis_circuit *circuit,
  42                            struct isis_lsp *, enum isis_tx_type);
  43         struct hash *hash;
  44 };
  45
  46 struct isis_tx_queue_entry {
  47         struct isis_lsp *lsp;
  48         enum isis_tx_type type;
  49         struct thread *retry;
  50         struct isis_tx_queue *queue;
  51 };
  52
  53 static unsigned tx_queue_hash_key(void *p)
  54 {
  55         struct isis_tx_queue_entry *e = p;
  56
  57         uint32_t id_key = jhash(e->lsp->hdr.lsp_id,
  58                                 ISIS_SYS_ID_LEN + 2, 0x55aa5a5a);
  59
  60         return jhash_1word(e->lsp->level, id_key);
  61 }
  62
  63 static bool tx_queue_hash_cmp(const void *a, const void *b)
  64 {
  65         const struct isis_tx_queue_entry *ea = a, *eb = b;
  66
  67         if (ea->lsp->level != eb->lsp->level)
  68                 return false;
  69
  70         if (memcmp(ea->lsp->hdr.lsp_id, eb->lsp->hdr.lsp_id,
  71                    ISIS_SYS_ID_LEN + 2))
  72                 return false;
  73
  74         return true;
  75 }
  76
  77 struct isis_tx_queue *isis_tx_queue_new(
  78                 struct isis_circuit *circuit,
  79                 void(*send_event)(struct isis_circuit *circuit,
  80                                   struct isis_lsp *,
  81                                   enum isis_tx_type))
  82 {
  83         struct isis_tx_queue *rv = XCALLOC(MTYPE_TX_QUEUE, sizeof(*rv));
  84
  85         rv->circuit = circuit;
  86         rv->send_event = send_event;
  87
  88         rv->hash = hash_create(tx_queue_hash_key, tx_queue_hash_cmp, NULL);
  89         return rv;
  90 }
  91
  92 static void tx_queue_element_free(void *element)
  93 {
  94         struct isis_tx_queue_entry *e = element;
  95
  96         if (e->retry)
  97                 thread_cancel(e->retry);
  98
  99         XFREE(MTYPE_TX_QUEUE_ENTRY, e);
 100 }
 101
 102 void isis_tx_queue_free(struct isis_tx_queue *queue)
 103 {
 104         hash_clean(queue->hash, tx_queue_element_free);
 105         hash_free(queue->hash);
 106         XFREE(MTYPE_TX_QUEUE, queue);
 107 }
 108
 109 static struct isis_tx_queue_entry *tx_queue_find(struct isis_tx_queue *queue,
 110                                                  struct isis_lsp *lsp)
 111 {
 112         struct isis_tx_queue_entry e = {
 113                 .lsp = lsp
 114         };
 115
 116         return hash_lookup(queue->hash, &e);
 117 }
 118
 119 static int tx_queue_send_event(struct thread *thread)
 120 {
 121         struct isis_tx_queue_entry *e = THREAD_ARG(thread);
 122         struct isis_tx_queue *queue = e->queue;
 123
 124         e->retry = NULL;
 125         thread_add_timer(master, tx_queue_send_event, e, 5, &e->retry);
 126
 127         queue->send_event(queue->circuit, e->lsp, e->type);
 128         /* Don't access e here anymore, send_event might have destroyed it */
 129
 130         return 0;
 131 }
 132
 133 void _isis_tx_queue_add(struct isis_tx_queue *queue,
 134                         struct isis_lsp *lsp,
 135                         enum isis_tx_type type,
 136                         const char *func, const char *file,
 137                         int line)
 138 {
 139         if (!queue)
 140                 return;
 141
 142         if (isis->debugs & DEBUG_TX_QUEUE) {
 143                 zlog_debug("Add LSP %s to %s queue as %s LSP. (From %s %s:%d)",
 144                            rawlspid_print(lsp->hdr.lsp_id),
 145                            queue->circuit->interface->name,
 146                            (type == TX_LSP_CIRCUIT_SCOPED) ?
 147                            "circuit scoped" : "regular",
 148                            func, file, line);
 149         }
 150
 151         struct isis_tx_queue_entry *e = tx_queue_find(queue, lsp);
 152         if (!e) {
 153                 e = XCALLOC(MTYPE_TX_QUEUE_ENTRY, sizeof(*e));
 154                 e->lsp = lsp;
 155                 e->queue = queue;
 156
 157                 struct isis_tx_queue_entry *inserted;
 158                 inserted = hash_get(queue->hash, e, hash_alloc_intern);
 159                 assert(inserted == e);
 160         }
 161
 162         e->type = type;
 163
 164         if (e->retry)
 165                 thread_cancel(e->retry);
 166         thread_add_event(master, tx_queue_send_event, e, 0, &e->retry);
 167 }
 168
 169 void _isis_tx_queue_del(struct isis_tx_queue *queue, struct isis_lsp *lsp,
 170                         const char *func, const char *file, int line)
 171 {
 172         if (!queue)
 173                 return;
 174
 175         struct isis_tx_queue_entry *e = tx_queue_find(queue, lsp);
 176         if (!e)
 177                 return;
 178
 179         if (isis->debugs & DEBUG_TX_QUEUE) {
 180                 zlog_debug("Remove LSP %s from %s queue. (From %s %s:%d)",
 181                            rawlspid_print(lsp->hdr.lsp_id),
 182                            queue->circuit->interface->name,
 183                            func, file, line);
 184         }
 185
 186         if (e->retry)
 187                 thread_cancel(e->retry);
 188
 189         hash_release(queue->hash, e);
 190         XFREE(MTYPE_TX_QUEUE_ENTRY, e);
 191 }
 192
 193 unsigned long isis_tx_queue_len(struct isis_tx_queue *queue)
 194 {
 195         if (!queue)
 196                 return 0;
 197
 198         return hashcount(queue->hash);
 199 }
 200
 201 void isis_tx_queue_clean(struct isis_tx_queue *queue)
 202 {
 203         hash_clean(queue->hash, tx_queue_element_free);
 204 }