1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
//! OpenFlow message types.
use bytes::{Buf, BufMut, Bytes, BytesMut};
use crate::{Error, Result, Version};
/// OpenFlow message header (8 bytes).
#[derive(Debug, Clone, Copy)]
pub struct Header {
/// Protocol version
pub version: Version,
/// Message type
pub msg_type: MessageType,
/// Total message length (including header)
pub length: u16,
/// Transaction ID
pub xid: u32,
}
impl Header {
/// Header size in bytes.
pub const SIZE: usize = 8;
/// Encode the header to bytes.
pub fn encode(&self, buf: &mut BytesMut) {
buf.put_u8(self.version.wire_version());
buf.put_u8(self.msg_type as u8);
buf.put_u16(self.length);
buf.put_u32(self.xid);
}
/// Decode a header from bytes.
pub fn decode(buf: &mut Bytes) -> Result<Self> {
if buf.remaining() < Self::SIZE {
return Err(Error::Parse("header too short".into()));
}
let version = Version::try_from(buf.get_u8())?;
let msg_type = MessageType::try_from(buf.get_u8())?;
let length = buf.get_u16();
let xid = buf.get_u32();
Ok(Self {
version,
msg_type,
length,
xid,
})
}
}
/// OpenFlow message types.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
#[repr(u8)]
pub enum MessageType {
// Symmetric messages
/// Hello message
Hello = 0,
/// Error message
Error = 1,
/// Echo request
EchoRequest = 2,
/// Echo reply
EchoReply = 3,
/// Experimenter message
Experimenter = 4,
// Controller-to-switch messages
/// Features request
FeaturesRequest = 5,
/// Features reply
FeaturesReply = 6,
/// Get config request
GetConfigRequest = 7,
/// Get config reply
GetConfigReply = 8,
/// Set config
SetConfig = 9,
// Async messages
/// Packet in
PacketIn = 10,
/// Flow removed
FlowRemoved = 11,
/// Port status
PortStatus = 12,
// Controller-to-switch messages
/// Packet out
PacketOut = 13,
/// Flow mod
FlowMod = 14,
/// Group mod (OF 1.1+)
GroupMod = 15,
/// Port mod
PortMod = 16,
/// Table mod (OF 1.1+)
TableMod = 17,
// Multipart messages (OF 1.3+)
/// Multipart request
MultipartRequest = 18,
/// Multipart reply
MultipartReply = 19,
// Barrier
/// Barrier request
BarrierRequest = 20,
/// Barrier reply
BarrierReply = 21,
// Controller role (OF 1.2+)
/// Role request
RoleRequest = 24,
/// Role reply
RoleReply = 25,
// Async config (OF 1.3+)
/// Get async request
GetAsyncRequest = 26,
/// Get async reply
GetAsyncReply = 27,
/// Set async
SetAsync = 28,
// Meters (OF 1.3+)
/// Meter mod
MeterMod = 29,
// Bundle (OF 1.4+)
/// Bundle control
BundleControl = 33,
/// Bundle add message
BundleAddMessage = 34,
}
impl TryFrom<u8> for MessageType {
type Error = Error;
fn try_from(v: u8) -> Result<Self> {
match v {
0 => Ok(Self::Hello),
1 => Ok(Self::Error),
2 => Ok(Self::EchoRequest),
3 => Ok(Self::EchoReply),
4 => Ok(Self::Experimenter),
5 => Ok(Self::FeaturesRequest),
6 => Ok(Self::FeaturesReply),
7 => Ok(Self::GetConfigRequest),
8 => Ok(Self::GetConfigReply),
9 => Ok(Self::SetConfig),
10 => Ok(Self::PacketIn),
11 => Ok(Self::FlowRemoved),
12 => Ok(Self::PortStatus),
13 => Ok(Self::PacketOut),
14 => Ok(Self::FlowMod),
15 => Ok(Self::GroupMod),
16 => Ok(Self::PortMod),
17 => Ok(Self::TableMod),
18 => Ok(Self::MultipartRequest),
19 => Ok(Self::MultipartReply),
20 => Ok(Self::BarrierRequest),
21 => Ok(Self::BarrierReply),
24 => Ok(Self::RoleRequest),
25 => Ok(Self::RoleReply),
26 => Ok(Self::GetAsyncRequest),
27 => Ok(Self::GetAsyncReply),
28 => Ok(Self::SetAsync),
29 => Ok(Self::MeterMod),
33 => Ok(Self::BundleControl),
34 => Ok(Self::BundleAddMessage),
_ => Err(Error::InvalidMessage(format!("unknown message type: {v}"))),
}
}
}
/// A complete OpenFlow message.
#[derive(Debug)]
pub struct Message {
/// Message header
pub header: Header,
/// Message body
pub body: Bytes,
}
impl Message {
/// Create a new message.
pub fn new(version: Version, msg_type: MessageType, xid: u32, body: Bytes) -> Self {
let length = (Header::SIZE + body.len()) as u16;
Self {
header: Header {
version,
msg_type,
length,
xid,
},
body,
}
}
/// Encode the message to bytes.
pub fn encode(&self) -> BytesMut {
let mut buf = BytesMut::with_capacity(self.header.length as usize);
self.header.encode(&mut buf);
buf.extend_from_slice(&self.body);
buf
}
}