/*
- * Copyright (c) 2009, 2010, 2011, 2012, 2013, 2014 Nicira, Inc.
+ * Copyright (c) 2009, 2010, 2011, 2012, 2013, 2014, 2016 Nicira, Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* 'netdev''s flags, features, ethernet address, or carrier changes. */
uint64_t change_seq;
- /* The following are protected by 'netdev_mutex' (internal to netdev.c). */
+ /* The core netdev code initializes these at netdev construction and only
+ * provide read-only access to its client. Netdev implementations may
+ * modify them. */
int n_txq;
int n_rxq;
+ /* Number of rx queues requested by user. */
+ int requested_n_rxq;
int ref_cnt; /* Times this devices was opened. */
struct shash_node *node; /* Pointer to element in global map. */
struct ovs_list saved_flags_list; /* Contains "struct netdev_saved_flags". */
* not yet been uninitialized, so the "destruct" function may refer to it. The
* "destruct" function is not allowed to fail.
*
- * Each "dealloc" function frees raw memory that was allocated by the the
+ * Each "dealloc" function frees raw memory that was allocated by the
* "alloc" function. The memory's base and derived members might not have ever
* been initialized (but if "construct" returned successfully, then it has been
* "destruct"ed already). The "dealloc" function is not allowed to fail.
/* Build Partial Tunnel header. Ethernet and ip header is already built,
* build_header() is suppose build protocol specific part of header. */
- int (*build_header)(const struct netdev *, struct ovs_action_push_tnl *data);
+ int (*build_header)(const struct netdev *, struct ovs_action_push_tnl *data,
+ const struct flow *tnl_flow);
/* build_header() can not build entire header for all packets for given
* flow. Push header is called for packet to build header specific to
* a packet on actual transmit. It uses partial header build by
* build_header() which is passed as data. */
- int (*push_header)(const struct netdev *netdev,
- struct dpif_packet **buffers, int cnt,
- const struct ovs_action_push_tnl *data);
+ void (*push_header)(struct dp_packet *packet,
+ const struct ovs_action_push_tnl *data);
/* Pop tunnel header from packet, build tunnel metadata and resize packet
* for further processing. */
- int (*pop_header)(struct netdev *netdev,
- struct dpif_packet **buffers, int cnt);
+ int (*pop_header)(struct dp_packet *packet);
/* Returns the id of the numa node the 'netdev' is on. If there is no
* such info, returns NETDEV_NUMA_UNSPEC. */
/* Configures the number of tx queues and rx queues of 'netdev'.
* Return 0 if successful, otherwise a positive errno value.
*
+ * 'n_rxq' specifies the maximum number of receive queues to create.
+ * The netdev provider might choose to create less (e.g. if the hardware
+ * supports only a smaller number). The actual number of queues created
+ * is stored in the 'netdev->n_rxq' field.
+ *
+ * 'n_txq' specifies the exact number of transmission queues to create.
+ * The caller will call netdev_send() concurrently from 'n_txq' different
+ * threads (with different qid). The netdev provider is responsible for
+ * making sure that these concurrent calls do not create a race condition
+ * by using multiple hw queues or locking.
+ *
* On error, the tx queue and rx queue configuration is indeterminant.
* Caller should make decision on whether to restore the previous or
* the default configuration. Also, caller must make sure there is no
* If the function returns a non-zero value, some of the packets might have
* been sent anyway.
*
- * To retain ownership of 'buffers' caller can set may_steal to false.
+ * If 'may_steal' is false, the caller retains ownership of all the
+ * packets. If 'may_steal' is true, the caller transfers ownership of all
+ * the packets to the network device, regardless of success.
*
* The network device is expected to maintain one or more packet
* transmission queues, so that the caller does not ordinarily have to
* network device from being usefully used by the netdev-based "userspace
* datapath". It will also prevent the OVS implementation of bonding from
* working properly over 'netdev'.) */
- int (*send)(struct netdev *netdev, int qid, struct dpif_packet **buffers,
+ int (*send)(struct netdev *netdev, int qid, struct dp_packet **buffers,
int cnt, bool may_steal);
/* Registers with the poll loop to wake up from the next call to
void (*send_wait)(struct netdev *netdev, int qid);
/* Sets 'netdev''s Ethernet address to 'mac' */
- int (*set_etheraddr)(struct netdev *netdev,
- const uint8_t mac[ETH_ADDR_LEN]);
+ int (*set_etheraddr)(struct netdev *netdev, const struct eth_addr mac);
/* Retrieves 'netdev''s Ethernet address into 'mac'.
*
* This address will be advertised as 'netdev''s MAC address through the
* OpenFlow protocol, among other uses. */
- int (*get_etheraddr)(const struct netdev *netdev,
- uint8_t mac[ETH_ADDR_LEN]);
+ int (*get_etheraddr)(const struct netdev *netdev, struct eth_addr *mac);
/* Retrieves 'netdev''s MTU into '*mtup'.
*
/* Forces ->get_carrier() to poll 'netdev''s MII registers for link status
* instead of checking 'netdev''s carrier. 'netdev''s MII registers will
- * be polled once ever 'interval' milliseconds. If 'netdev' does not
+ * be polled once every 'interval' milliseconds. If 'netdev' does not
* support MII, another method may be used as a fallback. If 'interval' is
* less than or equal to zero, reverts ->get_carrier() to its normal
* behavior.
* This function may be set to null if it would always return EOPNOTSUPP
* anyhow. */
int (*arp_lookup)(const struct netdev *netdev, ovs_be32 ip,
- uint8_t mac[ETH_ADDR_LEN]);
+ struct eth_addr *mac);
/* Retrieves the current set of flags on 'netdev' into '*old_flags'. Then,
* turns off the flags that are set to 1 in 'off' and turns on the flags
void (*rxq_destruct)(struct netdev_rxq *);
void (*rxq_dealloc)(struct netdev_rxq *);
- /* Attempts to receive batch of packets from 'rx' and place array of
- * pointers into '*pkts'. netdev is responsible for allocating buffers.
- * '*cnt' points to packet count for given batch. Once packets are returned
- * to caller, netdev should give up ownership of ofpbuf data.
+ /* Attempts to receive a batch of packets from 'rx'. The caller supplies
+ * 'pkts' as the pointer to the beginning of an array of MAX_RX_BATCH
+ * pointers to dp_packet. If successful, the implementation stores
+ * pointers to up to MAX_RX_BATCH dp_packets into the array, transferring
+ * ownership of the packets to the caller, stores the number of received
+ * packets into '*cnt', and returns 0.
*
- * Implementations should allocate buffer with DP_NETDEV_HEADROOM headroom
- * and add a VLAN header which is obtained out-of-band to the packet.
+ * The implementation does not necessarily initialize any non-data members
+ * of 'pkts'. That is, the caller must initialize layer pointers and
+ * metadata itself, if desired, e.g. with pkt_metadata_init() and
+ * miniflow_extract().
*
- * Caller is expected to pass array of size MAX_RX_BATCH.
- * This function may be set to null if it would always return EOPNOTSUPP
- * anyhow. */
- int (*rxq_recv)(struct netdev_rxq *rx, struct dpif_packet **pkts,
+ * Implementations should allocate buffers with DP_NETDEV_HEADROOM bytes of
+ * headroom.
+ *
+ * Returns EAGAIN immediately if no packet is ready to be received or
+ * another positive errno value if an error was encountered. */
+ int (*rxq_recv)(struct netdev_rxq *rx, struct dp_packet **pkts,
int *cnt);
/* Registers with the poll loop to wake up from the next call to
- * poll_block() when a packet is ready to be received with netdev_rxq_recv()
- * on 'rx'. */
+ * poll_block() when a packet is ready to be received with
+ * netdev_rxq_recv() on 'rx'. */
void (*rxq_wait)(struct netdev_rxq *rx);
/* Discards all packets waiting to be received from 'rx'. */