lib/dpif.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
  18 #ifndef DPIF_H
  19 #define DPIF_H 1
  20
  21 /* Operations for the datapath running in the local kernel.  The interface can
  22  * generalize to multiple types of local datapaths, but the implementation only
  23  * supports the openflow kernel module. */
  24
  25 #include "openvswitch/datapath-protocol.h"
  26 #include <stdbool.h>
  27 #include <stddef.h>
  28 #include <stdint.h>
  29
  30 struct dpif;
  31 struct ofpbuf;
  32 struct svec;
  33
  34 void dp_run(void);
  35 void dp_wait(void);
  36 int dp_enumerate(struct svec *);
  37
  38 int dpif_open(const char *name, struct dpif **);
  39 int dpif_create(const char *name, struct dpif **);
  40 int dpif_create_and_open(const char *name, struct dpif **);
  41 void dpif_close(struct dpif *);
  42
  43 const char *dpif_name(const struct dpif *);
  44 int dpif_get_all_names(const struct dpif *, struct svec *);
  45
  46 int dpif_delete(struct dpif *);
  47
  48 int dpif_get_dp_stats(const struct dpif *, struct odp_stats *);
  49 int dpif_get_drop_frags(const struct dpif *, bool *drop_frags);
  50 int dpif_set_drop_frags(struct dpif *, bool drop_frags);
  51
  52 int dpif_port_add(struct dpif *, const char *devname, uint16_t flags,
  53                   uint16_t *port_no);
  54 int dpif_port_del(struct dpif *, uint16_t port_no);
  55 int dpif_port_query_by_number(const struct dpif *, uint16_t port_no,
  56                               struct odp_port *);
  57 int dpif_port_query_by_name(const struct dpif *, const char *devname,
  58                             struct odp_port *);
  59 int dpif_port_get_name(struct dpif *, uint16_t port_no,
  60                        char *name, size_t name_size);
  61 int dpif_port_list(const struct dpif *, struct odp_port **, size_t *n_ports);
  62
  63 int dpif_port_poll(const struct dpif *, char **devnamep);
  64 void dpif_port_poll_wait(const struct dpif *);
  65
  66 int dpif_port_group_get(const struct dpif *, uint16_t group,
  67                         uint16_t **ports, size_t *n_ports);
  68 int dpif_port_group_set(struct dpif *, uint16_t group,
  69                         const uint16_t ports[], size_t n_ports);
  70
  71 int dpif_flow_flush(struct dpif *);
  72 int dpif_flow_put(struct dpif *, struct odp_flow_put *);
  73 int dpif_flow_del(struct dpif *, struct odp_flow *);
  74 int dpif_flow_get(const struct dpif *, struct odp_flow *);
  75 int dpif_flow_get_multiple(const struct dpif *, struct odp_flow[], size_t n);
  76 int dpif_flow_list(const struct dpif *, struct odp_flow[], size_t n,
  77                    size_t *n_out);
  78 int dpif_flow_list_all(const struct dpif *,
  79                        struct odp_flow **flowsp, size_t *np);
  80
  81 int dpif_execute(struct dpif *, uint16_t in_port,
  82                  const union odp_action[], size_t n_actions,
  83                  const struct ofpbuf *);
  84
  85 int dpif_recv_get_mask(const struct dpif *, int *listen_mask);
  86 int dpif_recv_set_mask(struct dpif *, int listen_mask);
  87 int dpif_get_sflow_probability(const struct dpif *, uint32_t *probability);
  88 int dpif_set_sflow_probability(struct dpif *, uint32_t probability);
  89 int dpif_recv(struct dpif *, struct ofpbuf **);
  90 int dpif_recv_purge(struct dpif *);
  91 void dpif_recv_wait(struct dpif *);
  92
  93 void dpif_get_netflow_ids(const struct dpif *,
  94                           uint8_t *engine_type, uint8_t *engine_id);
  95
  96 #endif /* dpif.h */