blob: c1cc8d7a5d52b7cdb5963e1ab70323398faf0a14 [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 Paul Maloy37e22162014-05-14 05:39:12 -04004 * Copyright (c) 2000-2007, 2014, 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>
Per Lidenb97bf3f2006-01-02 19:04:38 +010041
Allan Stephenscc4c4352011-04-08 10:50:52 -040042/*
43 * Constants and routines used to read and write TIPC payload message headers
44 *
45 * Note: Some items are also used with TIPC internal message headers
46 */
Per Lidenb97bf3f2006-01-02 19:04:38 +010047#define TIPC_VERSION 2
Jon Paul Maloyc637c102015-02-05 08:36:41 -050048struct plist;
Allan Stephens06d82c92008-03-06 15:06:55 -080049
Allan Stephensd265fef2010-11-30 12:00:53 +000050/*
Allan Stephenscc4c4352011-04-08 10:50:52 -040051 * Payload message users are defined in TIPC's public API:
52 * - TIPC_LOW_IMPORTANCE
53 * - TIPC_MEDIUM_IMPORTANCE
54 * - TIPC_HIGH_IMPORTANCE
55 * - TIPC_CRITICAL_IMPORTANCE
56 */
57
58/*
59 * Payload message types
Allan Stephensd265fef2010-11-30 12:00:53 +000060 */
Allan Stephensd265fef2010-11-30 12:00:53 +000061#define TIPC_CONN_MSG 0
62#define TIPC_MCAST_MSG 1
63#define TIPC_NAMED_MSG 2
64#define TIPC_DIRECT_MSG 3
65
Allan Stephenscc4c4352011-04-08 10:50:52 -040066/*
67 * Message header sizes
68 */
Allan Stephens741d9eb2011-05-31 15:03:18 -040069#define SHORT_H_SIZE 24 /* In-cluster basic payload message */
70#define BASIC_H_SIZE 32 /* Basic payload message */
71#define NAMED_H_SIZE 40 /* Named payload message */
72#define MCAST_H_SIZE 44 /* Multicast payload message */
Allan Stephens06d82c92008-03-06 15:06:55 -080073#define INT_H_SIZE 40 /* Internal messages */
74#define MIN_H_SIZE 24 /* Smallest legal TIPC header size */
75#define MAX_H_SIZE 60 /* Largest possible TIPC header size */
76
Per Lidenb97bf3f2006-01-02 19:04:38 +010077#define MAX_MSG_SIZE (MAX_H_SIZE + TIPC_MAX_USER_MSG_SIZE)
Per Lidenb97bf3f2006-01-02 19:04:38 +010078
Erik Hugne91e2eb52015-02-27 08:56:57 +010079#define TIPC_MEDIA_INFO_OFFSET 5
Allan Stephens3d749a62011-10-07 15:19:11 -040080
Ying Xue859fc7c2015-01-09 15:27:01 +080081/**
82 * TIPC message buffer code
83 *
84 * TIPC message buffer headroom reserves space for the worst-case
85 * link-level device header (in case the message is sent off-node).
86 *
87 * Note: Headroom should be a multiple of 4 to ensure the TIPC header fields
88 * are word aligned for quicker access
89 */
90#define BUF_HEADROOM LL_MAX_HEADER
91
92struct tipc_skb_cb {
93 void *handle;
94 struct sk_buff *tail;
95 bool deferred;
96 bool wakeup_pending;
97 bool bundling;
98 u16 chain_sz;
99 u16 chain_imp;
100};
101
102#define TIPC_SKB_CB(__skb) ((struct tipc_skb_cb *)&((__skb)->cb[0]))
103
Allan Stephensd265fef2010-11-30 12:00:53 +0000104struct tipc_msg {
105 __be32 hdr[15];
106};
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900107
Ying Xue859fc7c2015-01-09 15:27:01 +0800108static inline struct tipc_msg *buf_msg(struct sk_buff *skb)
109{
110 return (struct tipc_msg *)skb->data;
111}
112
Allan Stephensd265fef2010-11-30 12:00:53 +0000113static inline u32 msg_word(struct tipc_msg *m, u32 pos)
114{
115 return ntohl(m->hdr[pos]);
116}
Per Lidenb97bf3f2006-01-02 19:04:38 +0100117
118static inline void msg_set_word(struct tipc_msg *m, u32 w, u32 val)
119{
120 m->hdr[w] = htonl(val);
121}
122
Allan Stephensd265fef2010-11-30 12:00:53 +0000123static inline u32 msg_bits(struct tipc_msg *m, u32 w, u32 pos, u32 mask)
124{
125 return (msg_word(m, w) >> pos) & mask;
126}
127
Per Lidenb97bf3f2006-01-02 19:04:38 +0100128static inline void msg_set_bits(struct tipc_msg *m, u32 w,
129 u32 pos, u32 mask, u32 val)
130{
Allan Stephens1f9eda72007-04-24 14:51:55 -0700131 val = (val & mask) << pos;
Al Virobecf3da2008-04-26 22:42:14 -0700132 mask = mask << pos;
133 m->hdr[w] &= ~htonl(mask);
134 m->hdr[w] |= htonl(val);
Per Lidenb97bf3f2006-01-02 19:04:38 +0100135}
136
Allan Stephens40aecb12008-06-04 17:54:48 -0700137static inline void msg_swap_words(struct tipc_msg *msg, u32 a, u32 b)
138{
139 u32 temp = msg->hdr[a];
140
141 msg->hdr[a] = msg->hdr[b];
142 msg->hdr[b] = temp;
143}
144
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900145/*
Per Lidenb97bf3f2006-01-02 19:04:38 +0100146 * Word 0
147 */
Per Lidenb97bf3f2006-01-02 19:04:38 +0100148static inline u32 msg_version(struct tipc_msg *m)
149{
150 return msg_bits(m, 0, 29, 7);
151}
152
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900153static inline void msg_set_version(struct tipc_msg *m)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100154{
Allan Stephens37695422008-03-06 15:07:42 -0800155 msg_set_bits(m, 0, 29, 7, TIPC_VERSION);
Per Lidenb97bf3f2006-01-02 19:04:38 +0100156}
157
158static inline u32 msg_user(struct tipc_msg *m)
159{
160 return msg_bits(m, 0, 25, 0xf);
161}
162
163static inline u32 msg_isdata(struct tipc_msg *m)
164{
Eric Dumazeta02cec22010-09-22 20:43:57 +0000165 return msg_user(m) <= TIPC_CRITICAL_IMPORTANCE;
Per Lidenb97bf3f2006-01-02 19:04:38 +0100166}
167
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900168static inline void msg_set_user(struct tipc_msg *m, u32 n)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100169{
170 msg_set_bits(m, 0, 25, 0xf, n);
171}
172
Allan Stephensd265fef2010-11-30 12:00:53 +0000173static inline u32 msg_importance(struct tipc_msg *m)
174{
175 return msg_bits(m, 0, 25, 0xf);
176}
177
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900178static inline void msg_set_importance(struct tipc_msg *m, u32 i)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100179{
180 msg_set_user(m, i);
181}
182
Allan Stephensd265fef2010-11-30 12:00:53 +0000183static inline u32 msg_hdr_sz(struct tipc_msg *m)
184{
185 return msg_bits(m, 0, 21, 0xf) << 2;
186}
187
Allan Stephens0e659672010-12-31 18:59:32 +0000188static inline void msg_set_hdr_sz(struct tipc_msg *m, u32 n)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100189{
190 msg_set_bits(m, 0, 21, 0xf, n>>2);
191}
192
Allan Stephensd265fef2010-11-30 12:00:53 +0000193static inline u32 msg_size(struct tipc_msg *m)
194{
195 return msg_bits(m, 0, 0, 0x1ffff);
196}
197
198static inline u32 msg_data_sz(struct tipc_msg *m)
199{
200 return msg_size(m) - msg_hdr_sz(m);
201}
202
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900203static inline int msg_non_seq(struct tipc_msg *m)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100204{
205 return msg_bits(m, 0, 20, 1);
206}
207
Allan Stephens40aecb12008-06-04 17:54:48 -0700208static inline void msg_set_non_seq(struct tipc_msg *m, u32 n)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100209{
Allan Stephens40aecb12008-06-04 17:54:48 -0700210 msg_set_bits(m, 0, 20, 1, n);
Per Lidenb97bf3f2006-01-02 19:04:38 +0100211}
212
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900213static inline int msg_dest_droppable(struct tipc_msg *m)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100214{
215 return msg_bits(m, 0, 19, 1);
216}
217
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900218static inline void msg_set_dest_droppable(struct tipc_msg *m, u32 d)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100219{
220 msg_set_bits(m, 0, 19, 1, d);
221}
222
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900223static inline int msg_src_droppable(struct tipc_msg *m)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100224{
225 return msg_bits(m, 0, 18, 1);
226}
227
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900228static inline void msg_set_src_droppable(struct tipc_msg *m, u32 d)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100229{
230 msg_set_bits(m, 0, 18, 1, d);
231}
232
233static inline void msg_set_size(struct tipc_msg *m, u32 sz)
234{
235 m->hdr[0] = htonl((msg_word(m, 0) & ~0x1ffff) | sz);
236}
237
238
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900239/*
Per Lidenb97bf3f2006-01-02 19:04:38 +0100240 * Word 1
241 */
Allan Stephensd265fef2010-11-30 12:00:53 +0000242static inline u32 msg_type(struct tipc_msg *m)
243{
244 return msg_bits(m, 1, 29, 0x7);
245}
246
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900247static inline void msg_set_type(struct tipc_msg *m, u32 n)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100248{
249 msg_set_bits(m, 1, 29, 0x7, n);
250}
251
Allan Stephensd265fef2010-11-30 12:00:53 +0000252static inline u32 msg_named(struct tipc_msg *m)
253{
254 return msg_type(m) == TIPC_NAMED_MSG;
255}
256
257static inline u32 msg_mcast(struct tipc_msg *m)
258{
259 return msg_type(m) == TIPC_MCAST_MSG;
260}
261
262static inline u32 msg_connected(struct tipc_msg *m)
263{
264 return msg_type(m) == TIPC_CONN_MSG;
265}
266
267static inline u32 msg_errcode(struct tipc_msg *m)
268{
269 return msg_bits(m, 1, 25, 0xf);
270}
271
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900272static inline void msg_set_errcode(struct tipc_msg *m, u32 err)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100273{
274 msg_set_bits(m, 1, 25, 0xf, err);
275}
276
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900277static inline u32 msg_reroute_cnt(struct tipc_msg *m)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100278{
279 return msg_bits(m, 1, 21, 0xf);
280}
281
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900282static inline void msg_incr_reroute_cnt(struct tipc_msg *m)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100283{
284 msg_set_bits(m, 1, 21, 0xf, msg_reroute_cnt(m) + 1);
285}
286
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900287static inline void msg_reset_reroute_cnt(struct tipc_msg *m)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100288{
289 msg_set_bits(m, 1, 21, 0xf, 0);
290}
291
292static inline u32 msg_lookup_scope(struct tipc_msg *m)
293{
294 return msg_bits(m, 1, 19, 0x3);
295}
296
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900297static inline void msg_set_lookup_scope(struct tipc_msg *m, u32 n)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100298{
299 msg_set_bits(m, 1, 19, 0x3, n);
300}
301
Per Lidenb97bf3f2006-01-02 19:04:38 +0100302static inline u32 msg_bcast_ack(struct tipc_msg *m)
303{
304 return msg_bits(m, 1, 0, 0xffff);
305}
306
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900307static inline void msg_set_bcast_ack(struct tipc_msg *m, u32 n)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100308{
309 msg_set_bits(m, 1, 0, 0xffff, n);
310}
311
312
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900313/*
Per Lidenb97bf3f2006-01-02 19:04:38 +0100314 * Word 2
315 */
Per Lidenb97bf3f2006-01-02 19:04:38 +0100316static inline u32 msg_ack(struct tipc_msg *m)
317{
318 return msg_bits(m, 2, 16, 0xffff);
319}
320
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900321static inline void msg_set_ack(struct tipc_msg *m, u32 n)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100322{
323 msg_set_bits(m, 2, 16, 0xffff, n);
324}
325
326static inline u32 msg_seqno(struct tipc_msg *m)
327{
328 return msg_bits(m, 2, 0, 0xffff);
329}
330
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900331static inline void msg_set_seqno(struct tipc_msg *m, u32 n)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100332{
333 msg_set_bits(m, 2, 0, 0xffff, n);
334}
335
Allan Stephens40aecb12008-06-04 17:54:48 -0700336/*
Per Lidenb97bf3f2006-01-02 19:04:38 +0100337 * Words 3-10
338 */
Allan Stephensd265fef2010-11-30 12:00:53 +0000339static inline u32 msg_prevnode(struct tipc_msg *m)
340{
341 return msg_word(m, 3);
342}
343
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900344static inline void msg_set_prevnode(struct tipc_msg *m, u32 a)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100345{
346 msg_set_word(m, 3, a);
347}
348
Allan Stephensd265fef2010-11-30 12:00:53 +0000349static inline u32 msg_origport(struct tipc_msg *m)
350{
351 return msg_word(m, 4);
352}
353
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900354static inline void msg_set_origport(struct tipc_msg *m, u32 p)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100355{
356 msg_set_word(m, 4, p);
357}
358
Allan Stephensd265fef2010-11-30 12:00:53 +0000359static inline u32 msg_destport(struct tipc_msg *m)
360{
361 return msg_word(m, 5);
362}
363
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900364static inline void msg_set_destport(struct tipc_msg *m, u32 p)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100365{
366 msg_set_word(m, 5, p);
367}
368
Allan Stephensd265fef2010-11-30 12:00:53 +0000369static inline u32 msg_mc_netid(struct tipc_msg *m)
370{
371 return msg_word(m, 5);
372}
373
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900374static inline void msg_set_mc_netid(struct tipc_msg *m, u32 p)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100375{
376 msg_set_word(m, 5, p);
377}
378
Allan Stephensd265fef2010-11-30 12:00:53 +0000379static inline int msg_short(struct tipc_msg *m)
380{
Allan Stephens741d9eb2011-05-31 15:03:18 -0400381 return msg_hdr_sz(m) == SHORT_H_SIZE;
Allan Stephensd265fef2010-11-30 12:00:53 +0000382}
383
384static inline u32 msg_orignode(struct tipc_msg *m)
385{
386 if (likely(msg_short(m)))
387 return msg_prevnode(m);
388 return msg_word(m, 6);
389}
390
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900391static inline void msg_set_orignode(struct tipc_msg *m, u32 a)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100392{
393 msg_set_word(m, 6, a);
394}
395
Allan Stephensd265fef2010-11-30 12:00:53 +0000396static inline u32 msg_destnode(struct tipc_msg *m)
397{
398 return msg_word(m, 7);
399}
400
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900401static inline void msg_set_destnode(struct tipc_msg *m, u32 a)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100402{
403 msg_set_word(m, 7, a);
404}
405
Allan Stephensd265fef2010-11-30 12:00:53 +0000406static inline u32 msg_nametype(struct tipc_msg *m)
407{
408 return msg_word(m, 8);
409}
410
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900411static inline void msg_set_nametype(struct tipc_msg *m, u32 n)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100412{
413 msg_set_word(m, 8, n);
414}
415
Allan Stephensd265fef2010-11-30 12:00:53 +0000416static inline u32 msg_nameinst(struct tipc_msg *m)
417{
418 return msg_word(m, 9);
419}
420
421static inline u32 msg_namelower(struct tipc_msg *m)
422{
423 return msg_nameinst(m);
424}
425
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900426static inline void msg_set_namelower(struct tipc_msg *m, u32 n)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100427{
428 msg_set_word(m, 9, n);
429}
430
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900431static inline void msg_set_nameinst(struct tipc_msg *m, u32 n)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100432{
433 msg_set_namelower(m, n);
434}
435
Allan Stephensd265fef2010-11-30 12:00:53 +0000436static inline u32 msg_nameupper(struct tipc_msg *m)
437{
438 return msg_word(m, 10);
439}
440
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900441static inline void msg_set_nameupper(struct tipc_msg *m, u32 n)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100442{
443 msg_set_word(m, 10, n);
444}
445
Allan Stephensd265fef2010-11-30 12:00:53 +0000446static inline unchar *msg_data(struct tipc_msg *m)
447{
448 return ((unchar *)m) + msg_hdr_sz(m);
449}
450
Per Lidenb97bf3f2006-01-02 19:04:38 +0100451static inline struct tipc_msg *msg_get_wrapped(struct tipc_msg *m)
452{
453 return (struct tipc_msg *)msg_data(m);
454}
455
Per Lidenb97bf3f2006-01-02 19:04:38 +0100456/*
Allan Stephenscc4c4352011-04-08 10:50:52 -0400457 * Constants and routines used to read and write TIPC internal message headers
458 */
Per Lidenb97bf3f2006-01-02 19:04:38 +0100459
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900460/*
Allan Stephenscc4c4352011-04-08 10:50:52 -0400461 * Internal message users
Per Lidenb97bf3f2006-01-02 19:04:38 +0100462 */
Per Lidenb97bf3f2006-01-02 19:04:38 +0100463#define BCAST_PROTOCOL 5
464#define MSG_BUNDLER 6
465#define LINK_PROTOCOL 7
466#define CONN_MANAGER 8
Allan Stephens51a8e4d2010-12-31 18:59:18 +0000467#define ROUTE_DISTRIBUTOR 9 /* obsoleted */
Per Lidenb97bf3f2006-01-02 19:04:38 +0100468#define CHANGEOVER_PROTOCOL 10
469#define NAME_DISTRIBUTOR 11
470#define MSG_FRAGMENTER 12
471#define LINK_CONFIG 13
Jon Paul Maloy50100a52014-08-22 18:09:07 -0400472#define SOCK_WAKEUP 14 /* pseudo user */
Per Lidenb97bf3f2006-01-02 19:04:38 +0100473
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900474/*
Allan Stephenscc4c4352011-04-08 10:50:52 -0400475 * Connection management protocol message types
Per Lidenb97bf3f2006-01-02 19:04:38 +0100476 */
Per Lidenb97bf3f2006-01-02 19:04:38 +0100477#define CONN_PROBE 0
478#define CONN_PROBE_REPLY 1
479#define CONN_ACK 2
480
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900481/*
Allan Stephenscc4c4352011-04-08 10:50:52 -0400482 * Name distributor message types
Per Lidenb97bf3f2006-01-02 19:04:38 +0100483 */
Per Lidenb97bf3f2006-01-02 19:04:38 +0100484#define PUBLICATION 0
485#define WITHDRAWAL 1
486
Allan Stephens92138d12011-04-08 11:04:15 -0400487/*
488 * Segmentation message types
489 */
Allan Stephens92138d12011-04-08 11:04:15 -0400490#define FIRST_FRAGMENT 0
491#define FRAGMENT 1
492#define LAST_FRAGMENT 2
493
494/*
495 * Link management protocol message types
496 */
Allan Stephens92138d12011-04-08 11:04:15 -0400497#define STATE_MSG 0
498#define RESET_MSG 1
499#define ACTIVATE_MSG 2
500
501/*
502 * Changeover tunnel message types
503 */
504#define DUPLICATE_MSG 0
505#define ORIGINAL_MSG 1
506
507/*
508 * Config protocol message types
509 */
Allan Stephens92138d12011-04-08 11:04:15 -0400510#define DSC_REQ_MSG 0
511#define DSC_RESP_MSG 1
512
Per Lidenb97bf3f2006-01-02 19:04:38 +0100513
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900514/*
Per Lidenb97bf3f2006-01-02 19:04:38 +0100515 * Word 1
516 */
Per Lidenb97bf3f2006-01-02 19:04:38 +0100517static inline u32 msg_seq_gap(struct tipc_msg *m)
518{
Allan Stephensbd784532008-06-04 17:47:30 -0700519 return msg_bits(m, 1, 16, 0x1fff);
Per Lidenb97bf3f2006-01-02 19:04:38 +0100520}
521
522static inline void msg_set_seq_gap(struct tipc_msg *m, u32 n)
523{
Allan Stephensbd784532008-06-04 17:47:30 -0700524 msg_set_bits(m, 1, 16, 0x1fff, n);
Per Lidenb97bf3f2006-01-02 19:04:38 +0100525}
526
Allan Stephensfc0eea62011-10-28 16:26:41 -0400527static inline u32 msg_node_sig(struct tipc_msg *m)
528{
529 return msg_bits(m, 1, 0, 0xffff);
530}
531
532static inline void msg_set_node_sig(struct tipc_msg *m, u32 n)
533{
534 msg_set_bits(m, 1, 0, 0xffff, n);
535}
536
Per Lidenb97bf3f2006-01-02 19:04:38 +0100537
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900538/*
Per Lidenb97bf3f2006-01-02 19:04:38 +0100539 * Word 2
540 */
Per Lidenb97bf3f2006-01-02 19:04:38 +0100541static inline u32 msg_dest_domain(struct tipc_msg *m)
542{
543 return msg_word(m, 2);
544}
545
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900546static inline void msg_set_dest_domain(struct tipc_msg *m, u32 n)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100547{
548 msg_set_word(m, 2, n);
549}
550
551static inline u32 msg_bcgap_after(struct tipc_msg *m)
552{
553 return msg_bits(m, 2, 16, 0xffff);
554}
555
556static inline void msg_set_bcgap_after(struct tipc_msg *m, u32 n)
557{
558 msg_set_bits(m, 2, 16, 0xffff, n);
559}
560
561static inline u32 msg_bcgap_to(struct tipc_msg *m)
562{
563 return msg_bits(m, 2, 0, 0xffff);
564}
565
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900566static inline void msg_set_bcgap_to(struct tipc_msg *m, u32 n)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100567{
568 msg_set_bits(m, 2, 0, 0xffff, n);
569}
570
571
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900572/*
Per Lidenb97bf3f2006-01-02 19:04:38 +0100573 * Word 4
574 */
Per Lidenb97bf3f2006-01-02 19:04:38 +0100575static inline u32 msg_last_bcast(struct tipc_msg *m)
576{
577 return msg_bits(m, 4, 16, 0xffff);
578}
579
580static inline void msg_set_last_bcast(struct tipc_msg *m, u32 n)
581{
582 msg_set_bits(m, 4, 16, 0xffff, n);
583}
584
Per Lidenb97bf3f2006-01-02 19:04:38 +0100585static inline void msg_set_fragm_no(struct tipc_msg *m, u32 n)
586{
587 msg_set_bits(m, 4, 16, 0xffff, n);
588}
589
590
591static inline u32 msg_next_sent(struct tipc_msg *m)
592{
593 return msg_bits(m, 4, 0, 0xffff);
594}
595
596static inline void msg_set_next_sent(struct tipc_msg *m, u32 n)
597{
598 msg_set_bits(m, 4, 0, 0xffff, n);
599}
600
Per Lidenb97bf3f2006-01-02 19:04:38 +0100601static inline void msg_set_long_msgno(struct tipc_msg *m, u32 n)
602{
603 msg_set_bits(m, 4, 0, 0xffff, n);
604}
605
606static inline u32 msg_bc_netid(struct tipc_msg *m)
607{
608 return msg_word(m, 4);
609}
610
611static inline void msg_set_bc_netid(struct tipc_msg *m, u32 id)
612{
613 msg_set_word(m, 4, id);
614}
615
616static inline u32 msg_link_selector(struct tipc_msg *m)
617{
618 return msg_bits(m, 4, 0, 1);
619}
620
621static inline void msg_set_link_selector(struct tipc_msg *m, u32 n)
622{
Allan Stephens7eb878e2011-05-25 13:28:27 -0400623 msg_set_bits(m, 4, 0, 1, n);
Per Lidenb97bf3f2006-01-02 19:04:38 +0100624}
625
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900626/*
Per Lidenb97bf3f2006-01-02 19:04:38 +0100627 * Word 5
628 */
Per Lidenb97bf3f2006-01-02 19:04:38 +0100629static inline u32 msg_session(struct tipc_msg *m)
630{
631 return msg_bits(m, 5, 16, 0xffff);
632}
633
634static inline void msg_set_session(struct tipc_msg *m, u32 n)
635{
636 msg_set_bits(m, 5, 16, 0xffff, n);
637}
638
639static inline u32 msg_probe(struct tipc_msg *m)
640{
641 return msg_bits(m, 5, 0, 1);
642}
643
644static inline void msg_set_probe(struct tipc_msg *m, u32 val)
645{
Allan Stephens7eb878e2011-05-25 13:28:27 -0400646 msg_set_bits(m, 5, 0, 1, val);
Per Lidenb97bf3f2006-01-02 19:04:38 +0100647}
648
649static inline char msg_net_plane(struct tipc_msg *m)
650{
651 return msg_bits(m, 5, 1, 7) + 'A';
652}
653
654static inline void msg_set_net_plane(struct tipc_msg *m, char n)
655{
656 msg_set_bits(m, 5, 1, 7, (n - 'A'));
657}
658
659static inline u32 msg_linkprio(struct tipc_msg *m)
660{
661 return msg_bits(m, 5, 4, 0x1f);
662}
663
664static inline void msg_set_linkprio(struct tipc_msg *m, u32 n)
665{
666 msg_set_bits(m, 5, 4, 0x1f, n);
667}
668
669static inline u32 msg_bearer_id(struct tipc_msg *m)
670{
671 return msg_bits(m, 5, 9, 0x7);
672}
673
674static inline void msg_set_bearer_id(struct tipc_msg *m, u32 n)
675{
676 msg_set_bits(m, 5, 9, 0x7, n);
677}
678
679static inline u32 msg_redundant_link(struct tipc_msg *m)
680{
681 return msg_bits(m, 5, 12, 0x1);
682}
683
Allan Stephens77f167f2011-02-28 15:30:20 -0500684static inline void msg_set_redundant_link(struct tipc_msg *m, u32 r)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100685{
Allan Stephens77f167f2011-02-28 15:30:20 -0500686 msg_set_bits(m, 5, 12, 0x1, r);
Per Lidenb97bf3f2006-01-02 19:04:38 +0100687}
688
Allan Stephens3d749a62011-10-07 15:19:11 -0400689static inline char *msg_media_addr(struct tipc_msg *m)
690{
Erik Hugne91e2eb52015-02-27 08:56:57 +0100691 return (char *)&m->hdr[TIPC_MEDIA_INFO_OFFSET];
Allan Stephens3d749a62011-10-07 15:19:11 -0400692}
Per Lidenb97bf3f2006-01-02 19:04:38 +0100693
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900694/*
Per Lidenb97bf3f2006-01-02 19:04:38 +0100695 * Word 9
696 */
Per Lidenb97bf3f2006-01-02 19:04:38 +0100697static inline u32 msg_msgcnt(struct tipc_msg *m)
698{
699 return msg_bits(m, 9, 16, 0xffff);
700}
701
702static inline void msg_set_msgcnt(struct tipc_msg *m, u32 n)
703{
704 msg_set_bits(m, 9, 16, 0xffff, n);
705}
706
707static inline u32 msg_bcast_tag(struct tipc_msg *m)
708{
709 return msg_bits(m, 9, 16, 0xffff);
710}
711
712static inline void msg_set_bcast_tag(struct tipc_msg *m, u32 n)
713{
714 msg_set_bits(m, 9, 16, 0xffff, n);
715}
716
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900717static inline u32 msg_max_pkt(struct tipc_msg *m)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100718{
Eric Dumazeta02cec22010-09-22 20:43:57 +0000719 return msg_bits(m, 9, 16, 0xffff) * 4;
Per Lidenb97bf3f2006-01-02 19:04:38 +0100720}
721
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900722static inline void msg_set_max_pkt(struct tipc_msg *m, u32 n)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100723{
724 msg_set_bits(m, 9, 16, 0xffff, (n / 4));
725}
726
727static inline u32 msg_link_tolerance(struct tipc_msg *m)
728{
729 return msg_bits(m, 9, 0, 0xffff);
730}
731
732static inline void msg_set_link_tolerance(struct tipc_msg *m, u32 n)
733{
734 msg_set_bits(m, 9, 0, 0xffff, n);
735}
736
Jon Paul Maloy4f1688b2014-06-25 20:41:32 -0500737static inline u32 tipc_msg_tot_importance(struct tipc_msg *m)
738{
739 if ((msg_user(m) == MSG_FRAGMENTER) && (msg_type(m) == FIRST_FRAGMENT))
740 return msg_importance(msg_get_wrapped(m));
741 return msg_importance(m);
742}
743
744static inline u32 msg_tot_origport(struct tipc_msg *m)
745{
746 if ((msg_user(m) == MSG_FRAGMENTER) && (msg_type(m) == FIRST_FRAGMENT))
747 return msg_origport(msg_get_wrapped(m));
748 return msg_origport(m);
749}
750
Ying Xue859fc7c2015-01-09 15:27:01 +0800751struct sk_buff *tipc_buf_acquire(u32 size);
Jon Paul Maloyc5898632015-02-05 08:36:36 -0500752bool tipc_msg_reverse(u32 own_addr, struct sk_buff *buf, u32 *dnode,
Ying Xue34747532015-01-09 15:27:10 +0800753 int err);
Jon Paul Maloyc5898632015-02-05 08:36:36 -0500754void tipc_msg_init(u32 own_addr, struct tipc_msg *m, u32 user, u32 type,
Ying Xue34747532015-01-09 15:27:10 +0800755 u32 hsize, u32 destnode);
Jon Paul Maloye3a77562015-02-05 08:36:39 -0500756struct sk_buff *tipc_msg_create(uint user, uint type, uint hdr_sz,
757 uint data_sz, u32 dnode, u32 onode,
758 u32 dport, u32 oport, int errcode);
Jon Paul Maloy37e22162014-05-14 05:39:12 -0400759int tipc_buf_append(struct sk_buff **headbuf, struct sk_buff **buf);
Ying Xue58dc55f2014-11-26 11:41:52 +0800760bool tipc_msg_bundle(struct sk_buff_head *list, struct sk_buff *skb, u32 mtu);
Jon Paul Maloyc5898632015-02-05 08:36:36 -0500761bool tipc_msg_make_bundle(struct sk_buff_head *list,
Ying Xue34747532015-01-09 15:27:10 +0800762 struct sk_buff *skb, u32 mtu, u32 dnode);
Jon Paul Maloyc637c102015-02-05 08:36:41 -0500763bool tipc_msg_extract(struct sk_buff *skb, struct sk_buff **iskb, int *pos);
Jon Paul Maloyc5898632015-02-05 08:36:36 -0500764int tipc_msg_build(struct tipc_msg *mhdr, struct msghdr *m,
Ying Xue34747532015-01-09 15:27:10 +0800765 int offset, int dsz, int mtu, struct sk_buff_head *list);
Jon Paul Maloye3a77562015-02-05 08:36:39 -0500766bool tipc_msg_lookup_dest(struct net *net, struct sk_buff *skb, u32 *dnode,
767 int *err);
Ying Xuea6ca1092014-11-26 11:41:55 +0800768struct sk_buff *tipc_msg_reassemble(struct sk_buff_head *list);
Jon Paul Maloy078bec82014-07-16 20:41:00 -0400769
Jon Paul Maloycb1b7282015-02-05 08:36:44 -0500770/* tipc_skb_peek(): peek and reserve first buffer in list
771 * @list: list to be peeked in
772 * Returns pointer to first buffer in list, if any
773 */
774static inline struct sk_buff *tipc_skb_peek(struct sk_buff_head *list,
775 spinlock_t *lock)
776{
777 struct sk_buff *skb;
778
779 spin_lock_bh(lock);
780 skb = skb_peek(list);
781 if (skb)
782 skb_get(skb);
783 spin_unlock_bh(lock);
784 return skb;
785}
786
Jon Paul Maloyc637c102015-02-05 08:36:41 -0500787/* tipc_skb_peek_port(): find a destination port, ignoring all destinations
788 * up to and including 'filter'.
789 * Note: ignoring previously tried destinations minimizes the risk of
790 * contention on the socket lock
791 * @list: list to be peeked in
792 * @filter: last destination to be ignored from search
793 * Returns a destination port number, of applicable.
794 */
795static inline u32 tipc_skb_peek_port(struct sk_buff_head *list, u32 filter)
796{
797 struct sk_buff *skb;
798 u32 dport = 0;
799 bool ignore = true;
800
801 spin_lock_bh(&list->lock);
802 skb_queue_walk(list, skb) {
803 dport = msg_destport(buf_msg(skb));
804 if (!filter || skb_queue_is_last(list, skb))
805 break;
806 if (dport == filter)
807 ignore = false;
808 else if (!ignore)
809 break;
810 }
811 spin_unlock_bh(&list->lock);
812 return dport;
813}
814
815/* tipc_skb_dequeue(): unlink first buffer with dest 'dport' from list
816 * @list: list to be unlinked from
817 * @dport: selection criteria for buffer to unlink
818 */
819static inline struct sk_buff *tipc_skb_dequeue(struct sk_buff_head *list,
820 u32 dport)
821{
822 struct sk_buff *_skb, *tmp, *skb = NULL;
823
824 spin_lock_bh(&list->lock);
825 skb_queue_walk_safe(list, _skb, tmp) {
826 if (msg_destport(buf_msg(_skb)) == dport) {
827 __skb_unlink(_skb, list);
828 skb = _skb;
829 break;
830 }
831 }
832 spin_unlock_bh(&list->lock);
833 return skb;
834}
835
836/* tipc_skb_queue_tail(): add buffer to tail of list;
837 * @list: list to be appended to
838 * @skb: buffer to append. Always appended
839 * @dport: the destination port of the buffer
840 * returns true if dport differs from previous destination
841 */
842static inline bool tipc_skb_queue_tail(struct sk_buff_head *list,
843 struct sk_buff *skb, u32 dport)
844{
845 struct sk_buff *_skb = NULL;
846 bool rv = false;
847
848 spin_lock_bh(&list->lock);
849 _skb = skb_peek_tail(list);
850 if (!_skb || (msg_destport(buf_msg(_skb)) != dport) ||
851 (skb_queue_len(list) > 32))
852 rv = true;
853 __skb_queue_tail(list, skb);
854 spin_unlock_bh(&list->lock);
855 return rv;
856}
857
Per Lidenb97bf3f2006-01-02 19:04:38 +0100858#endif