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 netdev;
  34 struct nlattr;
  35 struct ofpbuf;
  36 struct svec;
  37 struct dpif_class;
  38
  39 void dp_run(void);
  40 void dp_wait(void);
  41
  42 int dp_register_provider(const struct dpif_class *);
  43 int dp_unregister_provider(const char *type);
  44 void dp_enumerate_types(struct svec *types);
  45
  46 int dp_enumerate_names(const char *type, struct svec *names);
  47 void dp_parse_name(const char *datapath_name, char **name, char **type);
  48
  49 int dpif_open(const char *name, const char *type, struct dpif **);
  50 int dpif_create(const char *name, const char *type, struct dpif **);
  51 int dpif_create_and_open(const char *name, const char *type, struct dpif **);
  52 void dpif_close(struct dpif *);
  53
  54 const char *dpif_name(const struct dpif *);
  55 const char *dpif_base_name(const struct dpif *);
  56 int dpif_get_all_names(const struct dpif *, struct svec *);
  57
  58 int dpif_delete(struct dpif *);
  59
  60 int dpif_get_dp_stats(const struct dpif *, struct odp_stats *);
  61 int dpif_get_drop_frags(const struct dpif *, bool *drop_frags);
  62 int dpif_set_drop_frags(struct dpif *, bool drop_frags);
  63
  64 int dpif_port_add(struct dpif *, struct netdev *, uint16_t *port_nop);
  65 int dpif_port_del(struct dpif *, uint16_t port_no);
  66 int dpif_port_query_by_number(const struct dpif *, uint16_t port_no,
  67                               struct odp_port *);
  68 int dpif_port_query_by_name(const struct dpif *, const char *devname,
  69                             struct odp_port *);
  70 int dpif_port_get_name(struct dpif *, uint16_t port_no,
  71                        char *name, size_t name_size);
  72 int dpif_port_list(const struct dpif *, struct odp_port **, size_t *n_ports);
  73
  74 int dpif_port_poll(const struct dpif *, char **devnamep);
  75 void dpif_port_poll_wait(const struct dpif *);
  76
  77 int dpif_flow_flush(struct dpif *);
  78 int dpif_flow_put(struct dpif *, struct odp_flow_put *);
  79 int dpif_flow_del(struct dpif *, struct odp_flow *);
  80 int dpif_flow_get(const struct dpif *, struct odp_flow *);
  81 int dpif_flow_get_multiple(const struct dpif *, struct odp_flow[], size_t n);
  82
  83 struct dpif_flow_dump {
  84     const struct dpif *dpif;
  85     int error;
  86     void *state;
  87 };
  88 void dpif_flow_dump_start(struct dpif_flow_dump *, const struct dpif *);
  89 bool dpif_flow_dump_next(struct dpif_flow_dump *, struct odp_flow *);
  90 int dpif_flow_dump_done(struct dpif_flow_dump *);
  91
  92 int dpif_execute(struct dpif *, const struct nlattr *actions,
  93                  size_t actions_len, const struct ofpbuf *);
  94
  95 /* A packet passed up from the datapath to userspace.
  96  *
  97  * If 'key' or 'actions' is nonnull, then it points into data owned by
  98  * 'packet', so their memory cannot be freed separately.  (This is hardly a
  99  * great way to do things but it works out OK for the dpif providers and
 100  * clients that exist so far.)
 101  */
 102 struct dpif_upcall {
 103     uint32_t type;              /* One of _ODPL_*_NR. */
 104
 105     /* All types. */
 106     struct ofpbuf *packet;      /* Packet data. */
 107     struct nlattr *key;         /* Flow key. */
 108     size_t key_len;             /* Length of 'key' in bytes. */
 109
 110     /* _ODPL_ACTION_NR only. */
 111     uint64_t userdata;          /* Argument to ODPAT_CONTROLLER. */
 112
 113     /* _ODPL_SFLOW_NR only. */
 114     uint32_t sample_pool;       /* # of sampling candidate packets so far. */
 115     struct nlattr *actions;     /* Associated flow actions. */
 116     size_t actions_len;
 117 };
 118
 119 int dpif_recv_get_mask(const struct dpif *, int *listen_mask);
 120 int dpif_recv_set_mask(struct dpif *, int listen_mask);
 121 int dpif_get_sflow_probability(const struct dpif *, uint32_t *probability);
 122 int dpif_set_sflow_probability(struct dpif *, uint32_t probability);
 123 int dpif_recv(struct dpif *, struct dpif_upcall *);
 124 int dpif_recv_purge(struct dpif *);
 125 void dpif_recv_wait(struct dpif *);
 126
 127 void dpif_get_netflow_ids(const struct dpif *,
 128                           uint8_t *engine_type, uint8_t *engine_id);
 129
 130 int dpif_queue_to_priority(const struct dpif *, uint32_t queue_id,
 131                            uint32_t *priority);
 132
 133 #ifdef  __cplusplus
 134 }
 135 #endif
 136
 137 #endif /* dpif.h */