xref: /linux/net/tipc/msg.h (revision 8f8d5745bb520c76b81abef4a2cb3023d0313bfd)
1 /*
2  * net/tipc/msg.h: Include file for TIPC message header routines
3  *
4  * Copyright (c) 2000-2007, 2014-2017 Ericsson AB
5  * Copyright (c) 2005-2008, 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 #ifndef _TIPC_MSG_H
38 #define _TIPC_MSG_H
39 
40 #include <linux/tipc.h>
41 #include "core.h"
42 
43 /*
44  * Constants and routines used to read and write TIPC payload message headers
45  *
46  * Note: Some items are also used with TIPC internal message headers
47  */
48 #define TIPC_VERSION              2
49 struct plist;
50 
51 /*
52  * Payload message users are defined in TIPC's public API:
53  * - TIPC_LOW_IMPORTANCE
54  * - TIPC_MEDIUM_IMPORTANCE
55  * - TIPC_HIGH_IMPORTANCE
56  * - TIPC_CRITICAL_IMPORTANCE
57  */
58 #define TIPC_SYSTEM_IMPORTANCE	4
59 
60 
61 /*
62  * Payload message types
63  */
64 #define TIPC_CONN_MSG           0
65 #define TIPC_MCAST_MSG          1
66 #define TIPC_NAMED_MSG          2
67 #define TIPC_DIRECT_MSG         3
68 #define TIPC_GRP_MEMBER_EVT     4
69 #define TIPC_GRP_BCAST_MSG      5
70 #define TIPC_GRP_MCAST_MSG      6
71 #define TIPC_GRP_UCAST_MSG      7
72 
73 /*
74  * Internal message users
75  */
76 #define  BCAST_PROTOCOL       5
77 #define  MSG_BUNDLER          6
78 #define  LINK_PROTOCOL        7
79 #define  CONN_MANAGER         8
80 #define  GROUP_PROTOCOL       9
81 #define  TUNNEL_PROTOCOL      10
82 #define  NAME_DISTRIBUTOR     11
83 #define  MSG_FRAGMENTER       12
84 #define  LINK_CONFIG          13
85 #define  SOCK_WAKEUP          14       /* pseudo user */
86 #define  TOP_SRV              15       /* pseudo user */
87 
88 /*
89  * Message header sizes
90  */
91 #define SHORT_H_SIZE              24	/* In-cluster basic payload message */
92 #define BASIC_H_SIZE              32	/* Basic payload message */
93 #define NAMED_H_SIZE              40	/* Named payload message */
94 #define MCAST_H_SIZE              44	/* Multicast payload message */
95 #define GROUP_H_SIZE              44	/* Group payload message */
96 #define INT_H_SIZE                40	/* Internal messages */
97 #define MIN_H_SIZE                24	/* Smallest legal TIPC header size */
98 #define MAX_H_SIZE                60	/* Largest possible TIPC header size */
99 
100 #define MAX_MSG_SIZE (MAX_H_SIZE + TIPC_MAX_USER_MSG_SIZE)
101 #define FB_MTU                  3744
102 #define TIPC_MEDIA_INFO_OFFSET	5
103 
104 struct tipc_skb_cb {
105 	u32 bytes_read;
106 	u32 orig_member;
107 	struct sk_buff *tail;
108 	unsigned long nxt_retr;
109 	bool validated;
110 	u16 chain_imp;
111 	u16 ackers;
112 };
113 
114 #define TIPC_SKB_CB(__skb) ((struct tipc_skb_cb *)&((__skb)->cb[0]))
115 
116 struct tipc_msg {
117 	__be32 hdr[15];
118 };
119 
120 static inline struct tipc_msg *buf_msg(struct sk_buff *skb)
121 {
122 	return (struct tipc_msg *)skb->data;
123 }
124 
125 static inline u32 msg_word(struct tipc_msg *m, u32 pos)
126 {
127 	return ntohl(m->hdr[pos]);
128 }
129 
130 static inline void msg_set_word(struct tipc_msg *m, u32 w, u32 val)
131 {
132 	m->hdr[w] = htonl(val);
133 }
134 
135 static inline u32 msg_bits(struct tipc_msg *m, u32 w, u32 pos, u32 mask)
136 {
137 	return (msg_word(m, w) >> pos) & mask;
138 }
139 
140 static inline void msg_set_bits(struct tipc_msg *m, u32 w,
141 				u32 pos, u32 mask, u32 val)
142 {
143 	val = (val & mask) << pos;
144 	mask = mask << pos;
145 	m->hdr[w] &= ~htonl(mask);
146 	m->hdr[w] |= htonl(val);
147 }
148 
149 static inline void msg_swap_words(struct tipc_msg *msg, u32 a, u32 b)
150 {
151 	u32 temp = msg->hdr[a];
152 
153 	msg->hdr[a] = msg->hdr[b];
154 	msg->hdr[b] = temp;
155 }
156 
157 /*
158  * Word 0
159  */
160 static inline u32 msg_version(struct tipc_msg *m)
161 {
162 	return msg_bits(m, 0, 29, 7);
163 }
164 
165 static inline void msg_set_version(struct tipc_msg *m)
166 {
167 	msg_set_bits(m, 0, 29, 7, TIPC_VERSION);
168 }
169 
170 static inline u32 msg_user(struct tipc_msg *m)
171 {
172 	return msg_bits(m, 0, 25, 0xf);
173 }
174 
175 static inline u32 msg_isdata(struct tipc_msg *m)
176 {
177 	return msg_user(m) <= TIPC_CRITICAL_IMPORTANCE;
178 }
179 
180 static inline void msg_set_user(struct tipc_msg *m, u32 n)
181 {
182 	msg_set_bits(m, 0, 25, 0xf, n);
183 }
184 
185 static inline u32 msg_hdr_sz(struct tipc_msg *m)
186 {
187 	return msg_bits(m, 0, 21, 0xf) << 2;
188 }
189 
190 static inline void msg_set_hdr_sz(struct tipc_msg *m, u32 n)
191 {
192 	msg_set_bits(m, 0, 21, 0xf, n>>2);
193 }
194 
195 static inline u32 msg_size(struct tipc_msg *m)
196 {
197 	return msg_bits(m, 0, 0, 0x1ffff);
198 }
199 
200 static inline u32 msg_blocks(struct tipc_msg *m)
201 {
202 	return (msg_size(m) / 1024) + 1;
203 }
204 
205 static inline u32 msg_data_sz(struct tipc_msg *m)
206 {
207 	return msg_size(m) - msg_hdr_sz(m);
208 }
209 
210 static inline int msg_non_seq(struct tipc_msg *m)
211 {
212 	return msg_bits(m, 0, 20, 1);
213 }
214 
215 static inline void msg_set_non_seq(struct tipc_msg *m, u32 n)
216 {
217 	msg_set_bits(m, 0, 20, 1, n);
218 }
219 
220 static inline int msg_is_syn(struct tipc_msg *m)
221 {
222 	return msg_bits(m, 0, 17, 1);
223 }
224 
225 static inline void msg_set_syn(struct tipc_msg *m, u32 d)
226 {
227 	msg_set_bits(m, 0, 17, 1, d);
228 }
229 
230 static inline int msg_dest_droppable(struct tipc_msg *m)
231 {
232 	return msg_bits(m, 0, 19, 1);
233 }
234 
235 static inline void msg_set_dest_droppable(struct tipc_msg *m, u32 d)
236 {
237 	msg_set_bits(m, 0, 19, 1, d);
238 }
239 
240 static inline int msg_is_keepalive(struct tipc_msg *m)
241 {
242 	return msg_bits(m, 0, 19, 1);
243 }
244 
245 static inline void msg_set_is_keepalive(struct tipc_msg *m, u32 d)
246 {
247 	msg_set_bits(m, 0, 19, 1, d);
248 }
249 
250 static inline int msg_src_droppable(struct tipc_msg *m)
251 {
252 	return msg_bits(m, 0, 18, 1);
253 }
254 
255 static inline void msg_set_src_droppable(struct tipc_msg *m, u32 d)
256 {
257 	msg_set_bits(m, 0, 18, 1, d);
258 }
259 
260 static inline void msg_set_size(struct tipc_msg *m, u32 sz)
261 {
262 	m->hdr[0] = htonl((msg_word(m, 0) & ~0x1ffff) | sz);
263 }
264 
265 static inline unchar *msg_data(struct tipc_msg *m)
266 {
267 	return ((unchar *)m) + msg_hdr_sz(m);
268 }
269 
270 static inline struct tipc_msg *msg_get_wrapped(struct tipc_msg *m)
271 {
272 	return (struct tipc_msg *)msg_data(m);
273 }
274 
275 /*
276  * Word 1
277  */
278 static inline u32 msg_type(struct tipc_msg *m)
279 {
280 	return msg_bits(m, 1, 29, 0x7);
281 }
282 
283 static inline void msg_set_type(struct tipc_msg *m, u32 n)
284 {
285 	msg_set_bits(m, 1, 29, 0x7, n);
286 }
287 
288 static inline int msg_in_group(struct tipc_msg *m)
289 {
290 	int mtyp = msg_type(m);
291 
292 	return mtyp >= TIPC_GRP_MEMBER_EVT && mtyp <= TIPC_GRP_UCAST_MSG;
293 }
294 
295 static inline bool msg_is_grp_evt(struct tipc_msg *m)
296 {
297 	return msg_type(m) == TIPC_GRP_MEMBER_EVT;
298 }
299 
300 static inline u32 msg_named(struct tipc_msg *m)
301 {
302 	return msg_type(m) == TIPC_NAMED_MSG;
303 }
304 
305 static inline u32 msg_mcast(struct tipc_msg *m)
306 {
307 	int mtyp = msg_type(m);
308 
309 	return ((mtyp == TIPC_MCAST_MSG) || (mtyp == TIPC_GRP_BCAST_MSG) ||
310 		(mtyp == TIPC_GRP_MCAST_MSG));
311 }
312 
313 static inline u32 msg_connected(struct tipc_msg *m)
314 {
315 	return msg_type(m) == TIPC_CONN_MSG;
316 }
317 
318 static inline u32 msg_errcode(struct tipc_msg *m)
319 {
320 	return msg_bits(m, 1, 25, 0xf);
321 }
322 
323 static inline void msg_set_errcode(struct tipc_msg *m, u32 err)
324 {
325 	msg_set_bits(m, 1, 25, 0xf, err);
326 }
327 
328 static inline u32 msg_reroute_cnt(struct tipc_msg *m)
329 {
330 	return msg_bits(m, 1, 21, 0xf);
331 }
332 
333 static inline void msg_incr_reroute_cnt(struct tipc_msg *m)
334 {
335 	msg_set_bits(m, 1, 21, 0xf, msg_reroute_cnt(m) + 1);
336 }
337 
338 static inline void msg_reset_reroute_cnt(struct tipc_msg *m)
339 {
340 	msg_set_bits(m, 1, 21, 0xf, 0);
341 }
342 
343 static inline u32 msg_lookup_scope(struct tipc_msg *m)
344 {
345 	return msg_bits(m, 1, 19, 0x3);
346 }
347 
348 static inline void msg_set_lookup_scope(struct tipc_msg *m, u32 n)
349 {
350 	msg_set_bits(m, 1, 19, 0x3, n);
351 }
352 
353 static inline u16 msg_bcast_ack(struct tipc_msg *m)
354 {
355 	return msg_bits(m, 1, 0, 0xffff);
356 }
357 
358 static inline void msg_set_bcast_ack(struct tipc_msg *m, u16 n)
359 {
360 	msg_set_bits(m, 1, 0, 0xffff, n);
361 }
362 
363 /* Note: reusing bits in word 1 for ACTIVATE_MSG only, to re-synch
364  * link peer session number
365  */
366 static inline bool msg_dest_session_valid(struct tipc_msg *m)
367 {
368 	return msg_bits(m, 1, 16, 0x1);
369 }
370 
371 static inline void msg_set_dest_session_valid(struct tipc_msg *m, bool valid)
372 {
373 	msg_set_bits(m, 1, 16, 0x1, valid);
374 }
375 
376 static inline u16 msg_dest_session(struct tipc_msg *m)
377 {
378 	return msg_bits(m, 1, 0, 0xffff);
379 }
380 
381 static inline void msg_set_dest_session(struct tipc_msg *m, u16 n)
382 {
383 	msg_set_bits(m, 1, 0, 0xffff, n);
384 }
385 
386 /*
387  * Word 2
388  */
389 static inline u16 msg_ack(struct tipc_msg *m)
390 {
391 	return msg_bits(m, 2, 16, 0xffff);
392 }
393 
394 static inline void msg_set_ack(struct tipc_msg *m, u16 n)
395 {
396 	msg_set_bits(m, 2, 16, 0xffff, n);
397 }
398 
399 static inline u16 msg_seqno(struct tipc_msg *m)
400 {
401 	return msg_bits(m, 2, 0, 0xffff);
402 }
403 
404 static inline void msg_set_seqno(struct tipc_msg *m, u16 n)
405 {
406 	msg_set_bits(m, 2, 0, 0xffff, n);
407 }
408 
409 /*
410  * Words 3-10
411  */
412 static inline u32 msg_importance(struct tipc_msg *m)
413 {
414 	int usr = msg_user(m);
415 
416 	if (likely((usr <= TIPC_CRITICAL_IMPORTANCE) && !msg_errcode(m)))
417 		return usr;
418 	if ((usr == MSG_FRAGMENTER) || (usr == MSG_BUNDLER))
419 		return msg_bits(m, 9, 0, 0x7);
420 	return TIPC_SYSTEM_IMPORTANCE;
421 }
422 
423 static inline void msg_set_importance(struct tipc_msg *m, u32 i)
424 {
425 	int usr = msg_user(m);
426 
427 	if (likely((usr == MSG_FRAGMENTER) || (usr == MSG_BUNDLER)))
428 		msg_set_bits(m, 9, 0, 0x7, i);
429 	else if (i < TIPC_SYSTEM_IMPORTANCE)
430 		msg_set_user(m, i);
431 	else
432 		pr_warn("Trying to set illegal importance in message\n");
433 }
434 
435 static inline u32 msg_prevnode(struct tipc_msg *m)
436 {
437 	return msg_word(m, 3);
438 }
439 
440 static inline void msg_set_prevnode(struct tipc_msg *m, u32 a)
441 {
442 	msg_set_word(m, 3, a);
443 }
444 
445 static inline u32 msg_origport(struct tipc_msg *m)
446 {
447 	if (msg_user(m) == MSG_FRAGMENTER)
448 		m = msg_get_wrapped(m);
449 	return msg_word(m, 4);
450 }
451 
452 static inline void msg_set_origport(struct tipc_msg *m, u32 p)
453 {
454 	msg_set_word(m, 4, p);
455 }
456 
457 static inline u32 msg_destport(struct tipc_msg *m)
458 {
459 	return msg_word(m, 5);
460 }
461 
462 static inline void msg_set_destport(struct tipc_msg *m, u32 p)
463 {
464 	msg_set_word(m, 5, p);
465 }
466 
467 static inline u32 msg_mc_netid(struct tipc_msg *m)
468 {
469 	return msg_word(m, 5);
470 }
471 
472 static inline void msg_set_mc_netid(struct tipc_msg *m, u32 p)
473 {
474 	msg_set_word(m, 5, p);
475 }
476 
477 static inline int msg_short(struct tipc_msg *m)
478 {
479 	return msg_hdr_sz(m) == SHORT_H_SIZE;
480 }
481 
482 static inline u32 msg_orignode(struct tipc_msg *m)
483 {
484 	if (likely(msg_short(m)))
485 		return msg_prevnode(m);
486 	return msg_word(m, 6);
487 }
488 
489 static inline void msg_set_orignode(struct tipc_msg *m, u32 a)
490 {
491 	msg_set_word(m, 6, a);
492 }
493 
494 static inline u32 msg_destnode(struct tipc_msg *m)
495 {
496 	return msg_word(m, 7);
497 }
498 
499 static inline void msg_set_destnode(struct tipc_msg *m, u32 a)
500 {
501 	msg_set_word(m, 7, a);
502 }
503 
504 static inline u32 msg_nametype(struct tipc_msg *m)
505 {
506 	return msg_word(m, 8);
507 }
508 
509 static inline void msg_set_nametype(struct tipc_msg *m, u32 n)
510 {
511 	msg_set_word(m, 8, n);
512 }
513 
514 static inline u32 msg_nameinst(struct tipc_msg *m)
515 {
516 	return msg_word(m, 9);
517 }
518 
519 static inline u32 msg_namelower(struct tipc_msg *m)
520 {
521 	return msg_nameinst(m);
522 }
523 
524 static inline void msg_set_namelower(struct tipc_msg *m, u32 n)
525 {
526 	msg_set_word(m, 9, n);
527 }
528 
529 static inline void msg_set_nameinst(struct tipc_msg *m, u32 n)
530 {
531 	msg_set_namelower(m, n);
532 }
533 
534 static inline u32 msg_nameupper(struct tipc_msg *m)
535 {
536 	return msg_word(m, 10);
537 }
538 
539 static inline void msg_set_nameupper(struct tipc_msg *m, u32 n)
540 {
541 	msg_set_word(m, 10, n);
542 }
543 
544 /*
545  * Constants and routines used to read and write TIPC internal message headers
546  */
547 
548 /*
549  *  Connection management protocol message types
550  */
551 #define CONN_PROBE        0
552 #define CONN_PROBE_REPLY  1
553 #define CONN_ACK          2
554 
555 /*
556  * Name distributor message types
557  */
558 #define PUBLICATION       0
559 #define WITHDRAWAL        1
560 
561 /*
562  * Segmentation message types
563  */
564 #define FIRST_FRAGMENT		0
565 #define FRAGMENT		1
566 #define LAST_FRAGMENT		2
567 
568 /*
569  * Link management protocol message types
570  */
571 #define STATE_MSG		0
572 #define RESET_MSG		1
573 #define ACTIVATE_MSG		2
574 
575 /*
576  * Changeover tunnel message types
577  */
578 #define SYNCH_MSG		0
579 #define FAILOVER_MSG		1
580 
581 /*
582  * Config protocol message types
583  */
584 #define DSC_REQ_MSG		0
585 #define DSC_RESP_MSG		1
586 #define DSC_TRIAL_MSG		2
587 #define DSC_TRIAL_FAIL_MSG	3
588 
589 /*
590  * Group protocol message types
591  */
592 #define GRP_JOIN_MSG         0
593 #define GRP_LEAVE_MSG        1
594 #define GRP_ADV_MSG          2
595 #define GRP_ACK_MSG          3
596 #define GRP_RECLAIM_MSG      4
597 #define GRP_REMIT_MSG        5
598 
599 /*
600  * Word 1
601  */
602 static inline u32 msg_seq_gap(struct tipc_msg *m)
603 {
604 	return msg_bits(m, 1, 16, 0x1fff);
605 }
606 
607 static inline void msg_set_seq_gap(struct tipc_msg *m, u32 n)
608 {
609 	msg_set_bits(m, 1, 16, 0x1fff, n);
610 }
611 
612 static inline u32 msg_node_sig(struct tipc_msg *m)
613 {
614 	return msg_bits(m, 1, 0, 0xffff);
615 }
616 
617 static inline void msg_set_node_sig(struct tipc_msg *m, u32 n)
618 {
619 	msg_set_bits(m, 1, 0, 0xffff, n);
620 }
621 
622 static inline u32 msg_node_capabilities(struct tipc_msg *m)
623 {
624 	return msg_bits(m, 1, 15, 0x1fff);
625 }
626 
627 static inline void msg_set_node_capabilities(struct tipc_msg *m, u32 n)
628 {
629 	msg_set_bits(m, 1, 15, 0x1fff, n);
630 }
631 
632 /*
633  * Word 2
634  */
635 static inline u32 msg_dest_domain(struct tipc_msg *m)
636 {
637 	return msg_word(m, 2);
638 }
639 
640 static inline void msg_set_dest_domain(struct tipc_msg *m, u32 n)
641 {
642 	msg_set_word(m, 2, n);
643 }
644 
645 static inline u32 msg_bcgap_after(struct tipc_msg *m)
646 {
647 	return msg_bits(m, 2, 16, 0xffff);
648 }
649 
650 static inline void msg_set_bcgap_after(struct tipc_msg *m, u32 n)
651 {
652 	msg_set_bits(m, 2, 16, 0xffff, n);
653 }
654 
655 static inline u32 msg_bcgap_to(struct tipc_msg *m)
656 {
657 	return msg_bits(m, 2, 0, 0xffff);
658 }
659 
660 static inline void msg_set_bcgap_to(struct tipc_msg *m, u32 n)
661 {
662 	msg_set_bits(m, 2, 0, 0xffff, n);
663 }
664 
665 /*
666  * Word 4
667  */
668 static inline u32 msg_last_bcast(struct tipc_msg *m)
669 {
670 	return msg_bits(m, 4, 16, 0xffff);
671 }
672 
673 static inline u32 msg_bc_snd_nxt(struct tipc_msg *m)
674 {
675 	return msg_last_bcast(m) + 1;
676 }
677 
678 static inline void msg_set_last_bcast(struct tipc_msg *m, u32 n)
679 {
680 	msg_set_bits(m, 4, 16, 0xffff, n);
681 }
682 
683 static inline void msg_set_fragm_no(struct tipc_msg *m, u32 n)
684 {
685 	msg_set_bits(m, 4, 16, 0xffff, n);
686 }
687 
688 
689 static inline u16 msg_next_sent(struct tipc_msg *m)
690 {
691 	return msg_bits(m, 4, 0, 0xffff);
692 }
693 
694 static inline void msg_set_next_sent(struct tipc_msg *m, u16 n)
695 {
696 	msg_set_bits(m, 4, 0, 0xffff, n);
697 }
698 
699 static inline void msg_set_long_msgno(struct tipc_msg *m, u32 n)
700 {
701 	msg_set_bits(m, 4, 0, 0xffff, n);
702 }
703 
704 static inline u32 msg_bc_netid(struct tipc_msg *m)
705 {
706 	return msg_word(m, 4);
707 }
708 
709 static inline void msg_set_bc_netid(struct tipc_msg *m, u32 id)
710 {
711 	msg_set_word(m, 4, id);
712 }
713 
714 static inline u32 msg_link_selector(struct tipc_msg *m)
715 {
716 	if (msg_user(m) == MSG_FRAGMENTER)
717 		m = (void *)msg_data(m);
718 	return msg_bits(m, 4, 0, 1);
719 }
720 
721 /*
722  * Word 5
723  */
724 static inline u16 msg_session(struct tipc_msg *m)
725 {
726 	return msg_bits(m, 5, 16, 0xffff);
727 }
728 
729 static inline void msg_set_session(struct tipc_msg *m, u16 n)
730 {
731 	msg_set_bits(m, 5, 16, 0xffff, n);
732 }
733 
734 static inline u32 msg_probe(struct tipc_msg *m)
735 {
736 	return msg_bits(m, 5, 0, 1);
737 }
738 
739 static inline void msg_set_probe(struct tipc_msg *m, u32 val)
740 {
741 	msg_set_bits(m, 5, 0, 1, val);
742 }
743 
744 static inline char msg_net_plane(struct tipc_msg *m)
745 {
746 	return msg_bits(m, 5, 1, 7) + 'A';
747 }
748 
749 static inline void msg_set_net_plane(struct tipc_msg *m, char n)
750 {
751 	msg_set_bits(m, 5, 1, 7, (n - 'A'));
752 }
753 
754 static inline u32 msg_linkprio(struct tipc_msg *m)
755 {
756 	return msg_bits(m, 5, 4, 0x1f);
757 }
758 
759 static inline void msg_set_linkprio(struct tipc_msg *m, u32 n)
760 {
761 	msg_set_bits(m, 5, 4, 0x1f, n);
762 }
763 
764 static inline u32 msg_bearer_id(struct tipc_msg *m)
765 {
766 	return msg_bits(m, 5, 9, 0x7);
767 }
768 
769 static inline void msg_set_bearer_id(struct tipc_msg *m, u32 n)
770 {
771 	msg_set_bits(m, 5, 9, 0x7, n);
772 }
773 
774 static inline u32 msg_redundant_link(struct tipc_msg *m)
775 {
776 	return msg_bits(m, 5, 12, 0x1);
777 }
778 
779 static inline void msg_set_redundant_link(struct tipc_msg *m, u32 r)
780 {
781 	msg_set_bits(m, 5, 12, 0x1, r);
782 }
783 
784 static inline u32 msg_peer_stopping(struct tipc_msg *m)
785 {
786 	return msg_bits(m, 5, 13, 0x1);
787 }
788 
789 static inline void msg_set_peer_stopping(struct tipc_msg *m, u32 s)
790 {
791 	msg_set_bits(m, 5, 13, 0x1, s);
792 }
793 
794 static inline bool msg_bc_ack_invalid(struct tipc_msg *m)
795 {
796 	switch (msg_user(m)) {
797 	case BCAST_PROTOCOL:
798 	case NAME_DISTRIBUTOR:
799 	case LINK_PROTOCOL:
800 		return msg_bits(m, 5, 14, 0x1);
801 	default:
802 		return false;
803 	}
804 }
805 
806 static inline void msg_set_bc_ack_invalid(struct tipc_msg *m, bool invalid)
807 {
808 	msg_set_bits(m, 5, 14, 0x1, invalid);
809 }
810 
811 static inline char *msg_media_addr(struct tipc_msg *m)
812 {
813 	return (char *)&m->hdr[TIPC_MEDIA_INFO_OFFSET];
814 }
815 
816 static inline u32 msg_bc_gap(struct tipc_msg *m)
817 {
818 	return msg_bits(m, 8, 0, 0x3ff);
819 }
820 
821 static inline void msg_set_bc_gap(struct tipc_msg *m, u32 n)
822 {
823 	msg_set_bits(m, 8, 0, 0x3ff, n);
824 }
825 
826 /*
827  * Word 9
828  */
829 static inline u16 msg_msgcnt(struct tipc_msg *m)
830 {
831 	return msg_bits(m, 9, 16, 0xffff);
832 }
833 
834 static inline void msg_set_msgcnt(struct tipc_msg *m, u16 n)
835 {
836 	msg_set_bits(m, 9, 16, 0xffff, n);
837 }
838 
839 static inline u32 msg_conn_ack(struct tipc_msg *m)
840 {
841 	return msg_bits(m, 9, 16, 0xffff);
842 }
843 
844 static inline void msg_set_conn_ack(struct tipc_msg *m, u32 n)
845 {
846 	msg_set_bits(m, 9, 16, 0xffff, n);
847 }
848 
849 static inline u16 msg_adv_win(struct tipc_msg *m)
850 {
851 	return msg_bits(m, 9, 0, 0xffff);
852 }
853 
854 static inline void msg_set_adv_win(struct tipc_msg *m, u16 n)
855 {
856 	msg_set_bits(m, 9, 0, 0xffff, n);
857 }
858 
859 static inline u32 msg_max_pkt(struct tipc_msg *m)
860 {
861 	return msg_bits(m, 9, 16, 0xffff) * 4;
862 }
863 
864 static inline void msg_set_max_pkt(struct tipc_msg *m, u32 n)
865 {
866 	msg_set_bits(m, 9, 16, 0xffff, (n / 4));
867 }
868 
869 static inline u32 msg_link_tolerance(struct tipc_msg *m)
870 {
871 	return msg_bits(m, 9, 0, 0xffff);
872 }
873 
874 static inline void msg_set_link_tolerance(struct tipc_msg *m, u32 n)
875 {
876 	msg_set_bits(m, 9, 0, 0xffff, n);
877 }
878 
879 static inline u16 msg_grp_bc_syncpt(struct tipc_msg *m)
880 {
881 	return msg_bits(m, 9, 16, 0xffff);
882 }
883 
884 static inline void msg_set_grp_bc_syncpt(struct tipc_msg *m, u16 n)
885 {
886 	msg_set_bits(m, 9, 16, 0xffff, n);
887 }
888 
889 static inline u16 msg_grp_bc_acked(struct tipc_msg *m)
890 {
891 	return msg_bits(m, 9, 16, 0xffff);
892 }
893 
894 static inline void msg_set_grp_bc_acked(struct tipc_msg *m, u16 n)
895 {
896 	msg_set_bits(m, 9, 16, 0xffff, n);
897 }
898 
899 static inline u16 msg_grp_remitted(struct tipc_msg *m)
900 {
901 	return msg_bits(m, 9, 16, 0xffff);
902 }
903 
904 static inline void msg_set_grp_remitted(struct tipc_msg *m, u16 n)
905 {
906 	msg_set_bits(m, 9, 16, 0xffff, n);
907 }
908 
909 /* Word 10
910  */
911 static inline u16 msg_grp_evt(struct tipc_msg *m)
912 {
913 	return msg_bits(m, 10, 0, 0x3);
914 }
915 
916 static inline void msg_set_grp_evt(struct tipc_msg *m, int n)
917 {
918 	msg_set_bits(m, 10, 0, 0x3, n);
919 }
920 
921 static inline u16 msg_grp_bc_ack_req(struct tipc_msg *m)
922 {
923 	return msg_bits(m, 10, 0, 0x1);
924 }
925 
926 static inline void msg_set_grp_bc_ack_req(struct tipc_msg *m, bool n)
927 {
928 	msg_set_bits(m, 10, 0, 0x1, n);
929 }
930 
931 static inline u16 msg_grp_bc_seqno(struct tipc_msg *m)
932 {
933 	return msg_bits(m, 10, 16, 0xffff);
934 }
935 
936 static inline void msg_set_grp_bc_seqno(struct tipc_msg *m, u32 n)
937 {
938 	msg_set_bits(m, 10, 16, 0xffff, n);
939 }
940 
941 static inline bool msg_peer_link_is_up(struct tipc_msg *m)
942 {
943 	if (likely(msg_user(m) != LINK_PROTOCOL))
944 		return true;
945 	if (msg_type(m) == STATE_MSG)
946 		return true;
947 	return false;
948 }
949 
950 static inline bool msg_peer_node_is_up(struct tipc_msg *m)
951 {
952 	if (msg_peer_link_is_up(m))
953 		return true;
954 	return msg_redundant_link(m);
955 }
956 
957 static inline bool msg_is_reset(struct tipc_msg *hdr)
958 {
959 	return (msg_user(hdr) == LINK_PROTOCOL) && (msg_type(hdr) == RESET_MSG);
960 }
961 
962 static inline u32 msg_sugg_node_addr(struct tipc_msg *m)
963 {
964 	return msg_word(m, 14);
965 }
966 
967 static inline void msg_set_sugg_node_addr(struct tipc_msg *m, u32 n)
968 {
969 	msg_set_word(m, 14, n);
970 }
971 
972 static inline void msg_set_node_id(struct tipc_msg *hdr, u8 *id)
973 {
974 	memcpy(msg_data(hdr), id, 16);
975 }
976 
977 static inline u8 *msg_node_id(struct tipc_msg *hdr)
978 {
979 	return (u8 *)msg_data(hdr);
980 }
981 
982 struct sk_buff *tipc_buf_acquire(u32 size, gfp_t gfp);
983 bool tipc_msg_validate(struct sk_buff **_skb);
984 bool tipc_msg_reverse(u32 own_addr, struct sk_buff **skb, int err);
985 void tipc_skb_reject(struct net *net, int err, struct sk_buff *skb,
986 		     struct sk_buff_head *xmitq);
987 void tipc_msg_init(u32 own_addr, struct tipc_msg *m, u32 user, u32 type,
988 		   u32 hsize, u32 destnode);
989 struct sk_buff *tipc_msg_create(uint user, uint type, uint hdr_sz,
990 				uint data_sz, u32 dnode, u32 onode,
991 				u32 dport, u32 oport, int errcode);
992 int tipc_buf_append(struct sk_buff **headbuf, struct sk_buff **buf);
993 bool tipc_msg_bundle(struct sk_buff *skb, struct tipc_msg *msg, u32 mtu);
994 bool tipc_msg_make_bundle(struct sk_buff **skb, struct tipc_msg *msg,
995 			  u32 mtu, u32 dnode);
996 bool tipc_msg_extract(struct sk_buff *skb, struct sk_buff **iskb, int *pos);
997 int tipc_msg_build(struct tipc_msg *mhdr, struct msghdr *m,
998 		   int offset, int dsz, int mtu, struct sk_buff_head *list);
999 bool tipc_msg_lookup_dest(struct net *net, struct sk_buff *skb, int *err);
1000 bool tipc_msg_assemble(struct sk_buff_head *list);
1001 bool tipc_msg_reassemble(struct sk_buff_head *list, struct sk_buff_head *rcvq);
1002 bool tipc_msg_pskb_copy(u32 dst, struct sk_buff_head *msg,
1003 			struct sk_buff_head *cpy);
1004 void __tipc_skb_queue_sorted(struct sk_buff_head *list, u16 seqno,
1005 			     struct sk_buff *skb);
1006 bool tipc_msg_skb_clone(struct sk_buff_head *msg, struct sk_buff_head *cpy);
1007 
1008 static inline u16 buf_seqno(struct sk_buff *skb)
1009 {
1010 	return msg_seqno(buf_msg(skb));
1011 }
1012 
1013 static inline int buf_roundup_len(struct sk_buff *skb)
1014 {
1015 	return (skb->len / 1024 + 1) * 1024;
1016 }
1017 
1018 /* tipc_skb_peek(): peek and reserve first buffer in list
1019  * @list: list to be peeked in
1020  * Returns pointer to first buffer in list, if any
1021  */
1022 static inline struct sk_buff *tipc_skb_peek(struct sk_buff_head *list,
1023 					    spinlock_t *lock)
1024 {
1025 	struct sk_buff *skb;
1026 
1027 	spin_lock_bh(lock);
1028 	skb = skb_peek(list);
1029 	if (skb)
1030 		skb_get(skb);
1031 	spin_unlock_bh(lock);
1032 	return skb;
1033 }
1034 
1035 /* tipc_skb_peek_port(): find a destination port, ignoring all destinations
1036  *                       up to and including 'filter'.
1037  * Note: ignoring previously tried destinations minimizes the risk of
1038  *       contention on the socket lock
1039  * @list: list to be peeked in
1040  * @filter: last destination to be ignored from search
1041  * Returns a destination port number, of applicable.
1042  */
1043 static inline u32 tipc_skb_peek_port(struct sk_buff_head *list, u32 filter)
1044 {
1045 	struct sk_buff *skb;
1046 	u32 dport = 0;
1047 	bool ignore = true;
1048 
1049 	spin_lock_bh(&list->lock);
1050 	skb_queue_walk(list, skb) {
1051 		dport = msg_destport(buf_msg(skb));
1052 		if (!filter || skb_queue_is_last(list, skb))
1053 			break;
1054 		if (dport == filter)
1055 			ignore = false;
1056 		else if (!ignore)
1057 			break;
1058 	}
1059 	spin_unlock_bh(&list->lock);
1060 	return dport;
1061 }
1062 
1063 /* tipc_skb_dequeue(): unlink first buffer with dest 'dport' from list
1064  * @list: list to be unlinked from
1065  * @dport: selection criteria for buffer to unlink
1066  */
1067 static inline struct sk_buff *tipc_skb_dequeue(struct sk_buff_head *list,
1068 					       u32 dport)
1069 {
1070 	struct sk_buff *_skb, *tmp, *skb = NULL;
1071 
1072 	spin_lock_bh(&list->lock);
1073 	skb_queue_walk_safe(list, _skb, tmp) {
1074 		if (msg_destport(buf_msg(_skb)) == dport) {
1075 			__skb_unlink(_skb, list);
1076 			skb = _skb;
1077 			break;
1078 		}
1079 	}
1080 	spin_unlock_bh(&list->lock);
1081 	return skb;
1082 }
1083 
1084 /* tipc_skb_queue_splice_tail - append an skb list to lock protected list
1085  * @list: the new list to append. Not lock protected
1086  * @head: target list. Lock protected.
1087  */
1088 static inline void tipc_skb_queue_splice_tail(struct sk_buff_head *list,
1089 					      struct sk_buff_head *head)
1090 {
1091 	spin_lock_bh(&head->lock);
1092 	skb_queue_splice_tail(list, head);
1093 	spin_unlock_bh(&head->lock);
1094 }
1095 
1096 /* tipc_skb_queue_splice_tail_init - merge two lock protected skb lists
1097  * @list: the new list to add. Lock protected. Will be reinitialized
1098  * @head: target list. Lock protected.
1099  */
1100 static inline void tipc_skb_queue_splice_tail_init(struct sk_buff_head *list,
1101 						   struct sk_buff_head *head)
1102 {
1103 	struct sk_buff_head tmp;
1104 
1105 	__skb_queue_head_init(&tmp);
1106 
1107 	spin_lock_bh(&list->lock);
1108 	skb_queue_splice_tail_init(list, &tmp);
1109 	spin_unlock_bh(&list->lock);
1110 	tipc_skb_queue_splice_tail(&tmp, head);
1111 }
1112 
1113 #endif
1114