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