lib/netdev.h

   1 /*
   2  * Copyright (c) 2008, 2009, 2010 Nicira Networks.
   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 NETDEV_H
  18 #define NETDEV_H 1
  19
  20 #include <stdbool.h>
  21 #include <stddef.h>
  22 #include <stdint.h>
  23
  24 /* Generic interface to network devices.
  25  *
  26  * Currently, there is a single implementation of this interface that supports
  27  * Linux.  The interface should be generic enough to be implementable on other
  28  * operating systems as well. */
  29
  30 struct ofpbuf;
  31 struct in_addr;
  32 struct in6_addr;
  33 struct shash;
  34 struct svec;
  35
  36 enum netdev_flags {
  37     NETDEV_UP = 0x0001,         /* Device enabled? */
  38     NETDEV_PROMISC = 0x0002,    /* Promiscuous mode? */
  39     NETDEV_LOOPBACK = 0x0004    /* This is a loopback device. */
  40 };
  41
  42 enum netdev_pseudo_ethertype {
  43     NETDEV_ETH_TYPE_NONE = -128, /* Receive no frames. */
  44     NETDEV_ETH_TYPE_ANY,         /* Receive all frames. */
  45     NETDEV_ETH_TYPE_802_2        /* Receive all IEEE 802.2 frames. */
  46 };
  47
  48 /* Network device statistics.
  49  *
  50  * Values of unsupported statistics are set to all-1-bits (UINT64_MAX). */
  51 struct netdev_stats {
  52     uint64_t rx_packets;        /* Total packets received. */
  53     uint64_t tx_packets;        /* Total packets transmitted. */
  54     uint64_t rx_bytes;          /* Total bytes received. */
  55     uint64_t tx_bytes;          /* Total bytes transmitted. */
  56     uint64_t rx_errors;         /* Bad packets received. */
  57     uint64_t tx_errors;         /* Packet transmit problems. */
  58     uint64_t rx_dropped;        /* No buffer space. */
  59     uint64_t tx_dropped;        /* No buffer space. */
  60     uint64_t multicast;         /* Multicast packets received. */
  61     uint64_t collisions;
  62
  63     /* Detailed receive errors. */
  64     uint64_t rx_length_errors;
  65     uint64_t rx_over_errors;    /* Receiver ring buff overflow. */
  66     uint64_t rx_crc_errors;     /* Recved pkt with crc error. */
  67     uint64_t rx_frame_errors;   /* Recv'd frame alignment error. */
  68     uint64_t rx_fifo_errors;    /* Recv'r fifo overrun . */
  69     uint64_t rx_missed_errors;  /* Receiver missed packet. */
  70
  71     /* Detailed transmit errors. */
  72     uint64_t tx_aborted_errors;
  73     uint64_t tx_carrier_errors;
  74     uint64_t tx_fifo_errors;
  75     uint64_t tx_heartbeat_errors;
  76     uint64_t tx_window_errors;
  77 };
  78
  79 struct netdev_options {
  80     const char *name;
  81     const char *type;
  82     const struct shash *args;
  83     int ethertype;
  84     bool may_create;
  85     bool may_open;
  86 };
  87
  88 struct netdev;
  89 struct netdev_class;
  90
  91 void netdev_run(void);
  92 void netdev_wait(void);
  93
  94 int netdev_register_provider(const struct netdev_class *);
  95 int netdev_unregister_provider(const char *type);
  96 void netdev_enumerate_types(struct svec *types);
  97
  98 int netdev_open(struct netdev_options *, struct netdev **);
  99 int netdev_open_default(const char *name, struct netdev **);
 100 int netdev_reconfigure(struct netdev *, const struct shash *args);
 101 void netdev_close(struct netdev *);
 102
 103 bool netdev_exists(const char *name);
 104
 105 int netdev_enumerate(struct svec *);
 106
 107 const char *netdev_get_name(const struct netdev *);
 108 const char *netdev_get_type(const struct netdev *);
 109 int netdev_get_mtu(const struct netdev *, int *mtup);
 110 int netdev_get_ifindex(const struct netdev *);
 111
 112 int netdev_recv(struct netdev *, struct ofpbuf *);
 113 void netdev_recv_wait(struct netdev *);
 114 int netdev_drain(struct netdev *);
 115
 116 int netdev_send(struct netdev *, const struct ofpbuf *);
 117 void netdev_send_wait(struct netdev *);
 118
 119 int netdev_set_etheraddr(struct netdev *, const uint8_t mac[6]);
 120 int netdev_get_etheraddr(const struct netdev *, uint8_t mac[6]);
 121
 122 int netdev_get_carrier(const struct netdev *, bool *carrier);
 123 int netdev_get_features(struct netdev *,
 124                         uint32_t *current, uint32_t *advertised,
 125                         uint32_t *supported, uint32_t *peer);
 126 uint64_t netdev_features_to_bps(uint32_t features);
 127 bool netdev_features_is_full_duplex(uint32_t features);
 128 int netdev_set_advertisements(struct netdev *, uint32_t advertise);
 129
 130 int netdev_get_in4(const struct netdev *, struct in_addr *address,
 131                    struct in_addr *netmask);
 132 int netdev_set_in4(struct netdev *, struct in_addr addr, struct in_addr mask);
 133 int netdev_get_in6(const struct netdev *, struct in6_addr *);
 134 int netdev_add_router(struct netdev *, struct in_addr router);
 135 int netdev_get_next_hop(const struct netdev *, const struct in_addr *host,
 136                         struct in_addr *next_hop, char **);
 137 int netdev_arp_lookup(const struct netdev *, uint32_t ip, uint8_t mac[6]);
 138
 139 int netdev_get_flags(const struct netdev *, enum netdev_flags *);
 140 int netdev_set_flags(struct netdev *, enum netdev_flags, bool permanent);
 141 int netdev_turn_flags_on(struct netdev *, enum netdev_flags, bool permanent);
 142 int netdev_turn_flags_off(struct netdev *, enum netdev_flags, bool permanent);
 143
 144 int netdev_get_stats(const struct netdev *, struct netdev_stats *);
 145 int netdev_set_policing(struct netdev *, uint32_t kbits_rate,
 146                         uint32_t kbits_burst);
 147
 148 int netdev_get_vlan_vid(const struct netdev *, int *vlan_vid);
 149 struct netdev *netdev_find_dev_by_in4(const struct in_addr *);
 150
 151 struct netdev_monitor *netdev_monitor_create(void);
 152 void netdev_monitor_destroy(struct netdev_monitor *);
 153 int netdev_monitor_add(struct netdev_monitor *, struct netdev *);
 154 void netdev_monitor_remove(struct netdev_monitor *, struct netdev *);
 155 int netdev_monitor_poll(struct netdev_monitor *, char **devnamep);
 156 void netdev_monitor_poll_wait(const struct netdev_monitor *);
 157
 158 #endif /* netdev.h */