X-Git-Url: http://git.onelab.eu/?a=blobdiff_plain;f=lib%2Fdpif.h;h=3c376ec1f380bfa7186362a5de66abb0c672e9fd;hb=bc4a05c639ee3789d009bb6143345cf121b2d4d4;hp=1d109c2d256ef168fccc956471ef3515bc062ad1;hpb=efacbce62f4ca3baf305441641ee35aa5b657442;p=sliver-openvswitch.git diff --git a/lib/dpif.h b/lib/dpif.h index 1d109c2d2..3c376ec1f 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 Nicira Networks. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -18,29 +18,41 @@ #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 "openflow/openflow.h" +#include "openvswitch/datapath-protocol.h" +#include "util.h" + +#ifdef __cplusplus +extern "C" { +#endif struct dpif; +struct netdev; +struct nlattr; struct ofpbuf; struct svec; +struct dpif_class; void dp_run(void); void dp_wait(void); -int dp_enumerate(struct svec *); -int dpif_open(const char *name, struct dpif **); -int dpif_create(const char *name, struct dpif **); -int dpif_create_and_open(const char *name, struct dpif **); +int dp_register_provider(const struct dpif_class *); +int dp_unregister_provider(const char *type); +void dp_enumerate_types(struct svec *types); + +int dp_enumerate_names(const char *type, struct svec *names); +void dp_parse_name(const char *datapath_name, char **name, char **type); + +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 *); const char *dpif_name(const struct dpif *); +const char *dpif_base_name(const struct dpif *); int dpif_get_all_names(const struct dpif *, struct svec *); int dpif_delete(struct dpif *); @@ -49,46 +61,109 @@ 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_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 *); + +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 *); -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); - 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 *); +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 *, struct odp_flow *); +int dpif_flow_dump_done(struct dpif_flow_dump *); + +int dpif_execute(struct dpif *, const struct nlattr *actions, + size_t actions_len, const struct ofpbuf *); + +/* 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 { + uint32_t type; /* One of _ODPL_*_NR. */ + + /* All types. */ + struct ofpbuf *packet; /* Packet data. */ + struct nlattr *key; /* Flow key. */ + size_t key_len; /* Length of 'key' in bytes. */ + + /* _ODPL_ACTION_NR only. */ + uint64_t userdata; /* Argument to ODPAT_CONTROLLER. */ + + /* _ODPL_SFLOW_NR only. */ + uint32_t sample_pool; /* # of sampling candidate packets so far. */ + struct nlattr *actions; /* Associated flow actions. */ + size_t actions_len; +}; 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 *); +int dpif_get_sflow_probability(const struct dpif *, uint32_t *probability); +int dpif_set_sflow_probability(struct dpif *, uint32_t probability); +int dpif_recv(struct dpif *, struct dpif_upcall *); +void dpif_recv_purge(struct dpif *); void dpif_recv_wait(struct dpif *); 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 */