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 #include "openvswitch/types.h"
  25
  26 struct ofpbuf;
  27 struct nln_notifier;
  28
  29 /* These functions are Linux specific, so they should be used directly only by
  30  * Linux-specific code. */
  31
  32 /* A digested version of an rtnetlink_link message sent down by the kernel to
  33  * indicate that a network device's status (link or address) has been changed.
  34  */
  35 struct rtnetlink_change {
  36     /* Copied from struct nlmsghdr. */
  37     int nlmsg_type;             /* e.g. RTM_NEWLINK, RTM_DELLINK. */
  38
  39     /* Common attributes. */
  40     int if_index;               /* Index of network device. */
  41     const char *ifname;         /* Name of network device. */
  42
  43     /* Network device link status. */
  44     int master_ifindex;         /* Ifindex of datapath master (0 if none). */
  45     int mtu;                    /* Current MTU. */
  46     struct eth_addr mac;
  47     unsigned int ifi_flags;     /* Flags of network device. */
  48
  49     /* Network device address status. */
  50     /* xxx To be added when needed. */
  51
  52     /* Link bonding info. */
  53     const char *primary;        /* Kind of primary (NULL if not primary). */
  54     const char *sub;            /* Kind of subordinate (NULL if not sub). */
  55 };
  56
  57 /* Function called to report that a netdev has changed.  'change' describes the
  58  * specific change.  It may be null if the buffer of change information
  59  * overflowed, in which case the function must assume that every device may
  60  * have changed.  'aux' is as specified in the call to
  61  * rtnetlink_notifier_register().  */
  62 typedef
  63 void rtnetlink_notify_func(const struct rtnetlink_change *change,
  64                            void *aux);
  65
  66 bool rtnetlink_type_is_rtnlgrp_link(uint16_t type);
  67 bool rtnetlink_type_is_rtnlgrp_addr(uint16_t type);
  68 bool rtnetlink_parse(struct ofpbuf *buf, struct rtnetlink_change *change);
  69 struct nln_notifier *
  70 rtnetlink_notifier_create(rtnetlink_notify_func *, void *aux);
  71 void rtnetlink_notifier_destroy(struct nln_notifier *);
  72 void rtnetlink_run(void);
  73 void rtnetlink_wait(void);
  74 void rtnetlink_report_link(void);
  75 #endif /* rtnetlink.h */