pintos-os.org Git - openvswitch/blob - 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 cls_rule;
  34 struct nlattr;
  35 struct ofhooks;
  36 struct ofproto;
  37 struct shash;
  38 struct svec;
  39
  40 struct ofproto_controller_info {
  41     bool is_connected;
  42     enum nx_role role;
  43     struct {
  44         const char *keys[3];
  45         const char *values[3];
  46         size_t n;
  47     } pairs;
  48 };
  49
  50 struct ofexpired {
  51     struct flow flow;
  52     uint64_t packet_count;      /* Packets from subrules. */
  53     uint64_t byte_count;        /* Bytes from subrules. */
  54     long long int used;         /* Last-used time (0 if never used). */
  55 };
  56
  57 struct ofproto_sflow_options {
  58     struct svec targets;
  59     uint32_t sampling_rate;
  60     uint32_t polling_interval;
  61     uint32_t header_len;
  62     uint32_t sub_id;
  63     char *agent_device;
  64     char *control_ip;
  65 };
  66
  67 /* How the switch should act if the controller cannot be contacted. */
  68 enum ofproto_fail_mode {
  69     OFPROTO_FAIL_SECURE,        /* Preserve flow table. */
  70     OFPROTO_FAIL_STANDALONE     /* Act as a standalone switch. */
  71 };
  72
  73 enum ofproto_band {
  74     OFPROTO_IN_BAND,            /* In-band connection to controller. */
  75     OFPROTO_OUT_OF_BAND         /* Out-of-band connection to controller. */
  76 };
  77
  78 struct ofproto_controller {
  79     char *target;               /* e.g. "tcp:127.0.0.1" */
  80     int max_backoff;            /* Maximum reconnection backoff, in seconds. */
  81     int probe_interval;         /* Max idle time before probing, in seconds. */
  82     enum ofproto_band band;      /* In-band or out-of-band? */
  83
  84     /* Discovery options. */
  85     char *accept_re;            /* Regexp for acceptable controllers.  */
  86     bool update_resolv_conf;    /* Update /etc/resolv.conf? */
  87
  88     /* OpenFlow packet-in rate-limiting. */
  89     int rate_limit;             /* Max packet-in rate in packets per second. */
  90     int burst_limit;            /* Limit on accumulating packet credits. */
  91 };
  92
  93 #define DEFAULT_MFR_DESC "Nicira Networks, Inc."
  94 #define DEFAULT_HW_DESC "Open vSwitch"
  95 #define DEFAULT_SW_DESC VERSION BUILDNR
  96 #define DEFAULT_SERIAL_DESC "None"
  97 #define DEFAULT_DP_DESC "None"
  98
  99 int ofproto_create(const char *datapath, const char *datapath_type,
 100                    const struct ofhooks *, void *aux,
 101                    struct ofproto **ofprotop);
 102 void ofproto_destroy(struct ofproto *);
 103 int ofproto_run(struct ofproto *);
 104 int ofproto_run1(struct ofproto *);
 105 int ofproto_run2(struct ofproto *, bool revalidate_all);
 106 void ofproto_wait(struct ofproto *);
 107 bool ofproto_is_alive(const struct ofproto *);
 108
 109 int ofproto_port_del(struct ofproto *, uint16_t odp_port);
 110 bool ofproto_port_is_floodable(struct ofproto *, uint16_t odp_port);
 111
 112 /* Configuration. */
 113 void ofproto_set_datapath_id(struct ofproto *, uint64_t datapath_id);
 114 void ofproto_set_controllers(struct ofproto *,
 115                              const struct ofproto_controller *, size_t n);
 116 void ofproto_set_fail_mode(struct ofproto *, enum ofproto_fail_mode fail_mode);
 117 void ofproto_reconnect_controllers(struct ofproto *);
 118 void ofproto_set_extra_in_band_remotes(struct ofproto *,
 119                                        const struct sockaddr_in *, size_t n);
 120 void ofproto_set_in_band_queue(struct ofproto *, int queue_id);
 121 void ofproto_set_desc(struct ofproto *,
 122                       const char *mfr_desc, const char *hw_desc,
 123                       const char *sw_desc, const char *serial_desc,
 124                       const char *dp_desc);
 125 int ofproto_set_snoops(struct ofproto *, const struct svec *snoops);
 126 int ofproto_set_netflow(struct ofproto *,
 127                         const struct netflow_options *nf_options);
 128 void ofproto_set_sflow(struct ofproto *, const struct ofproto_sflow_options *);
 129
 130 /* Configuration querying. */
 131 uint64_t ofproto_get_datapath_id(const struct ofproto *);
 132 bool ofproto_has_primary_controller(const struct ofproto *);
 133 enum ofproto_fail_mode ofproto_get_fail_mode(const struct ofproto *);
 134 void ofproto_get_listeners(const struct ofproto *, struct svec *);
 135 void ofproto_get_snoops(const struct ofproto *, struct svec *);
 136 void ofproto_get_all_flows(struct ofproto *p, struct ds *);
 137
 138 /* Functions for use by ofproto implementation modules, not by clients. */
 139 int ofproto_send_packet(struct ofproto *, const struct flow *,
 140                         const union ofp_action *, size_t n_actions,
 141                         const struct ofpbuf *);
 142 void ofproto_add_flow(struct ofproto *, const struct cls_rule *,
 143                       const union ofp_action *, size_t n_actions);
 144 void ofproto_delete_flow(struct ofproto *, const struct cls_rule *);
 145 void ofproto_flush_flows(struct ofproto *);
 146
 147 /* Hooks for ovs-vswitchd. */
 148 struct ofhooks {
 149     bool (*normal_cb)(const struct flow *, const struct ofpbuf *packet,
 150                       struct ofpbuf *odp_actions, tag_type *,
 151                       uint16_t *nf_output_iface, void *aux);
 152     bool (*special_cb)(const struct flow *flow, const struct ofpbuf *packet,
 153                        void *aux);
 154     void (*account_flow_cb)(const struct flow *, tag_type tags,
 155                             const struct nlattr *odp_actions,
 156                             size_t actions_len,
 157                             uint64_t n_bytes, void *aux);
 158     void (*account_checkpoint_cb)(void *aux);
 159 };
 160 void ofproto_revalidate(struct ofproto *, tag_type);
 161 struct tag_set *ofproto_get_revalidate_set(struct ofproto *);
 162
 163 void ofproto_get_ofproto_controller_info(const struct ofproto *, struct shash *);
 164 void ofproto_free_ofproto_controller_info(struct shash *);
 165
 166 #ifdef  __cplusplus
 167 }
 168 #endif
 169
 170 #endif /* ofproto.h */