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 odp_actions;
  35 struct ofhooks;
  36 struct ofproto;
  37 struct svec;
  38
  39 struct ofexpired {
  40     struct flow flow;
  41     uint64_t packet_count;      /* Packets from subrules. */
  42     uint64_t byte_count;        /* Bytes from subrules. */
  43     long long int used;         /* Last-used time (0 if never used). */
  44 };
  45
  46 struct ofproto_sflow_options {
  47     struct svec targets;
  48     uint32_t sampling_rate;
  49     uint32_t polling_interval;
  50     uint32_t header_len;
  51     uint32_t sub_id;
  52     char *agent_device;
  53     char *control_ip;
  54 };
  55
  56 /* How the switch should act if the controller cannot be contacted. */
  57 enum ofproto_fail_mode {
  58     OFPROTO_FAIL_SECURE,        /* Preserve flow table. */
  59     OFPROTO_FAIL_STANDALONE     /* Act as a standalone switch. */
  60 };
  61
  62 enum ofproto_band {
  63     OFPROTO_IN_BAND,            /* In-band connection to controller. */
  64     OFPROTO_OUT_OF_BAND         /* Out-of-band connection to controller. */
  65 };
  66
  67 struct ofproto_controller {
  68     char *target;               /* e.g. "tcp:127.0.0.1" */
  69     int max_backoff;            /* Maximum reconnection backoff, in seconds. */
  70     int probe_interval;         /* Max idle time before probing, in seconds. */
  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 int ofproto_port_del(struct ofproto *, uint16_t odp_port);
  99 bool ofproto_port_is_floodable(struct ofproto *, uint16_t odp_port);
 100
 101 /* Configuration. */
 102 void ofproto_set_datapath_id(struct ofproto *, uint64_t datapath_id);
 103 void ofproto_set_controllers(struct ofproto *,
 104                              const struct ofproto_controller *, size_t n);
 105 void ofproto_set_fail_mode(struct ofproto *, enum ofproto_fail_mode fail_mode);
 106 void ofproto_reconnect_controllers(struct ofproto *);
 107 void ofproto_set_extra_in_band_remotes(struct ofproto *,
 108                                        const struct sockaddr_in *, size_t n);
 109 void ofproto_set_desc(struct ofproto *,
 110                       const char *mfr_desc, const char *hw_desc,
 111                       const char *sw_desc, const char *serial_desc,
 112                       const char *dp_desc);
 113 int ofproto_set_snoops(struct ofproto *, const struct svec *snoops);
 114 int ofproto_set_netflow(struct ofproto *,
 115                         const struct netflow_options *nf_options);
 116 void ofproto_set_sflow(struct ofproto *, const struct ofproto_sflow_options *);
 117
 118 /* Configuration querying. */
 119 uint64_t ofproto_get_datapath_id(const struct ofproto *);
 120 bool ofproto_has_primary_controller(const struct ofproto *);
 121 enum ofproto_fail_mode ofproto_get_fail_mode(const struct ofproto *);
 122 void ofproto_get_listeners(const struct ofproto *, struct svec *);
 123 void ofproto_get_snoops(const struct ofproto *, struct svec *);
 124 void ofproto_get_all_flows(struct ofproto *p, struct ds *);
 125
 126 /* Functions for use by ofproto implementation modules, not by clients. */
 127 int ofproto_send_packet(struct ofproto *, const struct flow *,
 128                         const union ofp_action *, size_t n_actions,
 129                         const struct ofpbuf *);
 130 void ofproto_add_flow(struct ofproto *, const struct cls_rule *,
 131                       const union ofp_action *, size_t n_actions);
 132 void ofproto_delete_flow(struct ofproto *, const struct cls_rule *);
 133 void ofproto_flush_flows(struct ofproto *);
 134
 135 /* Hooks for ovs-vswitchd. */
 136 struct ofhooks {
 137     bool (*normal_cb)(const struct flow *, const struct ofpbuf *packet,
 138                       struct odp_actions *, tag_type *,
 139                       uint16_t *nf_output_iface, void *aux);
 140     void (*account_flow_cb)(const struct flow *, tag_type tags,
 141                             const union odp_action *, size_t n_actions,
 142                             unsigned long long int n_bytes, void *aux);
 143     void (*account_checkpoint_cb)(void *aux);
 144 };
 145 void ofproto_revalidate(struct ofproto *, tag_type);
 146 struct tag_set *ofproto_get_revalidate_set(struct ofproto *);
 147
 148 #ifdef  __cplusplus
 149 }
 150 #endif
 151
 152 #endif /* ofproto.h */