X-Git-Url: http://git.onelab.eu/?a=blobdiff_plain;f=lib%2Fofp-util.h;h=a9601aa14c1795fbc7e70a1425fe7f5003dc0253;hb=299016266ed13376a7d671f66d4e0181b41098e3;hp=fdca005fb217a155445e9fefc4798300e070d89d;hpb=daa68e9f291f94fb40a58843ddbe8a9cc8c99ec4;p=sliver-openvswitch.git diff --git a/lib/ofp-util.h b/lib/ofp-util.h index fdca005fb..a9601aa14 100644 --- a/lib/ofp-util.h +++ b/lib/ofp-util.h @@ -1,5 +1,5 @@ /* - * Copyright (c) 2008, 2009, 2010 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. @@ -21,15 +21,78 @@ #include #include #include +#include "classifier.h" #include "flow.h" +#include "openflow/nicira-ext.h" #include "openvswitch/types.h" struct cls_rule; struct ofpbuf; -struct ofp_action_header; -/* Alignment of ofp_actions. */ -#define OFP_ACTION_ALIGN 8 +/* Basic decoding and length validation of OpenFlow messages. */ +enum ofputil_msg_code { + OFPUTIL_MSG_INVALID, + + /* OFPT_* messages. */ + OFPUTIL_OFPT_HELLO, + OFPUTIL_OFPT_ERROR, + OFPUTIL_OFPT_ECHO_REQUEST, + OFPUTIL_OFPT_ECHO_REPLY, + OFPUTIL_OFPT_FEATURES_REQUEST, + OFPUTIL_OFPT_FEATURES_REPLY, + OFPUTIL_OFPT_GET_CONFIG_REQUEST, + OFPUTIL_OFPT_GET_CONFIG_REPLY, + OFPUTIL_OFPT_SET_CONFIG, + OFPUTIL_OFPT_PACKET_IN, + OFPUTIL_OFPT_FLOW_REMOVED, + OFPUTIL_OFPT_PORT_STATUS, + OFPUTIL_OFPT_PACKET_OUT, + OFPUTIL_OFPT_FLOW_MOD, + OFPUTIL_OFPT_PORT_MOD, + OFPUTIL_OFPT_BARRIER_REQUEST, + OFPUTIL_OFPT_BARRIER_REPLY, + OFPUTIL_OFPT_QUEUE_GET_CONFIG_REQUEST, + OFPUTIL_OFPT_QUEUE_GET_CONFIG_REPLY, + + /* OFPST_* stat requests. */ + OFPUTIL_OFPST_DESC_REQUEST, + OFPUTIL_OFPST_FLOW_REQUEST, + OFPUTIL_OFPST_AGGREGATE_REQUEST, + OFPUTIL_OFPST_TABLE_REQUEST, + OFPUTIL_OFPST_PORT_REQUEST, + OFPUTIL_OFPST_QUEUE_REQUEST, + + /* OFPST_* stat replies. */ + OFPUTIL_OFPST_DESC_REPLY, + OFPUTIL_OFPST_FLOW_REPLY, + OFPUTIL_OFPST_QUEUE_REPLY, + OFPUTIL_OFPST_PORT_REPLY, + OFPUTIL_OFPST_TABLE_REPLY, + OFPUTIL_OFPST_AGGREGATE_REPLY, + + /* NXT_* messages. */ + OFPUTIL_NXT_ROLE_REQUEST, + OFPUTIL_NXT_ROLE_REPLY, + OFPUTIL_NXT_SET_FLOW_FORMAT, + OFPUTIL_NXT_FLOW_MOD_TABLE_ID, + OFPUTIL_NXT_FLOW_MOD, + OFPUTIL_NXT_FLOW_REMOVED, + + /* NXST_* stat requests. */ + OFPUTIL_NXST_FLOW_REQUEST, + OFPUTIL_NXST_AGGREGATE_REQUEST, + + /* NXST_* stat replies. */ + OFPUTIL_NXST_FLOW_REPLY, + OFPUTIL_NXST_AGGREGATE_REPLY +}; + +struct ofputil_msg_type; +int ofputil_decode_msg_type(const struct ofp_header *, + const struct ofputil_msg_type **); +enum ofputil_msg_code ofputil_msg_type_code(const struct ofputil_msg_type *); +const char *ofputil_msg_type_name(const struct ofputil_msg_type *); +int ofputil_check_output_port(uint16_t ofp_port, int max_ports); /* Converting OFPFW_NW_SRC_MASK and OFPFW_NW_DST_MASK wildcard bit counts to * and from IP bitmasks. */ @@ -37,25 +100,158 @@ ovs_be32 ofputil_wcbits_to_netmask(int wcbits); int ofputil_netmask_to_wcbits(ovs_be32 netmask); /* Work with OpenFlow 1.0 ofp_match. */ +void ofputil_wildcard_from_openflow(uint32_t ofpfw, struct flow_wildcards *); void ofputil_cls_rule_from_match(const struct ofp_match *, - unsigned int priority, int flow_format, - uint64_t cookie, struct cls_rule *); -void ofputil_cls_rule_to_match(const struct cls_rule *, int flow_format, - struct ofp_match *); -void normalize_match(struct ofp_match *); -char *ofp_match_to_literal_string(const struct ofp_match *match); + unsigned int priority, struct cls_rule *); +void ofputil_normalize_rule(struct cls_rule *, enum nx_flow_format); +void ofputil_cls_rule_to_match(const struct cls_rule *, struct ofp_match *); + +/* dl_type translation between OpenFlow and 'struct flow' format. */ +ovs_be16 ofputil_dl_type_to_openflow(ovs_be16 flow_dl_type); +ovs_be16 ofputil_dl_type_from_openflow(ovs_be16 ofp_dl_type); + +/* Flow formats. */ +bool ofputil_flow_format_is_valid(enum nx_flow_format); +const char *ofputil_flow_format_to_string(enum nx_flow_format); +int ofputil_flow_format_from_string(const char *); +enum nx_flow_format ofputil_min_flow_format(const struct cls_rule *); + +struct ofpbuf *ofputil_make_set_flow_format(enum nx_flow_format); + +/* NXT_FLOW_MOD_TABLE_ID extension. */ +struct ofpbuf *ofputil_make_flow_mod_table_id(bool flow_mod_table_id); + +/* Flow format independent flow_mod. */ +struct flow_mod { + struct cls_rule cr; + ovs_be64 cookie; + uint8_t table_id; + uint16_t command; + uint16_t idle_timeout; + uint16_t hard_timeout; + uint32_t buffer_id; + uint16_t out_port; + uint16_t flags; + union ofp_action *actions; + size_t n_actions; +}; + +int ofputil_decode_flow_mod(struct flow_mod *, const struct ofp_header *, + bool flow_mod_table_id); +struct ofpbuf *ofputil_encode_flow_mod(const struct flow_mod *, + enum nx_flow_format, + bool flow_mod_table_id); + +/* Flow stats or aggregate stats request, independent of flow format. */ +struct flow_stats_request { + bool aggregate; /* Aggregate results? */ + struct cls_rule match; + uint16_t out_port; + uint8_t table_id; +}; + +int ofputil_decode_flow_stats_request(struct flow_stats_request *, + const struct ofp_header *); +struct ofpbuf *ofputil_encode_flow_stats_request( + const struct flow_stats_request *, enum nx_flow_format); + +/* Flow stats reply, independent of flow format. */ +struct ofputil_flow_stats { + struct cls_rule rule; + ovs_be64 cookie; + uint8_t table_id; + uint32_t duration_sec; + uint32_t duration_nsec; + uint16_t idle_timeout; + uint16_t hard_timeout; + uint64_t packet_count; /* Packet count, UINT64_MAX if unknown. */ + uint64_t byte_count; /* Byte count, UINT64_MAX if unknown. */ + union ofp_action *actions; + size_t n_actions; +}; + +int ofputil_decode_flow_stats_reply(struct ofputil_flow_stats *, + struct ofpbuf *msg); +void ofputil_append_flow_stats_reply(const struct ofputil_flow_stats *, + struct list *replies); + +/* Aggregate stats reply, independent of flow format. */ +struct ofputil_aggregate_stats { + uint64_t packet_count; /* Packet count, UINT64_MAX if unknown. */ + uint64_t byte_count; /* Byte count, UINT64_MAX if unknown. */ + uint32_t flow_count; +}; + +struct ofpbuf *ofputil_encode_aggregate_stats_reply( + const struct ofputil_aggregate_stats *stats, + const struct ofp_stats_msg *request); + +/* Flow removed message, independent of flow format. */ +struct ofputil_flow_removed { + struct cls_rule rule; + ovs_be64 cookie; + uint8_t reason; /* One of OFPRR_*. */ + uint32_t duration_sec; + uint32_t duration_nsec; + uint16_t idle_timeout; + uint64_t packet_count; /* Packet count, UINT64_MAX if unknown. */ + uint64_t byte_count; /* Byte count, UINT64_MAX if unknown. */ +}; + +int ofputil_decode_flow_removed(struct ofputil_flow_removed *, + const struct ofp_header *); +struct ofpbuf *ofputil_encode_flow_removed(const struct ofputil_flow_removed *, + enum nx_flow_format); + +/* Abstract packet-in message. */ +struct ofputil_packet_in { + struct ofpbuf *packet; + uint16_t in_port; + uint8_t reason; /* One of OFPR_*. */ + + uint32_t buffer_id; + int send_len; +}; + +struct ofpbuf *ofputil_encode_packet_in(const struct ofputil_packet_in *, + struct ofpbuf *rw_packet); /* OpenFlow protocol utility functions. */ void *make_openflow(size_t openflow_len, uint8_t type, struct ofpbuf **); void *make_nxmsg(size_t openflow_len, uint32_t subtype, struct ofpbuf **); + void *make_openflow_xid(size_t openflow_len, uint8_t type, ovs_be32 xid, struct ofpbuf **); void *make_nxmsg_xid(size_t openflow_len, uint32_t subtype, ovs_be32 xid, struct ofpbuf **); + void *put_openflow(size_t openflow_len, uint8_t type, struct ofpbuf *); void *put_openflow_xid(size_t openflow_len, uint8_t type, ovs_be32 xid, struct ofpbuf *); + +void *put_nxmsg(size_t openflow_len, uint32_t subtype, struct ofpbuf *); +void *put_nxmsg_xid(size_t openflow_len, uint32_t subtype, ovs_be32 xid, + struct ofpbuf *); + void update_openflow_length(struct ofpbuf *); + +void *ofputil_make_stats_request(size_t openflow_len, uint16_t type, + uint32_t subtype, struct ofpbuf **); +void *ofputil_make_stats_reply(size_t openflow_len, + const struct ofp_stats_msg *request, + struct ofpbuf **); + +void ofputil_start_stats_reply(const struct ofp_stats_msg *request, + struct list *); +struct ofpbuf *ofputil_reserve_stats_reply(size_t len, struct list *); +void *ofputil_append_stats_reply(size_t len, struct list *); + +const void *ofputil_stats_body(const struct ofp_header *); +size_t ofputil_stats_body_len(const struct ofp_header *); + +const void *ofputil_nxstats_body(const struct ofp_header *); +size_t ofputil_nxstats_body_len(const struct ofp_header *); + struct ofpbuf *make_flow_mod(uint16_t command, const struct cls_rule *, size_t actions_len); struct ofpbuf *make_add_flow(const struct cls_rule *, uint32_t buffer_id, @@ -77,31 +273,88 @@ struct ofpbuf *make_unbuffered_packet_out(const struct ofpbuf *packet, uint16_t in_port, uint16_t out_port); struct ofpbuf *make_echo_request(void); struct ofpbuf *make_echo_reply(const struct ofp_header *rq); -int check_ofp_message(const struct ofp_header *, uint8_t type, size_t size); -int check_ofp_message_array(const struct ofp_header *, uint8_t type, - size_t size, size_t array_elt_size, - size_t *n_array_elts); + +/* Actions. */ -struct flow_stats_iterator { - const uint8_t *pos, *end; -}; -const struct ofp_flow_stats *flow_stats_first(struct flow_stats_iterator *, - const struct ofp_stats_reply *); -const struct ofp_flow_stats *flow_stats_next(struct flow_stats_iterator *); +enum ofputil_action_code { + /* OFPAT_* actions. */ + OFPUTIL_OFPAT_OUTPUT, + OFPUTIL_OFPAT_SET_VLAN_VID, + OFPUTIL_OFPAT_SET_VLAN_PCP, + OFPUTIL_OFPAT_STRIP_VLAN, + OFPUTIL_OFPAT_SET_DL_SRC, + OFPUTIL_OFPAT_SET_DL_DST, + OFPUTIL_OFPAT_SET_NW_SRC, + OFPUTIL_OFPAT_SET_NW_DST, + OFPUTIL_OFPAT_SET_NW_TOS, + OFPUTIL_OFPAT_SET_TP_SRC, + OFPUTIL_OFPAT_SET_TP_DST, + OFPUTIL_OFPAT_ENQUEUE, -struct actions_iterator { - const union ofp_action *pos, *end; + /* NXAST_* actions. */ + OFPUTIL_NXAST_RESUBMIT, + OFPUTIL_NXAST_SET_TUNNEL, + OFPUTIL_NXAST_SET_QUEUE, + OFPUTIL_NXAST_POP_QUEUE, + OFPUTIL_NXAST_REG_MOVE, + OFPUTIL_NXAST_REG_LOAD, + OFPUTIL_NXAST_NOTE, + OFPUTIL_NXAST_SET_TUNNEL64, + OFPUTIL_NXAST_MULTIPATH, + OFPUTIL_NXAST_AUTOPATH, + OFPUTIL_NXAST_BUNDLE, + OFPUTIL_NXAST_BUNDLE_LOAD, + OFPUTIL_NXAST_RESUBMIT_TABLE }; -const union ofp_action *actions_first(struct actions_iterator *, - const union ofp_action *, - size_t n_actions); -const union ofp_action *actions_next(struct actions_iterator *); + +int ofputil_decode_action(const union ofp_action *); +enum ofputil_action_code ofputil_decode_action_unsafe( + const union ofp_action *); + +#define OFP_ACTION_ALIGN 8 /* Alignment of ofp_actions. */ + +static inline union ofp_action * +ofputil_action_next(const union ofp_action *a) +{ + return ((union ofp_action *) (void *) + ((uint8_t *) a + ntohs(a->header.len))); +} + +static inline bool +ofputil_action_is_valid(const union ofp_action *a, size_t n_actions) +{ + uint16_t len = ntohs(a->header.len); + return (!(len % OFP_ACTION_ALIGN) + && len >= sizeof *a + && len / sizeof *a <= n_actions); +} + +/* This macro is careful to check for actions with bad lengths. */ +#define OFPUTIL_ACTION_FOR_EACH(ITER, LEFT, ACTIONS, N_ACTIONS) \ + for ((ITER) = (ACTIONS), (LEFT) = (N_ACTIONS); \ + (LEFT) > 0 && ofputil_action_is_valid(ITER, LEFT); \ + ((LEFT) -= ntohs((ITER)->header.len) / sizeof(union ofp_action), \ + (ITER) = ofputil_action_next(ITER))) + +/* This macro does not check for actions with bad lengths. It should only be + * used with actions from trusted sources or with actions that have already + * been validated (e.g. with OFPUTIL_ACTION_FOR_EACH). */ +#define OFPUTIL_ACTION_FOR_EACH_UNSAFE(ITER, LEFT, ACTIONS, N_ACTIONS) \ + for ((ITER) = (ACTIONS), (LEFT) = (N_ACTIONS); \ + (LEFT) > 0; \ + ((LEFT) -= ntohs((ITER)->header.len) / sizeof(union ofp_action), \ + (ITER) = ofputil_action_next(ITER))) + int validate_actions(const union ofp_action *, size_t n_actions, const struct flow *, int max_ports); -bool action_outputs_to_port(const union ofp_action *, uint16_t port); +bool action_outputs_to_port(const union ofp_action *, ovs_be16 port); int ofputil_pull_actions(struct ofpbuf *, unsigned int actions_len, union ofp_action **, size_t *); + +bool ofputil_actions_equal(const union ofp_action *a, size_t n_a, + const union ofp_action *b, size_t n_b); +union ofp_action *ofputil_actions_clone(const union ofp_action *, size_t n); /* OpenFlow vendors. * @@ -240,6 +493,11 @@ get_ofp_err_code(int error) return error & 0xffff; } -struct ofpbuf *make_ofp_error_msg(int error, const struct ofp_header *); +struct ofpbuf *ofputil_encode_error_msg(int error, const struct ofp_header *); +int ofputil_decode_error_msg(const struct ofp_header *, size_t *payload_ofs); + +/* String versions of errors. */ +void ofputil_format_error(struct ds *, int error); +char *ofputil_error_to_string(int error); #endif /* ofp-util.h */