src/systemd/sd-ndisc.h

   1 #ifndef foosdndiscfoo
   2 #define foosdndiscfoo
   3
   4 /***
   5   This file is part of systemd.
   6
   7   Copyright (C) 2014 Intel Corporation. All rights reserved.
   8
   9   systemd is free software; you can redistribute it and/or modify it
  10   under the terms of the GNU Lesser General Public License as published by
  11   the Free Software Foundation; either version 2.1 of the License, or
  12   (at your option) any later version.
  13
  14   systemd is distributed in the hope that it will be useful, but
  15   WITHOUT ANY WARRANTY; without even the implied warranty of
  16   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  17   Lesser General Public License for more details.
  18
  19   You should have received a copy of the GNU Lesser General Public License
  20   along with systemd; If not, see <http://www.gnu.org/licenses/>.
  21 ***/
  22
  23 #include <inttypes.h>
  24 #include <net/ethernet.h>
  25 #include <netinet/in.h>
  26 #include <sys/types.h>
  27
  28 #include "sd-event.h"
  29
  30 #include "_sd-common.h"
  31
  32 _SD_BEGIN_DECLARATIONS;
  33
  34 /* Neightbor Discovery Options, RFC 4861, Section 4.6 and
  35  * https://www.iana.org/assignments/icmpv6-parameters/icmpv6-parameters.xhtml#icmpv6-parameters-5 */
  36 enum {
  37         SD_NDISC_OPTION_SOURCE_LL_ADDRESS  = 1,
  38         SD_NDISC_OPTION_TARGET_LL_ADDRESS  = 2,
  39         SD_NDISC_OPTION_PREFIX_INFORMATION = 3,
  40         SD_NDISC_OPTION_MTU                = 5,
  41         SD_NDISC_OPTION_ROUTE_INFORMATION  = 24,
  42         SD_NDISC_OPTION_RDNSS              = 25,
  43         SD_NDISC_OPTION_FLAGS_EXTENSION    = 26,
  44         SD_NDISC_OPTION_DNSSL              = 31,
  45         SD_NDISC_OPTION_CAPTIVE_PORTAL     = 37,
  46 };
  47
  48 /* Route preference, RFC 4191, Section 2.1 */
  49 enum {
  50         SD_NDISC_PREFERENCE_LOW    = 3U,
  51         SD_NDISC_PREFERENCE_MEDIUM = 0U,
  52         SD_NDISC_PREFERENCE_HIGH   = 1U,
  53 };
  54
  55 typedef struct sd_ndisc sd_ndisc;
  56 typedef struct sd_ndisc_router sd_ndisc_router;
  57
  58 typedef enum sd_ndisc_event {
  59         SD_NDISC_EVENT_TIMEOUT = 't',
  60         SD_NDISC_EVENT_ROUTER  = 'r',
  61 } sd_ndisc_event;
  62
  63 typedef void (*sd_ndisc_callback_t)(sd_ndisc *nd, sd_ndisc_event event, sd_ndisc_router *rt, void *userdata);
  64
  65 int sd_ndisc_new(sd_ndisc **ret);
  66 sd_ndisc *sd_ndisc_ref(sd_ndisc *nd);
  67 sd_ndisc *sd_ndisc_unref(sd_ndisc *nd);
  68
  69 int sd_ndisc_start(sd_ndisc *nd);
  70 int sd_ndisc_stop(sd_ndisc *nd);
  71
  72 int sd_ndisc_attach_event(sd_ndisc *nd, sd_event *event, int64_t priority);
  73 int sd_ndisc_detach_event(sd_ndisc *nd);
  74 sd_event *sd_ndisc_get_event(sd_ndisc *nd);
  75
  76 int sd_ndisc_set_callback(sd_ndisc *nd, sd_ndisc_callback_t cb, void *userdata);
  77 int sd_ndisc_set_ifindex(sd_ndisc *nd, int interface_index);
  78 int sd_ndisc_set_mac(sd_ndisc *nd, const struct ether_addr *mac_addr);
  79
  80 int sd_ndisc_get_mtu(sd_ndisc *nd, uint32_t *ret);
  81 int sd_ndisc_get_hop_limit(sd_ndisc *nd, uint8_t *ret);
  82
  83 int sd_ndisc_router_from_raw(sd_ndisc_router **ret, const void *raw, size_t raw_size);
  84 sd_ndisc_router *sd_ndisc_router_ref(sd_ndisc_router *rt);
  85 sd_ndisc_router *sd_ndisc_router_unref(sd_ndisc_router *rt);
  86
  87 int sd_ndisc_router_get_address(sd_ndisc_router *rt, struct in6_addr *ret_addr);
  88 int sd_ndisc_router_get_timestamp(sd_ndisc_router *rt, clockid_t clock, uint64_t *ret);
  89 int sd_ndisc_router_get_raw(sd_ndisc_router *rt, const void **ret, size_t *size);
  90
  91 int sd_ndisc_router_get_hop_limit(sd_ndisc_router *rt, uint8_t *ret);
  92 int sd_ndisc_router_get_flags(sd_ndisc_router *rt, uint64_t *ret_flags);
  93 int sd_ndisc_router_get_preference(sd_ndisc_router *rt, unsigned *ret);
  94 int sd_ndisc_router_get_lifetime(sd_ndisc_router *rt, uint16_t *ret_lifetime);
  95 int sd_ndisc_router_get_mtu(sd_ndisc_router *rt, uint32_t *ret);
  96
  97 /* Generic option access */
  98 int sd_ndisc_router_option_rewind(sd_ndisc_router *rt);
  99 int sd_ndisc_router_option_next(sd_ndisc_router *rt);
 100 int sd_ndisc_router_option_get_type(sd_ndisc_router *rt, uint8_t *ret);
 101 int sd_ndisc_router_option_is_type(sd_ndisc_router *rt, uint8_t type);
 102 int sd_ndisc_router_option_get_raw(sd_ndisc_router *rt, const void **ret, size_t *size);
 103
 104 /* Specific option access: SD_NDISC_OPTION_PREFIX_INFORMATION */
 105 int sd_ndisc_router_prefix_get_valid_lifetime(sd_ndisc_router *rt, uint32_t *ret);
 106 int sd_ndisc_router_prefix_get_preferred_lifetime(sd_ndisc_router *rt, uint32_t *ret);
 107 int sd_ndisc_router_prefix_get_flags(sd_ndisc_router *rt, uint8_t *ret);
 108 int sd_ndisc_router_prefix_get_address(sd_ndisc_router *rt, struct in6_addr *ret_addr);
 109 int sd_ndisc_router_prefix_get_prefixlen(sd_ndisc_router *rt, unsigned *prefixlen);
 110
 111 /* Specific option access: SD_NDISC_OPTION_ROUTE_INFORMATION */
 112 int sd_ndisc_router_route_get_lifetime(sd_ndisc_router *rt, uint32_t *ret);
 113 int sd_ndisc_router_route_get_address(sd_ndisc_router *rt, struct in6_addr *ret_addr);
 114 int sd_ndisc_router_route_get_prefixlen(sd_ndisc_router *rt, unsigned *prefixlen);
 115 int sd_ndisc_router_route_get_preference(sd_ndisc_router *rt, unsigned *ret);
 116
 117 /* Specific option access: SD_NDISC_OPTION_RDNSS */
 118 int sd_ndisc_router_rdnss_get_addresses(sd_ndisc_router *rt, const struct in6_addr **ret);
 119 int sd_ndisc_router_rdnss_get_lifetime(sd_ndisc_router *rt, uint32_t *ret);
 120
 121 /* Specific option access: SD_NDISC_OPTION_DNSSL */
 122 int sd_ndisc_router_dnssl_get_domains(sd_ndisc_router *rt, char ***ret);
 123 int sd_ndisc_router_dnssl_get_lifetime(sd_ndisc_router *rt, uint32_t *ret);
 124
 125 _SD_DEFINE_POINTER_CLEANUP_FUNC(sd_ndisc, sd_ndisc_unref);
 126 _SD_DEFINE_POINTER_CLEANUP_FUNC(sd_ndisc_router, sd_ndisc_router_unref);
 127
 128 _SD_END_DECLARATIONS;
 129
 130 #endif