lib/netdev.h

   1 /*
   2  * Copyright (c) 2008, 2009, 2010, 2011 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 #include "openvswitch/types.h"
  24
  25 #ifdef  __cplusplus
  26 extern "C" {
  27 #endif
  28
  29 /* Generic interface to network devices.
  30  *
  31  * Currently, there is a single implementation of this interface that supports
  32  * Linux.  The interface should be generic enough to be implementable on other
  33  * operating systems as well. */
  34
  35 struct ofpbuf;
  36 struct in_addr;
  37 struct in6_addr;
  38 struct shash;
  39 struct sset;
  40
  41 enum netdev_flags {
  42     NETDEV_UP = 0x0001,         /* Device enabled? */
  43     NETDEV_PROMISC = 0x0002,    /* Promiscuous mode? */
  44     NETDEV_LOOPBACK = 0x0004    /* This is a loopback device. */
  45 };
  46
  47 /* Network device statistics.
  48  *
  49  * Values of unsupported statistics are set to all-1-bits (UINT64_MAX). */
  50 struct netdev_stats {
  51     uint64_t rx_packets;        /* Total packets received. */
  52     uint64_t tx_packets;        /* Total packets transmitted. */
  53     uint64_t rx_bytes;          /* Total bytes received. */
  54     uint64_t tx_bytes;          /* Total bytes transmitted. */
  55     uint64_t rx_errors;         /* Bad packets received. */
  56     uint64_t tx_errors;         /* Packet transmit problems. */
  57     uint64_t rx_dropped;        /* No buffer space. */
  58     uint64_t tx_dropped;        /* No buffer space. */
  59     uint64_t multicast;         /* Multicast packets received. */
  60     uint64_t collisions;
  61
  62     /* Detailed receive errors. */
  63     uint64_t rx_length_errors;
  64     uint64_t rx_over_errors;    /* Receiver ring buff overflow. */
  65     uint64_t rx_crc_errors;     /* Recved pkt with crc error. */
  66     uint64_t rx_frame_errors;   /* Recv'd frame alignment error. */
  67     uint64_t rx_fifo_errors;    /* Recv'r fifo overrun . */
  68     uint64_t rx_missed_errors;  /* Receiver missed packet. */
  69
  70     /* Detailed transmit errors. */
  71     uint64_t tx_aborted_errors;
  72     uint64_t tx_carrier_errors;
  73     uint64_t tx_fifo_errors;
  74     uint64_t tx_heartbeat_errors;
  75     uint64_t tx_window_errors;
  76 };
  77
  78 struct netdev_options {
  79     const char *name;
  80     const char *type;
  81 };
  82
  83 struct netdev;
  84 struct netdev_class;
  85
  86 void netdev_run(void);
  87 void netdev_wait(void);
  88
  89 void netdev_enumerate_types(struct sset *types);
  90
  91 /* Open and close. */
  92 int netdev_open(struct netdev_options *, struct netdev **);
  93 int netdev_open_default(const char *name, struct netdev **);
  94 void netdev_close(struct netdev *);
  95
  96 bool netdev_exists(const char *name);
  97 bool netdev_is_open(const char *name);
  98
  99 int netdev_enumerate(struct sset *);
 100
 101 /* Options. */
 102 int netdev_set_config(struct netdev *, const struct shash *args);
 103 int netdev_get_config(const struct netdev *, struct shash *);
 104
 105 /* Basic properties. */
 106 const char *netdev_get_name(const struct netdev *);
 107 const char *netdev_get_type(const struct netdev *);
 108 int netdev_get_mtu(const struct netdev *, int *mtup);
 109 int netdev_get_ifindex(const struct netdev *);
 110
 111 /* Packet send and receive. */
 112 int netdev_listen(struct netdev *);
 113 int netdev_recv(struct netdev *, struct ofpbuf *);
 114 void netdev_recv_wait(struct netdev *);
 115 int netdev_drain(struct netdev *);
 116
 117 int netdev_send(struct netdev *, const struct ofpbuf *);
 118 void netdev_send_wait(struct netdev *);
 119
 120 /* Hardware address. */
 121 int netdev_set_etheraddr(struct netdev *, const uint8_t mac[6]);
 122 int netdev_get_etheraddr(const struct netdev *, uint8_t mac[6]);
 123
 124 /* PHY interface. */
 125 bool netdev_get_carrier(const struct netdev *);
 126 int netdev_set_miimon_interval(struct netdev *, long long int interval);
 127 int netdev_get_features(const struct netdev *,
 128                         uint32_t *current, uint32_t *advertised,
 129                         uint32_t *supported, uint32_t *peer);
 130 uint64_t netdev_features_to_bps(uint32_t features);
 131 bool netdev_features_is_full_duplex(uint32_t features);
 132 int netdev_set_advertisements(struct netdev *, uint32_t advertise);
 133
 134 /* TCP/IP stack interface. */
 135 int netdev_get_in4(const struct netdev *, struct in_addr *address,
 136                    struct in_addr *netmask);
 137 int netdev_set_in4(struct netdev *, struct in_addr addr, struct in_addr mask);
 138 int netdev_get_in6(const struct netdev *, struct in6_addr *);
 139 int netdev_add_router(struct netdev *, struct in_addr router);
 140 int netdev_get_next_hop(const struct netdev *, const struct in_addr *host,
 141                         struct in_addr *next_hop, char **);
 142 int netdev_get_status(const struct netdev *, struct shash *sh);
 143 int netdev_arp_lookup(const struct netdev *, ovs_be32 ip, uint8_t mac[6]);
 144
 145 int netdev_get_flags(const struct netdev *, enum netdev_flags *);
 146 int netdev_set_flags(struct netdev *, enum netdev_flags, bool permanent);
 147 int netdev_turn_flags_on(struct netdev *, enum netdev_flags, bool permanent);
 148 int netdev_turn_flags_off(struct netdev *, enum netdev_flags, bool permanent);
 149 struct netdev *netdev_find_dev_by_in4(const struct in_addr *);
 150
 151 /* Statistics. */
 152 int netdev_get_stats(const struct netdev *, struct netdev_stats *);
 153 int netdev_set_stats(struct netdev *, const struct netdev_stats *);
 154
 155 /* Quality of service. */
 156 struct netdev_qos_capabilities {
 157     unsigned int n_queues;
 158 };
 159
 160 struct netdev_queue_stats {
 161     /* Values of unsupported statistics are set to all-1-bits (UINT64_MAX). */
 162     uint64_t tx_bytes;
 163     uint64_t tx_packets;
 164     uint64_t tx_errors;
 165 };
 166
 167 int netdev_set_policing(struct netdev *, uint32_t kbits_rate,
 168                         uint32_t kbits_burst);
 169
 170 int netdev_get_qos_types(const struct netdev *, struct sset *types);
 171 int netdev_get_qos_capabilities(const struct netdev *,
 172                                 const char *type,
 173                                 struct netdev_qos_capabilities *);
 174 int netdev_get_n_queues(const struct netdev *,
 175                         const char *type, unsigned int *n_queuesp);
 176
 177 int netdev_get_qos(const struct netdev *,
 178                    const char **typep, struct shash *details);
 179 int netdev_set_qos(struct netdev *,
 180                    const char *type, const struct shash *details);
 181
 182 int netdev_get_queue(const struct netdev *,
 183                      unsigned int queue_id, struct shash *details);
 184 int netdev_set_queue(struct netdev *,
 185                      unsigned int queue_id, const struct shash *details);
 186 int netdev_delete_queue(struct netdev *, unsigned int queue_id);
 187 int netdev_get_queue_stats(const struct netdev *, unsigned int queue_id,
 188                            struct netdev_queue_stats *);
 189
 190 typedef void netdev_dump_queues_cb(unsigned int queue_id,
 191                                    const struct shash *details, void *aux);
 192 int netdev_dump_queues(const struct netdev *,
 193                        netdev_dump_queues_cb *, void *aux);
 194
 195 typedef void netdev_dump_queue_stats_cb(unsigned int queue_id,
 196                                         struct netdev_queue_stats *,
 197                                         void *aux);
 198 int netdev_dump_queue_stats(const struct netdev *,
 199                             netdev_dump_queue_stats_cb *, void *aux);
 200
 201 unsigned int netdev_change_seq(const struct netdev *netdev);
 202
 203 /* Linux stuff. */
 204 int netdev_get_vlan_vid(const struct netdev *, int *vlan_vid);
 205
 206 #ifdef  __cplusplus
 207 }
 208 #endif
 209
 210 #endif /* netdev.h */