lib/dpif.h

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