sys/netinet/cc/cc_module.h

   1 /*-
   2  * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
   3  *
   4  * Copyright (c) 2009-2010 Lawrence Stewart <lstewart@freebsd.org>
   5  * All rights reserved.
   6  *
   7  * This software was developed by Lawrence Stewart while studying at the Centre
   8  * for Advanced Internet Architectures, Swinburne University of Technology, made
   9  * possible in part by a grant from the Cisco University Research Program Fund
  10  * at Community Foundation Silicon Valley.
  11  *
  12  * Redistribution and use in source and binary forms, with or without
  13  * modification, are permitted provided that the following conditions
  14  * are met:
  15  * 1. Redistributions of source code must retain the above copyright
  16  *    notice, this list of conditions and the following disclaimer.
  17  * 2. Redistributions in binary form must reproduce the above copyright
  18  *    notice, this list of conditions and the following disclaimer in the
  19  *    documentation and/or other materials provided with the distribution.
  20  *
  21  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  22  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  23  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  24  * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  25  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  26  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  27  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  28  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  29  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  30  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  31  * SUCH DAMAGE.
  32  *
  33  * $FreeBSD$
  34  */
  35
  36 /*
  37  * This software was first released in 2009 by Lawrence Stewart as part of the
  38  * NewTCP research project at Swinburne University of Technology's Centre for
  39  * Advanced Internet Architectures, Melbourne, Australia, which was made
  40  * possible in part by a grant from the Cisco University Research Program Fund
  41  * at Community Foundation Silicon Valley. More details are available at:
  42  *   http://caia.swin.edu.au/urp/newtcp/
  43  */
  44
  45 #ifndef _NETINET_CC_MODULE_H_
  46 #define _NETINET_CC_MODULE_H_
  47
  48 /*
  49  * Allows a CC algorithm to manipulate a commonly named CC variable regardless
  50  * of the transport protocol and associated C struct.
  51  * XXXLAS: Out of action until the work to support SCTP is done.
  52  *
  53 #define CCV(ccv, what)                                                  \
  54 (*(                                                                     \
  55         (ccv)->type == IPPROTO_TCP ?    &(ccv)->ccvc.tcp->what :        \
  56                                         &(ccv)->ccvc.sctp->what         \
  57 ))
  58  */
  59 #define CCV(ccv, what) (ccv)->ccvc.tcp->what
  60
  61 #define DECLARE_CC_MODULE(ccname, ccalgo)                               \
  62         static moduledata_t cc_##ccname = {                             \
  63                 .name = #ccname,                                        \
  64                 .evhand = cc_modevent,                                  \
  65                 .priv = ccalgo                                          \
  66         };                                                              \
  67         DECLARE_MODULE(ccname, cc_##ccname,                             \
  68             SI_SUB_PROTO_IFATTACHDOMAIN, SI_ORDER_ANY)
  69
  70 int     cc_modevent(module_t mod, int type, void *data);
  71
  72 #endif /* _NETINET_CC_MODULE_H_ */