blob: bd3969a80dd4edede16c8d7bf1d38fbed217fe85 [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 Maloycf2157f2015-03-13 16:08:06 -04004 * Copyright (c) 2000-2007, 2014-2015 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 */
Jon Paul Maloye3eea1e2015-03-13 16:08:11 -040057#define TIPC_SYSTEM_IMPORTANCE 4
58
Allan Stephenscc4c4352011-04-08 10:50:52 -040059
60/*
61 * Payload message types
Allan Stephensd265fef2010-11-30 12:00:53 +000062 */
Allan Stephensd265fef2010-11-30 12:00:53 +000063#define TIPC_CONN_MSG 0
64#define TIPC_MCAST_MSG 1
65#define TIPC_NAMED_MSG 2
66#define TIPC_DIRECT_MSG 3
67
Allan Stephenscc4c4352011-04-08 10:50:52 -040068/*
Jon Paul Maloye3eea1e2015-03-13 16:08:11 -040069 * Internal message users
70 */
71#define BCAST_PROTOCOL 5
72#define MSG_BUNDLER 6
73#define LINK_PROTOCOL 7
74#define CONN_MANAGER 8
75#define CHANGEOVER_PROTOCOL 10
76#define NAME_DISTRIBUTOR 11
77#define MSG_FRAGMENTER 12
78#define LINK_CONFIG 13
79#define SOCK_WAKEUP 14 /* pseudo user */
80
81/*
Allan Stephenscc4c4352011-04-08 10:50:52 -040082 * Message header sizes
83 */
Allan Stephens741d9eb2011-05-31 15:03:18 -040084#define SHORT_H_SIZE 24 /* In-cluster basic payload message */
85#define BASIC_H_SIZE 32 /* Basic payload message */
86#define NAMED_H_SIZE 40 /* Named payload message */
87#define MCAST_H_SIZE 44 /* Multicast payload message */
Allan Stephens06d82c92008-03-06 15:06:55 -080088#define INT_H_SIZE 40 /* Internal messages */
89#define MIN_H_SIZE 24 /* Smallest legal TIPC header size */
90#define MAX_H_SIZE 60 /* Largest possible TIPC header size */
91
Per Lidenb97bf3f2006-01-02 19:04:38 +010092#define MAX_MSG_SIZE (MAX_H_SIZE + TIPC_MAX_USER_MSG_SIZE)
Per Lidenb97bf3f2006-01-02 19:04:38 +010093
Erik Hugne91e2eb52015-02-27 08:56:57 +010094#define TIPC_MEDIA_INFO_OFFSET 5
Allan Stephens3d749a62011-10-07 15:19:11 -040095
Ying Xue859fc7c2015-01-09 15:27:01 +080096/**
97 * TIPC message buffer code
98 *
99 * TIPC message buffer headroom reserves space for the worst-case
100 * link-level device header (in case the message is sent off-node).
101 *
102 * Note: Headroom should be a multiple of 4 to ensure the TIPC header fields
103 * are word aligned for quicker access
104 */
Erik Hugned0f91932015-03-05 10:23:49 +0100105#define BUF_HEADROOM (LL_MAX_HEADER + 48)
Ying Xue859fc7c2015-01-09 15:27:01 +0800106
107struct tipc_skb_cb {
108 void *handle;
109 struct sk_buff *tail;
Jon Paul Maloycf2157f2015-03-13 16:08:06 -0400110 bool validated;
Ying Xue859fc7c2015-01-09 15:27:01 +0800111 bool wakeup_pending;
112 bool bundling;
113 u16 chain_sz;
114 u16 chain_imp;
115};
116
117#define TIPC_SKB_CB(__skb) ((struct tipc_skb_cb *)&((__skb)->cb[0]))
118
Allan Stephensd265fef2010-11-30 12:00:53 +0000119struct tipc_msg {
120 __be32 hdr[15];
121};
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900122
Ying Xue859fc7c2015-01-09 15:27:01 +0800123static inline struct tipc_msg *buf_msg(struct sk_buff *skb)
124{
125 return (struct tipc_msg *)skb->data;
126}
127
Allan Stephensd265fef2010-11-30 12:00:53 +0000128static inline u32 msg_word(struct tipc_msg *m, u32 pos)
129{
130 return ntohl(m->hdr[pos]);
131}
Per Lidenb97bf3f2006-01-02 19:04:38 +0100132
133static inline void msg_set_word(struct tipc_msg *m, u32 w, u32 val)
134{
135 m->hdr[w] = htonl(val);
136}
137
Allan Stephensd265fef2010-11-30 12:00:53 +0000138static inline u32 msg_bits(struct tipc_msg *m, u32 w, u32 pos, u32 mask)
139{
140 return (msg_word(m, w) >> pos) & mask;
141}
142
Per Lidenb97bf3f2006-01-02 19:04:38 +0100143static inline void msg_set_bits(struct tipc_msg *m, u32 w,
144 u32 pos, u32 mask, u32 val)
145{
Allan Stephens1f9eda72007-04-24 14:51:55 -0700146 val = (val & mask) << pos;
Al Virobecf3da2008-04-26 22:42:14 -0700147 mask = mask << pos;
148 m->hdr[w] &= ~htonl(mask);
149 m->hdr[w] |= htonl(val);
Per Lidenb97bf3f2006-01-02 19:04:38 +0100150}
151
Allan Stephens40aecb12008-06-04 17:54:48 -0700152static inline void msg_swap_words(struct tipc_msg *msg, u32 a, u32 b)
153{
154 u32 temp = msg->hdr[a];
155
156 msg->hdr[a] = msg->hdr[b];
157 msg->hdr[b] = temp;
158}
159
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900160/*
Per Lidenb97bf3f2006-01-02 19:04:38 +0100161 * Word 0
162 */
Per Lidenb97bf3f2006-01-02 19:04:38 +0100163static inline u32 msg_version(struct tipc_msg *m)
164{
165 return msg_bits(m, 0, 29, 7);
166}
167
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900168static inline void msg_set_version(struct tipc_msg *m)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100169{
Allan Stephens37695422008-03-06 15:07:42 -0800170 msg_set_bits(m, 0, 29, 7, TIPC_VERSION);
Per Lidenb97bf3f2006-01-02 19:04:38 +0100171}
172
173static inline u32 msg_user(struct tipc_msg *m)
174{
175 return msg_bits(m, 0, 25, 0xf);
176}
177
178static inline u32 msg_isdata(struct tipc_msg *m)
179{
Eric Dumazeta02cec22010-09-22 20:43:57 +0000180 return msg_user(m) <= TIPC_CRITICAL_IMPORTANCE;
Per Lidenb97bf3f2006-01-02 19:04:38 +0100181}
182
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900183static inline void msg_set_user(struct tipc_msg *m, u32 n)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100184{
185 msg_set_bits(m, 0, 25, 0xf, n);
186}
187
Allan Stephensd265fef2010-11-30 12:00:53 +0000188static inline u32 msg_hdr_sz(struct tipc_msg *m)
189{
190 return msg_bits(m, 0, 21, 0xf) << 2;
191}
192
Allan Stephens0e659672010-12-31 18:59:32 +0000193static inline void msg_set_hdr_sz(struct tipc_msg *m, u32 n)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100194{
195 msg_set_bits(m, 0, 21, 0xf, n>>2);
196}
197
Allan Stephensd265fef2010-11-30 12:00:53 +0000198static inline u32 msg_size(struct tipc_msg *m)
199{
200 return msg_bits(m, 0, 0, 0x1ffff);
201}
202
203static inline u32 msg_data_sz(struct tipc_msg *m)
204{
205 return msg_size(m) - msg_hdr_sz(m);
206}
207
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900208static inline int msg_non_seq(struct tipc_msg *m)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100209{
210 return msg_bits(m, 0, 20, 1);
211}
212
Allan Stephens40aecb12008-06-04 17:54:48 -0700213static inline void msg_set_non_seq(struct tipc_msg *m, u32 n)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100214{
Allan Stephens40aecb12008-06-04 17:54:48 -0700215 msg_set_bits(m, 0, 20, 1, n);
Per Lidenb97bf3f2006-01-02 19:04:38 +0100216}
217
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900218static inline int msg_dest_droppable(struct tipc_msg *m)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100219{
220 return msg_bits(m, 0, 19, 1);
221}
222
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900223static inline void msg_set_dest_droppable(struct tipc_msg *m, u32 d)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100224{
225 msg_set_bits(m, 0, 19, 1, d);
226}
227
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900228static inline int msg_src_droppable(struct tipc_msg *m)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100229{
230 return msg_bits(m, 0, 18, 1);
231}
232
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900233static inline void msg_set_src_droppable(struct tipc_msg *m, u32 d)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100234{
235 msg_set_bits(m, 0, 18, 1, d);
236}
237
238static inline void msg_set_size(struct tipc_msg *m, u32 sz)
239{
240 m->hdr[0] = htonl((msg_word(m, 0) & ~0x1ffff) | sz);
241}
242
243
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900244/*
Per Lidenb97bf3f2006-01-02 19:04:38 +0100245 * Word 1
246 */
Allan Stephensd265fef2010-11-30 12:00:53 +0000247static inline u32 msg_type(struct tipc_msg *m)
248{
249 return msg_bits(m, 1, 29, 0x7);
250}
251
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900252static inline void msg_set_type(struct tipc_msg *m, u32 n)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100253{
254 msg_set_bits(m, 1, 29, 0x7, n);
255}
256
Allan Stephensd265fef2010-11-30 12:00:53 +0000257static inline u32 msg_named(struct tipc_msg *m)
258{
259 return msg_type(m) == TIPC_NAMED_MSG;
260}
261
262static inline u32 msg_mcast(struct tipc_msg *m)
263{
264 return msg_type(m) == TIPC_MCAST_MSG;
265}
266
267static inline u32 msg_connected(struct tipc_msg *m)
268{
269 return msg_type(m) == TIPC_CONN_MSG;
270}
271
272static inline u32 msg_errcode(struct tipc_msg *m)
273{
274 return msg_bits(m, 1, 25, 0xf);
275}
276
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900277static inline void msg_set_errcode(struct tipc_msg *m, u32 err)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100278{
279 msg_set_bits(m, 1, 25, 0xf, err);
280}
281
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900282static inline u32 msg_reroute_cnt(struct tipc_msg *m)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100283{
284 return msg_bits(m, 1, 21, 0xf);
285}
286
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900287static inline void msg_incr_reroute_cnt(struct tipc_msg *m)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100288{
289 msg_set_bits(m, 1, 21, 0xf, msg_reroute_cnt(m) + 1);
290}
291
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900292static inline void msg_reset_reroute_cnt(struct tipc_msg *m)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100293{
294 msg_set_bits(m, 1, 21, 0xf, 0);
295}
296
297static inline u32 msg_lookup_scope(struct tipc_msg *m)
298{
299 return msg_bits(m, 1, 19, 0x3);
300}
301
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900302static inline void msg_set_lookup_scope(struct tipc_msg *m, u32 n)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100303{
304 msg_set_bits(m, 1, 19, 0x3, n);
305}
306
Per Lidenb97bf3f2006-01-02 19:04:38 +0100307static inline u32 msg_bcast_ack(struct tipc_msg *m)
308{
309 return msg_bits(m, 1, 0, 0xffff);
310}
311
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900312static inline void msg_set_bcast_ack(struct tipc_msg *m, u32 n)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100313{
314 msg_set_bits(m, 1, 0, 0xffff, n);
315}
316
317
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900318/*
Per Lidenb97bf3f2006-01-02 19:04:38 +0100319 * Word 2
320 */
Per Lidenb97bf3f2006-01-02 19:04:38 +0100321static inline u32 msg_ack(struct tipc_msg *m)
322{
323 return msg_bits(m, 2, 16, 0xffff);
324}
325
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900326static inline void msg_set_ack(struct tipc_msg *m, u32 n)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100327{
328 msg_set_bits(m, 2, 16, 0xffff, n);
329}
330
331static inline u32 msg_seqno(struct tipc_msg *m)
332{
333 return msg_bits(m, 2, 0, 0xffff);
334}
335
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900336static inline void msg_set_seqno(struct tipc_msg *m, u32 n)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100337{
338 msg_set_bits(m, 2, 0, 0xffff, n);
339}
340
Allan Stephens40aecb12008-06-04 17:54:48 -0700341/*
Per Lidenb97bf3f2006-01-02 19:04:38 +0100342 * Words 3-10
343 */
Jon Paul Maloye3eea1e2015-03-13 16:08:11 -0400344static inline u32 msg_importance(struct tipc_msg *m)
345{
346 if (unlikely(msg_user(m) == MSG_FRAGMENTER))
347 return msg_bits(m, 5, 13, 0x7);
348 if (likely(msg_isdata(m) && !msg_errcode(m)))
349 return msg_user(m);
350 return TIPC_SYSTEM_IMPORTANCE;
351}
352
353static inline void msg_set_importance(struct tipc_msg *m, u32 i)
354{
355 if (unlikely(msg_user(m) == MSG_FRAGMENTER))
356 msg_set_bits(m, 5, 13, 0x7, i);
357 else if (likely(i < TIPC_SYSTEM_IMPORTANCE))
358 msg_set_user(m, i);
359 else
360 pr_warn("Trying to set illegal importance in message\n");
361}
362
Allan Stephensd265fef2010-11-30 12:00:53 +0000363static inline u32 msg_prevnode(struct tipc_msg *m)
364{
365 return msg_word(m, 3);
366}
367
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900368static inline void msg_set_prevnode(struct tipc_msg *m, u32 a)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100369{
370 msg_set_word(m, 3, a);
371}
372
Allan Stephensd265fef2010-11-30 12:00:53 +0000373static inline u32 msg_origport(struct tipc_msg *m)
374{
375 return msg_word(m, 4);
376}
377
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900378static inline void msg_set_origport(struct tipc_msg *m, u32 p)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100379{
380 msg_set_word(m, 4, p);
381}
382
Allan Stephensd265fef2010-11-30 12:00:53 +0000383static inline u32 msg_destport(struct tipc_msg *m)
384{
385 return msg_word(m, 5);
386}
387
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900388static inline void msg_set_destport(struct tipc_msg *m, u32 p)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100389{
390 msg_set_word(m, 5, p);
391}
392
Allan Stephensd265fef2010-11-30 12:00:53 +0000393static inline u32 msg_mc_netid(struct tipc_msg *m)
394{
395 return msg_word(m, 5);
396}
397
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900398static inline void msg_set_mc_netid(struct tipc_msg *m, u32 p)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100399{
400 msg_set_word(m, 5, p);
401}
402
Allan Stephensd265fef2010-11-30 12:00:53 +0000403static inline int msg_short(struct tipc_msg *m)
404{
Allan Stephens741d9eb2011-05-31 15:03:18 -0400405 return msg_hdr_sz(m) == SHORT_H_SIZE;
Allan Stephensd265fef2010-11-30 12:00:53 +0000406}
407
408static inline u32 msg_orignode(struct tipc_msg *m)
409{
410 if (likely(msg_short(m)))
411 return msg_prevnode(m);
412 return msg_word(m, 6);
413}
414
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900415static inline void msg_set_orignode(struct tipc_msg *m, u32 a)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100416{
417 msg_set_word(m, 6, a);
418}
419
Allan Stephensd265fef2010-11-30 12:00:53 +0000420static inline u32 msg_destnode(struct tipc_msg *m)
421{
422 return msg_word(m, 7);
423}
424
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900425static inline void msg_set_destnode(struct tipc_msg *m, u32 a)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100426{
427 msg_set_word(m, 7, a);
428}
429
Allan Stephensd265fef2010-11-30 12:00:53 +0000430static inline u32 msg_nametype(struct tipc_msg *m)
431{
432 return msg_word(m, 8);
433}
434
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900435static inline void msg_set_nametype(struct tipc_msg *m, u32 n)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100436{
437 msg_set_word(m, 8, n);
438}
439
Allan Stephensd265fef2010-11-30 12:00:53 +0000440static inline u32 msg_nameinst(struct tipc_msg *m)
441{
442 return msg_word(m, 9);
443}
444
445static inline u32 msg_namelower(struct tipc_msg *m)
446{
447 return msg_nameinst(m);
448}
449
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900450static inline void msg_set_namelower(struct tipc_msg *m, u32 n)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100451{
452 msg_set_word(m, 9, n);
453}
454
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900455static inline void msg_set_nameinst(struct tipc_msg *m, u32 n)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100456{
457 msg_set_namelower(m, n);
458}
459
Allan Stephensd265fef2010-11-30 12:00:53 +0000460static inline u32 msg_nameupper(struct tipc_msg *m)
461{
462 return msg_word(m, 10);
463}
464
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900465static inline void msg_set_nameupper(struct tipc_msg *m, u32 n)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100466{
467 msg_set_word(m, 10, n);
468}
469
Allan Stephensd265fef2010-11-30 12:00:53 +0000470static inline unchar *msg_data(struct tipc_msg *m)
471{
472 return ((unchar *)m) + msg_hdr_sz(m);
473}
474
Per Lidenb97bf3f2006-01-02 19:04:38 +0100475static inline struct tipc_msg *msg_get_wrapped(struct tipc_msg *m)
476{
477 return (struct tipc_msg *)msg_data(m);
478}
479
Per Lidenb97bf3f2006-01-02 19:04:38 +0100480/*
Allan Stephenscc4c4352011-04-08 10:50:52 -0400481 * Constants and routines used to read and write TIPC internal message headers
482 */
Per Lidenb97bf3f2006-01-02 19:04:38 +0100483
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900484/*
Allan Stephenscc4c4352011-04-08 10:50:52 -0400485 * Connection management protocol message types
Per Lidenb97bf3f2006-01-02 19:04:38 +0100486 */
Per Lidenb97bf3f2006-01-02 19:04:38 +0100487#define CONN_PROBE 0
488#define CONN_PROBE_REPLY 1
489#define CONN_ACK 2
490
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900491/*
Allan Stephenscc4c4352011-04-08 10:50:52 -0400492 * Name distributor message types
Per Lidenb97bf3f2006-01-02 19:04:38 +0100493 */
Per Lidenb97bf3f2006-01-02 19:04:38 +0100494#define PUBLICATION 0
495#define WITHDRAWAL 1
496
Allan Stephens92138d12011-04-08 11:04:15 -0400497/*
498 * Segmentation message types
499 */
Allan Stephens92138d12011-04-08 11:04:15 -0400500#define FIRST_FRAGMENT 0
501#define FRAGMENT 1
502#define LAST_FRAGMENT 2
503
504/*
505 * Link management protocol message types
506 */
Allan Stephens92138d12011-04-08 11:04:15 -0400507#define STATE_MSG 0
508#define RESET_MSG 1
509#define ACTIVATE_MSG 2
510
511/*
512 * Changeover tunnel message types
513 */
514#define DUPLICATE_MSG 0
515#define ORIGINAL_MSG 1
516
517/*
518 * Config protocol message types
519 */
Allan Stephens92138d12011-04-08 11:04:15 -0400520#define DSC_REQ_MSG 0
521#define DSC_RESP_MSG 1
522
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900523/*
Per Lidenb97bf3f2006-01-02 19:04:38 +0100524 * Word 1
525 */
Per Lidenb97bf3f2006-01-02 19:04:38 +0100526static inline u32 msg_seq_gap(struct tipc_msg *m)
527{
Allan Stephensbd784532008-06-04 17:47:30 -0700528 return msg_bits(m, 1, 16, 0x1fff);
Per Lidenb97bf3f2006-01-02 19:04:38 +0100529}
530
531static inline void msg_set_seq_gap(struct tipc_msg *m, u32 n)
532{
Allan Stephensbd784532008-06-04 17:47:30 -0700533 msg_set_bits(m, 1, 16, 0x1fff, n);
Per Lidenb97bf3f2006-01-02 19:04:38 +0100534}
535
Allan Stephensfc0eea62011-10-28 16:26:41 -0400536static inline u32 msg_node_sig(struct tipc_msg *m)
537{
538 return msg_bits(m, 1, 0, 0xffff);
539}
540
541static inline void msg_set_node_sig(struct tipc_msg *m, u32 n)
542{
543 msg_set_bits(m, 1, 0, 0xffff, n);
544}
545
Jon Paul Maloy7764d6e2015-03-13 16:08:05 -0400546static inline u32 msg_node_capabilities(struct tipc_msg *m)
547{
548 return msg_bits(m, 1, 15, 0x1fff);
549}
550
551static inline void msg_set_node_capabilities(struct tipc_msg *m, u32 n)
552{
553 msg_set_bits(m, 1, 15, 0x1fff, n);
554}
555
Per Lidenb97bf3f2006-01-02 19:04:38 +0100556
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900557/*
Per Lidenb97bf3f2006-01-02 19:04:38 +0100558 * Word 2
559 */
Per Lidenb97bf3f2006-01-02 19:04:38 +0100560static inline u32 msg_dest_domain(struct tipc_msg *m)
561{
562 return msg_word(m, 2);
563}
564
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900565static inline void msg_set_dest_domain(struct tipc_msg *m, u32 n)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100566{
567 msg_set_word(m, 2, n);
568}
569
570static inline u32 msg_bcgap_after(struct tipc_msg *m)
571{
572 return msg_bits(m, 2, 16, 0xffff);
573}
574
575static inline void msg_set_bcgap_after(struct tipc_msg *m, u32 n)
576{
577 msg_set_bits(m, 2, 16, 0xffff, n);
578}
579
580static inline u32 msg_bcgap_to(struct tipc_msg *m)
581{
582 return msg_bits(m, 2, 0, 0xffff);
583}
584
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900585static inline void msg_set_bcgap_to(struct tipc_msg *m, u32 n)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100586{
587 msg_set_bits(m, 2, 0, 0xffff, n);
588}
589
590
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900591/*
Per Lidenb97bf3f2006-01-02 19:04:38 +0100592 * Word 4
593 */
Per Lidenb97bf3f2006-01-02 19:04:38 +0100594static inline u32 msg_last_bcast(struct tipc_msg *m)
595{
596 return msg_bits(m, 4, 16, 0xffff);
597}
598
599static inline void msg_set_last_bcast(struct tipc_msg *m, u32 n)
600{
601 msg_set_bits(m, 4, 16, 0xffff, n);
602}
603
Per Lidenb97bf3f2006-01-02 19:04:38 +0100604static inline void msg_set_fragm_no(struct tipc_msg *m, u32 n)
605{
606 msg_set_bits(m, 4, 16, 0xffff, n);
607}
608
609
610static inline u32 msg_next_sent(struct tipc_msg *m)
611{
612 return msg_bits(m, 4, 0, 0xffff);
613}
614
615static inline void msg_set_next_sent(struct tipc_msg *m, u32 n)
616{
617 msg_set_bits(m, 4, 0, 0xffff, n);
618}
619
Per Lidenb97bf3f2006-01-02 19:04:38 +0100620static inline void msg_set_long_msgno(struct tipc_msg *m, u32 n)
621{
622 msg_set_bits(m, 4, 0, 0xffff, n);
623}
624
625static inline u32 msg_bc_netid(struct tipc_msg *m)
626{
627 return msg_word(m, 4);
628}
629
630static inline void msg_set_bc_netid(struct tipc_msg *m, u32 id)
631{
632 msg_set_word(m, 4, id);
633}
634
635static inline u32 msg_link_selector(struct tipc_msg *m)
636{
637 return msg_bits(m, 4, 0, 1);
638}
639
640static inline void msg_set_link_selector(struct tipc_msg *m, u32 n)
641{
Allan Stephens7eb878e2011-05-25 13:28:27 -0400642 msg_set_bits(m, 4, 0, 1, n);
Per Lidenb97bf3f2006-01-02 19:04:38 +0100643}
644
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900645/*
Per Lidenb97bf3f2006-01-02 19:04:38 +0100646 * Word 5
647 */
Per Lidenb97bf3f2006-01-02 19:04:38 +0100648static inline u32 msg_session(struct tipc_msg *m)
649{
650 return msg_bits(m, 5, 16, 0xffff);
651}
652
653static inline void msg_set_session(struct tipc_msg *m, u32 n)
654{
655 msg_set_bits(m, 5, 16, 0xffff, n);
656}
657
658static inline u32 msg_probe(struct tipc_msg *m)
659{
660 return msg_bits(m, 5, 0, 1);
661}
662
663static inline void msg_set_probe(struct tipc_msg *m, u32 val)
664{
Allan Stephens7eb878e2011-05-25 13:28:27 -0400665 msg_set_bits(m, 5, 0, 1, val);
Per Lidenb97bf3f2006-01-02 19:04:38 +0100666}
667
668static inline char msg_net_plane(struct tipc_msg *m)
669{
670 return msg_bits(m, 5, 1, 7) + 'A';
671}
672
673static inline void msg_set_net_plane(struct tipc_msg *m, char n)
674{
675 msg_set_bits(m, 5, 1, 7, (n - 'A'));
676}
677
678static inline u32 msg_linkprio(struct tipc_msg *m)
679{
680 return msg_bits(m, 5, 4, 0x1f);
681}
682
683static inline void msg_set_linkprio(struct tipc_msg *m, u32 n)
684{
685 msg_set_bits(m, 5, 4, 0x1f, n);
686}
687
688static inline u32 msg_bearer_id(struct tipc_msg *m)
689{
690 return msg_bits(m, 5, 9, 0x7);
691}
692
693static inline void msg_set_bearer_id(struct tipc_msg *m, u32 n)
694{
695 msg_set_bits(m, 5, 9, 0x7, n);
696}
697
698static inline u32 msg_redundant_link(struct tipc_msg *m)
699{
700 return msg_bits(m, 5, 12, 0x1);
701}
702
Allan Stephens77f167f2011-02-28 15:30:20 -0500703static inline void msg_set_redundant_link(struct tipc_msg *m, u32 r)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100704{
Allan Stephens77f167f2011-02-28 15:30:20 -0500705 msg_set_bits(m, 5, 12, 0x1, r);
Per Lidenb97bf3f2006-01-02 19:04:38 +0100706}
707
Allan Stephens3d749a62011-10-07 15:19:11 -0400708static inline char *msg_media_addr(struct tipc_msg *m)
709{
Erik Hugne91e2eb52015-02-27 08:56:57 +0100710 return (char *)&m->hdr[TIPC_MEDIA_INFO_OFFSET];
Allan Stephens3d749a62011-10-07 15:19:11 -0400711}
Per Lidenb97bf3f2006-01-02 19:04:38 +0100712
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900713/*
Per Lidenb97bf3f2006-01-02 19:04:38 +0100714 * Word 9
715 */
Per Lidenb97bf3f2006-01-02 19:04:38 +0100716static inline u32 msg_msgcnt(struct tipc_msg *m)
717{
718 return msg_bits(m, 9, 16, 0xffff);
719}
720
721static inline void msg_set_msgcnt(struct tipc_msg *m, u32 n)
722{
723 msg_set_bits(m, 9, 16, 0xffff, n);
724}
725
726static inline u32 msg_bcast_tag(struct tipc_msg *m)
727{
728 return msg_bits(m, 9, 16, 0xffff);
729}
730
731static inline void msg_set_bcast_tag(struct tipc_msg *m, u32 n)
732{
733 msg_set_bits(m, 9, 16, 0xffff, n);
734}
735
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900736static inline u32 msg_max_pkt(struct tipc_msg *m)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100737{
Eric Dumazeta02cec22010-09-22 20:43:57 +0000738 return msg_bits(m, 9, 16, 0xffff) * 4;
Per Lidenb97bf3f2006-01-02 19:04:38 +0100739}
740
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900741static inline void msg_set_max_pkt(struct tipc_msg *m, u32 n)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100742{
743 msg_set_bits(m, 9, 16, 0xffff, (n / 4));
744}
745
746static inline u32 msg_link_tolerance(struct tipc_msg *m)
747{
748 return msg_bits(m, 9, 0, 0xffff);
749}
750
751static inline void msg_set_link_tolerance(struct tipc_msg *m, u32 n)
752{
753 msg_set_bits(m, 9, 0, 0xffff, n);
754}
755
Jon Paul Maloy4f1688b2014-06-25 20:41:32 -0500756static inline u32 msg_tot_origport(struct tipc_msg *m)
757{
758 if ((msg_user(m) == MSG_FRAGMENTER) && (msg_type(m) == FIRST_FRAGMENT))
759 return msg_origport(msg_get_wrapped(m));
760 return msg_origport(m);
761}
762
Ying Xue859fc7c2015-01-09 15:27:01 +0800763struct sk_buff *tipc_buf_acquire(u32 size);
Jon Paul Maloycf2157f2015-03-13 16:08:06 -0400764bool tipc_msg_validate(struct sk_buff *skb);
Jon Paul Maloyc5898632015-02-05 08:36:36 -0500765bool tipc_msg_reverse(u32 own_addr, struct sk_buff *buf, u32 *dnode,
Ying Xue34747532015-01-09 15:27:10 +0800766 int err);
Jon Paul Maloyc5898632015-02-05 08:36:36 -0500767void tipc_msg_init(u32 own_addr, struct tipc_msg *m, u32 user, u32 type,
Ying Xue34747532015-01-09 15:27:10 +0800768 u32 hsize, u32 destnode);
Jon Paul Maloye3a77562015-02-05 08:36:39 -0500769struct sk_buff *tipc_msg_create(uint user, uint type, uint hdr_sz,
770 uint data_sz, u32 dnode, u32 onode,
771 u32 dport, u32 oport, int errcode);
Jon Paul Maloy37e22162014-05-14 05:39:12 -0400772int tipc_buf_append(struct sk_buff **headbuf, struct sk_buff **buf);
Jon Paul Maloy05dcc5a2015-03-13 16:08:10 -0400773bool tipc_msg_bundle(struct sk_buff *bskb, struct sk_buff *skb, u32 mtu);
774
775bool tipc_msg_make_bundle(struct sk_buff **skb, u32 mtu, u32 dnode);
Jon Paul Maloyc637c102015-02-05 08:36:41 -0500776bool tipc_msg_extract(struct sk_buff *skb, struct sk_buff **iskb, int *pos);
Jon Paul Maloyc5898632015-02-05 08:36:36 -0500777int tipc_msg_build(struct tipc_msg *mhdr, struct msghdr *m,
Ying Xue34747532015-01-09 15:27:10 +0800778 int offset, int dsz, int mtu, struct sk_buff_head *list);
Jon Paul Maloye3a77562015-02-05 08:36:39 -0500779bool tipc_msg_lookup_dest(struct net *net, struct sk_buff *skb, u32 *dnode,
780 int *err);
Ying Xuea6ca1092014-11-26 11:41:55 +0800781struct sk_buff *tipc_msg_reassemble(struct sk_buff_head *list);
Jon Paul Maloy078bec82014-07-16 20:41:00 -0400782
Jon Paul Maloycb1b7282015-02-05 08:36:44 -0500783/* tipc_skb_peek(): peek and reserve first buffer in list
784 * @list: list to be peeked in
785 * Returns pointer to first buffer in list, if any
786 */
787static inline struct sk_buff *tipc_skb_peek(struct sk_buff_head *list,
788 spinlock_t *lock)
789{
790 struct sk_buff *skb;
791
792 spin_lock_bh(lock);
793 skb = skb_peek(list);
794 if (skb)
795 skb_get(skb);
796 spin_unlock_bh(lock);
797 return skb;
798}
799
Jon Paul Maloyc637c102015-02-05 08:36:41 -0500800/* tipc_skb_peek_port(): find a destination port, ignoring all destinations
801 * up to and including 'filter'.
802 * Note: ignoring previously tried destinations minimizes the risk of
803 * contention on the socket lock
804 * @list: list to be peeked in
805 * @filter: last destination to be ignored from search
806 * Returns a destination port number, of applicable.
807 */
808static inline u32 tipc_skb_peek_port(struct sk_buff_head *list, u32 filter)
809{
810 struct sk_buff *skb;
811 u32 dport = 0;
812 bool ignore = true;
813
814 spin_lock_bh(&list->lock);
815 skb_queue_walk(list, skb) {
816 dport = msg_destport(buf_msg(skb));
817 if (!filter || skb_queue_is_last(list, skb))
818 break;
819 if (dport == filter)
820 ignore = false;
821 else if (!ignore)
822 break;
823 }
824 spin_unlock_bh(&list->lock);
825 return dport;
826}
827
828/* tipc_skb_dequeue(): unlink first buffer with dest 'dport' from list
829 * @list: list to be unlinked from
830 * @dport: selection criteria for buffer to unlink
831 */
832static inline struct sk_buff *tipc_skb_dequeue(struct sk_buff_head *list,
833 u32 dport)
834{
835 struct sk_buff *_skb, *tmp, *skb = NULL;
836
837 spin_lock_bh(&list->lock);
838 skb_queue_walk_safe(list, _skb, tmp) {
839 if (msg_destport(buf_msg(_skb)) == dport) {
840 __skb_unlink(_skb, list);
841 skb = _skb;
842 break;
843 }
844 }
845 spin_unlock_bh(&list->lock);
846 return skb;
847}
848
849/* tipc_skb_queue_tail(): add buffer to tail of list;
850 * @list: list to be appended to
851 * @skb: buffer to append. Always appended
852 * @dport: the destination port of the buffer
853 * returns true if dport differs from previous destination
854 */
855static inline bool tipc_skb_queue_tail(struct sk_buff_head *list,
856 struct sk_buff *skb, u32 dport)
857{
858 struct sk_buff *_skb = NULL;
859 bool rv = false;
860
861 spin_lock_bh(&list->lock);
862 _skb = skb_peek_tail(list);
863 if (!_skb || (msg_destport(buf_msg(_skb)) != dport) ||
864 (skb_queue_len(list) > 32))
865 rv = true;
866 __skb_queue_tail(list, skb);
867 spin_unlock_bh(&list->lock);
868 return rv;
869}
870
Per Lidenb97bf3f2006-01-02 19:04:38 +0100871#endif