2
0
mirror of https://github.com/openvswitch/ovs synced 2025-08-30 13:58:14 +00:00
ovs/lib/netdev.h
Ben Pfaff 8b61709d5e netdev: Implement an abstract interface to network devices.
This new abstraction layer allows multiple implementations of network
devices in a single running process.  This will be useful, for example, to
support network devices that are simulated entirely in the running process
or that communicate with other processes over Unix domain sockets, etc.

The reimplemented tap device support in this commit has not been tested.
2009-07-30 16:07:14 -07:00

136 lines
5.0 KiB
C

/*
* Copyright (c) 2008, 2009 Nicira Networks.
*
* 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 <stdbool.h>
#include <stddef.h>
#include <stdint.h>
/* Generic interface to network devices.
*
* Currently, there is a single implementation of this interface that supports
* Linux. The interface should be generic enough to be implementable on other
* operating systems as well. */
struct ofpbuf;
struct in_addr;
struct in6_addr;
struct svec;
enum netdev_flags {
NETDEV_UP = 0x0001, /* Device enabled? */
NETDEV_PROMISC = 0x0002, /* Promiscuous mode? */
NETDEV_LOOPBACK = 0x0004 /* This is a loopback device. */
};
enum netdev_pseudo_ethertype {
NETDEV_ETH_TYPE_NONE = -128, /* Receive no frames. */
NETDEV_ETH_TYPE_ANY, /* Receive all frames. */
NETDEV_ETH_TYPE_802_2 /* Receive all IEEE 802.2 frames. */
};
/* 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;
};
struct netdev;
int netdev_initialize(void);
void netdev_run(void);
void netdev_wait(void);
int netdev_open(const char *name, int ethertype, struct netdev **);
void netdev_close(struct netdev *);
bool netdev_exists(const char *name);
int netdev_enumerate(struct svec *);
const char *netdev_get_name(const struct netdev *);
int netdev_get_mtu(const struct netdev *, int *mtup);
int netdev_recv(struct netdev *, struct ofpbuf *);
void netdev_recv_wait(struct netdev *);
int netdev_drain(struct netdev *);
int netdev_send(struct netdev *, const struct ofpbuf *);
void netdev_send_wait(struct netdev *);
int netdev_set_etheraddr(struct netdev *, const uint8_t mac[6]);
int netdev_get_etheraddr(const struct netdev *, uint8_t mac[6]);
int netdev_get_carrier(const struct netdev *, bool *carrier);
int netdev_get_features(struct netdev *,
uint32_t *current, uint32_t *advertised,
uint32_t *supported, uint32_t *peer);
int netdev_set_advertisements(struct netdev *, uint32_t advertise);
int netdev_get_in4(const struct netdev *, struct in_addr *);
int netdev_set_in4(struct netdev *, struct in_addr addr, struct in_addr mask);
int netdev_get_in6(const struct netdev *, struct in6_addr *);
int netdev_add_router(struct netdev *, struct in_addr router);
int netdev_arp_lookup(const struct netdev *, uint32_t ip, uint8_t mac[6]);
int netdev_get_flags(const struct netdev *, enum netdev_flags *);
int netdev_set_flags(struct netdev *, enum netdev_flags, bool permanent);
int netdev_turn_flags_on(struct netdev *, enum netdev_flags, bool permanent);
int netdev_turn_flags_off(struct netdev *, enum netdev_flags, bool permanent);
int netdev_get_stats(const struct netdev *, struct netdev_stats *);
int netdev_set_policing(struct netdev *, uint32_t kbits_rate,
uint32_t kbits_burst);
int netdev_get_vlan_vid(const struct netdev *, int *vlan_vid);
struct netdev *netdev_find_dev_by_in4(const struct in_addr *);
struct netdev_monitor *netdev_monitor_create(void);
void netdev_monitor_destroy(struct netdev_monitor *);
int netdev_monitor_add(struct netdev_monitor *, struct netdev *);
void netdev_monitor_remove(struct netdev_monitor *, struct netdev *);
int netdev_monitor_poll(struct netdev_monitor *, char **devnamep);
void netdev_monitor_poll_wait(const struct netdev_monitor *);
#endif /* netdev.h */