X-Git-Url: https://pintos-os.org/cgi-bin/gitweb.cgi?a=blobdiff_plain;f=include%2Fopenvswitch%2Fdatapath-protocol.h;h=083800cc88399ac20fe16440fc52d0c34e336eb8;hb=254f2dc8e3eb18debf4a8f238b9c87cf4d4dbd3f;hp=cf81cb31c7ca8027f31f3eab194afd77af08c22f;hpb=9c52546b52018970d97b33b31a0578497663737a;p=openvswitch diff --git a/include/openvswitch/datapath-protocol.h b/include/openvswitch/datapath-protocol.h index cf81cb31..083800cc 100644 --- a/include/openvswitch/datapath-protocol.h +++ b/include/openvswitch/datapath-protocol.h @@ -69,35 +69,80 @@ #include #include + +/* datapaths. */ + +#define ODP_DATAPATH_FAMILY "odp_datapath" +#define ODP_DATAPATH_MCGROUP "odp_datapath" + +enum odp_datapath_cmd { + ODP_DP_CMD_UNSPEC, + ODP_DP_CMD_NEW, + ODP_DP_CMD_DEL, + ODP_DP_CMD_GET, + ODP_DP_CMD_SET +}; -#define ODP_MAX 256 /* Maximum number of datapaths. */ - -#define ODP_DP_CREATE _IO('O', 0) -#define ODP_DP_DESTROY _IO('O', 1) -#define ODP_DP_STATS _IOW('O', 2, struct odp_stats) - -#define ODP_GET_DROP_FRAGS _IOW('O', 3, int) -#define ODP_SET_DROP_FRAGS _IOR('O', 4, int) - -#define ODP_GET_LISTEN_MASK _IOW('O', 5, int) -#define ODP_SET_LISTEN_MASK _IOR('O', 6, int) - -#define ODP_VPORT_NEW _IOR('O', 7, struct odp_vport) -#define ODP_VPORT_DEL _IOR('O', 8, struct odp_vport) -#define ODP_VPORT_GET _IOWR('O', 9, struct odp_vport) -#define ODP_VPORT_SET _IOR('O', 22, struct odp_vport) -#define ODP_VPORT_DUMP _IOWR('O', 10, struct odp_vport) - -#define ODP_FLOW_GET _IOWR('O', 13, struct odp_flow) -#define ODP_FLOW_PUT _IOWR('O', 14, struct odp_flow) -#define ODP_FLOW_DUMP _IOWR('O', 15, struct odp_flow_dump) -#define ODP_FLOW_FLUSH _IO('O', 16) -#define ODP_FLOW_DEL _IOWR('O', 17, struct odp_flow) +/** + * struct odp_header - header for ODP Generic Netlink messages. + * @dp_ifindex: ifindex of local port for datapath (0 to make a request not + * specific to a datapath). + * + * Attributes following the header are specific to a particular ODP Generic + * Netlink family, but all of the ODP families use this header. + */ +struct odp_header { + int dp_ifindex; +}; + +/** + * enum odp_datapath_attr - attributes for %ODP_DP_* commands. + * @ODP_DP_ATTR_NAME: Name of the network device that serves as the "local + * port". This is the name of the network device whose dp_ifindex is given in + * the &struct odp_header. Always present in notifications. Required in + * %ODP_DP_NEW requests. May be used as an alternative to specifying + * dp_ifindex in other requests (with a dp_ifindex of 0). + * @ODP_DP_ATTR_STATS: Statistics about packets that have passed through the + * datapath. Always present in notifications. + * @ODP_DP_ATTR_IPV4_FRAGS: One of %ODP_DP_FRAG_*. Always present in + * notifications. May be included in %ODP_DP_NEW or %ODP_DP_SET requests to + * change the fragment handling policy. + * @ODP_DP_ATTR_SAMPLING: 32-bit fraction of packets to sample with + * @ODP_PACKET_CMD_SAMPLE. A value of 0 samples no packets, a value of + * %UINT32_MAX samples all packets, and intermediate values sample intermediate + * fractions of packets. + * @ODP_DP_ATTR_MCGROUPS: Nested attributes with multicast groups. Each nested + * attribute has a %ODP_PACKET_CMD_* type with a 32-bit value giving the + * Generic Netlink multicast group number used for sending this datapath's + * messages with that command type up to userspace. + * + * These attributes follow the &struct odp_header within the Generic Netlink + * payload for %ODP_DP_* commands. + */ +enum odp_datapath_attr { + ODP_DP_ATTR_UNSPEC, + ODP_DP_ATTR_NAME, /* name of dp_ifindex netdev */ + ODP_DP_ATTR_STATS, /* struct odp_stats */ + ODP_DP_ATTR_IPV4_FRAGS, /* 32-bit enum odp_frag_handling */ + ODP_DP_ATTR_SAMPLING, /* 32-bit fraction of packets to sample. */ + ODP_DP_ATTR_MCGROUPS, /* Nested attributes with multicast groups. */ + __ODP_DP_ATTR_MAX +}; -#define ODP_EXECUTE _IOR('O', 18, struct odp_execute) +#define ODP_DP_ATTR_MAX (__ODP_DP_ATTR_MAX - 1) -#define ODP_SET_SFLOW_PROBABILITY _IOR('O', 19, int) -#define ODP_GET_SFLOW_PROBABILITY _IOW('O', 20, int) +/** + * enum odp_frag_handling - policy for handling received IPv4 fragments. + * @ODP_DP_FRAG_ZERO: Treat IP fragments as IP protocol 0 and transport ports + * zero. + * @ODP_DP_FRAG_DROP: Drop IP fragments. Do not pass them through the flow + * table or up to userspace. + */ +enum odp_frag_handling { + ODP_DP_FRAG_UNSPEC, + ODP_DP_FRAG_ZERO, /* Treat IP fragments as transport port 0. */ + ODP_DP_FRAG_DROP /* Drop IP fragments. */ +}; struct odp_stats { uint64_t n_frags; /* Number of dropped IP fragments. */ @@ -108,20 +153,44 @@ struct odp_stats { /* Logical ports. */ #define ODPP_LOCAL ((uint16_t)0) -#define ODPP_NONE ((uint16_t)-1) - -/* Listening channels. */ -#define _ODPL_MISS_NR 0 /* Packet missed in flow table. */ -#define ODPL_MISS (1 << _ODPL_MISS_NR) -#define _ODPL_ACTION_NR 1 /* Packet output to ODPP_CONTROLLER. */ -#define ODPL_ACTION (1 << _ODPL_ACTION_NR) -#define _ODPL_SFLOW_NR 2 /* sFlow samples. */ -#define ODPL_SFLOW (1 << _ODPL_SFLOW_NR) -#define ODPL_ALL (ODPL_MISS | ODPL_ACTION | ODPL_SFLOW) - -enum odp_packet_type { + +#define ODP_PACKET_FAMILY "odp_packet" + +enum odp_packet_cmd { + ODP_PACKET_CMD_UNSPEC, + + /* Kernel-to-user notifications. */ + ODP_PACKET_CMD_MISS, /* Flow table miss. */ + ODP_PACKET_CMD_ACTION, /* ODPAT_CONTROLLER action. */ + ODP_PACKET_CMD_SAMPLE, /* Sampled packet. */ + + /* User commands. */ + ODP_PACKET_CMD_EXECUTE /* Apply actions to a packet. */ +}; + +/** + * enum odp_packet_attr - attributes for %ODP_PACKET_* commands. + * @ODP_PACKET_ATTR_PACKET: Present for all notifications. Contains the entire + * packet as received, from the start of the Ethernet header onward. For + * %ODP_PACKET_CMD_ACTION, %ODP_PACKET_ATTR_PACKET reflects changes made by + * actions preceding %ODPAT_CONTROLLER, but %ODP_PACKET_ATTR_KEY is the flow + * key extracted from the packet as originally received. + * @ODP_PACKET_ATTR_KEY: Present for all notifications. Contains the flow key + * extracted from the packet as nested %ODP_KEY_ATTR_* attributes. This allows + * userspace to adapt its flow setup strategy by comparing its notion of the + * flow key against the kernel's. + * @ODP_PACKET_ATTR_USERDATA: Present for an %ODP_PACKET_CMD_ACTION + * notification if the %ODPAT_CONTROLLER action's argument was nonzero. + * @ODP_PACKET_ATTR_SAMPLE_POOL: Present for %ODP_PACKET_CMD_SAMPLE. Contains + * the number of packets processed so far that were candidates for sampling. + * @ODP_PACKET_ATTR_ACTIONS: Present for %ODP_PACKET_CMD_SAMPLE. Contains a + * copy of the actions applied to the packet, as nested %ODPAT_* attributes. + * + * These attributes follow the &struct odp_header within the Generic Netlink + * payload for %ODP_PACKET_* commands. + */ +enum odp_packet_attr { ODP_PACKET_ATTR_UNSPEC, - ODP_PACKET_ATTR_TYPE, /* 32-bit enum, one of _ODP_*_NR. */ ODP_PACKET_ATTR_PACKET, /* Packet data. */ ODP_PACKET_ATTR_KEY, /* Nested ODP_KEY_ATTR_* attributes. */ ODP_PACKET_ATTR_USERDATA, /* 64-bit data from ODPAT_CONTROLLER. */ @@ -131,29 +200,7 @@ enum odp_packet_type { }; #define ODP_PACKET_ATTR_MAX (__ODP_PACKET_ATTR_MAX - 1) - -/** - * struct odp_packet - header for packets passed up between kernel and - * userspace. - * @dp_idx: Number of datapath to which the packet belongs. - * @len: Length of complete message, including this header. - * - * The header is followed by a sequence of Netlink attributes. The - * %ODP_PACKET_ATTR_TYPE, %ODP_PACKET_ATTR_PACKET, and %ODP_PACKET_ATTR_KEY - * attributes are always present. When @type == %_ODPL_ACTION_NR, the - * %ODP_PACKET_ATTR_USERDATA attribute is included if it would be nonzero. - * When @type == %_ODPL_SFLOW_NR, the %ODP_PACKET_ATTR_SAMPLE_POOL and - * %ODP_PACKET_ATTR_ACTIONS attributes are included. - * - * For @type of %_ODPL_ACTION_NR, %ODP_PACKET_ATTR_PACKET reflects changes made - * by actions preceding %ODPAT_CONTROLLER, but %ODP_PACKET_ATTR_KEY is the flow - * key extracted from the packet as originally received. - */ -struct odp_packet { - uint32_t dp_idx; - uint32_t len; -}; - + enum odp_vport_type { ODP_VPORT_TYPE_UNSPEC, ODP_VPORT_TYPE_NETDEV, /* network device */ @@ -165,24 +212,53 @@ enum odp_vport_type { }; #define ODP_VPORT_TYPE_MAX (__ODP_VPORT_TYPE_MAX - 1) + +#define ODP_VPORT_FAMILY "odp_vport" +#define ODP_VPORT_MCGROUP "odp_vport" + +enum odp_vport_cmd { + ODP_VPORT_CMD_UNSPEC, + ODP_VPORT_CMD_NEW, + ODP_VPORT_CMD_DEL, + ODP_VPORT_CMD_GET, + ODP_VPORT_CMD_SET +}; /** - * struct odp_vport - header with basic information about a virtual port. - * @dp_idx: Number of datapath to which the vport belongs. - * @len: Length of this structure plus the Netlink attributes following it. - * @total_len: Total space available for kernel reply to request. + * enum odp_vport_attr - attributes for %ODP_VPORT_* commands. + * @ODP_VPORT_ATTR_PORT_NO: 32-bit port number within datapath. + * @ODP_VPORT_ATTR_TYPE: 32-bit %ODP_VPORT_TYPE_* constant describing the type + * of vport. + * @ODP_VPORT_ATTR_NAME: Name of vport. For a vport based on a network device + * this is the name of the network device. Maximum length %IFNAMSIZ-1 bytes + * plus a null terminator. + * @ODP_VPORT_ATTR_STATS: A &struct rtnl_link_stats64 giving statistics for + * packets sent or received through the vport. + * @ODP_VPORT_ATTR_ADDRESS: A 6-byte Ethernet address for the vport. + * @ODP_VPORT_ATTR_MTU: MTU for the vport. + * @ODP_VPORT_ATTR_IFINDEX: ifindex of the underlying network device, if any. + * @ODP_VPORT_ATTR_IFLINK: ifindex of the device on which packets are sent (for + * tunnels), if any. + * + * These attributes follow the &struct odp_header within the Generic Netlink + * payload for %ODP_VPORT_* commands. + * + * All attributes applicable to a given port are present in notifications. + * This means that, for example, a vport that has no corresponding network + * device would omit %ODP_VPORT_ATTR_IFINDEX. + * + * For %ODP_VPORT_CMD_NEW requests, the %ODP_VPORT_ATTR_TYPE and + * %ODP_VPORT_ATTR_NAME attributes are required. %ODP_VPORT_ATTR_PORT_NO is + * optional; if not specified a free port number is automatically selected. + * Whether %ODP_VPORT_ATTR_OPTIONS is required or optional depends on the type + * of vport. %ODP_VPORT_ATTR_STATS, %ODP_VPORT_ATTR_ADDRESS, and + * %ODP_VPORT_ATTR_MTU are optional, and other attributes are ignored. * - * Followed by &struct nlattr attributes, whose types are drawn from - * %ODP_VPORT_ATTR_*, up to a length of @len bytes including the &struct - * odp_vport header. + * For other requests, if %ODP_VPORT_ATTR_NAME is specified then it is used to + * look up the vport to operate on; otherwise dp_idx from the &struct + * odp_header plus %ODP_VPORT_ATTR_PORT_NO determine the vport. */ -struct odp_vport { - uint32_t dp_idx; - uint32_t len; - uint32_t total_len; -}; - -enum { +enum odp_vport_attr { ODP_VPORT_ATTR_UNSPEC, ODP_VPORT_ATTR_PORT_NO, /* port number within datapath */ ODP_VPORT_ATTR_TYPE, /* 32-bit ODP_VPORT_TYPE_* constant. */ @@ -206,14 +282,23 @@ enum { }; #define ODP_PATCH_ATTR_MAX (__ODP_PATCH_ATTR_MAX - 1) + +/* Flows. */ + +#define ODP_FLOW_FAMILY "odp_flow" +#define ODP_FLOW_MCGROUP "odp_flow" + +enum odp_flow_cmd { + ODP_FLOW_CMD_UNSPEC, + ODP_FLOW_CMD_NEW, + ODP_FLOW_CMD_DEL, + ODP_FLOW_CMD_GET, + ODP_FLOW_CMD_SET +}; struct odp_flow_stats { uint64_t n_packets; /* Number of matched packets. */ uint64_t n_bytes; /* Number of matched bytes. */ - uint64_t used_sec; /* Time last used, in system monotonic time. */ - uint32_t used_nsec; - uint8_t tcp_flags; - uint8_t reserved; }; enum odp_key_type { @@ -271,42 +356,45 @@ struct odp_key_arp { ovs_be16 arp_op; }; -struct odp_flow { - uint32_t dp_idx; - struct odp_flow_stats stats; - struct nlattr *key; - uint32_t key_len; - struct nlattr *actions; - uint32_t actions_len; -}; - -/* Flags for ODP_FLOW_PUT. */ -#define ODPPF_CREATE (1 << 0) /* Allow creating a new flow. */ -#define ODPPF_MODIFY (1 << 1) /* Allow modifying an existing flow. */ -#define ODPPF_ZERO_STATS (1 << 2) /* Zero the stats of an existing flow. */ - -/* ODP_FLOW_PUT argument. */ -struct odp_flow_put { - struct odp_flow flow; - uint32_t flags; -}; - -/* ODP_FLOW_DUMP argument. - * - * This is used to iterate through the flow table flow-by-flow. Each - * ODP_FLOW_DUMP call either stores a new odp_flow into 'flow' or stores 0 into - * flow->key_len to indicate that the end of the table has been reached, and - * updates 'state' in-place. +/** + * enum odp_flow_attr - attributes for %ODP_FLOW_* commands. + * @ODP_FLOW_ATTR_KEY: Nested %ODP_KEY_ATTR_* attributes specifying the flow + * key. Always present in notifications. Required for all requests (except + * dumps). + * @ODP_FLOW_ATTR_ACTIONS: Nested %ODPAT_* attributes specifying the actions to + * take for packets that match the key. Always present in notifications. + * Required for %ODP_FLOW_CMD_NEW requests, optional on %ODP_FLOW_CMD_SET + * request to change the existing actions, ignored for other requests. + * @ODP_FLOW_ATTR_STATS: &struct odp_flow_stats giving statistics for this + * flow. Present in notifications if the stats would be nonzero. Ignored in + * requests. + * @ODP_FLOW_ATTR_TCP_FLAGS: An 8-bit value giving the OR'd value of all of the + * TCP flags seen on packets in this flow. Only present in notifications for + * TCP flows, and only if it would be nonzero. Ignored in requests. + * @ODP_FLOW_ATTR_USED: A 64-bit integer giving the time, in milliseconds on + * the system monotonic clock, at which a packet was last processed for this + * flow. Only present in notifications if a packet has been processed for this + * flow. Ignored in requests. + * @ODP_FLOW_ATTR_CLEAR: If present in a %ODP_FLOW_CMD_SET request, clears the + * last-used time, accumulated TCP flags, and statistics for this flow. + * Otherwise ignored in requests. Never present in notifications. * - * Before the first call, zero 'state'. The format of 'state' is otherwise - * unspecified. + * These attributes follow the &struct odp_header within the Generic Netlink + * payload for %ODP_FLOW_* commands. */ -struct odp_flow_dump { - uint32_t dp_idx; - struct odp_flow *flow; - uint32_t state[2]; +enum odp_flow_attr { + ODP_FLOW_ATTR_UNSPEC, + ODP_FLOW_ATTR_KEY, /* Sequence of ODP_KEY_ATTR_* attributes. */ + ODP_FLOW_ATTR_ACTIONS, /* Sequence of nested ODPAT_* attributes. */ + ODP_FLOW_ATTR_STATS, /* struct odp_flow_stats. */ + ODP_FLOW_ATTR_TCP_FLAGS, /* 8-bit OR'd TCP flags. */ + ODP_FLOW_ATTR_USED, /* u64 msecs last used in monotonic time. */ + ODP_FLOW_ATTR_CLEAR, /* Flag to clear stats, tcp_flags, used. */ + __ODP_FLOW_ATTR_MAX }; +#define ODP_FLOW_ATTR_MAX (__ODP_FLOW_ATTR_MAX - 1) + /* Action types. */ enum odp_action_type { ODPAT_UNSPEC, @@ -330,14 +418,4 @@ enum odp_action_type { #define ODPAT_MAX (__ODPAT_MAX - 1) -struct odp_execute { - uint32_t dp_idx; - - struct nlattr *actions; - uint32_t actions_len; - - const void *data; - uint32_t length; -}; - #endif /* openvswitch/datapath-protocol.h */