third_party/address_sorting/include/address_sorting/address_sorting.h

   1 /*      $NetBSD: getaddrinfo.c,v 1.82 2006/03/25 12:09:40 rpaulo Exp $  */
   2 /*      $KAME: getaddrinfo.c,v 1.29 2000/08/31 17:26:57 itojun Exp $    */
   3 /*
   4  * Copyright (C) 1995, 1996, 1997, and 1998 WIDE Project.
   5  * All rights reserved.
   6  *
   7  * Redistribution and use in source and binary forms, with or without
   8  * modification, are permitted provided that the following conditions
   9  * are met:
  10  * 1. Redistributions of source code must retain the above copyright
  11  *    notice, this list of conditions and the following disclaimer.
  12  * 2. Redistributions in binary form must reproduce the above copyright
  13  *    notice, this list of conditions and the following disclaimer in the
  14  *    documentation and/or other materials provided with the distribution.
  15  * 3. Neither the name of the project nor the names of its contributors
  16  *    may be used to endorse or promote products derived from this software
  17  *    without specific prior written permission.
  18  *
  19  * THIS SOFTWARE IS PROVIDED BY THE PROJECT 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 PROJECT 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  */
  32
  33 /*
  34  * This is an adaptation of Android's implementation of RFC 6724
  35  * (in Android's getaddrinfo.c). It has some cosmetic differences
  36  * from Android's getaddrinfo.c, but Android's getaddrinfo.c was
  37  * used as a guide or example of a way to implement the RFC 6724 spec when
  38  * this was written.
  39  */
  40
  41 #ifndef ADDRESS_SORTING_H
  42 #define ADDRESS_SORTING_H
  43
  44 #include <stddef.h>
  45
  46 #ifdef __cplusplus
  47 extern "C" {
  48 #endif
  49
  50 typedef struct address_sorting_address {
  51   char addr[128];
  52   size_t len;
  53 } address_sorting_address;
  54
  55 /* address_sorting_sortable represents one entry in a list of destination
  56  * IP addresses to sort. It contains the destination IP address
  57  * "sorting key", along with placeholder and scratch fields. */
  58 typedef struct address_sorting_sortable {
  59   // input data; sorting key
  60   address_sorting_address dest_addr;
  61   // input data; optional value to attach to the sorting key
  62   void* user_data;
  63   // internal fields, these must be zero'd when passed to sort function
  64   address_sorting_address source_addr;
  65   bool source_addr_exists;
  66   size_t original_index;
  67 } address_sorting_sortable;
  68
  69 void address_sorting_rfc_6724_sort(address_sorting_sortable* sortables,
  70                                    size_t sortables_len);
  71
  72 void address_sorting_init();
  73 void address_sorting_shutdown();
  74
  75 struct address_sorting_source_addr_factory;
  76
  77 /* The interfaces below are exposed only for testing */
  78 typedef struct {
  79   /* Gets the source address that would be used for the passed-in destination
  80    * address, and fills in *source_addr* with it if one exists.
  81    * Returns true if a source address exists for the destination address,
  82    * and false otherwise. */
  83   bool (*get_source_addr)(struct address_sorting_source_addr_factory* factory,
  84                           const address_sorting_address* dest_addr,
  85                           address_sorting_address* source_addr);
  86   void (*destroy)(struct address_sorting_source_addr_factory* factory);
  87 } address_sorting_source_addr_factory_vtable;
  88
  89 typedef struct address_sorting_source_addr_factory {
  90   const address_sorting_source_addr_factory_vtable* vtable;
  91 } address_sorting_source_addr_factory;
  92
  93 /* Platform-compatible address family types */
  94 typedef enum {
  95   ADDRESS_SORTING_AF_INET,
  96   ADDRESS_SORTING_AF_INET6,
  97   ADDRESS_SORTING_UNKNOWN_FAMILY,
  98 } address_sorting_family;
  99
 100 /* Indicates whether the address is AF_INET, AF_INET6, or another address
 101  * family. */
 102 address_sorting_family address_sorting_abstract_get_family(
 103     const address_sorting_address* address);
 104
 105 void address_sorting_override_source_addr_factory_for_testing(
 106     address_sorting_source_addr_factory* factory);
 107
 108 bool address_sorting_get_source_addr_for_testing(
 109     const address_sorting_address* dest, address_sorting_address* source);
 110
 111 #ifdef __cplusplus
 112 }
 113 #endif
 114
 115 #endif  // ADDRESS_SORTING_H