sys/netinet/cc/cc_module.h

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