lib/netdev.h

   1 /*
   2  * Copyright (c) 2008, 2009, 2010, 2011, 2012, 2013 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 ("netdev"s).
  30  *
  31  * Every port on a switch must have a corresponding netdev that must minimally
  32  * support a few operations, such as the ability to read the netdev's MTU.
  33  * The PORTING file at the top of the source tree has more information in the
  34  * "Writing a netdev Provider" section.
  35  *
  36  * Thread-safety
  37  * =============
  38  *
  39  * Most of the netdev functions are fully thread-safe: they may be called from
  40  * any number of threads on the same or different netdev objects.  The
  41  * exceptions are:
  42  *
  43  *    netdev_rx_recv()
  44  *    netdev_rx_wait()
  45  *    netdev_rx_drain()
  46  *
  47  *      These functions are conditionally thread-safe: they may be called from
  48  *      different threads only on different netdev_rx objects.  (The client may
  49  *      create multiple netdev_rx objects for a single netdev and access each
  50  *      of those from a different thread.) */
  51
  52 struct netdev;
  53 struct netdev_class;
  54 struct netdev_rx;
  55 struct netdev_saved_flags;
  56 struct ofpbuf;
  57 struct in_addr;
  58 struct in6_addr;
  59 struct smap;
  60 struct sset;
  61
  62 /* Network device statistics.
  63  *
  64  * Values of unsupported statistics are set to all-1-bits (UINT64_MAX). */
  65 struct netdev_stats {
  66     uint64_t rx_packets;        /* Total packets received. */
  67     uint64_t tx_packets;        /* Total packets transmitted. */
  68     uint64_t rx_bytes;          /* Total bytes received. */
  69     uint64_t tx_bytes;          /* Total bytes transmitted. */
  70     uint64_t rx_errors;         /* Bad packets received. */
  71     uint64_t tx_errors;         /* Packet transmit problems. */
  72     uint64_t rx_dropped;        /* No buffer space. */
  73     uint64_t tx_dropped;        /* No buffer space. */
  74     uint64_t multicast;         /* Multicast packets received. */
  75     uint64_t collisions;
  76
  77     /* Detailed receive errors. */
  78     uint64_t rx_length_errors;
  79     uint64_t rx_over_errors;    /* Receiver ring buff overflow. */
  80     uint64_t rx_crc_errors;     /* Recved pkt with crc error. */
  81     uint64_t rx_frame_errors;   /* Recv'd frame alignment error. */
  82     uint64_t rx_fifo_errors;    /* Recv'r fifo overrun . */
  83     uint64_t rx_missed_errors;  /* Receiver missed packet. */
  84
  85     /* Detailed transmit errors. */
  86     uint64_t tx_aborted_errors;
  87     uint64_t tx_carrier_errors;
  88     uint64_t tx_fifo_errors;
  89     uint64_t tx_heartbeat_errors;
  90     uint64_t tx_window_errors;
  91 };
  92
  93 /* Configuration specific to tunnels. */
  94 struct netdev_tunnel_config {
  95     bool in_key_present;
  96     bool in_key_flow;
  97     ovs_be64 in_key;
  98
  99     bool out_key_present;
 100     bool out_key_flow;
 101     ovs_be64 out_key;
 102
 103     ovs_be16 dst_port;
 104
 105     bool ip_src_flow;
 106     bool ip_dst_flow;
 107     ovs_be32 ip_src;
 108     ovs_be32 ip_dst;
 109
 110     uint8_t ttl;
 111     bool ttl_inherit;
 112
 113     uint8_t tos;
 114     bool tos_inherit;
 115
 116     bool csum;
 117     bool ipsec;
 118     bool dont_fragment;
 119 };
 120
 121 void netdev_run(void);
 122 void netdev_wait(void);
 123
 124 void netdev_enumerate_types(struct sset *types);
 125 bool netdev_is_reserved_name(const char *name);
 126
 127 /* Open and close. */
 128 int netdev_open(const char *name, const char *type, struct netdev **);
 129 struct netdev *netdev_ref(const struct netdev *);
 130 void netdev_close(struct netdev *);
 131
 132 void netdev_parse_name(const char *netdev_name, char **name, char **type);
 133
 134 /* Options. */
 135 int netdev_set_config(struct netdev *, const struct smap *args);
 136 int netdev_get_config(const struct netdev *, struct smap *);
 137 const struct netdev_tunnel_config *
 138     netdev_get_tunnel_config(const struct netdev *);
 139
 140 /* Basic properties. */
 141 const char *netdev_get_name(const struct netdev *);
 142 const char *netdev_get_type(const struct netdev *);
 143 const char *netdev_get_type_from_name(const char *);
 144 int netdev_get_mtu(const struct netdev *, int *mtup);
 145 int netdev_set_mtu(const struct netdev *, int mtu);
 146 int netdev_get_ifindex(const struct netdev *);
 147
 148 /* Packet reception. */
 149 int netdev_rx_open(struct netdev *, struct netdev_rx **);
 150 void netdev_rx_close(struct netdev_rx *);
 151
 152 const char *netdev_rx_get_name(const struct netdev_rx *);
 153
 154 int netdev_rx_recv(struct netdev_rx *, struct ofpbuf *);
 155 void netdev_rx_wait(struct netdev_rx *);
 156 int netdev_rx_drain(struct netdev_rx *);
 157
 158 /* Packet transmission. */
 159 int netdev_send(struct netdev *, const struct ofpbuf *);
 160 void netdev_send_wait(struct netdev *);
 161
 162 /* Hardware address. */
 163 int netdev_set_etheraddr(struct netdev *, const uint8_t mac[6]);
 164 int netdev_get_etheraddr(const struct netdev *, uint8_t mac[6]);
 165
 166 /* PHY interface. */
 167 bool netdev_get_carrier(const struct netdev *);
 168 long long int netdev_get_carrier_resets(const struct netdev *);
 169 int netdev_set_miimon_interval(struct netdev *, long long int interval);
 170
 171 /* Features. */
 172 enum netdev_features {
 173     NETDEV_F_10MB_HD =    1 << 0,  /* 10 Mb half-duplex rate support. */
 174     NETDEV_F_10MB_FD =    1 << 1,  /* 10 Mb full-duplex rate support. */
 175     NETDEV_F_100MB_HD =   1 << 2,  /* 100 Mb half-duplex rate support. */
 176     NETDEV_F_100MB_FD =   1 << 3,  /* 100 Mb full-duplex rate support. */
 177     NETDEV_F_1GB_HD =     1 << 4,  /* 1 Gb half-duplex rate support. */
 178     NETDEV_F_1GB_FD =     1 << 5,  /* 1 Gb full-duplex rate support. */
 179     NETDEV_F_10GB_FD =    1 << 6,  /* 10 Gb full-duplex rate support. */
 180     NETDEV_F_40GB_FD =    1 << 7,  /* 40 Gb full-duplex rate support. */
 181     NETDEV_F_100GB_FD =   1 << 8,  /* 100 Gb full-duplex rate support. */
 182     NETDEV_F_1TB_FD =     1 << 9,  /* 1 Tb full-duplex rate support. */
 183     NETDEV_F_OTHER =      1 << 10, /* Other rate, not in the list. */
 184     NETDEV_F_COPPER =     1 << 11, /* Copper medium. */
 185     NETDEV_F_FIBER =      1 << 12, /* Fiber medium. */
 186     NETDEV_F_AUTONEG =    1 << 13, /* Auto-negotiation. */
 187     NETDEV_F_PAUSE =      1 << 14, /* Pause. */
 188     NETDEV_F_PAUSE_ASYM = 1 << 15, /* Asymmetric pause. */
 189 };
 190
 191 int netdev_get_features(const struct netdev *,
 192                         enum netdev_features *current,
 193                         enum netdev_features *advertised,
 194                         enum netdev_features *supported,
 195                         enum netdev_features *peer);
 196 uint64_t netdev_features_to_bps(enum netdev_features features,
 197                                 uint64_t default_bps);
 198 bool netdev_features_is_full_duplex(enum netdev_features features);
 199 int netdev_set_advertisements(struct netdev *, enum netdev_features advertise);
 200
 201 /* Flags. */
 202 enum netdev_flags {
 203     NETDEV_UP = 0x0001,         /* Device enabled? */
 204     NETDEV_PROMISC = 0x0002,    /* Promiscuous mode? */
 205     NETDEV_LOOPBACK = 0x0004    /* This is a loopback device. */
 206 };
 207
 208 int netdev_get_flags(const struct netdev *, enum netdev_flags *);
 209 int netdev_set_flags(struct netdev *, enum netdev_flags,
 210                      struct netdev_saved_flags **);
 211 int netdev_turn_flags_on(struct netdev *, enum netdev_flags,
 212                          struct netdev_saved_flags **);
 213 int netdev_turn_flags_off(struct netdev *, enum netdev_flags,
 214                           struct netdev_saved_flags **);
 215
 216 void netdev_restore_flags(struct netdev_saved_flags *);
 217
 218 /* TCP/IP stack interface. */
 219 int netdev_get_in4(const struct netdev *, struct in_addr *address,
 220                    struct in_addr *netmask);
 221 int netdev_set_in4(struct netdev *, struct in_addr addr, struct in_addr mask);
 222 int netdev_get_in4_by_name(const char *device_name, struct in_addr *in4);
 223 int netdev_get_in6(const struct netdev *, struct in6_addr *);
 224 int netdev_add_router(struct netdev *, struct in_addr router);
 225 int netdev_get_next_hop(const struct netdev *, const struct in_addr *host,
 226                         struct in_addr *next_hop, char **);
 227 int netdev_get_status(const struct netdev *, struct smap *);
 228 int netdev_arp_lookup(const struct netdev *, ovs_be32 ip, uint8_t mac[6]);
 229
 230 struct netdev *netdev_find_dev_by_in4(const struct in_addr *);
 231
 232 /* Statistics. */
 233 int netdev_get_stats(const struct netdev *, struct netdev_stats *);
 234 int netdev_set_stats(struct netdev *, const struct netdev_stats *);
 235
 236 /* Quality of service. */
 237 struct netdev_qos_capabilities {
 238     unsigned int n_queues;
 239 };
 240
 241 struct netdev_queue_stats {
 242     /* Values of unsupported statistics are set to all-1-bits (UINT64_MAX). */
 243     uint64_t tx_bytes;
 244     uint64_t tx_packets;
 245     uint64_t tx_errors;
 246
 247     /* Time at which the queue was created, in msecs, LLONG_MIN if unknown. */
 248     long long int created;
 249 };
 250
 251 int netdev_set_policing(struct netdev *, uint32_t kbits_rate,
 252                         uint32_t kbits_burst);
 253
 254 int netdev_get_qos_types(const struct netdev *, struct sset *types);
 255 int netdev_get_qos_capabilities(const struct netdev *,
 256                                 const char *type,
 257                                 struct netdev_qos_capabilities *);
 258 int netdev_get_n_queues(const struct netdev *,
 259                         const char *type, unsigned int *n_queuesp);
 260
 261 int netdev_get_qos(const struct netdev *,
 262                    const char **typep, struct smap *details);
 263 int netdev_set_qos(struct netdev *,
 264                    const char *type, const struct smap *details);
 265
 266 int netdev_get_queue(const struct netdev *,
 267                      unsigned int queue_id, struct smap *details);
 268 int netdev_set_queue(struct netdev *,
 269                      unsigned int queue_id, const struct smap *details);
 270 int netdev_delete_queue(struct netdev *, unsigned int queue_id);
 271 int netdev_get_queue_stats(const struct netdev *, unsigned int queue_id,
 272                            struct netdev_queue_stats *);
 273
 274 typedef void netdev_dump_queues_cb(unsigned int queue_id,
 275                                    const struct smap *details, void *aux);
 276 int netdev_dump_queues(const struct netdev *,
 277                        netdev_dump_queues_cb *, void *aux);
 278
 279 typedef void netdev_dump_queue_stats_cb(unsigned int queue_id,
 280                                         struct netdev_queue_stats *,
 281                                         void *aux);
 282 int netdev_dump_queue_stats(const struct netdev *,
 283                             netdev_dump_queue_stats_cb *, void *aux);
 284
 285 unsigned int netdev_change_seq(const struct netdev *netdev);
 286
 287 #ifdef  __cplusplus
 288 }
 289 #endif
 290
 291 #endif /* netdev.h */