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 "openvswitch/netdev.h"
  21 #include "openvswitch/types.h"
  22 #include "packets.h"
  23 #include "flow.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 section of the documentation 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_QUEUE_FOR_EACH
  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 dp_packet_batch;
  63 struct dp_packet;
  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 struct ovs_action_push_tnl;
  73
  74 enum netdev_pt_mode {
  75     /* The netdev is packet type aware.  It can potentially carry any kind of
  76      * packet.  This "modern" mode is appropriate for both netdevs that handle
  77      * only a single kind of packet (such as a virtual or physical Ethernet
  78      * interface) and for those that can handle multiple (such as VXLAN-GPE or
  79      * Geneve). */
  80     NETDEV_PT_AWARE,
  81
  82     /* The netdev sends and receives only Ethernet frames.  The netdev cannot
  83      * carry packets other than Ethernet frames.  This is a legacy mode for
  84      * backward compability with controllers that are not prepared to handle
  85      * OpenFlow 1.5+ "packet_type". */
  86     NETDEV_PT_LEGACY_L2,
  87
  88     /* The netdev sends and receives only IPv4 and IPv6 packets.  The netdev
  89      * cannot carry Ethernet frames or other kinds of packets.
  90      *
  91      * IPv4 and IPv6 packets carried over the netdev are treated as Ethernet:
  92      * when they are received, they are converted to Ethernet by adding a dummy
  93      * header with the proper Ethertype; on tranmission, the Ethernet header is
  94      * stripped.  This is a legacy mode for backward compability with
  95      * controllers that are not prepared to handle OpenFlow 1.5+
  96      * "packet_type". */
  97     NETDEV_PT_LEGACY_L3,
  98 };
  99
 100 /* Configuration specific to tunnels. */
 101 struct netdev_tunnel_config {
 102     ovs_be64 in_key;
 103     bool in_key_present;
 104     bool in_key_flow;
 105
 106     bool out_key_present;
 107     bool out_key_flow;
 108     ovs_be64 out_key;
 109
 110     ovs_be16 dst_port;
 111
 112     bool ip_src_flow;
 113     bool ip_dst_flow;
 114     struct in6_addr ipv6_src;
 115     struct in6_addr ipv6_dst;
 116
 117     uint32_t exts;
 118     uint32_t egress_pkt_mark;
 119     bool set_egress_pkt_mark;
 120
 121     uint8_t ttl;
 122     bool ttl_inherit;
 123
 124     uint8_t tos;
 125     bool tos_inherit;
 126
 127     bool csum;
 128     bool dont_fragment;
 129     enum netdev_pt_mode pt_mode;
 130
 131     bool set_seq;
 132     uint32_t seqno;
 133     uint32_t erspan_idx;
 134     uint8_t erspan_ver;
 135     uint8_t erspan_dir;
 136     uint8_t erspan_hwid;
 137
 138     bool erspan_ver_flow;
 139     bool erspan_idx_flow;
 140     bool erspan_dir_flow;
 141     bool erspan_hwid_flow;
 142 };
 143
 144 void netdev_run(void);
 145 void netdev_wait(void);
 146
 147 void netdev_enumerate_types(struct sset *types);
 148 bool netdev_is_reserved_name(const char *name);
 149
 150 int netdev_n_txq(const struct netdev *netdev);
 151 int netdev_n_rxq(const struct netdev *netdev);
 152 bool netdev_is_pmd(const struct netdev *netdev);
 153 bool netdev_has_tunnel_push_pop(const struct netdev *netdev);
 154
 155 /* Open and close. */
 156 int netdev_open(const char *name, const char *type, struct netdev **netdevp);
 157
 158 struct netdev *netdev_ref(const struct netdev *);
 159 void netdev_remove(struct netdev *);
 160 void netdev_close(struct netdev *);
 161
 162 void netdev_parse_name(const char *netdev_name, char **name, char **type);
 163
 164 /* Options. */
 165 int netdev_set_config(struct netdev *, const struct smap *args, char **errp);
 166 int netdev_get_config(const struct netdev *, struct smap *);
 167 const struct netdev_tunnel_config *
 168     netdev_get_tunnel_config(const struct netdev *);
 169 int netdev_get_numa_id(const struct netdev *);
 170
 171 /* Basic properties. */
 172 const char *netdev_get_name(const struct netdev *);
 173 const char *netdev_get_type(const struct netdev *);
 174 const char *netdev_get_type_from_name(const char *);
 175 int netdev_get_mtu(const struct netdev *, int *mtup);
 176 int netdev_set_mtu(struct netdev *, int mtu);
 177 void netdev_mtu_user_config(struct netdev *, bool);
 178 bool netdev_mtu_is_user_config(struct netdev *);
 179 int netdev_get_ifindex(const struct netdev *);
 180 int netdev_set_tx_multiq(struct netdev *, unsigned int n_txq);
 181 enum netdev_pt_mode netdev_get_pt_mode(const struct netdev *);
 182 void netdev_set_dpif_type(struct netdev *, const char *);
 183 const char *netdev_get_dpif_type(const struct netdev *);
 184
 185 /* Packet reception. */
 186 int netdev_rxq_open(struct netdev *, struct netdev_rxq **, int id);
 187 void netdev_rxq_close(struct netdev_rxq *);
 188 bool netdev_rxq_enabled(struct netdev_rxq *);
 189
 190 const char *netdev_rxq_get_name(const struct netdev_rxq *);
 191 int netdev_rxq_get_queue_id(const struct netdev_rxq *);
 192
 193 int netdev_rxq_recv(struct netdev_rxq *rx, struct dp_packet_batch *,
 194                     int *qfill);
 195 void netdev_rxq_wait(struct netdev_rxq *);
 196 int netdev_rxq_drain(struct netdev_rxq *);
 197
 198 /* Packet transmission. */
 199 int netdev_send(struct netdev *, int qid, struct dp_packet_batch *,
 200                 bool concurrent_txq);
 201 void netdev_send_wait(struct netdev *, int qid);
 202
 203 /* native tunnel APIs */
 204 /* Structure to pass parameters required to build a tunnel header. */
 205 struct netdev_tnl_build_header_params {
 206     const struct flow *flow;
 207     const struct in6_addr *s_ip;
 208     struct eth_addr dmac;
 209     struct eth_addr smac;
 210     bool is_ipv6;
 211 };
 212
 213 void
 214 netdev_init_tnl_build_header_params(struct netdev_tnl_build_header_params *params,
 215                                     const struct flow *tnl_flow,
 216                                     const struct in6_addr *src,
 217                                     struct eth_addr dmac,
 218                                     struct eth_addr smac);
 219
 220 int netdev_build_header(const struct netdev *, struct ovs_action_push_tnl *data,
 221                         const struct netdev_tnl_build_header_params *params);
 222
 223 int netdev_push_header(const struct netdev *netdev,
 224                        struct dp_packet_batch *,
 225                        const struct ovs_action_push_tnl *data);
 226 void netdev_pop_header(struct netdev *netdev, struct dp_packet_batch *);
 227
 228 /* Hardware address. */
 229 int netdev_set_etheraddr(struct netdev *, const struct eth_addr mac);
 230 int netdev_get_etheraddr(const struct netdev *, struct eth_addr *mac);
 231
 232 /* PHY interface. */
 233 bool netdev_get_carrier(const struct netdev *);
 234 long long int netdev_get_carrier_resets(const struct netdev *);
 235 int netdev_set_miimon_interval(struct netdev *, long long int interval);
 236
 237 /* Flags. */
 238 enum netdev_flags {
 239     NETDEV_UP = 0x0001,         /* Device enabled? */
 240     NETDEV_PROMISC = 0x0002,    /* Promiscuous mode? */
 241     NETDEV_LOOPBACK = 0x0004    /* This is a loopback device. */
 242 };
 243
 244 int netdev_get_flags(const struct netdev *, enum netdev_flags *);
 245 int netdev_set_flags(struct netdev *, enum netdev_flags,
 246                      struct netdev_saved_flags **);
 247 int netdev_turn_flags_on(struct netdev *, enum netdev_flags,
 248                          struct netdev_saved_flags **);
 249 int netdev_turn_flags_off(struct netdev *, enum netdev_flags,
 250                           struct netdev_saved_flags **);
 251
 252 void netdev_restore_flags(struct netdev_saved_flags *);
 253
 254 /* TCP/IP stack interface. */
 255 int netdev_set_in4(struct netdev *, struct in_addr addr, struct in_addr mask);
 256 int netdev_get_in4_by_name(const char *device_name, struct in_addr *in4);
 257 int netdev_get_ip_by_name(const char *device_name, struct in6_addr *);
 258 int netdev_get_addr_list(const struct netdev *netdev, struct in6_addr **addr,
 259                          struct in6_addr **mask, int *n_in6);
 260
 261 int netdev_add_router(struct netdev *, struct in_addr router);
 262 int netdev_get_next_hop(const struct netdev *, const struct in_addr *host,
 263                         struct in_addr *next_hop, char **);
 264 int netdev_get_status(const struct netdev *, struct smap *);
 265 int netdev_arp_lookup(const struct netdev *, ovs_be32 ip,
 266                       struct eth_addr *mac);
 267
 268 struct netdev *netdev_find_dev_by_in4(const struct in_addr *);
 269
 270 /* Statistics. */
 271 int netdev_get_stats(const struct netdev *, struct netdev_stats *);
 272 int netdev_get_custom_stats(const struct netdev *,
 273                             struct netdev_custom_stats *);
 274
 275 /* Quality of service. */
 276 struct netdev_qos_capabilities {
 277     unsigned int n_queues;
 278 };
 279
 280 struct netdev_queue_stats {
 281     /* Values of unsupported statistics are set to all-1-bits (UINT64_MAX). */
 282     uint64_t tx_bytes;
 283     uint64_t tx_packets;
 284     uint64_t tx_errors;
 285
 286     /* Time at which the queue was created, in msecs, LLONG_MIN if unknown. */
 287     long long int created;
 288 };
 289
 290 int netdev_set_policing(struct netdev *, uint32_t kbits_rate,
 291                         uint32_t kbits_burst);
 292
 293 int netdev_get_qos_types(const struct netdev *, struct sset *types);
 294 int netdev_get_qos_capabilities(const struct netdev *,
 295                                 const char *type,
 296                                 struct netdev_qos_capabilities *);
 297 int netdev_get_n_queues(const struct netdev *,
 298                         const char *type, unsigned int *n_queuesp);
 299
 300 int netdev_get_qos(const struct netdev *,
 301                    const char **typep, struct smap *details);
 302 int netdev_set_qos(struct netdev *,
 303                    const char *type, const struct smap *details);
 304
 305 int netdev_get_queue(const struct netdev *,
 306                      unsigned int queue_id, struct smap *details);
 307 int netdev_set_queue(struct netdev *,
 308                      unsigned int queue_id, const struct smap *details);
 309 int netdev_delete_queue(struct netdev *, unsigned int queue_id);
 310 int netdev_get_queue_stats(const struct netdev *, unsigned int queue_id,
 311                            struct netdev_queue_stats *);
 312 uint64_t netdev_get_change_seq(const struct netdev *);
 313
 314 int netdev_reconfigure(struct netdev *netdev);
 315 void netdev_wait_reconf_required(struct netdev *netdev);
 316 bool netdev_is_reconf_required(struct netdev *netdev);
 317
 318 struct netdev_queue_dump {
 319     struct netdev *netdev;
 320     int error;
 321     void *state;
 322 };
 323 void netdev_queue_dump_start(struct netdev_queue_dump *,
 324                              const struct netdev *);
 325 bool netdev_queue_dump_next(struct netdev_queue_dump *,
 326                             unsigned int *queue_id, struct smap *details);
 327 int netdev_queue_dump_done(struct netdev_queue_dump *);
 328
 329 /* Iterates through each queue in NETDEV, using DUMP as state.  Fills QUEUE_ID
 330  * and DETAILS with information about queues.  The client must initialize and
 331  * destroy DETAILS.
 332  *
 333  * Arguments all have pointer type.
 334  *
 335  * If you break out of the loop, then you need to free the dump structure by
 336  * hand using netdev_queue_dump_done(). */
 337 #define NETDEV_QUEUE_FOR_EACH(QUEUE_ID, DETAILS, DUMP, NETDEV)  \
 338     for (netdev_queue_dump_start(DUMP, NETDEV);                 \
 339          (netdev_queue_dump_next(DUMP, QUEUE_ID, DETAILS)       \
 340           ? true                                                \
 341           : (netdev_queue_dump_done(DUMP), false));             \
 342         )
 343
 344 typedef void netdev_dump_queue_stats_cb(unsigned int queue_id,
 345                                         struct netdev_queue_stats *,
 346                                         void *aux);
 347 int netdev_dump_queue_stats(const struct netdev *,
 348                             netdev_dump_queue_stats_cb *, void *aux);
 349
 350 extern struct seq *tnl_conf_seq;
 351
 352 #ifndef _WIN32
 353 void netdev_get_addrs_list_flush(void);
 354 int netdev_get_addrs(const char dev[], struct in6_addr **paddr,
 355                      struct in6_addr **pmask, int *n_in6);
 356 #endif
 357
 358 #ifdef  __cplusplus
 359 }
 360 #endif
 361
 362 #endif /* netdev.h */