sys/netinet/sctp_os.h

   1 /*-
   2  * SPDX-License-Identifier: BSD-3-Clause
   3  *
   4  * Copyright (c) 2006-2007, by Cisco Systems, Inc. All rights reserved.
   5  * Copyright (c) 2008-2012, by Randall Stewart. All rights reserved.
   6  * Copyright (c) 2008-2012, by Michael Tuexen. All rights reserved.
   7  *
   8  * Redistribution and use in source and binary forms, with or without
   9  * modification, are permitted provided that the following conditions are met:
  10  *
  11  * a) Redistributions of source code must retain the above copyright notice,
  12  *    this list of conditions and the following disclaimer.
  13  *
  14  * b) Redistributions in binary form must reproduce the above copyright
  15  *    notice, this list of conditions and the following disclaimer in
  16  *    the documentation and/or other materials provided with the distribution.
  17  *
  18  * c) Neither the name of Cisco Systems, Inc. nor the names of its
  19  *    contributors may be used to endorse or promote products derived
  20  *    from this software without specific prior written permission.
  21  *
  22  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  23  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
  24  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  25  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
  26  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  27  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  28  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  29  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  30  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  31  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
  32  * THE POSSIBILITY OF SUCH DAMAGE.
  33  */
  34
  35 #include <sys/cdefs.h>
  36 __FBSDID("$FreeBSD$");
  37
  38 #ifndef _NETINET_SCTP_OS_H_
  39 #define _NETINET_SCTP_OS_H_
  40
  41 /*
  42  * General kernel memory allocation:
  43  *  SCTP_MALLOC(element, type, size, name)
  44  *  SCTP_FREE(element)
  45  * Kernel memory allocation for "soname"- memory must be zeroed.
  46  *  SCTP_MALLOC_SONAME(name, type, size)
  47  *  SCTP_FREE_SONAME(name)
  48  */
  49
  50 /*
  51  * Zone(pool) allocation routines: MUST be defined for each OS.
  52  *  zone = zone/pool pointer.
  53  *  name = string name of the zone/pool.
  54  *  size = size of each zone/pool element.
  55  *  number = number of elements in zone/pool.
  56  *  type = structure type to allocate
  57  *
  58  * sctp_zone_t
  59  * SCTP_ZONE_INIT(zone, name, size, number)
  60  * SCTP_ZONE_GET(zone, type)
  61  * SCTP_ZONE_FREE(zone, element)
  62  * SCTP_ZONE_DESTROY(zone)
  63  */
  64
  65 #include <netinet/sctp_os_bsd.h>
  66
  67 /* All os's must implement this address gatherer. If
  68  * no VRF's exist, then vrf 0 is the only one and all
  69  * addresses and ifn's live here.
  70  */
  71 #define SCTP_DEFAULT_VRF 0
  72 void sctp_init_vrf_list(int vrfid);
  73
  74 #endif