2 * net/tipc/msg.c: TIPC message header routines
4 * Copyright (c) 2000-2006, Ericsson AB
5 * Copyright (c) 2005, 2010-2011, Wind River Systems
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions are met:
11 * 1. Redistributions of source code must retain the above copyright
12 * notice, this list of conditions and the following disclaimer.
13 * 2. Redistributions in binary form must reproduce the above copyright
14 * notice, this list of conditions and the following disclaimer in the
15 * documentation and/or other materials provided with the distribution.
16 * 3. Neither the names of the copyright holders nor the names of its
17 * contributors may be used to endorse or promote products derived from
18 * this software without specific prior written permission.
20 * Alternatively, this software may be distributed under the terms of the
21 * GNU General Public License ("GPL") version 2 as published by the Free
22 * Software Foundation.
24 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
25 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
26 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
27 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
28 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
29 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
30 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
31 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
32 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
33 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
34 * POSSIBILITY OF SUCH DAMAGE.
40 u32 tipc_msg_tot_importance(struct tipc_msg *m)
42 if (likely(msg_isdata(m))) {
43 if (likely(msg_orignode(m) == tipc_own_addr))
44 return msg_importance(m);
45 return msg_importance(m) + 4;
47 if ((msg_user(m) == MSG_FRAGMENTER) &&
48 (msg_type(m) == FIRST_FRAGMENT))
49 return msg_importance(msg_get_wrapped(m));
50 return msg_importance(m);
54 void tipc_msg_init(struct tipc_msg *m, u32 user, u32 type,
55 u32 hsize, u32 destnode)
59 msg_set_user(m, user);
60 msg_set_hdr_sz(m, hsize);
61 msg_set_size(m, hsize);
62 msg_set_prevnode(m, tipc_own_addr);
63 msg_set_type(m, type);
65 msg_set_orignode(m, tipc_own_addr);
66 msg_set_destnode(m, destnode);
71 * tipc_msg_build - create message using specified header and data
73 * Note: Caller must not hold any locks in case copy_from_user() is interrupted!
75 * Returns message data size or errno
78 int tipc_msg_build(struct tipc_msg *hdr, struct iovec const *msg_sect,
79 u32 num_sect, unsigned int total_len,
80 int max_size, int usrmem, struct sk_buff **buf)
82 int dsz, sz, hsz, pos, res, cnt;
85 pos = hsz = msg_hdr_sz(hdr);
87 msg_set_size(hdr, sz);
88 if (unlikely(sz > max_size)) {
93 *buf = tipc_buf_acquire(sz);
96 skb_copy_to_linear_data(*buf, hdr, hsz);
97 for (res = 1, cnt = 0; res && (cnt < num_sect); cnt++) {
99 res = !copy_from_user((*buf)->data + pos,
100 msg_sect[cnt].iov_base,
101 msg_sect[cnt].iov_len);
103 skb_copy_to_linear_data_offset(*buf, pos,
104 msg_sect[cnt].iov_base,
105 msg_sect[cnt].iov_len);
106 pos += msg_sect[cnt].iov_len;
116 #ifdef CONFIG_TIPC_DEBUG
118 void tipc_msg_dbg(struct print_buf *buf, struct tipc_msg *msg, const char *str)
120 u32 usr = msg_user(msg);
121 tipc_printf(buf, KERN_DEBUG);
122 tipc_printf(buf, str);
126 tipc_printf(buf, "BNDL::");
127 tipc_printf(buf, "MSGS(%u):", msg_msgcnt(msg));
130 tipc_printf(buf, "BCASTP::");
133 tipc_printf(buf, "FRAGM::");
134 switch (msg_type(msg)) {
136 tipc_printf(buf, "FIRST:");
139 tipc_printf(buf, "BODY:");
142 tipc_printf(buf, "LAST:");
145 tipc_printf(buf, "UNKNOWN:%x", msg_type(msg));
148 tipc_printf(buf, "NO(%u/%u):", msg_long_msgno(msg),
151 case TIPC_LOW_IMPORTANCE:
152 case TIPC_MEDIUM_IMPORTANCE:
153 case TIPC_HIGH_IMPORTANCE:
154 case TIPC_CRITICAL_IMPORTANCE:
155 tipc_printf(buf, "DAT%u:", msg_user(msg));
156 if (msg_short(msg)) {
157 tipc_printf(buf, "CON:");
160 switch (msg_type(msg)) {
162 tipc_printf(buf, "CON:");
165 tipc_printf(buf, "MCST:");
168 tipc_printf(buf, "NAM:");
170 case TIPC_DIRECT_MSG:
171 tipc_printf(buf, "DIR:");
174 tipc_printf(buf, "UNKNOWN TYPE %u", msg_type(msg));
176 if (msg_reroute_cnt(msg))
177 tipc_printf(buf, "REROUTED(%u):",
178 msg_reroute_cnt(msg));
180 case NAME_DISTRIBUTOR:
181 tipc_printf(buf, "NMD::");
182 switch (msg_type(msg)) {
184 tipc_printf(buf, "PUBL(%u):", (msg_size(msg) - msg_hdr_sz(msg)) / 20); /* Items */
187 tipc_printf(buf, "WDRW:");
190 tipc_printf(buf, "UNKNOWN:%x", msg_type(msg));
192 if (msg_reroute_cnt(msg))
193 tipc_printf(buf, "REROUTED(%u):",
194 msg_reroute_cnt(msg));
197 tipc_printf(buf, "CONN_MNG:");
198 switch (msg_type(msg)) {
200 tipc_printf(buf, "PROBE:");
202 case CONN_PROBE_REPLY:
203 tipc_printf(buf, "PROBE_REPLY:");
206 tipc_printf(buf, "CONN_ACK:");
207 tipc_printf(buf, "ACK(%u):", msg_msgcnt(msg));
210 tipc_printf(buf, "UNKNOWN TYPE:%x", msg_type(msg));
212 if (msg_reroute_cnt(msg))
213 tipc_printf(buf, "REROUTED(%u):", msg_reroute_cnt(msg));
216 switch (msg_type(msg)) {
218 tipc_printf(buf, "STATE:");
219 tipc_printf(buf, "%s:", msg_probe(msg) ? "PRB" : "");
220 tipc_printf(buf, "NXS(%u):", msg_next_sent(msg));
221 tipc_printf(buf, "GAP(%u):", msg_seq_gap(msg));
222 tipc_printf(buf, "LSTBC(%u):", msg_last_bcast(msg));
225 tipc_printf(buf, "RESET:");
226 if (msg_size(msg) != msg_hdr_sz(msg))
227 tipc_printf(buf, "BEAR:%s:", msg_data(msg));
230 tipc_printf(buf, "ACTIVATE:");
233 tipc_printf(buf, "UNKNOWN TYPE:%x", msg_type(msg));
235 tipc_printf(buf, "PLANE(%c):", msg_net_plane(msg));
236 tipc_printf(buf, "SESS(%u):", msg_session(msg));
238 case CHANGEOVER_PROTOCOL:
239 tipc_printf(buf, "TUNL:");
240 switch (msg_type(msg)) {
242 tipc_printf(buf, "DUPL:");
245 tipc_printf(buf, "ORIG:");
246 tipc_printf(buf, "EXP(%u)", msg_msgcnt(msg));
249 tipc_printf(buf, "UNKNOWN TYPE:%x", msg_type(msg));
253 tipc_printf(buf, "CFG:");
254 switch (msg_type(msg)) {
256 tipc_printf(buf, "DSC_REQ:");
259 tipc_printf(buf, "DSC_RESP:");
262 tipc_printf(buf, "UNKNOWN TYPE:%x:", msg_type(msg));
267 tipc_printf(buf, "UNKNOWN USER:");
272 case TIPC_LOW_IMPORTANCE:
273 case TIPC_MEDIUM_IMPORTANCE:
274 case TIPC_HIGH_IMPORTANCE:
275 case TIPC_CRITICAL_IMPORTANCE:
276 switch (msg_errcode(msg)) {
279 case TIPC_ERR_NO_NAME:
280 tipc_printf(buf, "NO_NAME:");
282 case TIPC_ERR_NO_PORT:
283 tipc_printf(buf, "NO_PORT:");
285 case TIPC_ERR_NO_NODE:
286 tipc_printf(buf, "NO_PROC:");
288 case TIPC_ERR_OVERLOAD:
289 tipc_printf(buf, "OVERLOAD:");
291 case TIPC_CONN_SHUTDOWN:
292 tipc_printf(buf, "SHUTDOWN:");
295 tipc_printf(buf, "UNKNOWN ERROR(%x):",
302 tipc_printf(buf, "HZ(%u):", msg_hdr_sz(msg));
303 tipc_printf(buf, "SZ(%u):", msg_size(msg));
304 tipc_printf(buf, "SQNO(%u):", msg_seqno(msg));
306 if (msg_non_seq(msg))
307 tipc_printf(buf, "NOSEQ:");
309 tipc_printf(buf, "ACK(%u):", msg_ack(msg));
310 tipc_printf(buf, "BACK(%u):", msg_bcast_ack(msg));
311 tipc_printf(buf, "PRND(%x)", msg_prevnode(msg));
313 if (msg_isdata(msg)) {
314 if (msg_named(msg)) {
315 tipc_printf(buf, "NTYP(%u):", msg_nametype(msg));
316 tipc_printf(buf, "NINST(%u)", msg_nameinst(msg));
320 if ((usr != LINK_PROTOCOL) && (usr != LINK_CONFIG) &&
321 (usr != MSG_BUNDLER)) {
322 if (!msg_short(msg)) {
323 tipc_printf(buf, ":ORIG(%x:%u):",
324 msg_orignode(msg), msg_origport(msg));
325 tipc_printf(buf, ":DEST(%x:%u):",
326 msg_destnode(msg), msg_destport(msg));
328 tipc_printf(buf, ":OPRT(%u):", msg_origport(msg));
329 tipc_printf(buf, ":DPRT(%u):", msg_destport(msg));
332 if (msg_user(msg) == NAME_DISTRIBUTOR) {
333 tipc_printf(buf, ":ONOD(%x):", msg_orignode(msg));
334 tipc_printf(buf, ":DNOD(%x):", msg_destnode(msg));
337 if (msg_user(msg) == LINK_CONFIG) {
338 u32 *raw = (u32 *)msg;
339 struct tipc_media_addr *orig = (struct tipc_media_addr *)&raw[5];
340 tipc_printf(buf, ":DDOM(%x):", msg_dest_domain(msg));
341 tipc_printf(buf, ":NETID(%u):", msg_bc_netid(msg));
342 tipc_media_addr_printf(buf, orig);
344 if (msg_user(msg) == BCAST_PROTOCOL) {
345 tipc_printf(buf, "BCNACK:AFTER(%u):", msg_bcgap_after(msg));
346 tipc_printf(buf, "TO(%u):", msg_bcgap_to(msg));
348 tipc_printf(buf, "\n");
349 if ((usr == CHANGEOVER_PROTOCOL) && (msg_msgcnt(msg)))
350 tipc_msg_dbg(buf, msg_get_wrapped(msg), " /");
351 if ((usr == MSG_FRAGMENTER) && (msg_type(msg) == FIRST_FRAGMENT))
352 tipc_msg_dbg(buf, msg_get_wrapped(msg), " /");