/* * Copyright (c) 2008, 2009, 2010, 2011, 2012, 2013 Nicira, Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at: * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ #ifndef NETDEV_H #define NETDEV_H 1 #include #include #include #include "openvswitch/types.h" #ifdef __cplusplus extern "C" { #endif /* Generic interface to network devices ("netdev"s). * * Every port on a switch must have a corresponding netdev that must minimally * support a few operations, such as the ability to read the netdev's MTU. * The PORTING file at the top of the source tree has more information in the * "Writing a netdev Provider" section. * * Thread-safety * ============= * * Most of the netdev functions are fully thread-safe: they may be called from * any number of threads on the same or different netdev objects. The * exceptions are: * * netdev_rxq_recv() * netdev_rxq_wait() * netdev_rxq_drain() * * These functions are conditionally thread-safe: they may be called from * different threads only on different netdev_rxq objects. (The client may * create multiple netdev_rxq objects for a single netdev and access each * of those from a different thread.) * * NETDEV_FOR_EACH_QUEUE * netdev_queue_dump_next() * netdev_queue_dump_done() * * These functions are conditionally thread-safe: they may be called from * different threads only on different netdev_queue_dump objects. (The * client may create multiple netdev_queue_dump objects for a single * netdev and access each of those from a different thread.) */ struct netdev; struct netdev_class; struct netdev_rxq; struct netdev_saved_flags; struct ofpbuf; struct in_addr; struct in6_addr; struct smap; struct sset; /* Network device statistics. * * Values of unsupported statistics are set to all-1-bits (UINT64_MAX). */ struct netdev_stats { uint64_t rx_packets; /* Total packets received. */ uint64_t tx_packets; /* Total packets transmitted. */ uint64_t rx_bytes; /* Total bytes received. */ uint64_t tx_bytes; /* Total bytes transmitted. */ uint64_t rx_errors; /* Bad packets received. */ uint64_t tx_errors; /* Packet transmit problems. */ uint64_t rx_dropped; /* No buffer space. */ uint64_t tx_dropped; /* No buffer space. */ uint64_t multicast; /* Multicast packets received. */ uint64_t collisions; /* Detailed receive errors. */ uint64_t rx_length_errors; uint64_t rx_over_errors; /* Receiver ring buff overflow. */ uint64_t rx_crc_errors; /* Recved pkt with crc error. */ uint64_t rx_frame_errors; /* Recv'd frame alignment error. */ uint64_t rx_fifo_errors; /* Recv'r fifo overrun . */ uint64_t rx_missed_errors; /* Receiver missed packet. */ /* Detailed transmit errors. */ uint64_t tx_aborted_errors; uint64_t tx_carrier_errors; uint64_t tx_fifo_errors; uint64_t tx_heartbeat_errors; uint64_t tx_window_errors; }; /* Configuration specific to tunnels. */ struct netdev_tunnel_config { bool in_key_present; bool in_key_flow; ovs_be64 in_key; bool out_key_present; bool out_key_flow; ovs_be64 out_key; ovs_be16 dst_port; bool ip_src_flow; bool ip_dst_flow; ovs_be32 ip_src; ovs_be32 ip_dst; uint8_t ttl; bool ttl_inherit; uint8_t tos; bool tos_inherit; bool csum; bool ipsec; bool dont_fragment; }; void netdev_run(void); void netdev_wait(void); void netdev_enumerate_types(struct sset *types); bool netdev_is_reserved_name(const char *name); int netdev_n_rxq(const struct netdev *netdev); bool netdev_is_pmd(const struct netdev *netdev); /* Open and close. */ int netdev_open(const char *name, const char *type, struct netdev **netdevp); struct netdev *netdev_ref(const struct netdev *); void netdev_close(struct netdev *); void netdev_parse_name(const char *netdev_name, char **name, char **type); /* Options. */ int netdev_set_config(struct netdev *, const struct smap *args); int netdev_get_config(const struct netdev *, struct smap *); const struct netdev_tunnel_config * netdev_get_tunnel_config(const struct netdev *); /* Basic properties. */ const char *netdev_get_name(const struct netdev *); const char *netdev_get_type(const struct netdev *); const char *netdev_get_type_from_name(const char *); int netdev_get_mtu(const struct netdev *, int *mtup); int netdev_set_mtu(const struct netdev *, int mtu); int netdev_get_ifindex(const struct netdev *); /* Packet reception. */ int netdev_rxq_open(struct netdev *, struct netdev_rxq **, int id); void netdev_rxq_close(struct netdev_rxq *); const char *netdev_rxq_get_name(const struct netdev_rxq *); int netdev_rxq_recv(struct netdev_rxq *rx, struct ofpbuf **buffers, int *cnt); void netdev_rxq_wait(struct netdev_rxq *); int netdev_rxq_drain(struct netdev_rxq *); /* Packet transmission. */ int netdev_send(struct netdev *, struct ofpbuf *, bool may_steal); void netdev_send_wait(struct netdev *); /* Hardware address. */ int netdev_set_etheraddr(struct netdev *, const uint8_t mac[6]); int netdev_get_etheraddr(const struct netdev *, uint8_t mac[6]); /* PHY interface. */ bool netdev_get_carrier(const struct netdev *); long long int netdev_get_carrier_resets(const struct netdev *); int netdev_set_miimon_interval(struct netdev *, long long int interval); /* Features. */ enum netdev_features { NETDEV_F_10MB_HD = 1 << 0, /* 10 Mb half-duplex rate support. */ NETDEV_F_10MB_FD = 1 << 1, /* 10 Mb full-duplex rate support. */ NETDEV_F_100MB_HD = 1 << 2, /* 100 Mb half-duplex rate support. */ NETDEV_F_100MB_FD = 1 << 3, /* 100 Mb full-duplex rate support. */ NETDEV_F_1GB_HD = 1 << 4, /* 1 Gb half-duplex rate support. */ NETDEV_F_1GB_FD = 1 << 5, /* 1 Gb full-duplex rate support. */ NETDEV_F_10GB_FD = 1 << 6, /* 10 Gb full-duplex rate support. */ NETDEV_F_40GB_FD = 1 << 7, /* 40 Gb full-duplex rate support. */ NETDEV_F_100GB_FD = 1 << 8, /* 100 Gb full-duplex rate support. */ NETDEV_F_1TB_FD = 1 << 9, /* 1 Tb full-duplex rate support. */ NETDEV_F_OTHER = 1 << 10, /* Other rate, not in the list. */ NETDEV_F_COPPER = 1 << 11, /* Copper medium. */ NETDEV_F_FIBER = 1 << 12, /* Fiber medium. */ NETDEV_F_AUTONEG = 1 << 13, /* Auto-negotiation. */ NETDEV_F_PAUSE = 1 << 14, /* Pause. */ NETDEV_F_PAUSE_ASYM = 1 << 15, /* Asymmetric pause. */ }; int netdev_get_features(const struct netdev *, enum netdev_features *current, enum netdev_features *advertised, enum netdev_features *supported, enum netdev_features *peer); uint64_t netdev_features_to_bps(enum netdev_features features, uint64_t default_bps); bool netdev_features_is_full_duplex(enum netdev_features features); int netdev_set_advertisements(struct netdev *, enum netdev_features advertise); /* Flags. */ enum netdev_flags { NETDEV_UP = 0x0001, /* Device enabled? */ NETDEV_PROMISC = 0x0002, /* Promiscuous mode? */ NETDEV_LOOPBACK = 0x0004 /* This is a loopback device. */ }; int netdev_get_flags(const struct netdev *, enum netdev_flags *); int netdev_set_flags(struct netdev *, enum netdev_flags, struct netdev_saved_flags **); int netdev_turn_flags_on(struct netdev *, enum netdev_flags, struct netdev_saved_flags **); int netdev_turn_flags_off(struct netdev *, enum netdev_flags, struct netdev_saved_flags **); void netdev_restore_flags(struct netdev_saved_flags *); /* TCP/IP stack interface. */ int netdev_get_in4(const struct netdev *, struct in_addr *address, struct in_addr *netmask); int netdev_set_in4(struct netdev *, struct in_addr addr, struct in_addr mask); int netdev_get_in4_by_name(const char *device_name, struct in_addr *in4); int netdev_get_in6(const struct netdev *, struct in6_addr *); int netdev_add_router(struct netdev *, struct in_addr router); int netdev_get_next_hop(const struct netdev *, const struct in_addr *host, struct in_addr *next_hop, char **); int netdev_get_status(const struct netdev *, struct smap *); int netdev_arp_lookup(const struct netdev *, ovs_be32 ip, uint8_t mac[6]); struct netdev *netdev_find_dev_by_in4(const struct in_addr *); /* Statistics. */ int netdev_get_stats(const struct netdev *, struct netdev_stats *); int netdev_set_stats(struct netdev *, const struct netdev_stats *); /* Quality of service. */ struct netdev_qos_capabilities { unsigned int n_queues; }; struct netdev_queue_stats { /* Values of unsupported statistics are set to all-1-bits (UINT64_MAX). */ uint64_t tx_bytes; uint64_t tx_packets; uint64_t tx_errors; /* Time at which the queue was created, in msecs, LLONG_MIN if unknown. */ long long int created; }; int netdev_set_policing(struct netdev *, uint32_t kbits_rate, uint32_t kbits_burst); int netdev_get_qos_types(const struct netdev *, struct sset *types); int netdev_get_qos_capabilities(const struct netdev *, const char *type, struct netdev_qos_capabilities *); int netdev_get_n_queues(const struct netdev *, const char *type, unsigned int *n_queuesp); int netdev_get_qos(const struct netdev *, const char **typep, struct smap *details); int netdev_set_qos(struct netdev *, const char *type, const struct smap *details); int netdev_get_queue(const struct netdev *, unsigned int queue_id, struct smap *details); int netdev_set_queue(struct netdev *, unsigned int queue_id, const struct smap *details); int netdev_delete_queue(struct netdev *, unsigned int queue_id); int netdev_get_queue_stats(const struct netdev *, unsigned int queue_id, struct netdev_queue_stats *); uint64_t netdev_get_change_seq(const struct netdev *); struct netdev_queue_dump { struct netdev *netdev; int error; void *state; }; void netdev_queue_dump_start(struct netdev_queue_dump *, const struct netdev *); bool netdev_queue_dump_next(struct netdev_queue_dump *, unsigned int *queue_id, struct smap *details); int netdev_queue_dump_done(struct netdev_queue_dump *); /* Iterates through each queue in NETDEV, using DUMP as state. Fills QUEUE_ID * and DETAILS with information about queues. The client must initialize and * destroy DETAILS. * * Arguments all have pointer type. * * If you break out of the loop, then you need to free the dump structure by * hand using netdev_queue_dump_done(). */ #define NETDEV_QUEUE_FOR_EACH(QUEUE_ID, DETAILS, DUMP, NETDEV) \ for (netdev_queue_dump_start(DUMP, NETDEV); \ (netdev_queue_dump_next(DUMP, QUEUE_ID, DETAILS) \ ? true \ : (netdev_queue_dump_done(DUMP), false)); \ ) typedef void netdev_dump_queue_stats_cb(unsigned int queue_id, struct netdev_queue_stats *, void *aux); int netdev_dump_queue_stats(const struct netdev *, netdev_dump_queue_stats_cb *, void *aux); enum { NETDEV_MAX_RX_BATCH = 256 }; /* Maximum number packets in rx_recv() batch. */ #ifdef __cplusplus } #endif #endif /* netdev.h */