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 <stdbool.h>
  22 #include <stddef.h>
  23 #include <stdint.h>
  24 #include "openflow/openflow.h"
  25 #include "openvswitch/datapath-protocol.h"
  26 #include "util.h"
  27
  28 #ifdef  __cplusplus
  29 extern "C" {
  30 #endif
  31
  32 struct dpif;
  33 struct ofpbuf;
  34 struct svec;
  35 struct dpif_class;
  36
  37 void dp_run(void);
  38 void dp_wait(void);
  39 #ifdef THREADED
  40 void dp_start(void);
  41 #endif
  42
  43 int dp_register_provider(const struct dpif_class *);
  44 int dp_unregister_provider(const char *type);
  45 void dp_enumerate_types(struct svec *types);
  46
  47 int dp_enumerate_names(const char *type, struct svec *names);
  48 void dp_parse_name(const char *datapath_name, char **name, char **type);
  49
  50 int dpif_open(const char *name, const char *type, struct dpif **);
  51 int dpif_create(const char *name, const char *type, struct dpif **);
  52 int dpif_create_and_open(const char *name, const char *type, struct dpif **);
  53 void dpif_close(struct dpif *);
  54
  55 const char *dpif_name(const struct dpif *);
  56 const char *dpif_base_name(const struct dpif *);
  57 int dpif_get_all_names(const struct dpif *, struct svec *);
  58
  59 int dpif_delete(struct dpif *);
  60
  61 int dpif_get_dp_stats(const struct dpif *, struct odp_stats *);
  62 int dpif_get_drop_frags(const struct dpif *, bool *drop_frags);
  63 int dpif_set_drop_frags(struct dpif *, bool drop_frags);
  64
  65 int dpif_port_add(struct dpif *, const char *devname, uint16_t flags,
  66                   uint16_t *port_no);
  67 int dpif_port_del(struct dpif *, uint16_t port_no);
  68 int dpif_port_query_by_number(const struct dpif *, uint16_t port_no,
  69                               struct odp_port *);
  70 int dpif_port_query_by_name(const struct dpif *, const char *devname,
  71                             struct odp_port *);
  72 int dpif_port_get_name(struct dpif *, uint16_t port_no,
  73                        char *name, size_t name_size);
  74 int dpif_port_list(const struct dpif *, struct odp_port **, size_t *n_ports);
  75
  76 int dpif_port_poll(const struct dpif *, char **devnamep);
  77 void dpif_port_poll_wait(const struct dpif *);
  78
  79 int dpif_port_group_get(const struct dpif *, uint16_t group,
  80                         uint16_t **ports, size_t *n_ports);
  81 int dpif_port_group_set(struct dpif *, uint16_t group,
  82                         const uint16_t ports[], size_t n_ports);
  83
  84 int dpif_flow_flush(struct dpif *);
  85 int dpif_flow_put(struct dpif *, struct odp_flow_put *);
  86 int dpif_flow_del(struct dpif *, struct odp_flow *);
  87 int dpif_flow_get(const struct dpif *, struct odp_flow *);
  88 int dpif_flow_get_multiple(const struct dpif *, struct odp_flow[], size_t n);
  89 int dpif_flow_list(const struct dpif *, struct odp_flow[], size_t n,
  90                    size_t *n_out);
  91 int dpif_flow_list_all(const struct dpif *,
  92                        struct odp_flow **flowsp, size_t *np);
  93
  94 int dpif_execute(struct dpif *, uint16_t in_port,
  95                  const union odp_action[], size_t n_actions,
  96                  const struct ofpbuf *);
  97
  98 /* Minimum number of bytes of headroom for a packet returned by dpif_recv()
  99  * member function.  This headroom allows "struct odp_msg" to be replaced by
 100  * "struct ofp_packet_in" without copying the buffer. */
 101 #define DPIF_RECV_MSG_PADDING (sizeof(struct ofp_packet_in) \
 102                                - sizeof(struct odp_msg))
 103 BUILD_ASSERT_DECL(sizeof(struct ofp_packet_in) > sizeof(struct odp_msg));
 104 BUILD_ASSERT_DECL(DPIF_RECV_MSG_PADDING % 4 == 0);
 105
 106 int dpif_recv_get_mask(const struct dpif *, int *listen_mask);
 107 int dpif_recv_set_mask(struct dpif *, int listen_mask);
 108 int dpif_get_sflow_probability(const struct dpif *, uint32_t *probability);
 109 int dpif_set_sflow_probability(struct dpif *, uint32_t probability);
 110 int dpif_recv(struct dpif *, struct ofpbuf **);
 111 int dpif_recv_purge(struct dpif *);
 112 void dpif_recv_wait(struct dpif *);
 113
 114 void dpif_get_netflow_ids(const struct dpif *,
 115                           uint8_t *engine_type, uint8_t *engine_id);
 116
 117 int dpif_queue_to_priority(const struct dpif *, uint32_t queue_id,
 118                            uint32_t *priority);
 119
 120 #ifdef  __cplusplus
 121 }
 122 #endif
 123
 124 #endif /* dpif.h */