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 ofpbuf;
  31 struct svec;
  32
  33 /* A datapath interface.  Opaque. */
  34 struct dpif {
  35     unsigned int minor;         /* For use in error messages. */
  36     int fd;
  37 };
  38
  39 int dp_enumerate(struct svec *);
  40
  41 int dpif_open(const char *name, struct dpif *);
  42 int dpif_create(const char *name, struct dpif *);
  43 void dpif_close(struct dpif *);
  44
  45 static inline unsigned int dpif_id(const struct dpif *dpif);
  46 int dpif_get_name(struct dpif *, char *name, size_t name_size);
  47
  48 int dpif_delete(struct dpif *);
  49
  50 int dpif_get_dp_stats(const struct dpif *, struct odp_stats *);
  51 int dpif_get_drop_frags(const struct dpif *, bool *drop_frags);
  52 int dpif_set_drop_frags(struct dpif *, bool drop_frags);
  53
  54 int dpif_get_listen_mask(const struct dpif *, int *listen_mask);
  55 int dpif_set_listen_mask(struct dpif *, int listen_mask);
  56 int dpif_purge(struct dpif *);
  57
  58 int dpif_port_add(struct dpif *, const char *devname, uint16_t port_no,
  59                   uint16_t flags);
  60 int dpif_port_del(struct dpif *, uint16_t port_no);
  61 int dpif_port_query_by_number(const struct dpif *, uint16_t port_no,
  62                               struct odp_port *);
  63 int dpif_port_query_by_name(const struct dpif *, const char *devname,
  64                             struct odp_port *);
  65 int dpif_port_list(const struct dpif *, struct odp_port **, size_t *n_ports);
  66
  67 int dpif_port_group_set(struct dpif *, uint16_t group,
  68                         const uint16_t ports[], size_t n_ports);
  69 int dpif_port_group_get(const struct dpif *, uint16_t group,
  70                         uint16_t ports[], size_t n_ports, size_t *n_out);
  71
  72 int dpif_flow_flush(struct dpif *);
  73 int dpif_flow_put(struct dpif *, struct odp_flow_put *);
  74 int dpif_flow_del(struct dpif *, struct odp_flow *);
  75 int dpif_flow_get(const struct dpif *, struct odp_flow *);
  76 int dpif_flow_get_multiple(const struct dpif *, struct odp_flow[], size_t n);
  77 int dpif_flow_list(const struct dpif *, struct odp_flow[], size_t n,
  78                    size_t *n_out);
  79 int dpif_flow_list_all(const struct dpif *,
  80                        struct odp_flow **flowsp, size_t *np);
  81
  82 int dpif_execute(struct dpif *, uint16_t in_port,
  83                  const union odp_action[], size_t n_actions,
  84                  const struct ofpbuf *);
  85
  86 int dpif_recv(struct dpif *, struct ofpbuf **);
  87 void dpif_recv_wait(struct dpif *);
  88
  89 static inline unsigned int
  90 dpif_id(const struct dpif *dpif)
  91 {
  92     return dpif->minor;
  93 }
  94 \f
  95 struct dpifmon;
  96
  97 int dpifmon_create(const char *datapath_name, struct dpifmon **);
  98 void dpifmon_destroy(struct dpifmon *);
  99
 100 int dpifmon_poll(struct dpifmon *, char **devnamep);
 101
 102 void dpifmon_run(struct dpifmon *);
 103 void dpifmon_wait(struct dpifmon *);
 104
 105 #endif /* dpif.h */