ofproto/ofproto.h

   1 /*
   2  * Copyright (c) 2009, 2010 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 OFPROTO_H
  18 #define OFPROTO_H 1
  19
  20 #include <sys/types.h>
  21 #include <netinet/in.h>
  22 #include <stdbool.h>
  23 #include <stddef.h>
  24 #include <stdint.h>
  25 #include "flow.h"
  26 #include "netflow.h"
  27 #include "tag.h"
  28
  29 #ifdef  __cplusplus
  30 extern "C" {
  31 #endif
  32
  33 struct xflow_actions;
  34 struct ofhooks;
  35 struct ofproto;
  36 struct svec;
  37
  38 struct ofexpired {
  39     flow_t flow;
  40     uint64_t packet_count;      /* Packets from subrules. */
  41     uint64_t byte_count;        /* Bytes from subrules. */
  42     long long int used;         /* Last-used time (0 if never used). */
  43 };
  44
  45 struct ofproto_sflow_options {
  46     struct svec targets;
  47     uint32_t sampling_rate;
  48     uint32_t polling_interval;
  49     uint32_t header_len;
  50     uint32_t sub_id;
  51     char *agent_device;
  52     char *control_ip;
  53 };
  54
  55 /* How the switch should act if the controller cannot be contacted. */
  56 enum ofproto_fail_mode {
  57     OFPROTO_FAIL_SECURE,        /* Preserve flow table. */
  58     OFPROTO_FAIL_STANDALONE     /* Act as a standalone switch. */
  59 };
  60
  61 enum ofproto_band {
  62     OFPROTO_IN_BAND,            /* In-band connection to controller. */
  63     OFPROTO_OUT_OF_BAND         /* Out-of-band connection to controller. */
  64 };
  65
  66 struct ofproto_controller {
  67     char *target;               /* e.g. "tcp:127.0.0.1" */
  68     int max_backoff;            /* Maximum reconnection backoff, in seconds. */
  69     int probe_interval;         /* Max idle time before probing, in seconds. */
  70     enum ofproto_fail_mode fail; /* Controller failure handling mode. */
  71     enum ofproto_band band;      /* In-band or out-of-band? */
  72
  73     /* Discovery options. */
  74     char *accept_re;            /* Regexp for acceptable controllers.  */
  75     bool update_resolv_conf;    /* Update /etc/resolv.conf? */
  76
  77     /* OpenFlow packet-in rate-limiting. */
  78     int rate_limit;             /* Max packet-in rate in packets per second. */
  79     int burst_limit;            /* Limit on accumulating packet credits. */
  80 };
  81
  82 #define DEFAULT_MFR_DESC "Nicira Networks, Inc."
  83 #define DEFAULT_HW_DESC "Open vSwitch"
  84 #define DEFAULT_SW_DESC VERSION BUILDNR
  85 #define DEFAULT_SERIAL_DESC "None"
  86 #define DEFAULT_DP_DESC "None"
  87
  88 int ofproto_create(const char *datapath, const char *datapath_type,
  89                    const struct ofhooks *, void *aux,
  90                    struct ofproto **ofprotop);
  91 void ofproto_destroy(struct ofproto *);
  92 int ofproto_run(struct ofproto *);
  93 int ofproto_run1(struct ofproto *);
  94 int ofproto_run2(struct ofproto *, bool revalidate_all);
  95 void ofproto_wait(struct ofproto *);
  96 bool ofproto_is_alive(const struct ofproto *);
  97
  98 /* Configuration. */
  99 void ofproto_set_datapath_id(struct ofproto *, uint64_t datapath_id);
 100 void ofproto_set_controllers(struct ofproto *,
 101                              const struct ofproto_controller *, size_t n);
 102 void ofproto_reconnect_controllers(struct ofproto *);
 103 void ofproto_set_extra_in_band_remotes(struct ofproto *,
 104                                        const struct sockaddr_in *, size_t n);
 105 void ofproto_set_desc(struct ofproto *,
 106                       const char *mfr_desc, const char *hw_desc,
 107                       const char *sw_desc, const char *serial_desc,
 108                       const char *dp_desc);
 109 int ofproto_set_listeners(struct ofproto *, const struct svec *listeners);
 110 int ofproto_set_snoops(struct ofproto *, const struct svec *snoops);
 111 int ofproto_set_netflow(struct ofproto *,
 112                         const struct netflow_options *nf_options);
 113 void ofproto_set_sflow(struct ofproto *, const struct ofproto_sflow_options *);
 114 int ofproto_set_stp(struct ofproto *, bool enable_stp);
 115
 116 /* Configuration querying. */
 117 uint64_t ofproto_get_datapath_id(const struct ofproto *);
 118 bool ofproto_has_controller(const struct ofproto *);
 119 void ofproto_get_listeners(const struct ofproto *, struct svec *);
 120 void ofproto_get_snoops(const struct ofproto *, struct svec *);
 121 void ofproto_get_all_flows(struct ofproto *p, struct ds *);
 122
 123 /* Functions for use by ofproto implementation modules, not by clients. */
 124 int ofproto_send_packet(struct ofproto *, const flow_t *,
 125                         const union ofp_action *, size_t n_actions,
 126                         const struct ofpbuf *);
 127 void ofproto_add_flow(struct ofproto *, const flow_t *,
 128                       const union ofp_action *, size_t n_actions,
 129                       int idle_timeout);
 130 void ofproto_delete_flow(struct ofproto *, const flow_t *);
 131 void ofproto_flush_flows(struct ofproto *);
 132
 133 /* Hooks for ovs-vswitchd.
 134  *
 135  * This needs to be redesigned; it only makes sense for wdp-xflow. */
 136 struct ofhooks {
 137     void (*port_changed_cb)(enum ofp_port_reason, const struct ofp_phy_port *,
 138                             void *aux);
 139     bool (*normal_cb)(const flow_t *, const struct ofpbuf *packet,
 140                       struct xflow_actions *, tag_type *,
 141                       uint16_t *nf_output_iface, void *aux);
 142     void (*account_flow_cb)(const flow_t *, const union xflow_action *,
 143                             size_t n_actions, unsigned long long int n_bytes,
 144                             void *aux);
 145     void (*account_checkpoint_cb)(void *aux);
 146 };
 147 void ofproto_revalidate(struct ofproto *, tag_type);
 148 void ofproto_revalidate_all(struct ofproto *);
 149
 150 #ifdef  __cplusplus
 151 }
 152 #endif
 153
 154 #endif /* ofproto.h */