blob: 5d64596ba98775d5dfe2d2d4918bcc11273d485b [file] [log] [blame]
Per Lidenb97bf3f2006-01-02 19:04:38 +01001/*
2 * net/tipc/msg.h: Include file for TIPC message header routines
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +09003 *
Jon Maloy75da2162017-10-13 11:04:23 +02004 * Copyright (c) 2000-2007, 2014-2017 Ericsson AB
Allan Stephens741de3e2011-01-25 13:33:31 -05005 * Copyright (c) 2005-2008, 2010-2011, Wind River Systems
Per Lidenb97bf3f2006-01-02 19:04:38 +01006 * All rights reserved.
7 *
Per Liden9ea1fd32006-01-11 13:30:43 +01008 * Redistribution and use in source and binary forms, with or without
Per Lidenb97bf3f2006-01-02 19:04:38 +01009 * modification, are permitted provided that the following conditions are met:
10 *
Per Liden9ea1fd32006-01-11 13:30:43 +010011 * 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.
Per Lidenb97bf3f2006-01-02 19:04:38 +010019 *
Per Liden9ea1fd32006-01-11 13:30:43 +010020 * 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
Per Lidenb97bf3f2006-01-02 19:04:38 +010034 * POSSIBILITY OF SUCH DAMAGE.
35 */
36
37#ifndef _TIPC_MSG_H
38#define _TIPC_MSG_H
39
Ying Xue1da46562015-01-09 15:27:07 +080040#include <linux/tipc.h>
Jon Paul Maloyd9992972015-07-16 16:54:31 -040041#include "core.h"
Per Lidenb97bf3f2006-01-02 19:04:38 +010042
Allan Stephenscc4c4352011-04-08 10:50:52 -040043/*
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 */
Per Lidenb97bf3f2006-01-02 19:04:38 +010048#define TIPC_VERSION 2
Jon Paul Maloyc637c102015-02-05 08:36:41 -050049struct plist;
Allan Stephens06d82c92008-03-06 15:06:55 -080050
Allan Stephensd265fef2010-11-30 12:00:53 +000051/*
Allan Stephenscc4c4352011-04-08 10:50:52 -040052 * 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 */
Jon Paul Maloye3eea1e2015-03-13 16:08:11 -040058#define TIPC_SYSTEM_IMPORTANCE 4
59
Allan Stephenscc4c4352011-04-08 10:50:52 -040060
61/*
62 * Payload message types
Allan Stephensd265fef2010-11-30 12:00:53 +000063 */
Jon Maloy75da2162017-10-13 11:04:23 +020064#define TIPC_CONN_MSG 0
65#define TIPC_MCAST_MSG 1
66#define TIPC_NAMED_MSG 2
67#define TIPC_DIRECT_MSG 3
Jon Maloyae236fb2017-10-13 11:04:25 +020068#define TIPC_GRP_MEMBER_EVT 4
69#define TIPC_GRP_BCAST_MSG 5
Jon Maloy5b8dddb2017-10-13 11:04:29 +020070#define TIPC_GRP_MCAST_MSG 6
71#define TIPC_GRP_UCAST_MSG 7
Allan Stephensd265fef2010-11-30 12:00:53 +000072
Allan Stephenscc4c4352011-04-08 10:50:52 -040073/*
Jon Paul Maloye3eea1e2015-03-13 16:08:11 -040074 * Internal message users
75 */
76#define BCAST_PROTOCOL 5
77#define MSG_BUNDLER 6
78#define LINK_PROTOCOL 7
79#define CONN_MANAGER 8
Jon Maloy75da2162017-10-13 11:04:23 +020080#define GROUP_PROTOCOL 9
Jon Paul Maloydff29b12015-04-02 09:33:01 -040081#define TUNNEL_PROTOCOL 10
Jon Paul Maloye3eea1e2015-03-13 16:08:11 -040082#define NAME_DISTRIBUTOR 11
83#define MSG_FRAGMENTER 12
84#define LINK_CONFIG 13
Tuong Lien1ef6f7c2020-09-18 08:17:28 +070085#define MSG_CRYPTO 14
Jon Paul Maloye3eea1e2015-03-13 16:08:11 -040086#define SOCK_WAKEUP 14 /* pseudo user */
Jon Maloy14c04492017-10-13 11:04:17 +020087#define TOP_SRV 15 /* pseudo user */
Jon Paul Maloye3eea1e2015-03-13 16:08:11 -040088
89/*
Allan Stephenscc4c4352011-04-08 10:50:52 -040090 * Message header sizes
91 */
Allan Stephens741d9eb2011-05-31 15:03:18 -040092#define SHORT_H_SIZE 24 /* In-cluster basic payload message */
93#define BASIC_H_SIZE 32 /* Basic payload message */
94#define NAMED_H_SIZE 40 /* Named payload message */
95#define MCAST_H_SIZE 44 /* Multicast payload message */
Jon Maloy75da2162017-10-13 11:04:23 +020096#define GROUP_H_SIZE 44 /* Group payload message */
Allan Stephens06d82c92008-03-06 15:06:55 -080097#define INT_H_SIZE 40 /* Internal messages */
98#define MIN_H_SIZE 24 /* Smallest legal TIPC header size */
99#define MAX_H_SIZE 60 /* Largest possible TIPC header size */
100
Per Lidenb97bf3f2006-01-02 19:04:38 +0100101#define MAX_MSG_SIZE (MAX_H_SIZE + TIPC_MAX_USER_MSG_SIZE)
Jon Maloy4c94cc22017-11-30 16:47:25 +0100102#define FB_MTU 3744
Erik Hugne91e2eb52015-02-27 08:56:57 +0100103#define TIPC_MEDIA_INFO_OFFSET 5
Allan Stephens3d749a62011-10-07 15:19:11 -0400104
Ying Xue859fc7c2015-01-09 15:27:01 +0800105struct tipc_skb_cb {
Tuong Lienfc1b6d62019-11-08 12:05:11 +0700106 union {
107 struct {
108 struct sk_buff *tail;
109 unsigned long nxt_retr;
110 unsigned long retr_stamp;
111 u32 bytes_read;
112 u32 orig_member;
113 u16 chain_imp;
114 u16 ackers;
115 u16 retr_cnt;
116 } __packed;
117#ifdef CONFIG_TIPC_CRYPTO
118 struct {
119 struct tipc_crypto *rx;
120 struct tipc_aead *last;
121 u8 recurs;
122 } tx_clone_ctx __packed;
123#endif
124 } __packed;
125 union {
126 struct {
127 u8 validated:1;
128#ifdef CONFIG_TIPC_CRYPTO
129 u8 encrypted:1;
130 u8 decrypted:1;
Tuong Liendaef1ee2020-09-18 08:17:27 +0700131#define SKB_PROBING 1
132#define SKB_GRACING 2
133 u8 xmit_type:2;
Tuong Lienfc1b6d62019-11-08 12:05:11 +0700134 u8 tx_clone_deferred:1;
135#endif
136 };
137 u8 flags;
138 };
139 u8 reserved;
140#ifdef CONFIG_TIPC_CRYPTO
141 void *crypto_ctx;
142#endif
143} __packed;
Ying Xue859fc7c2015-01-09 15:27:01 +0800144
145#define TIPC_SKB_CB(__skb) ((struct tipc_skb_cb *)&((__skb)->cb[0]))
146
Allan Stephensd265fef2010-11-30 12:00:53 +0000147struct tipc_msg {
148 __be32 hdr[15];
149};
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900150
Tuong Lien91959482019-04-04 11:09:51 +0700151/* struct tipc_gap_ack - TIPC Gap ACK block
152 * @ack: seqno of the last consecutive packet in link deferdq
153 * @gap: number of gap packets since the last ack
154 *
155 * E.g:
156 * link deferdq: 1 2 3 4 10 11 13 14 15 20
157 * --> Gap ACK blocks: <4, 5>, <11, 1>, <15, 4>, <20, 0>
158 */
159struct tipc_gap_ack {
160 __be16 ack;
161 __be16 gap;
162};
163
164/* struct tipc_gap_ack_blks
165 * @len: actual length of the record
Tuong Liend7626b52020-05-26 16:38:34 +0700166 * @ugack_cnt: number of Gap ACK blocks for unicast (following the broadcast
167 * ones)
168 * @start_index: starting index for "valid" broadcast Gap ACK blocks
169 * @bgack_cnt: number of Gap ACK blocks for broadcast in the record
Tuong Lien91959482019-04-04 11:09:51 +0700170 * @gacks: array of Gap ACK blocks
Tuong Liend7626b52020-05-26 16:38:34 +0700171 *
172 * 31 16 15 0
173 * +-------------+-------------+-------------+-------------+
174 * | bgack_cnt | ugack_cnt | len |
175 * +-------------+-------------+-------------+-------------+ -
176 * | gap | ack | |
177 * +-------------+-------------+-------------+-------------+ > bc gacks
178 * : : : |
179 * +-------------+-------------+-------------+-------------+ -
180 * | gap | ack | |
181 * +-------------+-------------+-------------+-------------+ > uc gacks
182 * : : : |
183 * +-------------+-------------+-------------+-------------+ -
Tuong Lien91959482019-04-04 11:09:51 +0700184 */
185struct tipc_gap_ack_blks {
186 __be16 len;
Tuong Liend7626b52020-05-26 16:38:34 +0700187 union {
188 u8 ugack_cnt;
189 u8 start_index;
190 };
191 u8 bgack_cnt;
Tuong Lien91959482019-04-04 11:09:51 +0700192 struct tipc_gap_ack gacks[];
193};
194
Tuong Liend7626b52020-05-26 16:38:34 +0700195#define MAX_GAP_ACK_BLKS 128
Gustavo A. R. Silvae034c6d2020-06-18 08:35:00 -0500196#define MAX_GAP_ACK_BLKS_SZ (sizeof(struct tipc_gap_ack_blks) + \
197 sizeof(struct tipc_gap_ack) * MAX_GAP_ACK_BLKS)
Tuong Lien91959482019-04-04 11:09:51 +0700198
Ying Xue859fc7c2015-01-09 15:27:01 +0800199static inline struct tipc_msg *buf_msg(struct sk_buff *skb)
200{
201 return (struct tipc_msg *)skb->data;
202}
203
Allan Stephensd265fef2010-11-30 12:00:53 +0000204static inline u32 msg_word(struct tipc_msg *m, u32 pos)
205{
206 return ntohl(m->hdr[pos]);
207}
Per Lidenb97bf3f2006-01-02 19:04:38 +0100208
209static inline void msg_set_word(struct tipc_msg *m, u32 w, u32 val)
210{
211 m->hdr[w] = htonl(val);
212}
213
Allan Stephensd265fef2010-11-30 12:00:53 +0000214static inline u32 msg_bits(struct tipc_msg *m, u32 w, u32 pos, u32 mask)
215{
216 return (msg_word(m, w) >> pos) & mask;
217}
218
Per Lidenb97bf3f2006-01-02 19:04:38 +0100219static inline void msg_set_bits(struct tipc_msg *m, u32 w,
220 u32 pos, u32 mask, u32 val)
221{
Allan Stephens1f9eda72007-04-24 14:51:55 -0700222 val = (val & mask) << pos;
Al Virobecf3da2008-04-26 22:42:14 -0700223 mask = mask << pos;
224 m->hdr[w] &= ~htonl(mask);
225 m->hdr[w] |= htonl(val);
Per Lidenb97bf3f2006-01-02 19:04:38 +0100226}
227
Allan Stephens40aecb12008-06-04 17:54:48 -0700228static inline void msg_swap_words(struct tipc_msg *msg, u32 a, u32 b)
229{
230 u32 temp = msg->hdr[a];
231
232 msg->hdr[a] = msg->hdr[b];
233 msg->hdr[b] = temp;
234}
235
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900236/*
Per Lidenb97bf3f2006-01-02 19:04:38 +0100237 * Word 0
238 */
Per Lidenb97bf3f2006-01-02 19:04:38 +0100239static inline u32 msg_version(struct tipc_msg *m)
240{
241 return msg_bits(m, 0, 29, 7);
242}
243
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900244static inline void msg_set_version(struct tipc_msg *m)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100245{
Allan Stephens37695422008-03-06 15:07:42 -0800246 msg_set_bits(m, 0, 29, 7, TIPC_VERSION);
Per Lidenb97bf3f2006-01-02 19:04:38 +0100247}
248
249static inline u32 msg_user(struct tipc_msg *m)
250{
251 return msg_bits(m, 0, 25, 0xf);
252}
253
254static inline u32 msg_isdata(struct tipc_msg *m)
255{
Eric Dumazeta02cec22010-09-22 20:43:57 +0000256 return msg_user(m) <= TIPC_CRITICAL_IMPORTANCE;
Per Lidenb97bf3f2006-01-02 19:04:38 +0100257}
258
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900259static inline void msg_set_user(struct tipc_msg *m, u32 n)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100260{
261 msg_set_bits(m, 0, 25, 0xf, n);
262}
263
Allan Stephensd265fef2010-11-30 12:00:53 +0000264static inline u32 msg_hdr_sz(struct tipc_msg *m)
265{
266 return msg_bits(m, 0, 21, 0xf) << 2;
267}
268
Allan Stephens0e659672010-12-31 18:59:32 +0000269static inline void msg_set_hdr_sz(struct tipc_msg *m, u32 n)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100270{
271 msg_set_bits(m, 0, 21, 0xf, n>>2);
272}
273
Allan Stephensd265fef2010-11-30 12:00:53 +0000274static inline u32 msg_size(struct tipc_msg *m)
275{
276 return msg_bits(m, 0, 0, 0x1ffff);
277}
278
Jon Maloy5b8dddb2017-10-13 11:04:29 +0200279static inline u32 msg_blocks(struct tipc_msg *m)
280{
281 return (msg_size(m) / 1024) + 1;
282}
283
Allan Stephensd265fef2010-11-30 12:00:53 +0000284static inline u32 msg_data_sz(struct tipc_msg *m)
285{
286 return msg_size(m) - msg_hdr_sz(m);
287}
288
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900289static inline int msg_non_seq(struct tipc_msg *m)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100290{
291 return msg_bits(m, 0, 20, 1);
292}
293
Allan Stephens40aecb12008-06-04 17:54:48 -0700294static inline void msg_set_non_seq(struct tipc_msg *m, u32 n)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100295{
Allan Stephens40aecb12008-06-04 17:54:48 -0700296 msg_set_bits(m, 0, 20, 1, n);
Per Lidenb97bf3f2006-01-02 19:04:38 +0100297}
298
Jon Maloy25b92212018-09-28 20:23:21 +0200299static inline int msg_is_syn(struct tipc_msg *m)
300{
301 return msg_bits(m, 0, 17, 1);
302}
303
304static inline void msg_set_syn(struct tipc_msg *m, u32 d)
305{
306 msg_set_bits(m, 0, 17, 1, d);
307}
308
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900309static inline int msg_dest_droppable(struct tipc_msg *m)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100310{
311 return msg_bits(m, 0, 19, 1);
312}
313
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900314static inline void msg_set_dest_droppable(struct tipc_msg *m, u32 d)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100315{
316 msg_set_bits(m, 0, 19, 1, d);
317}
318
Jon Maloy8d6e79d2017-11-08 09:59:26 +0100319static inline int msg_is_keepalive(struct tipc_msg *m)
320{
321 return msg_bits(m, 0, 19, 1);
322}
323
324static inline void msg_set_is_keepalive(struct tipc_msg *m, u32 d)
325{
326 msg_set_bits(m, 0, 19, 1, d);
327}
328
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900329static inline int msg_src_droppable(struct tipc_msg *m)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100330{
331 return msg_bits(m, 0, 18, 1);
332}
333
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900334static inline void msg_set_src_droppable(struct tipc_msg *m, u32 d)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100335{
336 msg_set_bits(m, 0, 18, 1, d);
337}
338
Jon Maloyc0bceb92019-10-30 14:00:41 +0100339static inline int msg_ack_required(struct tipc_msg *m)
340{
341 return msg_bits(m, 0, 18, 1);
342}
343
Tuong Lien0a3e0602020-05-26 16:38:38 +0700344static inline void msg_set_ack_required(struct tipc_msg *m)
Jon Maloyc0bceb92019-10-30 14:00:41 +0100345{
Tuong Lien0a3e0602020-05-26 16:38:38 +0700346 msg_set_bits(m, 0, 18, 1, 1);
347}
348
349static inline int msg_nagle_ack(struct tipc_msg *m)
350{
351 return msg_bits(m, 0, 18, 1);
352}
353
354static inline void msg_set_nagle_ack(struct tipc_msg *m)
355{
356 msg_set_bits(m, 0, 18, 1, 1);
Jon Maloyc0bceb92019-10-30 14:00:41 +0100357}
358
Hoang Lec55c8ed2019-03-19 18:49:50 +0700359static inline bool msg_is_rcast(struct tipc_msg *m)
360{
361 return msg_bits(m, 0, 18, 0x1);
362}
363
364static inline void msg_set_is_rcast(struct tipc_msg *m, bool d)
365{
366 msg_set_bits(m, 0, 18, 0x1, d);
367}
368
Per Lidenb97bf3f2006-01-02 19:04:38 +0100369static inline void msg_set_size(struct tipc_msg *m, u32 sz)
370{
371 m->hdr[0] = htonl((msg_word(m, 0) & ~0x1ffff) | sz);
372}
373
Jon Paul Maloy3127a022015-03-25 12:07:25 -0400374static inline unchar *msg_data(struct tipc_msg *m)
375{
376 return ((unchar *)m) + msg_hdr_sz(m);
377}
378
Jon Maloya7dc51a2019-06-25 19:37:00 +0200379static inline struct tipc_msg *msg_inner_hdr(struct tipc_msg *m)
Jon Paul Maloy3127a022015-03-25 12:07:25 -0400380{
381 return (struct tipc_msg *)msg_data(m);
382}
Per Lidenb97bf3f2006-01-02 19:04:38 +0100383
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900384/*
Per Lidenb97bf3f2006-01-02 19:04:38 +0100385 * Word 1
386 */
Allan Stephensd265fef2010-11-30 12:00:53 +0000387static inline u32 msg_type(struct tipc_msg *m)
388{
389 return msg_bits(m, 1, 29, 0x7);
390}
391
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900392static inline void msg_set_type(struct tipc_msg *m, u32 n)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100393{
394 msg_set_bits(m, 1, 29, 0x7, n);
395}
396
Jon Maloy75da2162017-10-13 11:04:23 +0200397static inline int msg_in_group(struct tipc_msg *m)
398{
Jon Maloyae236fb2017-10-13 11:04:25 +0200399 int mtyp = msg_type(m);
400
Jon Maloy27bd9ec2017-10-13 11:04:27 +0200401 return mtyp >= TIPC_GRP_MEMBER_EVT && mtyp <= TIPC_GRP_UCAST_MSG;
Jon Maloyae236fb2017-10-13 11:04:25 +0200402}
403
404static inline bool msg_is_grp_evt(struct tipc_msg *m)
405{
406 return msg_type(m) == TIPC_GRP_MEMBER_EVT;
Jon Maloy75da2162017-10-13 11:04:23 +0200407}
408
Allan Stephensd265fef2010-11-30 12:00:53 +0000409static inline u32 msg_named(struct tipc_msg *m)
410{
411 return msg_type(m) == TIPC_NAMED_MSG;
412}
413
414static inline u32 msg_mcast(struct tipc_msg *m)
415{
Jon Maloy75da2162017-10-13 11:04:23 +0200416 int mtyp = msg_type(m);
417
Jon Maloy5b8dddb2017-10-13 11:04:29 +0200418 return ((mtyp == TIPC_MCAST_MSG) || (mtyp == TIPC_GRP_BCAST_MSG) ||
419 (mtyp == TIPC_GRP_MCAST_MSG));
Allan Stephensd265fef2010-11-30 12:00:53 +0000420}
421
422static inline u32 msg_connected(struct tipc_msg *m)
423{
424 return msg_type(m) == TIPC_CONN_MSG;
425}
426
Hoang Le8b1e5b0a2020-03-26 09:50:29 +0700427static inline u32 msg_direct(struct tipc_msg *m)
428{
429 return msg_type(m) == TIPC_DIRECT_MSG;
430}
431
Allan Stephensd265fef2010-11-30 12:00:53 +0000432static inline u32 msg_errcode(struct tipc_msg *m)
433{
434 return msg_bits(m, 1, 25, 0xf);
435}
436
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900437static inline void msg_set_errcode(struct tipc_msg *m, u32 err)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100438{
439 msg_set_bits(m, 1, 25, 0xf, err);
440}
441
Hoang Huu Lecad29292020-06-17 13:56:05 +0700442static inline void msg_set_bulk(struct tipc_msg *m)
443{
444 msg_set_bits(m, 1, 28, 0x1, 1);
445}
446
447static inline u32 msg_is_bulk(struct tipc_msg *m)
448{
449 return msg_bits(m, 1, 28, 0x1);
450}
451
452static inline void msg_set_last_bulk(struct tipc_msg *m)
453{
454 msg_set_bits(m, 1, 27, 0x1, 1);
455}
456
457static inline u32 msg_is_last_bulk(struct tipc_msg *m)
458{
459 return msg_bits(m, 1, 27, 0x1);
460}
461
462static inline void msg_set_non_legacy(struct tipc_msg *m)
463{
464 msg_set_bits(m, 1, 26, 0x1, 1);
465}
466
467static inline u32 msg_is_legacy(struct tipc_msg *m)
468{
469 return !msg_bits(m, 1, 26, 0x1);
470}
471
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900472static inline u32 msg_reroute_cnt(struct tipc_msg *m)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100473{
474 return msg_bits(m, 1, 21, 0xf);
475}
476
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900477static inline void msg_incr_reroute_cnt(struct tipc_msg *m)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100478{
479 msg_set_bits(m, 1, 21, 0xf, msg_reroute_cnt(m) + 1);
480}
481
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900482static inline void msg_reset_reroute_cnt(struct tipc_msg *m)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100483{
484 msg_set_bits(m, 1, 21, 0xf, 0);
485}
486
487static inline u32 msg_lookup_scope(struct tipc_msg *m)
488{
489 return msg_bits(m, 1, 19, 0x3);
490}
491
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900492static inline void msg_set_lookup_scope(struct tipc_msg *m, u32 n)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100493{
494 msg_set_bits(m, 1, 19, 0x3, n);
495}
496
Jon Paul Maloye4bf4f72015-05-14 10:46:14 -0400497static inline u16 msg_bcast_ack(struct tipc_msg *m)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100498{
499 return msg_bits(m, 1, 0, 0xffff);
500}
501
Jon Paul Maloye4bf4f72015-05-14 10:46:14 -0400502static inline void msg_set_bcast_ack(struct tipc_msg *m, u16 n)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100503{
504 msg_set_bits(m, 1, 0, 0xffff, n);
505}
506
Tuong Lien91986ee2019-02-11 13:29:43 +0700507/* Note: reusing bits in word 1 for ACTIVATE_MSG only, to re-synch
508 * link peer session number
509 */
510static inline bool msg_dest_session_valid(struct tipc_msg *m)
511{
512 return msg_bits(m, 1, 16, 0x1);
513}
514
515static inline void msg_set_dest_session_valid(struct tipc_msg *m, bool valid)
516{
517 msg_set_bits(m, 1, 16, 0x1, valid);
518}
519
520static inline u16 msg_dest_session(struct tipc_msg *m)
521{
522 return msg_bits(m, 1, 0, 0xffff);
523}
524
525static inline void msg_set_dest_session(struct tipc_msg *m, u16 n)
526{
527 msg_set_bits(m, 1, 0, 0xffff, n);
528}
Per Lidenb97bf3f2006-01-02 19:04:38 +0100529
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900530/*
Per Lidenb97bf3f2006-01-02 19:04:38 +0100531 * Word 2
532 */
Jon Paul Maloye4bf4f72015-05-14 10:46:14 -0400533static inline u16 msg_ack(struct tipc_msg *m)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100534{
535 return msg_bits(m, 2, 16, 0xffff);
536}
537
Jon Paul Maloye4bf4f72015-05-14 10:46:14 -0400538static inline void msg_set_ack(struct tipc_msg *m, u16 n)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100539{
540 msg_set_bits(m, 2, 16, 0xffff, n);
541}
542
Jon Paul Maloye4bf4f72015-05-14 10:46:14 -0400543static inline u16 msg_seqno(struct tipc_msg *m)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100544{
545 return msg_bits(m, 2, 0, 0xffff);
546}
547
Jon Paul Maloye4bf4f72015-05-14 10:46:14 -0400548static inline void msg_set_seqno(struct tipc_msg *m, u16 n)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100549{
550 msg_set_bits(m, 2, 0, 0xffff, n);
551}
552
Allan Stephens40aecb12008-06-04 17:54:48 -0700553/*
Per Lidenb97bf3f2006-01-02 19:04:38 +0100554 * Words 3-10
555 */
Jon Paul Maloye3eea1e2015-03-13 16:08:11 -0400556static inline u32 msg_importance(struct tipc_msg *m)
557{
Jon Paul Maloyf21e8972015-05-14 10:46:17 -0400558 int usr = msg_user(m);
559
560 if (likely((usr <= TIPC_CRITICAL_IMPORTANCE) && !msg_errcode(m)))
561 return usr;
562 if ((usr == MSG_FRAGMENTER) || (usr == MSG_BUNDLER))
Jon Paul Maloydde4b5a2015-10-14 09:23:18 -0400563 return msg_bits(m, 9, 0, 0x7);
Jon Paul Maloye3eea1e2015-03-13 16:08:11 -0400564 return TIPC_SYSTEM_IMPORTANCE;
565}
566
567static inline void msg_set_importance(struct tipc_msg *m, u32 i)
568{
Jon Paul Maloyf21e8972015-05-14 10:46:17 -0400569 int usr = msg_user(m);
570
571 if (likely((usr == MSG_FRAGMENTER) || (usr == MSG_BUNDLER)))
Jon Paul Maloydde4b5a2015-10-14 09:23:18 -0400572 msg_set_bits(m, 9, 0, 0x7, i);
Jon Paul Maloyf21e8972015-05-14 10:46:17 -0400573 else if (i < TIPC_SYSTEM_IMPORTANCE)
Jon Paul Maloye3eea1e2015-03-13 16:08:11 -0400574 msg_set_user(m, i);
575 else
576 pr_warn("Trying to set illegal importance in message\n");
577}
578
Allan Stephensd265fef2010-11-30 12:00:53 +0000579static inline u32 msg_prevnode(struct tipc_msg *m)
580{
581 return msg_word(m, 3);
582}
583
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900584static inline void msg_set_prevnode(struct tipc_msg *m, u32 a)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100585{
586 msg_set_word(m, 3, a);
587}
588
Allan Stephensd265fef2010-11-30 12:00:53 +0000589static inline u32 msg_origport(struct tipc_msg *m)
590{
Jon Paul Maloy3127a022015-03-25 12:07:25 -0400591 if (msg_user(m) == MSG_FRAGMENTER)
Jon Maloya7dc51a2019-06-25 19:37:00 +0200592 m = msg_inner_hdr(m);
Allan Stephensd265fef2010-11-30 12:00:53 +0000593 return msg_word(m, 4);
594}
595
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900596static inline void msg_set_origport(struct tipc_msg *m, u32 p)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100597{
598 msg_set_word(m, 4, p);
599}
600
Hoang Huu Lecad29292020-06-17 13:56:05 +0700601static inline u16 msg_named_seqno(struct tipc_msg *m)
602{
603 return msg_bits(m, 4, 0, 0xffff);
604}
605
606static inline void msg_set_named_seqno(struct tipc_msg *m, u16 n)
607{
608 msg_set_bits(m, 4, 0, 0xffff, n);
609}
610
Allan Stephensd265fef2010-11-30 12:00:53 +0000611static inline u32 msg_destport(struct tipc_msg *m)
612{
613 return msg_word(m, 5);
614}
615
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900616static inline void msg_set_destport(struct tipc_msg *m, u32 p)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100617{
618 msg_set_word(m, 5, p);
619}
620
Allan Stephensd265fef2010-11-30 12:00:53 +0000621static inline u32 msg_mc_netid(struct tipc_msg *m)
622{
623 return msg_word(m, 5);
624}
625
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900626static inline void msg_set_mc_netid(struct tipc_msg *m, u32 p)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100627{
628 msg_set_word(m, 5, p);
629}
630
Allan Stephensd265fef2010-11-30 12:00:53 +0000631static inline int msg_short(struct tipc_msg *m)
632{
Allan Stephens741d9eb2011-05-31 15:03:18 -0400633 return msg_hdr_sz(m) == SHORT_H_SIZE;
Allan Stephensd265fef2010-11-30 12:00:53 +0000634}
635
636static inline u32 msg_orignode(struct tipc_msg *m)
637{
638 if (likely(msg_short(m)))
639 return msg_prevnode(m);
640 return msg_word(m, 6);
641}
642
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900643static inline void msg_set_orignode(struct tipc_msg *m, u32 a)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100644{
645 msg_set_word(m, 6, a);
646}
647
Allan Stephensd265fef2010-11-30 12:00:53 +0000648static inline u32 msg_destnode(struct tipc_msg *m)
649{
650 return msg_word(m, 7);
651}
652
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900653static inline void msg_set_destnode(struct tipc_msg *m, u32 a)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100654{
655 msg_set_word(m, 7, a);
656}
657
Allan Stephensd265fef2010-11-30 12:00:53 +0000658static inline u32 msg_nametype(struct tipc_msg *m)
659{
660 return msg_word(m, 8);
661}
662
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900663static inline void msg_set_nametype(struct tipc_msg *m, u32 n)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100664{
665 msg_set_word(m, 8, n);
666}
667
Allan Stephensd265fef2010-11-30 12:00:53 +0000668static inline u32 msg_nameinst(struct tipc_msg *m)
669{
670 return msg_word(m, 9);
671}
672
673static inline u32 msg_namelower(struct tipc_msg *m)
674{
675 return msg_nameinst(m);
676}
677
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900678static inline void msg_set_namelower(struct tipc_msg *m, u32 n)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100679{
680 msg_set_word(m, 9, n);
681}
682
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900683static inline void msg_set_nameinst(struct tipc_msg *m, u32 n)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100684{
685 msg_set_namelower(m, n);
686}
687
Allan Stephensd265fef2010-11-30 12:00:53 +0000688static inline u32 msg_nameupper(struct tipc_msg *m)
689{
690 return msg_word(m, 10);
691}
692
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900693static inline void msg_set_nameupper(struct tipc_msg *m, u32 n)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100694{
695 msg_set_word(m, 10, n);
696}
697
Per Lidenb97bf3f2006-01-02 19:04:38 +0100698/*
Allan Stephenscc4c4352011-04-08 10:50:52 -0400699 * Constants and routines used to read and write TIPC internal message headers
700 */
Per Lidenb97bf3f2006-01-02 19:04:38 +0100701
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900702/*
Allan Stephenscc4c4352011-04-08 10:50:52 -0400703 * Connection management protocol message types
Per Lidenb97bf3f2006-01-02 19:04:38 +0100704 */
Per Lidenb97bf3f2006-01-02 19:04:38 +0100705#define CONN_PROBE 0
706#define CONN_PROBE_REPLY 1
707#define CONN_ACK 2
708
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900709/*
Allan Stephenscc4c4352011-04-08 10:50:52 -0400710 * Name distributor message types
Per Lidenb97bf3f2006-01-02 19:04:38 +0100711 */
Per Lidenb97bf3f2006-01-02 19:04:38 +0100712#define PUBLICATION 0
713#define WITHDRAWAL 1
714
Allan Stephens92138d12011-04-08 11:04:15 -0400715/*
716 * Segmentation message types
717 */
Allan Stephens92138d12011-04-08 11:04:15 -0400718#define FIRST_FRAGMENT 0
719#define FRAGMENT 1
720#define LAST_FRAGMENT 2
721
722/*
723 * Link management protocol message types
724 */
Allan Stephens92138d12011-04-08 11:04:15 -0400725#define STATE_MSG 0
726#define RESET_MSG 1
727#define ACTIVATE_MSG 2
728
729/*
730 * Changeover tunnel message types
731 */
Jon Paul Maloydff29b12015-04-02 09:33:01 -0400732#define SYNCH_MSG 0
733#define FAILOVER_MSG 1
Allan Stephens92138d12011-04-08 11:04:15 -0400734
735/*
736 * Config protocol message types
737 */
Allan Stephens92138d12011-04-08 11:04:15 -0400738#define DSC_REQ_MSG 0
739#define DSC_RESP_MSG 1
Jon Maloy25b0b9c2018-03-22 20:42:51 +0100740#define DSC_TRIAL_MSG 2
741#define DSC_TRIAL_FAIL_MSG 3
Allan Stephens92138d12011-04-08 11:04:15 -0400742
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900743/*
Jon Maloy75da2162017-10-13 11:04:23 +0200744 * Group protocol message types
745 */
746#define GRP_JOIN_MSG 0
747#define GRP_LEAVE_MSG 1
Jon Maloyb7d42632017-10-13 11:04:26 +0200748#define GRP_ADV_MSG 2
Jon Maloy2f487712017-10-13 11:04:31 +0200749#define GRP_ACK_MSG 3
Jon Maloy04d7b572017-10-13 11:04:34 +0200750#define GRP_RECLAIM_MSG 4
751#define GRP_REMIT_MSG 5
Jon Maloy75da2162017-10-13 11:04:23 +0200752
Tuong Lien1ef6f7c2020-09-18 08:17:28 +0700753/* Crypto message types */
754#define KEY_DISTR_MSG 0
755
Jon Maloy75da2162017-10-13 11:04:23 +0200756/*
Per Lidenb97bf3f2006-01-02 19:04:38 +0100757 * Word 1
758 */
Per Lidenb97bf3f2006-01-02 19:04:38 +0100759static inline u32 msg_seq_gap(struct tipc_msg *m)
760{
Allan Stephensbd784532008-06-04 17:47:30 -0700761 return msg_bits(m, 1, 16, 0x1fff);
Per Lidenb97bf3f2006-01-02 19:04:38 +0100762}
763
764static inline void msg_set_seq_gap(struct tipc_msg *m, u32 n)
765{
Allan Stephensbd784532008-06-04 17:47:30 -0700766 msg_set_bits(m, 1, 16, 0x1fff, n);
Per Lidenb97bf3f2006-01-02 19:04:38 +0100767}
768
Allan Stephensfc0eea62011-10-28 16:26:41 -0400769static inline u32 msg_node_sig(struct tipc_msg *m)
770{
771 return msg_bits(m, 1, 0, 0xffff);
772}
773
774static inline void msg_set_node_sig(struct tipc_msg *m, u32 n)
775{
776 msg_set_bits(m, 1, 0, 0xffff, n);
777}
778
Jon Paul Maloy7764d6e2015-03-13 16:08:05 -0400779static inline u32 msg_node_capabilities(struct tipc_msg *m)
780{
781 return msg_bits(m, 1, 15, 0x1fff);
782}
783
784static inline void msg_set_node_capabilities(struct tipc_msg *m, u32 n)
785{
786 msg_set_bits(m, 1, 15, 0x1fff, n);
787}
788
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900789/*
Per Lidenb97bf3f2006-01-02 19:04:38 +0100790 * Word 2
791 */
Per Lidenb97bf3f2006-01-02 19:04:38 +0100792static inline u32 msg_dest_domain(struct tipc_msg *m)
793{
794 return msg_word(m, 2);
795}
796
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900797static inline void msg_set_dest_domain(struct tipc_msg *m, u32 n)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100798{
799 msg_set_word(m, 2, n);
800}
801
802static inline u32 msg_bcgap_after(struct tipc_msg *m)
803{
804 return msg_bits(m, 2, 16, 0xffff);
805}
806
807static inline void msg_set_bcgap_after(struct tipc_msg *m, u32 n)
808{
809 msg_set_bits(m, 2, 16, 0xffff, n);
810}
811
812static inline u32 msg_bcgap_to(struct tipc_msg *m)
813{
814 return msg_bits(m, 2, 0, 0xffff);
815}
816
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900817static inline void msg_set_bcgap_to(struct tipc_msg *m, u32 n)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100818{
819 msg_set_bits(m, 2, 0, 0xffff, n);
820}
821
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900822/*
Per Lidenb97bf3f2006-01-02 19:04:38 +0100823 * Word 4
824 */
Per Lidenb97bf3f2006-01-02 19:04:38 +0100825static inline u32 msg_last_bcast(struct tipc_msg *m)
826{
827 return msg_bits(m, 4, 16, 0xffff);
828}
829
Jon Paul Maloy52666982015-10-22 08:51:41 -0400830static inline u32 msg_bc_snd_nxt(struct tipc_msg *m)
831{
832 return msg_last_bcast(m) + 1;
833}
834
Per Lidenb97bf3f2006-01-02 19:04:38 +0100835static inline void msg_set_last_bcast(struct tipc_msg *m, u32 n)
836{
837 msg_set_bits(m, 4, 16, 0xffff, n);
838}
839
Tuong Lien2320bcd2019-07-24 08:56:12 +0700840static inline u32 msg_nof_fragms(struct tipc_msg *m)
841{
842 return msg_bits(m, 4, 0, 0xffff);
843}
844
845static inline void msg_set_nof_fragms(struct tipc_msg *m, u32 n)
846{
847 msg_set_bits(m, 4, 0, 0xffff, n);
848}
849
850static inline u32 msg_fragm_no(struct tipc_msg *m)
851{
852 return msg_bits(m, 4, 16, 0xffff);
853}
854
Per Lidenb97bf3f2006-01-02 19:04:38 +0100855static inline void msg_set_fragm_no(struct tipc_msg *m, u32 n)
856{
857 msg_set_bits(m, 4, 16, 0xffff, n);
858}
859
Jon Paul Maloy6e498152015-07-30 18:24:19 -0400860static inline u16 msg_next_sent(struct tipc_msg *m)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100861{
862 return msg_bits(m, 4, 0, 0xffff);
863}
864
Jon Paul Maloy6e498152015-07-30 18:24:19 -0400865static inline void msg_set_next_sent(struct tipc_msg *m, u16 n)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100866{
867 msg_set_bits(m, 4, 0, 0xffff, n);
868}
869
Per Lidenb97bf3f2006-01-02 19:04:38 +0100870static inline void msg_set_long_msgno(struct tipc_msg *m, u32 n)
871{
872 msg_set_bits(m, 4, 0, 0xffff, n);
873}
874
875static inline u32 msg_bc_netid(struct tipc_msg *m)
876{
877 return msg_word(m, 4);
878}
879
880static inline void msg_set_bc_netid(struct tipc_msg *m, u32 id)
881{
882 msg_set_word(m, 4, id);
883}
884
885static inline u32 msg_link_selector(struct tipc_msg *m)
886{
Jon Paul Maloya853e4c2017-01-18 13:50:52 -0500887 if (msg_user(m) == MSG_FRAGMENTER)
888 m = (void *)msg_data(m);
Per Lidenb97bf3f2006-01-02 19:04:38 +0100889 return msg_bits(m, 4, 0, 1);
890}
891
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900892/*
Per Lidenb97bf3f2006-01-02 19:04:38 +0100893 * Word 5
894 */
Jon Paul Maloyd9992972015-07-16 16:54:31 -0400895static inline u16 msg_session(struct tipc_msg *m)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100896{
897 return msg_bits(m, 5, 16, 0xffff);
898}
899
Jon Paul Maloyd9992972015-07-16 16:54:31 -0400900static inline void msg_set_session(struct tipc_msg *m, u16 n)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100901{
902 msg_set_bits(m, 5, 16, 0xffff, n);
903}
904
905static inline u32 msg_probe(struct tipc_msg *m)
906{
907 return msg_bits(m, 5, 0, 1);
908}
909
910static inline void msg_set_probe(struct tipc_msg *m, u32 val)
911{
Allan Stephens7eb878e2011-05-25 13:28:27 -0400912 msg_set_bits(m, 5, 0, 1, val);
Per Lidenb97bf3f2006-01-02 19:04:38 +0100913}
914
915static inline char msg_net_plane(struct tipc_msg *m)
916{
917 return msg_bits(m, 5, 1, 7) + 'A';
918}
919
920static inline void msg_set_net_plane(struct tipc_msg *m, char n)
921{
922 msg_set_bits(m, 5, 1, 7, (n - 'A'));
923}
924
925static inline u32 msg_linkprio(struct tipc_msg *m)
926{
927 return msg_bits(m, 5, 4, 0x1f);
928}
929
930static inline void msg_set_linkprio(struct tipc_msg *m, u32 n)
931{
932 msg_set_bits(m, 5, 4, 0x1f, n);
933}
934
935static inline u32 msg_bearer_id(struct tipc_msg *m)
936{
937 return msg_bits(m, 5, 9, 0x7);
938}
939
940static inline void msg_set_bearer_id(struct tipc_msg *m, u32 n)
941{
942 msg_set_bits(m, 5, 9, 0x7, n);
943}
944
945static inline u32 msg_redundant_link(struct tipc_msg *m)
946{
947 return msg_bits(m, 5, 12, 0x1);
948}
949
Allan Stephens77f167f2011-02-28 15:30:20 -0500950static inline void msg_set_redundant_link(struct tipc_msg *m, u32 r)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100951{
Allan Stephens77f167f2011-02-28 15:30:20 -0500952 msg_set_bits(m, 5, 12, 0x1, r);
Per Lidenb97bf3f2006-01-02 19:04:38 +0100953}
954
Jon Paul Maloy634696b2016-04-15 13:33:03 -0400955static inline u32 msg_peer_stopping(struct tipc_msg *m)
956{
957 return msg_bits(m, 5, 13, 0x1);
958}
959
960static inline void msg_set_peer_stopping(struct tipc_msg *m, u32 s)
961{
962 msg_set_bits(m, 5, 13, 0x1, s);
963}
964
Jon Paul Maloy06bd2b12016-10-27 18:51:55 -0400965static inline bool msg_bc_ack_invalid(struct tipc_msg *m)
966{
967 switch (msg_user(m)) {
968 case BCAST_PROTOCOL:
969 case NAME_DISTRIBUTOR:
970 case LINK_PROTOCOL:
971 return msg_bits(m, 5, 14, 0x1);
972 default:
973 return false;
974 }
975}
976
977static inline void msg_set_bc_ack_invalid(struct tipc_msg *m, bool invalid)
978{
979 msg_set_bits(m, 5, 14, 0x1, invalid);
980}
981
Allan Stephens3d749a62011-10-07 15:19:11 -0400982static inline char *msg_media_addr(struct tipc_msg *m)
983{
Erik Hugne91e2eb52015-02-27 08:56:57 +0100984 return (char *)&m->hdr[TIPC_MEDIA_INFO_OFFSET];
Allan Stephens3d749a62011-10-07 15:19:11 -0400985}
Per Lidenb97bf3f2006-01-02 19:04:38 +0100986
Jon Paul Maloy02d11ca2016-09-01 13:52:49 -0400987static inline u32 msg_bc_gap(struct tipc_msg *m)
988{
989 return msg_bits(m, 8, 0, 0x3ff);
990}
991
992static inline void msg_set_bc_gap(struct tipc_msg *m, u32 n)
993{
994 msg_set_bits(m, 8, 0, 0x3ff, n);
995}
996
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900997/*
Per Lidenb97bf3f2006-01-02 19:04:38 +0100998 * Word 9
999 */
Jon Paul Maloy6e498152015-07-30 18:24:19 -04001000static inline u16 msg_msgcnt(struct tipc_msg *m)
Per Lidenb97bf3f2006-01-02 19:04:38 +01001001{
1002 return msg_bits(m, 9, 16, 0xffff);
1003}
1004
Jon Paul Maloy6e498152015-07-30 18:24:19 -04001005static inline void msg_set_msgcnt(struct tipc_msg *m, u16 n)
Per Lidenb97bf3f2006-01-02 19:04:38 +01001006{
1007 msg_set_bits(m, 9, 16, 0xffff, n);
1008}
1009
Tuong Lien4929a932019-07-24 08:56:11 +07001010static inline u16 msg_syncpt(struct tipc_msg *m)
1011{
1012 return msg_bits(m, 9, 16, 0xffff);
1013}
1014
1015static inline void msg_set_syncpt(struct tipc_msg *m, u16 n)
1016{
1017 msg_set_bits(m, 9, 16, 0xffff, n);
1018}
1019
Jon Paul Maloy10724cc2016-05-02 11:58:47 -04001020static inline u32 msg_conn_ack(struct tipc_msg *m)
Per Lidenb97bf3f2006-01-02 19:04:38 +01001021{
1022 return msg_bits(m, 9, 16, 0xffff);
1023}
1024
Jon Paul Maloy10724cc2016-05-02 11:58:47 -04001025static inline void msg_set_conn_ack(struct tipc_msg *m, u32 n)
Per Lidenb97bf3f2006-01-02 19:04:38 +01001026{
1027 msg_set_bits(m, 9, 16, 0xffff, n);
1028}
1029
Jon Maloyb7d42632017-10-13 11:04:26 +02001030static inline u16 msg_adv_win(struct tipc_msg *m)
Jon Paul Maloy10724cc2016-05-02 11:58:47 -04001031{
1032 return msg_bits(m, 9, 0, 0xffff);
1033}
1034
Jon Maloyb7d42632017-10-13 11:04:26 +02001035static inline void msg_set_adv_win(struct tipc_msg *m, u16 n)
Jon Paul Maloy10724cc2016-05-02 11:58:47 -04001036{
1037 msg_set_bits(m, 9, 0, 0xffff, n);
1038}
1039
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +09001040static inline u32 msg_max_pkt(struct tipc_msg *m)
Per Lidenb97bf3f2006-01-02 19:04:38 +01001041{
Eric Dumazeta02cec22010-09-22 20:43:57 +00001042 return msg_bits(m, 9, 16, 0xffff) * 4;
Per Lidenb97bf3f2006-01-02 19:04:38 +01001043}
1044
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +09001045static inline void msg_set_max_pkt(struct tipc_msg *m, u32 n)
Per Lidenb97bf3f2006-01-02 19:04:38 +01001046{
1047 msg_set_bits(m, 9, 16, 0xffff, (n / 4));
1048}
1049
1050static inline u32 msg_link_tolerance(struct tipc_msg *m)
1051{
1052 return msg_bits(m, 9, 0, 0xffff);
1053}
1054
1055static inline void msg_set_link_tolerance(struct tipc_msg *m, u32 n)
1056{
1057 msg_set_bits(m, 9, 0, 0xffff, n);
1058}
1059
Jon Maloy75da2162017-10-13 11:04:23 +02001060static inline u16 msg_grp_bc_syncpt(struct tipc_msg *m)
1061{
1062 return msg_bits(m, 9, 16, 0xffff);
1063}
1064
1065static inline void msg_set_grp_bc_syncpt(struct tipc_msg *m, u16 n)
1066{
1067 msg_set_bits(m, 9, 16, 0xffff, n);
1068}
1069
Jon Maloy2f487712017-10-13 11:04:31 +02001070static inline u16 msg_grp_bc_acked(struct tipc_msg *m)
1071{
1072 return msg_bits(m, 9, 16, 0xffff);
1073}
1074
1075static inline void msg_set_grp_bc_acked(struct tipc_msg *m, u16 n)
1076{
1077 msg_set_bits(m, 9, 16, 0xffff, n);
1078}
1079
Jon Maloy04d7b572017-10-13 11:04:34 +02001080static inline u16 msg_grp_remitted(struct tipc_msg *m)
1081{
1082 return msg_bits(m, 9, 16, 0xffff);
1083}
1084
1085static inline void msg_set_grp_remitted(struct tipc_msg *m, u16 n)
1086{
1087 msg_set_bits(m, 9, 16, 0xffff, n);
1088}
1089
Jon Maloy75da2162017-10-13 11:04:23 +02001090/* Word 10
1091 */
Jon Maloyae236fb2017-10-13 11:04:25 +02001092static inline u16 msg_grp_evt(struct tipc_msg *m)
1093{
1094 return msg_bits(m, 10, 0, 0x3);
1095}
1096
1097static inline void msg_set_grp_evt(struct tipc_msg *m, int n)
1098{
1099 msg_set_bits(m, 10, 0, 0x3, n);
1100}
1101
Jon Maloy2f487712017-10-13 11:04:31 +02001102static inline u16 msg_grp_bc_ack_req(struct tipc_msg *m)
1103{
1104 return msg_bits(m, 10, 0, 0x1);
1105}
1106
1107static inline void msg_set_grp_bc_ack_req(struct tipc_msg *m, bool n)
1108{
1109 msg_set_bits(m, 10, 0, 0x1, n);
1110}
1111
Jon Maloy75da2162017-10-13 11:04:23 +02001112static inline u16 msg_grp_bc_seqno(struct tipc_msg *m)
1113{
1114 return msg_bits(m, 10, 16, 0xffff);
1115}
1116
1117static inline void msg_set_grp_bc_seqno(struct tipc_msg *m, u32 n)
1118{
1119 msg_set_bits(m, 10, 16, 0xffff, n);
1120}
1121
Jon Paul Maloy6e498152015-07-30 18:24:19 -04001122static inline bool msg_peer_link_is_up(struct tipc_msg *m)
Jon Paul Maloyd9992972015-07-16 16:54:31 -04001123{
1124 if (likely(msg_user(m) != LINK_PROTOCOL))
1125 return true;
Jon Paul Maloy6e498152015-07-30 18:24:19 -04001126 if (msg_type(m) == STATE_MSG)
1127 return true;
1128 return false;
Jon Paul Maloyd9992972015-07-16 16:54:31 -04001129}
1130
Jon Paul Maloy6e498152015-07-30 18:24:19 -04001131static inline bool msg_peer_node_is_up(struct tipc_msg *m)
Jon Paul Maloy1a20cc22015-07-16 16:54:30 -04001132{
Jon Paul Maloy6e498152015-07-30 18:24:19 -04001133 if (msg_peer_link_is_up(m))
1134 return true;
Jon Paul Maloy1a20cc22015-07-16 16:54:30 -04001135 return msg_redundant_link(m);
1136}
1137
Jon Paul Maloy5b7066c2016-04-07 10:09:14 -04001138static inline bool msg_is_reset(struct tipc_msg *hdr)
1139{
1140 return (msg_user(hdr) == LINK_PROTOCOL) && (msg_type(hdr) == RESET_MSG);
1141}
1142
Hoang Lef73b1282019-10-29 07:51:21 +07001143/* Word 13
1144 */
1145static inline void msg_set_peer_net_hash(struct tipc_msg *m, u32 n)
1146{
1147 msg_set_word(m, 13, n);
1148}
1149
1150static inline u32 msg_peer_net_hash(struct tipc_msg *m)
1151{
1152 return msg_word(m, 13);
1153}
1154
1155/* Word 14
1156 */
Jon Maloy25b0b9c2018-03-22 20:42:51 +01001157static inline u32 msg_sugg_node_addr(struct tipc_msg *m)
1158{
1159 return msg_word(m, 14);
1160}
1161
1162static inline void msg_set_sugg_node_addr(struct tipc_msg *m, u32 n)
1163{
1164 msg_set_word(m, 14, n);
1165}
1166
1167static inline void msg_set_node_id(struct tipc_msg *hdr, u8 *id)
1168{
1169 memcpy(msg_data(hdr), id, 16);
1170}
1171
1172static inline u8 *msg_node_id(struct tipc_msg *hdr)
1173{
1174 return (u8 *)msg_data(hdr);
1175}
1176
Parthasarathy Bhuvaragan57d5f642017-01-13 15:46:25 +01001177struct sk_buff *tipc_buf_acquire(u32 size, gfp_t gfp);
Jon Maloyd618d092017-11-15 21:23:56 +01001178bool tipc_msg_validate(struct sk_buff **_skb);
Jon Paul Maloybcd3ffd2015-07-22 10:11:19 -04001179bool tipc_msg_reverse(u32 own_addr, struct sk_buff **skb, int err);
Jon Maloy64ac5f52017-10-13 11:04:20 +02001180void tipc_skb_reject(struct net *net, int err, struct sk_buff *skb,
1181 struct sk_buff_head *xmitq);
Jon Paul Maloyc5898632015-02-05 08:36:36 -05001182void tipc_msg_init(u32 own_addr, struct tipc_msg *m, u32 user, u32 type,
Ying Xue34747532015-01-09 15:27:10 +08001183 u32 hsize, u32 destnode);
Jon Paul Maloye3a77562015-02-05 08:36:39 -05001184struct sk_buff *tipc_msg_create(uint user, uint type, uint hdr_sz,
1185 uint data_sz, u32 dnode, u32 onode,
1186 u32 dport, u32 oport, int errcode);
Jon Paul Maloy37e22162014-05-14 05:39:12 -04001187int tipc_buf_append(struct sk_buff **headbuf, struct sk_buff **buf);
Tuong Lien06e7c702019-11-01 09:58:57 +07001188bool tipc_msg_try_bundle(struct sk_buff *tskb, struct sk_buff **skb, u32 mss,
1189 u32 dnode, bool *new_bundle);
Jon Paul Maloyc637c102015-02-05 08:36:41 -05001190bool tipc_msg_extract(struct sk_buff *skb, struct sk_buff **iskb, int *pos);
Tuong Lien2320bcd2019-07-24 08:56:12 +07001191int tipc_msg_fragment(struct sk_buff *skb, const struct tipc_msg *hdr,
1192 int pktmax, struct sk_buff_head *frags);
Jon Paul Maloyc5898632015-02-05 08:36:36 -05001193int tipc_msg_build(struct tipc_msg *mhdr, struct msghdr *m,
Ying Xue34747532015-01-09 15:27:10 +08001194 int offset, int dsz, int mtu, struct sk_buff_head *list);
Jon Maloyc0bceb92019-10-30 14:00:41 +01001195int tipc_msg_append(struct tipc_msg *hdr, struct msghdr *m, int dlen,
1196 int mss, struct sk_buff_head *txq);
Jon Paul Maloycda36962015-07-22 10:11:20 -04001197bool tipc_msg_lookup_dest(struct net *net, struct sk_buff *skb, int *err);
Jon Maloy4c94cc22017-11-30 16:47:25 +01001198bool tipc_msg_assemble(struct sk_buff_head *list);
Jon Paul Maloy2f566122015-10-22 08:51:39 -04001199bool tipc_msg_reassemble(struct sk_buff_head *list, struct sk_buff_head *rcvq);
Jon Paul Maloya853e4c2017-01-18 13:50:52 -05001200bool tipc_msg_pskb_copy(u32 dst, struct sk_buff_head *msg,
1201 struct sk_buff_head *cpy);
Tuong Lien03b6fef2020-05-26 16:38:37 +07001202bool __tipc_skb_queue_sorted(struct sk_buff_head *list, u16 seqno,
Jon Paul Maloy8306f992015-10-15 14:52:43 -04001203 struct sk_buff *skb);
Tung Nguyen67879272018-09-28 20:23:22 +02001204bool tipc_msg_skb_clone(struct sk_buff_head *msg, struct sk_buff_head *cpy);
Jon Paul Maloy078bec82014-07-16 20:41:00 -04001205
Jon Paul Maloye4bf4f72015-05-14 10:46:14 -04001206static inline u16 buf_seqno(struct sk_buff *skb)
1207{
1208 return msg_seqno(buf_msg(skb));
1209}
1210
Jon Maloyd618d092017-11-15 21:23:56 +01001211static inline int buf_roundup_len(struct sk_buff *skb)
1212{
1213 return (skb->len / 1024 + 1) * 1024;
1214}
1215
Jon Paul Maloycb1b7282015-02-05 08:36:44 -05001216/* tipc_skb_peek(): peek and reserve first buffer in list
1217 * @list: list to be peeked in
1218 * Returns pointer to first buffer in list, if any
1219 */
1220static inline struct sk_buff *tipc_skb_peek(struct sk_buff_head *list,
1221 spinlock_t *lock)
1222{
1223 struct sk_buff *skb;
1224
1225 spin_lock_bh(lock);
1226 skb = skb_peek(list);
1227 if (skb)
1228 skb_get(skb);
1229 spin_unlock_bh(lock);
1230 return skb;
1231}
1232
Jon Paul Maloyc637c102015-02-05 08:36:41 -05001233/* tipc_skb_peek_port(): find a destination port, ignoring all destinations
1234 * up to and including 'filter'.
1235 * Note: ignoring previously tried destinations minimizes the risk of
1236 * contention on the socket lock
1237 * @list: list to be peeked in
1238 * @filter: last destination to be ignored from search
1239 * Returns a destination port number, of applicable.
1240 */
1241static inline u32 tipc_skb_peek_port(struct sk_buff_head *list, u32 filter)
1242{
1243 struct sk_buff *skb;
1244 u32 dport = 0;
1245 bool ignore = true;
1246
1247 spin_lock_bh(&list->lock);
1248 skb_queue_walk(list, skb) {
1249 dport = msg_destport(buf_msg(skb));
1250 if (!filter || skb_queue_is_last(list, skb))
1251 break;
1252 if (dport == filter)
1253 ignore = false;
1254 else if (!ignore)
1255 break;
1256 }
1257 spin_unlock_bh(&list->lock);
1258 return dport;
1259}
1260
1261/* tipc_skb_dequeue(): unlink first buffer with dest 'dport' from list
1262 * @list: list to be unlinked from
1263 * @dport: selection criteria for buffer to unlink
1264 */
1265static inline struct sk_buff *tipc_skb_dequeue(struct sk_buff_head *list,
1266 u32 dport)
1267{
1268 struct sk_buff *_skb, *tmp, *skb = NULL;
1269
1270 spin_lock_bh(&list->lock);
1271 skb_queue_walk_safe(list, _skb, tmp) {
1272 if (msg_destport(buf_msg(_skb)) == dport) {
1273 __skb_unlink(_skb, list);
1274 skb = _skb;
1275 break;
1276 }
1277 }
1278 spin_unlock_bh(&list->lock);
1279 return skb;
1280}
1281
Jon Paul Maloy598411d2015-07-30 18:24:23 -04001282/* tipc_skb_queue_splice_tail - append an skb list to lock protected list
1283 * @list: the new list to append. Not lock protected
1284 * @head: target list. Lock protected.
1285 */
1286static inline void tipc_skb_queue_splice_tail(struct sk_buff_head *list,
1287 struct sk_buff_head *head)
1288{
1289 spin_lock_bh(&head->lock);
1290 skb_queue_splice_tail(list, head);
1291 spin_unlock_bh(&head->lock);
1292}
1293
1294/* tipc_skb_queue_splice_tail_init - merge two lock protected skb lists
1295 * @list: the new list to add. Lock protected. Will be reinitialized
1296 * @head: target list. Lock protected.
1297 */
1298static inline void tipc_skb_queue_splice_tail_init(struct sk_buff_head *list,
1299 struct sk_buff_head *head)
1300{
1301 struct sk_buff_head tmp;
1302
1303 __skb_queue_head_init(&tmp);
1304
1305 spin_lock_bh(&list->lock);
1306 skb_queue_splice_tail_init(list, &tmp);
1307 spin_unlock_bh(&list->lock);
1308 tipc_skb_queue_splice_tail(&tmp, head);
1309}
1310
Tuong Lien382f5982019-04-04 11:09:52 +07001311/* __tipc_skb_dequeue() - dequeue the head skb according to expected seqno
1312 * @list: list to be dequeued from
1313 * @seqno: seqno of the expected msg
1314 *
1315 * returns skb dequeued from the list if its seqno is less than or equal to
1316 * the expected one, otherwise the skb is still hold
1317 *
1318 * Note: must be used with appropriate locks held only
1319 */
1320static inline struct sk_buff *__tipc_skb_dequeue(struct sk_buff_head *list,
1321 u16 seqno)
1322{
1323 struct sk_buff *skb = skb_peek(list);
1324
1325 if (skb && less_eq(buf_seqno(skb), seqno)) {
1326 __skb_unlink(skb, list);
1327 return skb;
1328 }
1329 return NULL;
1330}
1331
Per Lidenb97bf3f2006-01-02 19:04:38 +01001332#endif