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 FRRouting (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_flags.h"
  29 #include "isisd/isis_circuit.h"
  30 #include "isisd/isis_lsp.h"
  31 #include "isisd/isis_misc.h"
  32 #include "isisd/isis_tx_queue.h"
  33
  34 DEFINE_MTYPE_STATIC(ISISD, TX_QUEUE, "ISIS TX Queue");
  35 DEFINE_MTYPE_STATIC(ISISD, TX_QUEUE_ENTRY, "ISIS TX Queue Entry");
  36
  37 struct isis_tx_queue {
  38         struct isis_circuit *circuit;
  39         void (*send_event)(struct isis_circuit *circuit,
  40                            struct isis_lsp *, enum isis_tx_type);
  41         struct hash *hash;
  42 };
  43
  44 struct isis_tx_queue_entry {
  45         struct isis_lsp *lsp;
  46         enum isis_tx_type type;
  47         bool is_retry;
  48         struct thread *retry;
  49         struct isis_tx_queue *queue;
  50 };
  51
  52 static unsigned tx_queue_hash_key(const void *p)
  53 {
  54         const struct isis_tx_queue_entry *e = p;
  55
  56         uint32_t id_key = jhash(e->lsp->hdr.lsp_id,
  57                                 ISIS_SYS_ID_LEN + 2, 0x55aa5a5a);
  58
  59         return jhash_1word(e->lsp->level, id_key);
  60 }
  61
  62 static bool tx_queue_hash_cmp(const void *a, const void *b)
  63 {
  64         const struct isis_tx_queue_entry *ea = a, *eb = b;
  65
  66         if (ea->lsp->level != eb->lsp->level)
  67                 return false;
  68
  69         if (memcmp(ea->lsp->hdr.lsp_id, eb->lsp->hdr.lsp_id,
  70                    ISIS_SYS_ID_LEN + 2))
  71                 return false;
  72
  73         return true;
  74 }
  75
  76 struct isis_tx_queue *isis_tx_queue_new(
  77                 struct isis_circuit *circuit,
  78                 void(*send_event)(struct isis_circuit *circuit,
  79                                   struct isis_lsp *,
  80                                   enum isis_tx_type))
  81 {
  82         struct isis_tx_queue *rv = XCALLOC(MTYPE_TX_QUEUE, sizeof(*rv));
  83
  84         rv->circuit = circuit;
  85         rv->send_event = send_event;
  86
  87         rv->hash = hash_create(tx_queue_hash_key, tx_queue_hash_cmp, NULL);
  88         return rv;
  89 }
  90
  91 static void tx_queue_element_free(void *element)
  92 {
  93         struct isis_tx_queue_entry *e = element;
  94
  95         thread_cancel(&(e->retry));
  96
  97         XFREE(MTYPE_TX_QUEUE_ENTRY, e);
  98 }
  99
 100 void isis_tx_queue_free(struct isis_tx_queue *queue)
 101 {
 102         hash_clean(queue->hash, tx_queue_element_free);
 103         hash_free(queue->hash);
 104         XFREE(MTYPE_TX_QUEUE, queue);
 105 }
 106
 107 static struct isis_tx_queue_entry *tx_queue_find(struct isis_tx_queue *queue,
 108                                                  struct isis_lsp *lsp)
 109 {
 110         struct isis_tx_queue_entry e = {
 111                 .lsp = lsp
 112         };
 113
 114         return hash_lookup(queue->hash, &e);
 115 }
 116
 117 static int tx_queue_send_event(struct thread *thread)
 118 {
 119         struct isis_tx_queue_entry *e = THREAD_ARG(thread);
 120         struct isis_tx_queue *queue = e->queue;
 121
 122         thread_add_timer(master, tx_queue_send_event, e, 5, &e->retry);
 123
 124         if (e->is_retry)
 125                 queue->circuit->area->lsp_rxmt_count++;
 126         else
 127                 e->is_retry = true;
 128
 129         queue->send_event(queue->circuit, e->lsp, e->type);
 130         /* Don't access e here anymore, send_event might have destroyed it */
 131
 132         return 0;
 133 }
 134
 135 void _isis_tx_queue_add(struct isis_tx_queue *queue,
 136                         struct isis_lsp *lsp,
 137                         enum isis_tx_type type,
 138                         const char *func, const char *file,
 139                         int line)
 140 {
 141         if (!queue)
 142                 return;
 143
 144         if (IS_DEBUG_TX_QUEUE) {
 145                 zlog_debug("Add LSP %s to %s queue as %s LSP. (From %s %s:%d)",
 146                            rawlspid_print(lsp->hdr.lsp_id),
 147                            queue->circuit->interface->name,
 148                            (type == TX_LSP_CIRCUIT_SCOPED) ?
 149                            "circuit scoped" : "regular",
 150                            func, file, line);
 151         }
 152
 153         struct isis_tx_queue_entry *e = tx_queue_find(queue, lsp);
 154         if (!e) {
 155                 e = XCALLOC(MTYPE_TX_QUEUE_ENTRY, sizeof(*e));
 156                 e->lsp = lsp;
 157                 e->queue = queue;
 158
 159                 struct isis_tx_queue_entry *inserted;
 160                 inserted = hash_get(queue->hash, e, hash_alloc_intern);
 161                 assert(inserted == e);
 162         }
 163
 164         e->type = type;
 165
 166         thread_cancel(&(e->retry));
 167         thread_add_event(master, tx_queue_send_event, e, 0, &e->retry);
 168
 169         e->is_retry = false;
 170 }
 171
 172 void _isis_tx_queue_del(struct isis_tx_queue *queue, struct isis_lsp *lsp,
 173                         const char *func, const char *file, int line)
 174 {
 175         if (!queue)
 176                 return;
 177
 178         struct isis_tx_queue_entry *e = tx_queue_find(queue, lsp);
 179         if (!e)
 180                 return;
 181
 182         if (IS_DEBUG_TX_QUEUE) {
 183                 zlog_debug("Remove LSP %s from %s queue. (From %s %s:%d)",
 184                            rawlspid_print(lsp->hdr.lsp_id),
 185                            queue->circuit->interface->name,
 186                            func, file, line);
 187         }
 188
 189         thread_cancel(&(e->retry));
 190
 191         hash_release(queue->hash, e);
 192         XFREE(MTYPE_TX_QUEUE_ENTRY, e);
 193 }
 194
 195 unsigned long isis_tx_queue_len(struct isis_tx_queue *queue)
 196 {
 197         if (!queue)
 198                 return 0;
 199
 200         return hashcount(queue->hash);
 201 }
 202
 203 void isis_tx_queue_clean(struct isis_tx_queue *queue)
 204 {
 205         hash_clean(queue->hash, tx_queue_element_free);
 206 }