lib/netdev.h

   1 /*
   2  * Copyright (c) 2008, 2009, 2010, 2011, 2012 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 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;
  79 struct netdev_class;
  80
  81 void netdev_run(void);
  82 void netdev_wait(void);
  83
  84 void netdev_enumerate_types(struct sset *types);
  85
  86 /* Open and close. */
  87 int netdev_open(const char *name, const char *type, struct netdev **);
  88 void netdev_close(struct netdev *);
  89
  90 bool netdev_exists(const char *name);
  91 bool netdev_is_open(const char *name);
  92
  93 void netdev_parse_name(const char *netdev_name, char **name, char **type);
  94
  95 /* Options. */
  96 int netdev_set_config(struct netdev *, const struct shash *args);
  97 int netdev_get_config(const struct netdev *, struct shash *);
  98
  99 /* Basic properties. */
 100 const char *netdev_get_name(const struct netdev *);
 101 const char *netdev_get_type(const struct netdev *);
 102 int netdev_get_mtu(const struct netdev *, int *mtup);
 103 int netdev_set_mtu(const struct netdev *, int mtu);
 104 int netdev_get_ifindex(const struct netdev *);
 105
 106 /* Packet send and receive. */
 107 int netdev_listen(struct netdev *);
 108 int netdev_recv(struct netdev *, struct ofpbuf *);
 109 void netdev_recv_wait(struct netdev *);
 110 int netdev_drain(struct netdev *);
 111
 112 int netdev_send(struct netdev *, const struct ofpbuf *);
 113 void netdev_send_wait(struct netdev *);
 114
 115 /* Hardware address. */
 116 int netdev_set_etheraddr(struct netdev *, const uint8_t mac[6]);
 117 int netdev_get_etheraddr(const struct netdev *, uint8_t mac[6]);
 118
 119 /* PHY interface. */
 120 bool netdev_get_carrier(const struct netdev *);
 121 long long int netdev_get_carrier_resets(const struct netdev *);
 122 int netdev_set_miimon_interval(struct netdev *, long long int interval);
 123
 124 /* Features. */
 125 enum netdev_features {
 126     NETDEV_F_10MB_HD =    1 << 0,  /* 10 Mb half-duplex rate support. */
 127     NETDEV_F_10MB_FD =    1 << 1,  /* 10 Mb full-duplex rate support. */
 128     NETDEV_F_100MB_HD =   1 << 2,  /* 100 Mb half-duplex rate support. */
 129     NETDEV_F_100MB_FD =   1 << 3,  /* 100 Mb full-duplex rate support. */
 130     NETDEV_F_1GB_HD =     1 << 4,  /* 1 Gb half-duplex rate support. */
 131     NETDEV_F_1GB_FD =     1 << 5,  /* 1 Gb full-duplex rate support. */
 132     NETDEV_F_10GB_FD =    1 << 6,  /* 10 Gb full-duplex rate support. */
 133     NETDEV_F_40GB_FD =    1 << 7,  /* 40 Gb full-duplex rate support. */
 134     NETDEV_F_100GB_FD =   1 << 8,  /* 100 Gb full-duplex rate support. */
 135     NETDEV_F_1TB_FD =     1 << 9,  /* 1 Tb full-duplex rate support. */
 136     NETDEV_F_OTHER =      1 << 10, /* Other rate, not in the list. */
 137     NETDEV_F_COPPER =     1 << 11, /* Copper medium. */
 138     NETDEV_F_FIBER =      1 << 12, /* Fiber medium. */
 139     NETDEV_F_AUTONEG =    1 << 13, /* Auto-negotiation. */
 140     NETDEV_F_PAUSE =      1 << 14, /* Pause. */
 141     NETDEV_F_PAUSE_ASYM = 1 << 15, /* Asymmetric pause. */
 142 };
 143
 144 int netdev_get_features(const struct netdev *,
 145                         enum netdev_features *current,
 146                         enum netdev_features *advertised,
 147                         enum netdev_features *supported,
 148                         enum netdev_features *peer);
 149 uint64_t netdev_features_to_bps(enum netdev_features features);
 150 bool netdev_features_is_full_duplex(enum netdev_features features);
 151 int netdev_set_advertisements(struct netdev *, enum netdev_features advertise);
 152
 153 /* TCP/IP stack interface. */
 154 int netdev_get_in4(const struct netdev *, struct in_addr *address,
 155                    struct in_addr *netmask);
 156 int netdev_set_in4(struct netdev *, struct in_addr addr, struct in_addr mask);
 157 int netdev_get_in4_by_name(const char *device_name, struct in_addr *in4);
 158 int netdev_get_in6(const struct netdev *, struct in6_addr *);
 159 int netdev_add_router(struct netdev *, struct in_addr router);
 160 int netdev_get_next_hop(const struct netdev *, const struct in_addr *host,
 161                         struct in_addr *next_hop, char **);
 162 int netdev_get_drv_info(const struct netdev *, struct shash *sh);
 163 int netdev_arp_lookup(const struct netdev *, ovs_be32 ip, uint8_t mac[6]);
 164
 165 int netdev_get_flags(const struct netdev *, enum netdev_flags *);
 166 int netdev_set_flags(struct netdev *, enum netdev_flags, bool permanent);
 167 int netdev_turn_flags_on(struct netdev *, enum netdev_flags, bool permanent);
 168 int netdev_turn_flags_off(struct netdev *, enum netdev_flags, bool permanent);
 169 struct netdev *netdev_find_dev_by_in4(const struct in_addr *);
 170
 171 /* Statistics. */
 172 int netdev_get_stats(const struct netdev *, struct netdev_stats *);
 173 int netdev_set_stats(struct netdev *, const struct netdev_stats *);
 174
 175 /* Quality of service. */
 176 struct netdev_qos_capabilities {
 177     unsigned int n_queues;
 178 };
 179
 180 struct netdev_queue_stats {
 181     /* Values of unsupported statistics are set to all-1-bits (UINT64_MAX). */
 182     uint64_t tx_bytes;
 183     uint64_t tx_packets;
 184     uint64_t tx_errors;
 185 };
 186
 187 int netdev_set_policing(struct netdev *, uint32_t kbits_rate,
 188                         uint32_t kbits_burst);
 189
 190 int netdev_get_qos_types(const struct netdev *, struct sset *types);
 191 int netdev_get_qos_capabilities(const struct netdev *,
 192                                 const char *type,
 193                                 struct netdev_qos_capabilities *);
 194 int netdev_get_n_queues(const struct netdev *,
 195                         const char *type, unsigned int *n_queuesp);
 196
 197 int netdev_get_qos(const struct netdev *,
 198                    const char **typep, struct shash *details);
 199 int netdev_set_qos(struct netdev *,
 200                    const char *type, const struct shash *details);
 201
 202 int netdev_get_queue(const struct netdev *,
 203                      unsigned int queue_id, struct shash *details);
 204 int netdev_set_queue(struct netdev *,
 205                      unsigned int queue_id, const struct shash *details);
 206 int netdev_delete_queue(struct netdev *, unsigned int queue_id);
 207 int netdev_get_queue_stats(const struct netdev *, unsigned int queue_id,
 208                            struct netdev_queue_stats *);
 209
 210 typedef void netdev_dump_queues_cb(unsigned int queue_id,
 211                                    const struct shash *details, void *aux);
 212 int netdev_dump_queues(const struct netdev *,
 213                        netdev_dump_queues_cb *, void *aux);
 214
 215 typedef void netdev_dump_queue_stats_cb(unsigned int queue_id,
 216                                         struct netdev_queue_stats *,
 217                                         void *aux);
 218 int netdev_dump_queue_stats(const struct netdev *,
 219                             netdev_dump_queue_stats_cb *, void *aux);
 220
 221 unsigned int netdev_change_seq(const struct netdev *netdev);
 222
 223 #ifdef  __cplusplus
 224 }
 225 #endif
 226
 227 #endif /* netdev.h */