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