lib/netdev.h

   1 /*
   2  * Copyright (c) 2008, 2009 Nicira Networks.
   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 <stdbool.h>
  21 #include <stddef.h>
  22 #include <stdint.h>
  23
  24 /* Generic interface to network devices.
  25  *
  26  * Currently, there is a single implementation of this interface that supports
  27  * Linux.  The interface should be generic enough to be implementable on other
  28  * operating systems as well. */
  29
  30 struct ofpbuf;
  31 struct in_addr;
  32 struct in6_addr;
  33 struct svec;
  34
  35 enum netdev_flags {
  36     NETDEV_UP = 0x0001,         /* Device enabled? */
  37     NETDEV_PROMISC = 0x0002,    /* Promiscuous mode? */
  38     NETDEV_LOOPBACK = 0x0004    /* This is a loopback device. */
  39 };
  40
  41 enum netdev_pseudo_ethertype {
  42     NETDEV_ETH_TYPE_NONE = -128, /* Receive no frames. */
  43     NETDEV_ETH_TYPE_ANY,         /* Receive all frames. */
  44     NETDEV_ETH_TYPE_802_2        /* Receive all IEEE 802.2 frames. */
  45 };
  46
  47 struct netdev_stats {
  48     uint64_t rx_packets;        /* Total packets received. */
  49     uint64_t tx_packets;        /* Total packets transmitted. */
  50     uint64_t rx_bytes;          /* Total bytes received. */
  51     uint64_t tx_bytes;          /* Total bytes transmitted. */
  52     uint64_t rx_errors;         /* Bad packets received. */
  53     uint64_t tx_errors;         /* Packet transmit problems. */
  54     uint64_t rx_dropped;        /* No buffer space. */
  55     uint64_t tx_dropped;        /* No buffer space. */
  56     uint64_t multicast;         /* Multicast packets received. */
  57     uint64_t collisions;
  58
  59     /* Detailed receive errors. */
  60     uint64_t rx_length_errors;
  61     uint64_t rx_over_errors;    /* Receiver ring buff overflow. */
  62     uint64_t rx_crc_errors;     /* Recved pkt with crc error. */
  63     uint64_t rx_frame_errors;   /* Recv'd frame alignment error. */
  64     uint64_t rx_fifo_errors;    /* Recv'r fifo overrun . */
  65     uint64_t rx_missed_errors;  /* Receiver missed packet. */
  66
  67     /* Detailed transmit errors. */
  68     uint64_t tx_aborted_errors;
  69     uint64_t tx_carrier_errors;
  70     uint64_t tx_fifo_errors;
  71     uint64_t tx_heartbeat_errors;
  72     uint64_t tx_window_errors;
  73 };
  74
  75 struct netdev;
  76
  77 int netdev_open(const char *name, int ethertype, struct netdev **);
  78 void netdev_close(struct netdev *);
  79
  80 bool netdev_exists(const char *netdev_name);
  81
  82 int netdev_recv(struct netdev *, struct ofpbuf *);
  83 void netdev_recv_wait(struct netdev *);
  84 int netdev_drain(struct netdev *);
  85 int netdev_send(struct netdev *, const struct ofpbuf *);
  86 void netdev_send_wait(struct netdev *);
  87 int netdev_set_etheraddr(struct netdev *, const uint8_t mac[6]);
  88 int netdev_get_etheraddr(const struct netdev *, uint8_t mac[6]);
  89 const char *netdev_get_name(const struct netdev *);
  90 int netdev_get_mtu(const struct netdev *, int *mtup);
  91 int netdev_get_features(struct netdev *,
  92                         uint32_t *current, uint32_t *advertised,
  93                         uint32_t *supported, uint32_t *peer);
  94 int netdev_set_advertisements(struct netdev *, uint32_t advertise);
  95 int netdev_get_in4(const struct netdev *, struct in_addr *);
  96 int netdev_set_in4(struct netdev *, struct in_addr addr, struct in_addr mask);
  97 int netdev_add_router(struct netdev *, struct in_addr router);
  98 bool netdev_get_in6(const struct netdev *, struct in6_addr *);
  99 int netdev_get_flags(const struct netdev *, enum netdev_flags *);
 100 int netdev_set_flags(struct netdev *, enum netdev_flags, bool permanent);
 101 int netdev_turn_flags_on(struct netdev *, enum netdev_flags, bool permanent);
 102 int netdev_turn_flags_off(struct netdev *, enum netdev_flags, bool permanent);
 103 int netdev_arp_lookup(const struct netdev *, uint32_t ip, uint8_t mac[6]);
 104 int netdev_get_carrier(const struct netdev *, bool *carrier);
 105 int netdev_get_stats(const struct netdev *, struct netdev_stats *);
 106 int netdev_set_policing(struct netdev *, uint32_t kbits_rate,
 107                         uint32_t kbits_burst);
 108
 109 void netdev_enumerate(struct svec *);
 110 bool netdev_find_dev_by_in4(const struct in_addr *in4, char **netdev_name);
 111 int netdev_nodev_get_flags(const char *netdev_name, enum netdev_flags *);
 112 int netdev_nodev_get_in4(const char *netdev_name, struct in_addr *);
 113 int netdev_nodev_set_etheraddr(const char *name, const uint8_t mac[6]);
 114 int netdev_nodev_get_etheraddr(const char *netdev_name, uint8_t mac[6]);
 115 int netdev_nodev_set_policing(const char *netdev_name, uint32_t kbits_rate,
 116                               uint32_t kbits_burst);
 117 int netdev_nodev_arp_lookup(const char *netdev_name, uint32_t ip,
 118                             uint8_t mac[6]);
 119 int netdev_nodev_get_carrier(const char *netdev_name, bool *carrier);
 120
 121 int netdev_get_vlan_vid(const char *netdev_name, int *vlan_vid);
 122
 123 struct netdev_monitor;
 124 int netdev_monitor_create(struct netdev_monitor **);
 125 void netdev_monitor_destroy(struct netdev_monitor *);
 126 void netdev_monitor_add(struct netdev_monitor *, struct netdev *);
 127 void netdev_monitor_remove(struct netdev_monitor *, struct netdev *);
 128 int netdev_monitor_poll(struct netdev_monitor *, char **devnamep);
 129 void netdev_monitor_poll_wait(const struct netdev_monitor *);
 130
 131 #endif /* netdev.h */