2 * Copyright (c) 2009 Nicira Networks.
4 * Permission to use, copy, modify, and/or distribute this software for any
5 * purpose with or without fee is hereby granted, provided that the above
6 * copyright notice and this permission notice appear in all copies.
8 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
9 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
10 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
11 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
12 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
13 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
14 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
17 #ifndef OPENFLOW_OPENFLOW_MGMT_H
18 #define OPENFLOW_OPENFLOW_MGMT_H 1
20 #include "openflow/nicira-ext.h"
23 OFMPT_CAPABILITY_REQUEST,
24 OFMPT_CAPABILITY_REPLY,
25 OFMPT_RESOURCES_REQUEST,
26 OFMPT_RESOURCES_UPDATE,
29 OFMPT_CONFIG_UPDATE_ACK,
33 /* Header on all OpenFlow management packets. */
35 struct nicira_header header;
36 uint16_t type; /* One of OFMPT_* above. */
39 OFP_ASSERT(sizeof(struct ofmp_header) == sizeof(struct nicira_header) + 4);
42 /* Generic TLV header. */
44 uint16_t type; /* Type of value (one of OFMPTLV_*). */
45 uint16_t len; /* Length of TLV (includes this header). */
46 uint8_t data[0]; /* Value of data as defined by type and length. */
48 OFP_ASSERT(sizeof(struct ofmp_tlv) == 4);
50 /* Universal TLV terminator. Used to indicate end of TLV list. */
52 uint16_t type; /* Type is 0. */
53 uint16_t len; /* Length is 4. */
55 OFP_ASSERT(sizeof(struct ofmp_tlv_end) == 4);
58 /* Bitmask of capability description styles. */
59 enum ofmp_capability_format {
60 OFMPCAF_SIMPLE = 0 << 0, /* "ovs-vswitchd.conf" style. */
63 /* Body of capbility request.
65 * OFMPT_CAPABILITY_REQUEST (controller -> switch) */
66 struct ofmp_capability_request {
67 struct ofmp_header header;
68 uint32_t format; /* One of OFMPCAF_*. */
70 OFP_ASSERT(sizeof(struct ofmp_capability_request) == 24);
72 /* Body of reply to capability request.
74 * OFMPT_CAPABILITY_REPLY (switch -> controller). */
75 struct ofmp_capability_reply {
76 struct ofmp_header header;
77 uint32_t format; /* One of OFMPCAF_*. */
78 uint64_t mgmt_id; /* Management ID. */
81 OFP_ASSERT(sizeof(struct ofmp_capability_reply) == 32);
84 /* Resource TLV for datapath description. */
86 uint16_t type; /* OFMPTSR_DP. */
87 uint16_t len; /* 28. */
89 uint64_t dp_id; /* Datapath ID. */
90 uint8_t name[OFP_MAX_PORT_NAME_LEN]; /* Null-terminated name. */
92 OFP_ASSERT(sizeof(struct ofmptsr_dp) == 32);
94 /* TLV types for switch resource descriptions. */
95 enum ofmp_switch_resources {
96 OFMPTSR_END = 0, /* Terminator. */
97 OFMPTSR_DP, /* Datapath. */
100 /* Body of resources request.
102 * OFMPT_RESOURCES_REQUEST (controller -> switch) */
103 struct ofmp_resources_request {
104 struct ofmp_header header;
107 /* Body of capbility update. Sent in response to a resources request or
108 * sent asynchronously when resources change on the switch.
110 * OFMPT_RESOURCES_UPDATE (switch -> controller) */
111 struct ofmp_resources_update {
112 struct ofmp_header header;
115 OFP_ASSERT(sizeof(struct ofmp_resources_update) == 20);
118 /* Bitmask of capability description styles. */
119 enum ofmp_config_format {
120 OFMPCOF_SIMPLE = 0 << 0, /* "ovs-vswitchd.conf" style. */
123 #define CONFIG_COOKIE_LEN 20
125 /* Body of configuration request.
127 * OFMPT_CONFIG_REQUEST (controller -> switch) */
128 struct ofmp_config_request {
129 struct ofmp_header header;
130 uint32_t format; /* One of OFMPCOF_*. */
132 OFP_ASSERT(sizeof(struct ofmp_config_request) == 24);
134 /* Body of configuration update. Sent in response to a configuration
135 * request from the controller. May be sent asynchronously by either
136 * the controller or switch to modify configuration or notify of
137 * changes, respectively. If sent by the controller, the switch must
138 * respond with a OFMPT_CONFIG_UPDATE_ACK.
140 * OFMPT_CONFIG_UPDATE (switch <-> controller) */
141 struct ofmp_config_update {
142 struct ofmp_header header;
143 uint32_t format; /* One of OFMPCOF_*. */
144 uint8_t cookie[CONFIG_COOKIE_LEN]; /* Cookie of config attempting to be
145 * replaced by this update. */
148 OFP_ASSERT(sizeof(struct ofmp_config_update) == 44);
150 /* Bitmask of configuration update ack flags. */
151 enum ofmp_config_update_ack_flags {
152 OFMPCUAF_SUCCESS = 1 << 0, /* Config succeeded. */
155 /* Body of configuration update ack. Sent in response to a configuration
158 * OFMPT_CONFIG_UPDATE_ACK (switch -> controller) */
159 struct ofmp_config_update_ack {
160 struct ofmp_header header;
161 uint32_t format; /* One of OFMPCOF_*. */
162 uint32_t flags; /* One of OFMPCUAF_*. */
163 uint8_t cookie[CONFIG_COOKIE_LEN]; /* Cookie of current configuration
164 * being used in the switch. */
166 OFP_ASSERT(sizeof(struct ofmp_config_update_ack) == 48);
168 /* Values for 'type' in ofmp_error_msg. */
169 enum ofmp_error_type {
170 OFMPET_BAD_CONFIG /* Problem with configuration. */
173 /* ofmp_error_msg 'code' values for OFMPET_BAD_CONFIG. 'data' contains
174 * at least the first 64 bytes of the failed request. */
175 enum ofmp_bad_config_code {
176 OFMPBCC_BUSY, /* Config updating, try again. */
177 OFMPBCC_OLD_COOKIE, /* Config has changed. */
180 /* Body of error message. May be sent by either the switch or the
181 * controller to indicate some error condition.
183 * OFMPT_ERROR (switch <-> controller) */
184 struct ofmp_error_msg {
185 struct ofmp_header header;
187 uint16_t type; /* One of OFMPET_*. */
188 uint16_t code; /* Code depending on 'type'. */
189 uint8_t data[0]; /* Variable-length data. Interpreted based
190 on the type and code. */
192 OFP_ASSERT(sizeof(struct ofmp_error_msg) == 24);
194 #endif /* openflow/openflow-mgmt.h */