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