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