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