sys/net/route/nhgrp_var.h

   1 /*-
   2  * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
   3  *
   4  * Copyright (c) 2020 Alexander V. Chernikov
   5  *
   6  * Redistribution and use in source and binary forms, with or without
   7  * modification, are permitted provided that the following conditions
   8  * are met:
   9  * 1. Redistributions of source code must retain the above copyright
  10  *    notice, this list of conditions and the following disclaimer.
  11  * 2. Redistributions in binary form must reproduce the above copyright
  12  *    notice, this list of conditions and the following disclaimer in the
  13  *    documentation and/or other materials provided with the distribution.
  14  *
  15  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  16  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  17  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  18  * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  19  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  20  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  21  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  22  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  23  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  24  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  25  * SUCH DAMAGE.
  26  *
  27  * $FreeBSD$
  28  */
  29
  30 /*
  31  * This header file contains private definitions for the nexthop groups.
  32  *
  33  * Header is not intended to be included by the code external to the
  34  * routing subsystem.
  35  */
  36
  37 #ifndef _NET_ROUTE_NHGRP_VAR_H_
  38 #define _NET_ROUTE_NHGRP_VAR_H_
  39
  40 /* nhgrp hash definition */
  41 /* produce hash value for an object */
  42 #define mpath_hash_obj(_obj)    (hash_nhgrp(_obj))
  43 /* compare two objects */
  44 #define mpath_cmp(_one, _two)   (cmp_nhgrp(_one, _two))
  45 /* next object accessor */
  46 #define mpath_next(_obj)        (_obj)->nhg_priv_next
  47
  48 struct nhgrp_priv {
  49         uint32_t                nhg_idx;
  50         uint8_t                 nhg_nh_count;   /* number of items in nh_weights */
  51         uint8_t                 nhg_spare[3];
  52         u_int                   nhg_refcount;   /* use refcount */
  53         u_int                   nhg_linked;     /* refcount(9), == 2 if linked to the list */
  54         struct nh_control       *nh_control;    /* parent control structure */
  55         struct nhgrp_priv       *nhg_priv_next;
  56         struct nhgrp_object     *nhg;
  57         struct epoch_context    nhg_epoch_ctx;  /* epoch data for nhop */
  58         struct weightened_nhop  nhg_nh_weights[0];
  59 };
  60
  61 #define _NHGRP_PRIV(_src)        (&(_src)->nhops[(_src)->nhg_size])
  62 #define NHGRP_PRIV(_src)         ((struct nhgrp_priv *)_NHGRP_PRIV(_src))
  63 #define NHGRP_PRIV_CONST(_src)   ((const struct nhgrp_priv *)_NHGRP_PRIV(_src))
  64
  65 /* nhgrp.c */
  66 bool nhgrp_ctl_alloc_default(struct nh_control *ctl, int malloc_flags);
  67 struct nhgrp_priv *find_nhgrp(struct nh_control *ctl, const struct nhgrp_priv *key);
  68 int link_nhgrp(struct nh_control *ctl, struct nhgrp_priv *grp_priv);
  69 struct nhgrp_priv *unlink_nhgrp(struct nh_control *ctl, struct nhgrp_priv *key);
  70
  71 #endif
  72