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_rxq_recv()
  44  *    netdev_rxq_wait()
  45  *    netdev_rxq_drain()
  46  *
  47  *      These functions are conditionally thread-safe: they may be called from
  48  *      different threads only on different netdev_rxq objects.  (The client may
  49  *      create multiple netdev_rxq objects for a single netdev and access each
  50  *      of those from a different thread.)
  51  *
  52  *    NETDEV_FOR_EACH_QUEUE
  53  *    netdev_queue_dump_next()
  54  *    netdev_queue_dump_done()
  55  *
  56  *      These functions are conditionally thread-safe: they may be called from
  57  *      different threads only on different netdev_queue_dump objects.  (The
  58  *      client may create multiple netdev_queue_dump objects for a single
  59  *      netdev and access each of those from a different thread.)
  60  */
  61
  62 struct dpif_packet;
  63 struct netdev;
  64 struct netdev_class;
  65 struct netdev_rxq;
  66 struct netdev_saved_flags;
  67 struct ofpbuf;
  68 struct in_addr;
  69 struct in6_addr;
  70 struct smap;
  71 struct sset;
  72
  73 /* Network device statistics.
  74  *
  75  * Values of unsupported statistics are set to all-1-bits (UINT64_MAX). */
  76 struct netdev_stats {
  77     uint64_t rx_packets;        /* Total packets received. */
  78     uint64_t tx_packets;        /* Total packets transmitted. */
  79     uint64_t rx_bytes;          /* Total bytes received. */
  80     uint64_t tx_bytes;          /* Total bytes transmitted. */
  81     uint64_t rx_errors;         /* Bad packets received. */
  82     uint64_t tx_errors;         /* Packet transmit problems. */
  83     uint64_t rx_dropped;        /* No buffer space. */
  84     uint64_t tx_dropped;        /* No buffer space. */
  85     uint64_t multicast;         /* Multicast packets received. */
  86     uint64_t collisions;
  87
  88     /* Detailed receive errors. */
  89     uint64_t rx_length_errors;
  90     uint64_t rx_over_errors;    /* Receiver ring buff overflow. */
  91     uint64_t rx_crc_errors;     /* Recved pkt with crc error. */
  92     uint64_t rx_frame_errors;   /* Recv'd frame alignment error. */
  93     uint64_t rx_fifo_errors;    /* Recv'r fifo overrun . */
  94     uint64_t rx_missed_errors;  /* Receiver missed packet. */
  95
  96     /* Detailed transmit errors. */
  97     uint64_t tx_aborted_errors;
  98     uint64_t tx_carrier_errors;
  99     uint64_t tx_fifo_errors;
 100     uint64_t tx_heartbeat_errors;
 101     uint64_t tx_window_errors;
 102 };
 103
 104 /* Configuration specific to tunnels. */
 105 struct netdev_tunnel_config {
 106     bool in_key_present;
 107     bool in_key_flow;
 108     ovs_be64 in_key;
 109
 110     bool out_key_present;
 111     bool out_key_flow;
 112     ovs_be64 out_key;
 113
 114     ovs_be16 dst_port;
 115
 116     bool ip_src_flow;
 117     bool ip_dst_flow;
 118     ovs_be32 ip_src;
 119     ovs_be32 ip_dst;
 120
 121     uint8_t ttl;
 122     bool ttl_inherit;
 123
 124     uint8_t tos;
 125     bool tos_inherit;
 126
 127     bool csum;
 128     bool ipsec;
 129     bool dont_fragment;
 130 };
 131
 132 void netdev_run(void);
 133 void netdev_wait(void);
 134
 135 void netdev_enumerate_types(struct sset *types);
 136 bool netdev_is_reserved_name(const char *name);
 137
 138 int netdev_n_rxq(const struct netdev *netdev);
 139 bool netdev_is_pmd(const struct netdev *netdev);
 140
 141 /* Open and close. */
 142 int netdev_open(const char *name, const char *type, struct netdev **netdevp);
 143
 144 struct netdev *netdev_ref(const struct netdev *);
 145 void netdev_remove(struct netdev *);
 146 void netdev_close(struct netdev *);
 147
 148 void netdev_parse_name(const char *netdev_name, char **name, char **type);
 149
 150 /* Options. */
 151 int netdev_set_config(struct netdev *, const struct smap *args, char **errp);
 152 int netdev_get_config(const struct netdev *, struct smap *);
 153 const struct netdev_tunnel_config *
 154     netdev_get_tunnel_config(const struct netdev *);
 155
 156 /* Basic properties. */
 157 const char *netdev_get_name(const struct netdev *);
 158 const char *netdev_get_type(const struct netdev *);
 159 const char *netdev_get_type_from_name(const char *);
 160 int netdev_get_mtu(const struct netdev *, int *mtup);
 161 int netdev_set_mtu(const struct netdev *, int mtu);
 162 int netdev_get_ifindex(const struct netdev *);
 163
 164 /* Packet reception. */
 165 int netdev_rxq_open(struct netdev *, struct netdev_rxq **, int id);
 166 void netdev_rxq_close(struct netdev_rxq *);
 167
 168 const char *netdev_rxq_get_name(const struct netdev_rxq *);
 169
 170 int netdev_rxq_recv(struct netdev_rxq *rx, struct dpif_packet **buffers,
 171                     int *cnt);
 172 void netdev_rxq_wait(struct netdev_rxq *);
 173 int netdev_rxq_drain(struct netdev_rxq *);
 174
 175 /* Packet transmission. */
 176 int netdev_send(struct netdev *, struct dpif_packet **, int cnt,
 177                 bool may_steal);
 178 void netdev_send_wait(struct netdev *);
 179
 180 /* Hardware address. */
 181 int netdev_set_etheraddr(struct netdev *, const uint8_t mac[6]);
 182 int netdev_get_etheraddr(const struct netdev *, uint8_t mac[6]);
 183
 184 /* PHY interface. */
 185 bool netdev_get_carrier(const struct netdev *);
 186 long long int netdev_get_carrier_resets(const struct netdev *);
 187 int netdev_set_miimon_interval(struct netdev *, long long int interval);
 188
 189 /* Features. */
 190 enum netdev_features {
 191     NETDEV_F_10MB_HD =    1 << 0,  /* 10 Mb half-duplex rate support. */
 192     NETDEV_F_10MB_FD =    1 << 1,  /* 10 Mb full-duplex rate support. */
 193     NETDEV_F_100MB_HD =   1 << 2,  /* 100 Mb half-duplex rate support. */
 194     NETDEV_F_100MB_FD =   1 << 3,  /* 100 Mb full-duplex rate support. */
 195     NETDEV_F_1GB_HD =     1 << 4,  /* 1 Gb half-duplex rate support. */
 196     NETDEV_F_1GB_FD =     1 << 5,  /* 1 Gb full-duplex rate support. */
 197     NETDEV_F_10GB_FD =    1 << 6,  /* 10 Gb full-duplex rate support. */
 198     NETDEV_F_40GB_FD =    1 << 7,  /* 40 Gb full-duplex rate support. */
 199     NETDEV_F_100GB_FD =   1 << 8,  /* 100 Gb full-duplex rate support. */
 200     NETDEV_F_1TB_FD =     1 << 9,  /* 1 Tb full-duplex rate support. */
 201     NETDEV_F_OTHER =      1 << 10, /* Other rate, not in the list. */
 202     NETDEV_F_COPPER =     1 << 11, /* Copper medium. */
 203     NETDEV_F_FIBER =      1 << 12, /* Fiber medium. */
 204     NETDEV_F_AUTONEG =    1 << 13, /* Auto-negotiation. */
 205     NETDEV_F_PAUSE =      1 << 14, /* Pause. */
 206     NETDEV_F_PAUSE_ASYM = 1 << 15, /* Asymmetric pause. */
 207 };
 208
 209 int netdev_get_features(const struct netdev *,
 210                         enum netdev_features *current,
 211                         enum netdev_features *advertised,
 212                         enum netdev_features *supported,
 213                         enum netdev_features *peer);
 214 uint64_t netdev_features_to_bps(enum netdev_features features,
 215                                 uint64_t default_bps);
 216 bool netdev_features_is_full_duplex(enum netdev_features features);
 217 int netdev_set_advertisements(struct netdev *, enum netdev_features advertise);
 218
 219 /* Flags. */
 220 enum netdev_flags {
 221     NETDEV_UP = 0x0001,         /* Device enabled? */
 222     NETDEV_PROMISC = 0x0002,    /* Promiscuous mode? */
 223     NETDEV_LOOPBACK = 0x0004    /* This is a loopback device. */
 224 };
 225
 226 int netdev_get_flags(const struct netdev *, enum netdev_flags *);
 227 int netdev_set_flags(struct netdev *, enum netdev_flags,
 228                      struct netdev_saved_flags **);
 229 int netdev_turn_flags_on(struct netdev *, enum netdev_flags,
 230                          struct netdev_saved_flags **);
 231 int netdev_turn_flags_off(struct netdev *, enum netdev_flags,
 232                           struct netdev_saved_flags **);
 233
 234 void netdev_restore_flags(struct netdev_saved_flags *);
 235
 236 /* TCP/IP stack interface. */
 237 int netdev_get_in4(const struct netdev *, struct in_addr *address,
 238                    struct in_addr *netmask);
 239 int netdev_set_in4(struct netdev *, struct in_addr addr, struct in_addr mask);
 240 int netdev_get_in4_by_name(const char *device_name, struct in_addr *in4);
 241 int netdev_get_in6(const struct netdev *, struct in6_addr *);
 242 int netdev_add_router(struct netdev *, struct in_addr router);
 243 int netdev_get_next_hop(const struct netdev *, const struct in_addr *host,
 244                         struct in_addr *next_hop, char **);
 245 int netdev_get_status(const struct netdev *, struct smap *);
 246 int netdev_arp_lookup(const struct netdev *, ovs_be32 ip, uint8_t mac[6]);
 247
 248 struct netdev *netdev_find_dev_by_in4(const struct in_addr *);
 249
 250 /* Statistics. */
 251 int netdev_get_stats(const struct netdev *, struct netdev_stats *);
 252 int netdev_set_stats(struct netdev *, const struct netdev_stats *);
 253
 254 /* Quality of service. */
 255 struct netdev_qos_capabilities {
 256     unsigned int n_queues;
 257 };
 258
 259 struct netdev_queue_stats {
 260     /* Values of unsupported statistics are set to all-1-bits (UINT64_MAX). */
 261     uint64_t tx_bytes;
 262     uint64_t tx_packets;
 263     uint64_t tx_errors;
 264
 265     /* Time at which the queue was created, in msecs, LLONG_MIN if unknown. */
 266     long long int created;
 267 };
 268
 269 int netdev_set_policing(struct netdev *, uint32_t kbits_rate,
 270                         uint32_t kbits_burst);
 271
 272 int netdev_get_qos_types(const struct netdev *, struct sset *types);
 273 int netdev_get_qos_capabilities(const struct netdev *,
 274                                 const char *type,
 275                                 struct netdev_qos_capabilities *);
 276 int netdev_get_n_queues(const struct netdev *,
 277                         const char *type, unsigned int *n_queuesp);
 278
 279 int netdev_get_qos(const struct netdev *,
 280                    const char **typep, struct smap *details);
 281 int netdev_set_qos(struct netdev *,
 282                    const char *type, const struct smap *details);
 283
 284 int netdev_get_queue(const struct netdev *,
 285                      unsigned int queue_id, struct smap *details);
 286 int netdev_set_queue(struct netdev *,
 287                      unsigned int queue_id, const struct smap *details);
 288 int netdev_delete_queue(struct netdev *, unsigned int queue_id);
 289 int netdev_get_queue_stats(const struct netdev *, unsigned int queue_id,
 290                            struct netdev_queue_stats *);
 291 uint64_t netdev_get_change_seq(const struct netdev *);
 292
 293 struct netdev_queue_dump {
 294     struct netdev *netdev;
 295     int error;
 296     void *state;
 297 };
 298 void netdev_queue_dump_start(struct netdev_queue_dump *,
 299                              const struct netdev *);
 300 bool netdev_queue_dump_next(struct netdev_queue_dump *,
 301                             unsigned int *queue_id, struct smap *details);
 302 int netdev_queue_dump_done(struct netdev_queue_dump *);
 303
 304 /* Iterates through each queue in NETDEV, using DUMP as state.  Fills QUEUE_ID
 305  * and DETAILS with information about queues.  The client must initialize and
 306  * destroy DETAILS.
 307  *
 308  * Arguments all have pointer type.
 309  *
 310  * If you break out of the loop, then you need to free the dump structure by
 311  * hand using netdev_queue_dump_done(). */
 312 #define NETDEV_QUEUE_FOR_EACH(QUEUE_ID, DETAILS, DUMP, NETDEV)  \
 313     for (netdev_queue_dump_start(DUMP, NETDEV);                 \
 314          (netdev_queue_dump_next(DUMP, QUEUE_ID, DETAILS)       \
 315           ? true                                                \
 316           : (netdev_queue_dump_done(DUMP), false));             \
 317         )
 318
 319 typedef void netdev_dump_queue_stats_cb(unsigned int queue_id,
 320                                         struct netdev_queue_stats *,
 321                                         void *aux);
 322 int netdev_dump_queue_stats(const struct netdev *,
 323                             netdev_dump_queue_stats_cb *, void *aux);
 324
 325 enum { NETDEV_MAX_RX_BATCH = 256 };     /* Maximum number packets in rx_recv() batch. */
 326
 327 #ifdef  __cplusplus
 328 }
 329 #endif
 330
 331 #endif /* netdev.h */