1 /*
2  * net/tipc/msg.c: TIPC message header routines
3  *
4  * Copyright (c) 2000-2006, Ericsson AB
5  * Copyright (c) 2005, 2010-2011, Wind River Systems
6  * All rights reserved.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions are met:
10  *
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.
19  *
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.
23  *
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.
35  */
36 
37 #include "core.h"
38 #include "msg.h"
39 
tipc_msg_tot_importance(struct tipc_msg * m)40 u32 tipc_msg_tot_importance(struct tipc_msg *m)
41 {
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;
46 	}
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);
51 }
52 
53 
tipc_msg_init(struct tipc_msg * m,u32 user,u32 type,u32 hsize,u32 destnode)54 void tipc_msg_init(struct tipc_msg *m, u32 user, u32 type,
55 			    u32 hsize, u32 destnode)
56 {
57 	memset(m, 0, hsize);
58 	msg_set_version(m);
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);
64 	if (!msg_short(m)) {
65 		msg_set_orignode(m, tipc_own_addr);
66 		msg_set_destnode(m, destnode);
67 	}
68 }
69 
70 /**
71  * tipc_msg_calc_data_size - determine total data size for message
72  */
73 
tipc_msg_calc_data_size(struct iovec const * msg_sect,u32 num_sect)74 int tipc_msg_calc_data_size(struct iovec const *msg_sect, u32 num_sect)
75 {
76 	int dsz = 0;
77 	int i;
78 
79 	for (i = 0; i < num_sect; i++)
80 		dsz += msg_sect[i].iov_len;
81 	return dsz;
82 }
83 
84 /**
85  * tipc_msg_build - create message using specified header and data
86  *
87  * Note: Caller must not hold any locks in case copy_from_user() is interrupted!
88  *
89  * Returns message data size or errno
90  */
91 
tipc_msg_build(struct tipc_msg * hdr,struct iovec const * msg_sect,u32 num_sect,int max_size,int usrmem,struct sk_buff ** buf)92 int tipc_msg_build(struct tipc_msg *hdr,
93 			    struct iovec const *msg_sect, u32 num_sect,
94 			    int max_size, int usrmem, struct sk_buff **buf)
95 {
96 	int dsz, sz, hsz, pos, res, cnt;
97 
98 	dsz = tipc_msg_calc_data_size(msg_sect, num_sect);
99 	if (unlikely(dsz > TIPC_MAX_USER_MSG_SIZE)) {
100 		*buf = NULL;
101 		return -EINVAL;
102 	}
103 
104 	pos = hsz = msg_hdr_sz(hdr);
105 	sz = hsz + dsz;
106 	msg_set_size(hdr, sz);
107 	if (unlikely(sz > max_size)) {
108 		*buf = NULL;
109 		return dsz;
110 	}
111 
112 	*buf = tipc_buf_acquire(sz);
113 	if (!(*buf))
114 		return -ENOMEM;
115 	skb_copy_to_linear_data(*buf, hdr, hsz);
116 	for (res = 1, cnt = 0; res && (cnt < num_sect); cnt++) {
117 		if (likely(usrmem))
118 			res = !copy_from_user((*buf)->data + pos,
119 					      msg_sect[cnt].iov_base,
120 					      msg_sect[cnt].iov_len);
121 		else
122 			skb_copy_to_linear_data_offset(*buf, pos,
123 						       msg_sect[cnt].iov_base,
124 						       msg_sect[cnt].iov_len);
125 		pos += msg_sect[cnt].iov_len;
126 	}
127 	if (likely(res))
128 		return dsz;
129 
130 	buf_discard(*buf);
131 	*buf = NULL;
132 	return -EFAULT;
133 }
134 
135 #ifdef CONFIG_TIPC_DEBUG
136 
tipc_msg_dbg(struct print_buf * buf,struct tipc_msg * msg,const char * str)137 void tipc_msg_dbg(struct print_buf *buf, struct tipc_msg *msg, const char *str)
138 {
139 	u32 usr = msg_user(msg);
140 	tipc_printf(buf, KERN_DEBUG);
141 	tipc_printf(buf, str);
142 
143 	switch (usr) {
144 	case MSG_BUNDLER:
145 		tipc_printf(buf, "BNDL::");
146 		tipc_printf(buf, "MSGS(%u):", msg_msgcnt(msg));
147 		break;
148 	case BCAST_PROTOCOL:
149 		tipc_printf(buf, "BCASTP::");
150 		break;
151 	case MSG_FRAGMENTER:
152 		tipc_printf(buf, "FRAGM::");
153 		switch (msg_type(msg)) {
154 		case FIRST_FRAGMENT:
155 			tipc_printf(buf, "FIRST:");
156 			break;
157 		case FRAGMENT:
158 			tipc_printf(buf, "BODY:");
159 			break;
160 		case LAST_FRAGMENT:
161 			tipc_printf(buf, "LAST:");
162 			break;
163 		default:
164 			tipc_printf(buf, "UNKNOWN:%x", msg_type(msg));
165 
166 		}
167 		tipc_printf(buf, "NO(%u/%u):", msg_long_msgno(msg),
168 			    msg_fragm_no(msg));
169 		break;
170 	case TIPC_LOW_IMPORTANCE:
171 	case TIPC_MEDIUM_IMPORTANCE:
172 	case TIPC_HIGH_IMPORTANCE:
173 	case TIPC_CRITICAL_IMPORTANCE:
174 		tipc_printf(buf, "DAT%u:", msg_user(msg));
175 		if (msg_short(msg)) {
176 			tipc_printf(buf, "CON:");
177 			break;
178 		}
179 		switch (msg_type(msg)) {
180 		case TIPC_CONN_MSG:
181 			tipc_printf(buf, "CON:");
182 			break;
183 		case TIPC_MCAST_MSG:
184 			tipc_printf(buf, "MCST:");
185 			break;
186 		case TIPC_NAMED_MSG:
187 			tipc_printf(buf, "NAM:");
188 			break;
189 		case TIPC_DIRECT_MSG:
190 			tipc_printf(buf, "DIR:");
191 			break;
192 		default:
193 			tipc_printf(buf, "UNKNOWN TYPE %u", msg_type(msg));
194 		}
195 		if (msg_reroute_cnt(msg))
196 			tipc_printf(buf, "REROUTED(%u):",
197 				    msg_reroute_cnt(msg));
198 		break;
199 	case NAME_DISTRIBUTOR:
200 		tipc_printf(buf, "NMD::");
201 		switch (msg_type(msg)) {
202 		case PUBLICATION:
203 			tipc_printf(buf, "PUBL(%u):", (msg_size(msg) - msg_hdr_sz(msg)) / 20);	/* Items */
204 			break;
205 		case WITHDRAWAL:
206 			tipc_printf(buf, "WDRW:");
207 			break;
208 		default:
209 			tipc_printf(buf, "UNKNOWN:%x", msg_type(msg));
210 		}
211 		if (msg_reroute_cnt(msg))
212 			tipc_printf(buf, "REROUTED(%u):",
213 				    msg_reroute_cnt(msg));
214 		break;
215 	case CONN_MANAGER:
216 		tipc_printf(buf, "CONN_MNG:");
217 		switch (msg_type(msg)) {
218 		case CONN_PROBE:
219 			tipc_printf(buf, "PROBE:");
220 			break;
221 		case CONN_PROBE_REPLY:
222 			tipc_printf(buf, "PROBE_REPLY:");
223 			break;
224 		case CONN_ACK:
225 			tipc_printf(buf, "CONN_ACK:");
226 			tipc_printf(buf, "ACK(%u):", msg_msgcnt(msg));
227 			break;
228 		default:
229 			tipc_printf(buf, "UNKNOWN TYPE:%x", msg_type(msg));
230 		}
231 		if (msg_reroute_cnt(msg))
232 			tipc_printf(buf, "REROUTED(%u):", msg_reroute_cnt(msg));
233 		break;
234 	case LINK_PROTOCOL:
235 		switch (msg_type(msg)) {
236 		case STATE_MSG:
237 			tipc_printf(buf, "STATE:");
238 			tipc_printf(buf, "%s:", msg_probe(msg) ? "PRB" : "");
239 			tipc_printf(buf, "NXS(%u):", msg_next_sent(msg));
240 			tipc_printf(buf, "GAP(%u):", msg_seq_gap(msg));
241 			tipc_printf(buf, "LSTBC(%u):", msg_last_bcast(msg));
242 			break;
243 		case RESET_MSG:
244 			tipc_printf(buf, "RESET:");
245 			if (msg_size(msg) != msg_hdr_sz(msg))
246 				tipc_printf(buf, "BEAR:%s:", msg_data(msg));
247 			break;
248 		case ACTIVATE_MSG:
249 			tipc_printf(buf, "ACTIVATE:");
250 			break;
251 		default:
252 			tipc_printf(buf, "UNKNOWN TYPE:%x", msg_type(msg));
253 		}
254 		tipc_printf(buf, "PLANE(%c):", msg_net_plane(msg));
255 		tipc_printf(buf, "SESS(%u):", msg_session(msg));
256 		break;
257 	case CHANGEOVER_PROTOCOL:
258 		tipc_printf(buf, "TUNL:");
259 		switch (msg_type(msg)) {
260 		case DUPLICATE_MSG:
261 			tipc_printf(buf, "DUPL:");
262 			break;
263 		case ORIGINAL_MSG:
264 			tipc_printf(buf, "ORIG:");
265 			tipc_printf(buf, "EXP(%u)", msg_msgcnt(msg));
266 			break;
267 		default:
268 			tipc_printf(buf, "UNKNOWN TYPE:%x", msg_type(msg));
269 		}
270 		break;
271 	case LINK_CONFIG:
272 		tipc_printf(buf, "CFG:");
273 		switch (msg_type(msg)) {
274 		case DSC_REQ_MSG:
275 			tipc_printf(buf, "DSC_REQ:");
276 			break;
277 		case DSC_RESP_MSG:
278 			tipc_printf(buf, "DSC_RESP:");
279 			break;
280 		default:
281 			tipc_printf(buf, "UNKNOWN TYPE:%x:", msg_type(msg));
282 			break;
283 		}
284 		break;
285 	default:
286 		tipc_printf(buf, "UNKNOWN USER:");
287 	}
288 
289 	switch (usr) {
290 	case CONN_MANAGER:
291 	case TIPC_LOW_IMPORTANCE:
292 	case TIPC_MEDIUM_IMPORTANCE:
293 	case TIPC_HIGH_IMPORTANCE:
294 	case TIPC_CRITICAL_IMPORTANCE:
295 		switch (msg_errcode(msg)) {
296 		case TIPC_OK:
297 			break;
298 		case TIPC_ERR_NO_NAME:
299 			tipc_printf(buf, "NO_NAME:");
300 			break;
301 		case TIPC_ERR_NO_PORT:
302 			tipc_printf(buf, "NO_PORT:");
303 			break;
304 		case TIPC_ERR_NO_NODE:
305 			tipc_printf(buf, "NO_PROC:");
306 			break;
307 		case TIPC_ERR_OVERLOAD:
308 			tipc_printf(buf, "OVERLOAD:");
309 			break;
310 		case TIPC_CONN_SHUTDOWN:
311 			tipc_printf(buf, "SHUTDOWN:");
312 			break;
313 		default:
314 			tipc_printf(buf, "UNKNOWN ERROR(%x):",
315 				    msg_errcode(msg));
316 		}
317 	default:
318 		break;
319 	}
320 
321 	tipc_printf(buf, "HZ(%u):", msg_hdr_sz(msg));
322 	tipc_printf(buf, "SZ(%u):", msg_size(msg));
323 	tipc_printf(buf, "SQNO(%u):", msg_seqno(msg));
324 
325 	if (msg_non_seq(msg))
326 		tipc_printf(buf, "NOSEQ:");
327 	else
328 		tipc_printf(buf, "ACK(%u):", msg_ack(msg));
329 	tipc_printf(buf, "BACK(%u):", msg_bcast_ack(msg));
330 	tipc_printf(buf, "PRND(%x)", msg_prevnode(msg));
331 
332 	if (msg_isdata(msg)) {
333 		if (msg_named(msg)) {
334 			tipc_printf(buf, "NTYP(%u):", msg_nametype(msg));
335 			tipc_printf(buf, "NINST(%u)", msg_nameinst(msg));
336 		}
337 	}
338 
339 	if ((usr != LINK_PROTOCOL) && (usr != LINK_CONFIG) &&
340 	    (usr != MSG_BUNDLER)) {
341 		if (!msg_short(msg)) {
342 			tipc_printf(buf, ":ORIG(%x:%u):",
343 				    msg_orignode(msg), msg_origport(msg));
344 			tipc_printf(buf, ":DEST(%x:%u):",
345 				    msg_destnode(msg), msg_destport(msg));
346 		} else {
347 			tipc_printf(buf, ":OPRT(%u):", msg_origport(msg));
348 			tipc_printf(buf, ":DPRT(%u):", msg_destport(msg));
349 		}
350 	}
351 	if (msg_user(msg) == NAME_DISTRIBUTOR) {
352 		tipc_printf(buf, ":ONOD(%x):", msg_orignode(msg));
353 		tipc_printf(buf, ":DNOD(%x):", msg_destnode(msg));
354 	}
355 
356 	if (msg_user(msg) ==  LINK_CONFIG) {
357 		u32 *raw = (u32 *)msg;
358 		struct tipc_media_addr *orig = (struct tipc_media_addr *)&raw[5];
359 		tipc_printf(buf, ":DDOM(%x):", msg_dest_domain(msg));
360 		tipc_printf(buf, ":NETID(%u):", msg_bc_netid(msg));
361 		tipc_media_addr_printf(buf, orig);
362 	}
363 	if (msg_user(msg) == BCAST_PROTOCOL) {
364 		tipc_printf(buf, "BCNACK:AFTER(%u):", msg_bcgap_after(msg));
365 		tipc_printf(buf, "TO(%u):", msg_bcgap_to(msg));
366 	}
367 	tipc_printf(buf, "\n");
368 	if ((usr == CHANGEOVER_PROTOCOL) && (msg_msgcnt(msg)))
369 		tipc_msg_dbg(buf, msg_get_wrapped(msg), "      /");
370 	if ((usr == MSG_FRAGMENTER) && (msg_type(msg) == FIRST_FRAGMENT))
371 		tipc_msg_dbg(buf, msg_get_wrapped(msg), "      /");
372 }
373 
374 #endif
375