lib/rtnetlink.h

   1 /*
   2  * Copyright (c) 2009, 2015 Nicira, Inc.
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at:
   7  *
   8  *     http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17 #ifndef RTNETLINK_LINK_H
  18 #define RTNETLINK_LINK_H 1
  19
  20 #include <stdbool.h>
  21 #include <stdint.h>
  22 #include <linux/if_ether.h>
  23
  24 struct ofpbuf;
  25 struct nln_notifier;
  26
  27 /* These functions are Linux specific, so they should be used directly only by
  28  * Linux-specific code. */
  29
  30 /* A digested version of an rtnetlink_link message sent down by the kernel to
  31  * indicate that a network device's status (link or address) has been changed.
  32  */
  33 struct rtnetlink_change {
  34     /* Copied from struct nlmsghdr. */
  35     int nlmsg_type;             /* e.g. RTM_NEWLINK, RTM_DELLINK. */
  36
  37     /* Common attributes. */
  38     int if_index;               /* Index of network device. */
  39     const char *ifname;         /* Name of network device. */
  40
  41     /* Network device link status. */
  42     int master_ifindex;         /* Ifindex of datapath master (0 if none). */
  43     int mtu;                    /* Current MTU. */
  44     uint8_t addr[ETH_ALEN];
  45     unsigned int ifi_flags;     /* Flags of network device. */
  46
  47     /* Network device address status. */
  48     /* xxx To be added when needed. */
  49 };
  50
  51 /* Function called to report that a netdev has changed.  'change' describes the
  52  * specific change.  It may be null if the buffer of change information
  53  * overflowed, in which case the function must assume that every device may
  54  * have changed.  'aux' is as specified in the call to
  55  * rtnetlink_notifier_register().  */
  56 typedef
  57 void rtnetlink_notify_func(const struct rtnetlink_change *change,
  58                            void *aux);
  59
  60 bool rtnetlink_type_is_rtnlgrp_link(uint16_t type);
  61 bool rtnetlink_type_is_rtnlgrp_addr(uint16_t type);
  62 bool rtnetlink_parse(struct ofpbuf *buf, struct rtnetlink_change *change);
  63 struct nln_notifier *
  64 rtnetlink_notifier_create(rtnetlink_notify_func *, void *aux);
  65 void rtnetlink_notifier_destroy(struct nln_notifier *);
  66 void rtnetlink_run(void);
  67 void rtnetlink_wait(void);
  68 #endif /* rtnetlink.h */