X-Git-Url: http://git.onelab.eu/?a=blobdiff_plain;f=lib%2Fdpif.h;h=02029150ecb5d458d3f7652eb56b664aa23660da;hb=e0edde6fee279cdbbf3c179f5f50adaf0c7c7f1e;hp=216c0996931484cbb16013f5e41f3342ea9c183b;hpb=1d87357a1322c2faa290452c08c7f794c0be848b;p=sliver-openvswitch.git diff --git a/lib/dpif.h b/lib/dpif.h index 216c09969..02029150e 100644 --- a/lib/dpif.h +++ b/lib/dpif.h @@ -1,5 +1,5 @@ /* - * Copyright (c) 2008, 2009 Nicira Networks. + * Copyright (c) 2008, 2009, 2010, 2011, 2012 Nicira, Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -18,76 +18,253 @@ #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 #include #include +#include +#include "openflow/openflow.h" +#include "netdev.h" +#include "util.h" + +#ifdef __cplusplus +extern "C" { +#endif struct dpif; +struct ds; +struct flow; +struct nlattr; struct ofpbuf; -struct svec; +struct sset; +struct dpif_class; + +int dp_register_provider(const struct dpif_class *); +int dp_unregister_provider(const char *type); +void dp_blacklist_provider(const char *type); +void dp_enumerate_types(struct sset *types); +const char *dpif_normalize_type(const char *); -void dp_run(void); -void dp_wait(void); -int dp_enumerate(struct svec *); +int dp_enumerate_names(const char *type, struct sset *names); +void dp_parse_name(const char *datapath_name, char **name, char **type); -int dpif_open(const char *name, struct dpif **); -int dpif_create(const char *name, struct dpif **); +int dpif_open(const char *name, const char *type, struct dpif **); +int dpif_create(const char *name, const char *type, struct dpif **); +int dpif_create_and_open(const char *name, const char *type, struct dpif **); void dpif_close(struct dpif *); +void dpif_run(struct dpif *); +void dpif_wait(struct dpif *); + const char *dpif_name(const struct dpif *); -int dpif_get_all_names(const struct dpif *, struct svec *); +const char *dpif_base_name(const struct dpif *); 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); +/* Statisticss for a dpif as a whole. */ +struct dpif_dp_stats { + uint64_t n_hit; /* Number of flow table matches. */ + uint64_t n_missed; /* Number of flow table misses. */ + uint64_t n_lost; /* Number of misses not sent to userspace. */ + uint64_t n_flows; /* Number of flows present. */ +}; +int dpif_get_dp_stats(const struct dpif *, struct dpif_dp_stats *); + + +/* Port operations. */ -int dpif_port_add(struct dpif *, const char *devname, uint16_t flags, - uint16_t *port_no); +int dpif_port_add(struct dpif *, struct netdev *, uint16_t *port_nop); int dpif_port_del(struct dpif *, uint16_t port_no); + +/* A port within a datapath. + * + * 'name' and 'type' are suitable for passing to netdev_open(). */ +struct dpif_port { + char *name; /* Network device name, e.g. "eth0". */ + char *type; /* Network device type, e.g. "system". */ + uint32_t port_no; /* Port number within datapath. */ +}; +void dpif_port_clone(struct dpif_port *, const struct dpif_port *); +void dpif_port_destroy(struct dpif_port *); int dpif_port_query_by_number(const struct dpif *, uint16_t port_no, - struct odp_port *); + struct dpif_port *); int dpif_port_query_by_name(const struct dpif *, const char *devname, - struct odp_port *); + struct dpif_port *); int dpif_port_get_name(struct dpif *, uint16_t port_no, char *name, size_t name_size); -int dpif_port_list(const struct dpif *, struct odp_port **, size_t *n_ports); +int dpif_get_max_ports(const struct dpif *); +uint32_t dpif_port_get_pid(const struct dpif *, uint16_t port_no); + +struct dpif_port_dump { + const struct dpif *dpif; + int error; + void *state; +}; +void dpif_port_dump_start(struct dpif_port_dump *, const struct dpif *); +bool dpif_port_dump_next(struct dpif_port_dump *, struct dpif_port *); +int dpif_port_dump_done(struct dpif_port_dump *); + +/* Iterates through each DPIF_PORT in DPIF, using DUMP as state. + * + * Arguments all have pointer type. + * + * If you break out of the loop, then you need to free the dump structure by + * hand using dpif_port_dump_done(). */ +#define DPIF_PORT_FOR_EACH(DPIF_PORT, DUMP, DPIF) \ + for (dpif_port_dump_start(DUMP, DPIF); \ + (dpif_port_dump_next(DUMP, DPIF_PORT) \ + ? true \ + : (dpif_port_dump_done(DUMP), false)); \ + ) int dpif_port_poll(const struct dpif *, char **devnamep); void dpif_port_poll_wait(const struct dpif *); + +/* Flow table operations. */ + +struct dpif_flow_stats { + uint64_t n_packets; + uint64_t n_bytes; + long long int used; + uint8_t tcp_flags; +}; + +void dpif_flow_stats_extract(const struct flow *, const struct ofpbuf *packet, + struct dpif_flow_stats *); +void dpif_flow_stats_format(const struct dpif_flow_stats *, struct ds *); -int dpif_port_group_get(const struct dpif *, uint16_t group, - uint16_t **ports, size_t *n_ports); -int dpif_port_group_set(struct dpif *, uint16_t group, - const uint16_t ports[], size_t n_ports); +enum dpif_flow_put_flags { + DPIF_FP_CREATE = 1 << 0, /* Allow creating a new flow. */ + DPIF_FP_MODIFY = 1 << 1, /* Allow modifying an existing flow. */ + DPIF_FP_ZERO_STATS = 1 << 2 /* Zero the stats of an existing flow. */ +}; 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, +int dpif_flow_put(struct dpif *, enum dpif_flow_put_flags, + const struct nlattr *key, size_t key_len, + const struct nlattr *actions, size_t actions_len, + struct dpif_flow_stats *); +int dpif_flow_del(struct dpif *, + const struct nlattr *key, size_t key_len, + struct dpif_flow_stats *); +int dpif_flow_get(const struct dpif *, + const struct nlattr *key, size_t key_len, + struct ofpbuf **actionsp, struct dpif_flow_stats *); + +struct dpif_flow_dump { + const struct dpif *dpif; + int error; + void *state; +}; +void dpif_flow_dump_start(struct dpif_flow_dump *, const struct dpif *); +bool dpif_flow_dump_next(struct dpif_flow_dump *, + const struct nlattr **key, size_t *key_len, + const struct nlattr **actions, size_t *actions_len, + const struct dpif_flow_stats **); +int dpif_flow_dump_done(struct dpif_flow_dump *); + +/* Packet operations. */ + +int dpif_execute(struct dpif *, + const struct nlattr *key, size_t key_len, + const struct nlattr *actions, size_t actions_len, const struct ofpbuf *); + +/* Operation batching interface. + * + * Some datapaths are faster at performing N operations together than the same + * N operations individually, hence an interface for batching. + */ -int dpif_recv_get_mask(const struct dpif *, int *listen_mask); -int dpif_recv_set_mask(struct dpif *, int listen_mask); -int dpif_recv(struct dpif *, struct ofpbuf **); -int dpif_recv_purge(struct dpif *); +enum dpif_op_type { + DPIF_OP_FLOW_PUT = 1, + DPIF_OP_FLOW_DEL, + DPIF_OP_EXECUTE, +}; + +struct dpif_flow_put { + /* Input. */ + enum dpif_flow_put_flags flags; /* DPIF_FP_*. */ + const struct nlattr *key; /* Flow to put. */ + size_t key_len; /* Length of 'key' in bytes. */ + const struct nlattr *actions; /* Actions to perform on flow. */ + size_t actions_len; /* Length of 'actions' in bytes. */ + + /* Output. */ + struct dpif_flow_stats *stats; /* Optional flow statistics. */ +}; + +struct dpif_flow_del { + /* Input. */ + const struct nlattr *key; /* Flow to delete. */ + size_t key_len; /* Length of 'key' in bytes. */ + + /* Output. */ + struct dpif_flow_stats *stats; /* Optional flow statistics. */ +}; + +struct dpif_execute { + const struct nlattr *key; /* Partial flow key (only for metadata). */ + size_t key_len; /* Length of 'key' in bytes. */ + const struct nlattr *actions; /* Actions to execute on packet. */ + size_t actions_len; /* Length of 'actions' in bytes. */ + const struct ofpbuf *packet; /* Packet to execute. */ +}; + +struct dpif_op { + enum dpif_op_type type; + int error; + union { + struct dpif_flow_put flow_put; + struct dpif_flow_del flow_del; + struct dpif_execute execute; + } u; +}; + +void dpif_operate(struct dpif *, struct dpif_op **ops, size_t n_ops); + +/* Upcalls. */ + +enum dpif_upcall_type { + DPIF_UC_MISS, /* Miss in flow table. */ + DPIF_UC_ACTION, /* OVS_ACTION_ATTR_USERSPACE action. */ + DPIF_N_UC_TYPES +}; + +const char *dpif_upcall_type_to_string(enum dpif_upcall_type); + +/* A packet passed up from the datapath to userspace. + * + * If 'key' or 'actions' is nonnull, then it points into data owned by + * 'packet', so their memory cannot be freed separately. (This is hardly a + * great way to do things but it works out OK for the dpif providers and + * clients that exist so far.) + */ +struct dpif_upcall { + /* All types. */ + enum dpif_upcall_type type; + struct ofpbuf *packet; /* Packet data. */ + struct nlattr *key; /* Flow key. */ + size_t key_len; /* Length of 'key' in bytes. */ + + /* DPIF_UC_ACTION only. */ + uint64_t userdata; /* Argument to OVS_ACTION_ATTR_USERSPACE. */ +}; + +int dpif_recv_set(struct dpif *, bool enable); +int dpif_recv(struct dpif *, struct dpif_upcall *, struct ofpbuf *); +void dpif_recv_purge(struct dpif *); void dpif_recv_wait(struct dpif *); + +/* Miscellaneous. */ void dpif_get_netflow_ids(const struct dpif *, uint8_t *engine_type, uint8_t *engine_id); +int dpif_queue_to_priority(const struct dpif *, uint32_t queue_id, + uint32_t *priority); + +#ifdef __cplusplus +} +#endif + #endif /* dpif.h */