ofproto/ofproto.h

   1 /*
   2  * Copyright (c) 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 OFPROTO_H
  18 #define OFPROTO_H 1
  19
  20 #include <stdbool.h>
  21 #include <stddef.h>
  22 #include <stdint.h>
  23 #include "flow.h"
  24 #include "netflow.h"
  25 #include "tag.h"
  26
  27 #ifdef  __cplusplus
  28 extern "C" {
  29 #endif
  30
  31 struct odp_actions;
  32 struct ofhooks;
  33 struct ofproto;
  34 struct svec;
  35
  36 enum {
  37     DP_GROUP_FLOOD = 0,
  38     DP_GROUP_ALL = 1
  39 };
  40
  41 struct ofexpired {
  42     flow_t flow;
  43     uint64_t packet_count;      /* Packets from subrules. */
  44     uint64_t byte_count;        /* Bytes from subrules. */
  45     long long int used;         /* Last-used time (0 if never used). */
  46 };
  47
  48 struct ofproto_sflow_options {
  49     struct svec targets;
  50     uint32_t sampling_rate;
  51     uint32_t polling_interval;
  52     uint32_t header_len;
  53     uint32_t sub_id;
  54     char *agent_device;
  55     char *control_ip;
  56 };
  57
  58 int ofproto_create(const char *datapath, const struct ofhooks *, void *aux,
  59                    struct ofproto **ofprotop);
  60 void ofproto_destroy(struct ofproto *);
  61 int ofproto_run(struct ofproto *);
  62 int ofproto_run1(struct ofproto *);
  63 int ofproto_run2(struct ofproto *, bool revalidate_all);
  64 void ofproto_wait(struct ofproto *);
  65 bool ofproto_is_alive(const struct ofproto *);
  66
  67 /* Configuration. */
  68 void ofproto_set_datapath_id(struct ofproto *, uint64_t datapath_id);
  69 void ofproto_set_mgmt_id(struct ofproto *, uint64_t mgmt_id);
  70 void ofproto_set_probe_interval(struct ofproto *, int probe_interval);
  71 void ofproto_set_max_backoff(struct ofproto *, int max_backoff);
  72 void ofproto_set_desc(struct ofproto *,
  73                       const char *manufacturer, const char *hardware,
  74                       const char *software, const char *serial);
  75 int ofproto_set_in_band(struct ofproto *, bool in_band);
  76 int ofproto_set_discovery(struct ofproto *, bool discovery,
  77                           const char *accept_controller_re,
  78                           bool update_resolv_conf);
  79 int ofproto_set_controller(struct ofproto *, const char *controller);
  80 int ofproto_set_listeners(struct ofproto *, const struct svec *listeners);
  81 int ofproto_set_snoops(struct ofproto *, const struct svec *snoops);
  82 int ofproto_set_netflow(struct ofproto *,
  83                         const struct netflow_options *nf_options);
  84 void ofproto_set_sflow(struct ofproto *, const struct ofproto_sflow_options *);
  85 void ofproto_set_failure(struct ofproto *, bool fail_open);
  86 void ofproto_set_rate_limit(struct ofproto *, int rate_limit, int burst_limit);
  87 int ofproto_set_stp(struct ofproto *, bool enable_stp);
  88 int ofproto_set_remote_execution(struct ofproto *, const char *command_acl,
  89                                  const char *command_dir);
  90
  91 /* Configuration querying. */
  92 uint64_t ofproto_get_datapath_id(const struct ofproto *);
  93 uint64_t ofproto_get_mgmt_id(const struct ofproto *);
  94 int ofproto_get_probe_interval(const struct ofproto *);
  95 int ofproto_get_max_backoff(const struct ofproto *);
  96 bool ofproto_get_in_band(const struct ofproto *);
  97 bool ofproto_get_discovery(const struct ofproto *);
  98 const char *ofproto_get_controller(const struct ofproto *);
  99 void ofproto_get_listeners(const struct ofproto *, struct svec *);
 100 void ofproto_get_snoops(const struct ofproto *, struct svec *);
 101 void ofproto_get_all_flows(struct ofproto *p, struct ds *);
 102
 103 /* Functions for use by ofproto implementation modules, not by clients. */
 104 int ofproto_send_packet(struct ofproto *, const flow_t *,
 105                         const union ofp_action *, size_t n_actions,
 106                         const struct ofpbuf *);
 107 void ofproto_add_flow(struct ofproto *, const flow_t *, uint32_t wildcards,
 108                       unsigned int priority,
 109                       const union ofp_action *, size_t n_actions,
 110                       int idle_timeout);
 111 void ofproto_delete_flow(struct ofproto *, const flow_t *, uint32_t wildcards,
 112                          unsigned int priority);
 113 void ofproto_flush_flows(struct ofproto *);
 114
 115 /* Hooks for ovs-vswitchd. */
 116 struct ofhooks {
 117     void (*port_changed_cb)(enum ofp_port_reason, const struct ofp_phy_port *,
 118                             void *aux);
 119     bool (*normal_cb)(const flow_t *, const struct ofpbuf *packet,
 120                       struct odp_actions *, tag_type *,
 121                       uint16_t *nf_output_iface, void *aux);
 122     void (*account_flow_cb)(const flow_t *, const union odp_action *,
 123                             size_t n_actions, unsigned long long int n_bytes,
 124                             void *aux);
 125     void (*account_checkpoint_cb)(void *aux);
 126 };
 127 void ofproto_revalidate(struct ofproto *, tag_type);
 128 struct tag_set *ofproto_get_revalidate_set(struct ofproto *);
 129
 130 #ifdef  __cplusplus
 131 }
 132 #endif
 133
 134 #endif /* ofproto.h */