summaryrefslogtreecommitdiff
path: root/lib/dpif.h
blob: 22f835554c2e901f8d70d8a985944df3b47a9841 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
/*
 * Copyright (c) 2008, 2009 Nicira Networks.
 *
 * Permission to use, copy, modify, and/or distribute this software for any
 * purpose with or without fee is hereby granted, provided that the above
 * copyright notice and this permission notice appear in all copies.
 *
 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 */


#ifndef DPIF_H
#define DPIF_H 1

/* Operations for the datapath running in the local kernel.  The interface can
 * generalize to multiple types of local datapaths, but the implementation only
 * supports the openflow kernel module. */

#include "openvswitch/datapath-protocol.h"
#include <stdbool.h>
#include <stddef.h>
#include <stdint.h>

struct ofpbuf;

/* A datapath interface.  Opaque. */
struct dpif {
    unsigned int minor;         /* For use in error messages. */
    int fd;
};

int dpif_open(const char *name, struct dpif *);
int dpif_create(const char *name, struct dpif *);
void dpif_close(struct dpif *);

static inline unsigned int dpif_id(const struct dpif *dpif);
int dpif_get_name(struct dpif *, char *name, size_t name_size);

int dpif_delete(struct dpif *);

int dpif_get_dp_stats(const struct dpif *, struct odp_stats *);
int dpif_get_drop_frags(const struct dpif *, bool *drop_frags);
int dpif_set_drop_frags(struct dpif *, bool drop_frags);

int dpif_get_listen_mask(const struct dpif *, int *listen_mask);
int dpif_set_listen_mask(struct dpif *, int listen_mask);
int dpif_purge(struct dpif *);

int dpif_port_add(struct dpif *, const char *devname, uint16_t port_no,
                  uint16_t flags);
int dpif_port_del(struct dpif *, uint16_t port_no);
int dpif_port_query_by_number(const struct dpif *, uint16_t port_no,
                              struct odp_port *);
int dpif_port_query_by_name(const struct dpif *, const char *devname,
                            struct odp_port *);
int dpif_port_list(const struct dpif *, struct odp_port **, size_t *n_ports);

int dpif_port_group_set(struct dpif *, uint16_t group,
                        const uint16_t ports[], size_t n_ports);
int dpif_port_group_get(const struct dpif *, uint16_t group,
                        uint16_t ports[], size_t n_ports, size_t *n_out);

int dpif_flow_flush(struct dpif *);
int dpif_flow_put(struct dpif *, struct odp_flow_put *);
int dpif_flow_del(struct dpif *, struct odp_flow *);
int dpif_flow_get(const struct dpif *, struct odp_flow *);
int dpif_flow_get_multiple(const struct dpif *, struct odp_flow[], size_t n);
int dpif_flow_list(const struct dpif *, struct odp_flow[], size_t n,
                   size_t *n_out);
int dpif_flow_list_all(const struct dpif *,
                       struct odp_flow **flowsp, size_t *np);

int dpif_execute(struct dpif *, uint16_t in_port,
                 const union odp_action[], size_t n_actions,
                 const struct ofpbuf *);

int dpif_recv(struct dpif *, struct ofpbuf **);
void dpif_recv_wait(struct dpif *);

static inline unsigned int
dpif_id(const struct dpif *dpif)
{
    return dpif->minor;
}

struct dpifmon;

int dpifmon_create(const char *datapath_name, struct dpifmon **);
void dpifmon_destroy(struct dpifmon *);

int dpifmon_poll(struct dpifmon *, char **devnamep);

void dpifmon_run(struct dpifmon *);
void dpifmon_wait(struct dpifmon *);

#endif /* dpif.h */