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 /* Configuration specific to tunnels. */
  75 struct netdev_tunnel_config {
  76     bool in_key_present;
  77     bool in_key_flow;
  78     ovs_be64 in_key;
  79
  80     bool out_key_present;
  81     bool out_key_flow;
  82     ovs_be64 out_key;
  83
  84     ovs_be16 dst_port;
  85
  86     bool ip_src_flow;
  87     bool ip_dst_flow;
  88     struct in6_addr ipv6_src;
  89     struct in6_addr ipv6_dst;
  90
  91     uint32_t exts;
  92     bool set_egress_pkt_mark;
  93     uint32_t egress_pkt_mark;
  94
  95     uint8_t ttl;
  96     bool ttl_inherit;
  97
  98     uint8_t tos;
  99     bool tos_inherit;
 100
 101     bool csum;
 102     bool dont_fragment;
 103 };
 104
 105 void netdev_run(void);
 106 void netdev_wait(void);
 107
 108 void netdev_enumerate_types(struct sset *types);
 109 bool netdev_is_reserved_name(const char *name);
 110
 111 int netdev_n_txq(const struct netdev *netdev);
 112 int netdev_n_rxq(const struct netdev *netdev);
 113 bool netdev_is_pmd(const struct netdev *netdev);
 114 bool netdev_has_tunnel_push_pop(const struct netdev *netdev);
 115
 116 /* Open and close. */
 117 int netdev_open(const char *name, const char *type, struct netdev **netdevp);
 118
 119 struct netdev *netdev_ref(const struct netdev *);
 120 void netdev_remove(struct netdev *);
 121 void netdev_close(struct netdev *);
 122
 123 void netdev_parse_name(const char *netdev_name, char **name, char **type);
 124
 125 /* Options. */
 126 int netdev_set_config(struct netdev *, const struct smap *args, char **errp);
 127 int netdev_get_config(const struct netdev *, struct smap *);
 128 const struct netdev_tunnel_config *
 129     netdev_get_tunnel_config(const struct netdev *);
 130 int netdev_get_numa_id(const struct netdev *);
 131
 132 /* Basic properties. */
 133 const char *netdev_get_name(const struct netdev *);
 134 const char *netdev_get_type(const struct netdev *);
 135 const char *netdev_get_type_from_name(const char *);
 136 int netdev_get_mtu(const struct netdev *, int *mtup);
 137 int netdev_set_mtu(struct netdev *, int mtu);
 138 void netdev_mtu_user_config(struct netdev *, bool);
 139 bool netdev_mtu_is_user_config(struct netdev *);
 140 int netdev_get_ifindex(const struct netdev *);
 141 int netdev_set_tx_multiq(struct netdev *, unsigned int n_txq);
 142
 143 /* Packet reception. */
 144 int netdev_rxq_open(struct netdev *, struct netdev_rxq **, int id);
 145 void netdev_rxq_close(struct netdev_rxq *);
 146
 147 const char *netdev_rxq_get_name(const struct netdev_rxq *);
 148 int netdev_rxq_get_queue_id(const struct netdev_rxq *);
 149
 150 int netdev_rxq_recv(struct netdev_rxq *rx, struct dp_packet_batch *);
 151 void netdev_rxq_wait(struct netdev_rxq *);
 152 int netdev_rxq_drain(struct netdev_rxq *);
 153
 154 /* Packet transmission. */
 155 int netdev_send(struct netdev *, int qid, struct dp_packet_batch *,
 156                 bool may_steal, bool concurrent_txq);
 157 void netdev_send_wait(struct netdev *, int qid);
 158
 159 /* native tunnel APIs */
 160 /* Structure to pass parameters required to build a tunnel header. */
 161 struct netdev_tnl_build_header_params {
 162     const struct flow *flow;
 163     const struct in6_addr *s_ip;
 164     struct eth_addr dmac;
 165     struct eth_addr smac;
 166     bool is_ipv6;
 167 };
 168
 169 void
 170 netdev_init_tnl_build_header_params(struct netdev_tnl_build_header_params *params,
 171                                     const struct flow *tnl_flow,
 172                                     const struct in6_addr *src,
 173                                     struct eth_addr dmac,
 174                                     struct eth_addr smac);
 175
 176 int netdev_build_header(const struct netdev *, struct ovs_action_push_tnl *data,
 177                         const struct netdev_tnl_build_header_params *params);
 178
 179 int netdev_push_header(const struct netdev *netdev,
 180                        struct dp_packet_batch *,
 181                        const struct ovs_action_push_tnl *data);
 182 void netdev_pop_header(struct netdev *netdev, struct dp_packet_batch *);
 183
 184 /* Hardware address. */
 185 int netdev_set_etheraddr(struct netdev *, const struct eth_addr mac);
 186 int netdev_get_etheraddr(const struct netdev *, struct eth_addr *mac);
 187
 188 /* PHY interface. */
 189 bool netdev_get_carrier(const struct netdev *);
 190 long long int netdev_get_carrier_resets(const struct netdev *);
 191 int netdev_set_miimon_interval(struct netdev *, long long int interval);
 192
 193 /* Flags. */
 194 enum netdev_flags {
 195     NETDEV_UP = 0x0001,         /* Device enabled? */
 196     NETDEV_PROMISC = 0x0002,    /* Promiscuous mode? */
 197     NETDEV_LOOPBACK = 0x0004    /* This is a loopback device. */
 198 };
 199
 200 int netdev_get_flags(const struct netdev *, enum netdev_flags *);
 201 int netdev_set_flags(struct netdev *, enum netdev_flags,
 202                      struct netdev_saved_flags **);
 203 int netdev_turn_flags_on(struct netdev *, enum netdev_flags,
 204                          struct netdev_saved_flags **);
 205 int netdev_turn_flags_off(struct netdev *, enum netdev_flags,
 206                           struct netdev_saved_flags **);
 207
 208 void netdev_restore_flags(struct netdev_saved_flags *);
 209
 210 /* TCP/IP stack interface. */
 211 int netdev_set_in4(struct netdev *, struct in_addr addr, struct in_addr mask);
 212 int netdev_get_in4_by_name(const char *device_name, struct in_addr *in4);
 213 int netdev_get_addr_list(const struct netdev *netdev, struct in6_addr **addr,
 214                          struct in6_addr **mask, int *n_in6);
 215
 216 int netdev_add_router(struct netdev *, struct in_addr router);
 217 int netdev_get_next_hop(const struct netdev *, const struct in_addr *host,
 218                         struct in_addr *next_hop, char **);
 219 int netdev_get_status(const struct netdev *, struct smap *);
 220 int netdev_arp_lookup(const struct netdev *, ovs_be32 ip,
 221                       struct eth_addr *mac);
 222
 223 struct netdev *netdev_find_dev_by_in4(const struct in_addr *);
 224
 225 /* Statistics. */
 226 int netdev_get_stats(const struct netdev *, struct netdev_stats *);
 227
 228 /* Quality of service. */
 229 struct netdev_qos_capabilities {
 230     unsigned int n_queues;
 231 };
 232
 233 struct netdev_queue_stats {
 234     /* Values of unsupported statistics are set to all-1-bits (UINT64_MAX). */
 235     uint64_t tx_bytes;
 236     uint64_t tx_packets;
 237     uint64_t tx_errors;
 238
 239     /* Time at which the queue was created, in msecs, LLONG_MIN if unknown. */
 240     long long int created;
 241 };
 242
 243 int netdev_set_policing(struct netdev *, uint32_t kbits_rate,
 244                         uint32_t kbits_burst);
 245
 246 int netdev_get_qos_types(const struct netdev *, struct sset *types);
 247 int netdev_get_qos_capabilities(const struct netdev *,
 248                                 const char *type,
 249                                 struct netdev_qos_capabilities *);
 250 int netdev_get_n_queues(const struct netdev *,
 251                         const char *type, unsigned int *n_queuesp);
 252
 253 int netdev_get_qos(const struct netdev *,
 254                    const char **typep, struct smap *details);
 255 int netdev_set_qos(struct netdev *,
 256                    const char *type, const struct smap *details);
 257
 258 int netdev_get_queue(const struct netdev *,
 259                      unsigned int queue_id, struct smap *details);
 260 int netdev_set_queue(struct netdev *,
 261                      unsigned int queue_id, const struct smap *details);
 262 int netdev_delete_queue(struct netdev *, unsigned int queue_id);
 263 int netdev_get_queue_stats(const struct netdev *, unsigned int queue_id,
 264                            struct netdev_queue_stats *);
 265 uint64_t netdev_get_change_seq(const struct netdev *);
 266
 267 int netdev_reconfigure(struct netdev *netdev);
 268 void netdev_wait_reconf_required(struct netdev *netdev);
 269 bool netdev_is_reconf_required(struct netdev *netdev);
 270
 271 struct netdev_queue_dump {
 272     struct netdev *netdev;
 273     int error;
 274     void *state;
 275 };
 276 void netdev_queue_dump_start(struct netdev_queue_dump *,
 277                              const struct netdev *);
 278 bool netdev_queue_dump_next(struct netdev_queue_dump *,
 279                             unsigned int *queue_id, struct smap *details);
 280 int netdev_queue_dump_done(struct netdev_queue_dump *);
 281
 282 /* Iterates through each queue in NETDEV, using DUMP as state.  Fills QUEUE_ID
 283  * and DETAILS with information about queues.  The client must initialize and
 284  * destroy DETAILS.
 285  *
 286  * Arguments all have pointer type.
 287  *
 288  * If you break out of the loop, then you need to free the dump structure by
 289  * hand using netdev_queue_dump_done(). */
 290 #define NETDEV_QUEUE_FOR_EACH(QUEUE_ID, DETAILS, DUMP, NETDEV)  \
 291     for (netdev_queue_dump_start(DUMP, NETDEV);                 \
 292          (netdev_queue_dump_next(DUMP, QUEUE_ID, DETAILS)       \
 293           ? true                                                \
 294           : (netdev_queue_dump_done(DUMP), false));             \
 295         )
 296
 297 typedef void netdev_dump_queue_stats_cb(unsigned int queue_id,
 298                                         struct netdev_queue_stats *,
 299                                         void *aux);
 300 int netdev_dump_queue_stats(const struct netdev *,
 301                             netdev_dump_queue_stats_cb *, void *aux);
 302
 303 extern struct seq *tnl_conf_seq;
 304
 305 #ifndef _WIN32
 306 void netdev_get_addrs_list_flush(void);
 307 int netdev_get_addrs(const char dev[], struct in6_addr **paddr,
 308                      struct in6_addr **pmask, int *n_in6);
 309 #endif
 310
 311 #ifdef  __cplusplus
 312 }
 313 #endif
 314
 315 #endif /* netdev.h */