blob: 6caf16c475e0ba45382466b40c4a166092da4b02 [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
Jon Paul Maloydff29b12015-04-02 09:33:01 -040075#define TUNNEL_PROTOCOL 10
Jon Paul Maloye3eea1e2015-03-13 16:08:11 -040076#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
Jon Paul Maloy3127a022015-03-25 12:07:25 -0400243static inline unchar *msg_data(struct tipc_msg *m)
244{
245 return ((unchar *)m) + msg_hdr_sz(m);
246}
247
248static inline struct tipc_msg *msg_get_wrapped(struct tipc_msg *m)
249{
250 return (struct tipc_msg *)msg_data(m);
251}
Per Lidenb97bf3f2006-01-02 19:04:38 +0100252
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900253/*
Per Lidenb97bf3f2006-01-02 19:04:38 +0100254 * Word 1
255 */
Allan Stephensd265fef2010-11-30 12:00:53 +0000256static inline u32 msg_type(struct tipc_msg *m)
257{
258 return msg_bits(m, 1, 29, 0x7);
259}
260
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900261static inline void msg_set_type(struct tipc_msg *m, u32 n)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100262{
263 msg_set_bits(m, 1, 29, 0x7, n);
264}
265
Allan Stephensd265fef2010-11-30 12:00:53 +0000266static inline u32 msg_named(struct tipc_msg *m)
267{
268 return msg_type(m) == TIPC_NAMED_MSG;
269}
270
271static inline u32 msg_mcast(struct tipc_msg *m)
272{
273 return msg_type(m) == TIPC_MCAST_MSG;
274}
275
276static inline u32 msg_connected(struct tipc_msg *m)
277{
278 return msg_type(m) == TIPC_CONN_MSG;
279}
280
281static inline u32 msg_errcode(struct tipc_msg *m)
282{
283 return msg_bits(m, 1, 25, 0xf);
284}
285
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900286static inline void msg_set_errcode(struct tipc_msg *m, u32 err)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100287{
288 msg_set_bits(m, 1, 25, 0xf, err);
289}
290
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900291static inline u32 msg_reroute_cnt(struct tipc_msg *m)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100292{
293 return msg_bits(m, 1, 21, 0xf);
294}
295
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900296static inline void msg_incr_reroute_cnt(struct tipc_msg *m)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100297{
298 msg_set_bits(m, 1, 21, 0xf, msg_reroute_cnt(m) + 1);
299}
300
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900301static inline void msg_reset_reroute_cnt(struct tipc_msg *m)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100302{
303 msg_set_bits(m, 1, 21, 0xf, 0);
304}
305
306static inline u32 msg_lookup_scope(struct tipc_msg *m)
307{
308 return msg_bits(m, 1, 19, 0x3);
309}
310
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900311static inline void msg_set_lookup_scope(struct tipc_msg *m, u32 n)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100312{
313 msg_set_bits(m, 1, 19, 0x3, n);
314}
315
Jon Paul Maloye4bf4f72015-05-14 10:46:14 -0400316static inline u16 msg_bcast_ack(struct tipc_msg *m)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100317{
318 return msg_bits(m, 1, 0, 0xffff);
319}
320
Jon Paul Maloye4bf4f72015-05-14 10:46:14 -0400321static inline void msg_set_bcast_ack(struct tipc_msg *m, u16 n)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100322{
323 msg_set_bits(m, 1, 0, 0xffff, n);
324}
325
326
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900327/*
Per Lidenb97bf3f2006-01-02 19:04:38 +0100328 * Word 2
329 */
Jon Paul Maloye4bf4f72015-05-14 10:46:14 -0400330static inline u16 msg_ack(struct tipc_msg *m)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100331{
332 return msg_bits(m, 2, 16, 0xffff);
333}
334
Jon Paul Maloye4bf4f72015-05-14 10:46:14 -0400335static inline void msg_set_ack(struct tipc_msg *m, u16 n)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100336{
337 msg_set_bits(m, 2, 16, 0xffff, n);
338}
339
Jon Paul Maloye4bf4f72015-05-14 10:46:14 -0400340static inline u16 msg_seqno(struct tipc_msg *m)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100341{
342 return msg_bits(m, 2, 0, 0xffff);
343}
344
Jon Paul Maloye4bf4f72015-05-14 10:46:14 -0400345static inline void msg_set_seqno(struct tipc_msg *m, u16 n)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100346{
347 msg_set_bits(m, 2, 0, 0xffff, n);
348}
349
Allan Stephens40aecb12008-06-04 17:54:48 -0700350/*
Per Lidenb97bf3f2006-01-02 19:04:38 +0100351 * Words 3-10
352 */
Jon Paul Maloye3eea1e2015-03-13 16:08:11 -0400353static inline u32 msg_importance(struct tipc_msg *m)
354{
Jon Paul Maloyf21e8972015-05-14 10:46:17 -0400355 int usr = msg_user(m);
356
357 if (likely((usr <= TIPC_CRITICAL_IMPORTANCE) && !msg_errcode(m)))
358 return usr;
359 if ((usr == MSG_FRAGMENTER) || (usr == MSG_BUNDLER))
Jon Paul Maloye3eea1e2015-03-13 16:08:11 -0400360 return msg_bits(m, 5, 13, 0x7);
Jon Paul Maloye3eea1e2015-03-13 16:08:11 -0400361 return TIPC_SYSTEM_IMPORTANCE;
362}
363
364static inline void msg_set_importance(struct tipc_msg *m, u32 i)
365{
Jon Paul Maloyf21e8972015-05-14 10:46:17 -0400366 int usr = msg_user(m);
367
368 if (likely((usr == MSG_FRAGMENTER) || (usr == MSG_BUNDLER)))
Jon Paul Maloye3eea1e2015-03-13 16:08:11 -0400369 msg_set_bits(m, 5, 13, 0x7, i);
Jon Paul Maloyf21e8972015-05-14 10:46:17 -0400370 else if (i < TIPC_SYSTEM_IMPORTANCE)
Jon Paul Maloye3eea1e2015-03-13 16:08:11 -0400371 msg_set_user(m, i);
372 else
373 pr_warn("Trying to set illegal importance in message\n");
374}
375
Allan Stephensd265fef2010-11-30 12:00:53 +0000376static inline u32 msg_prevnode(struct tipc_msg *m)
377{
378 return msg_word(m, 3);
379}
380
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900381static inline void msg_set_prevnode(struct tipc_msg *m, u32 a)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100382{
383 msg_set_word(m, 3, a);
384}
385
Allan Stephensd265fef2010-11-30 12:00:53 +0000386static inline u32 msg_origport(struct tipc_msg *m)
387{
Jon Paul Maloy3127a022015-03-25 12:07:25 -0400388 if (msg_user(m) == MSG_FRAGMENTER)
389 m = msg_get_wrapped(m);
Allan Stephensd265fef2010-11-30 12:00:53 +0000390 return msg_word(m, 4);
391}
392
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900393static inline void msg_set_origport(struct tipc_msg *m, u32 p)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100394{
395 msg_set_word(m, 4, p);
396}
397
Allan Stephensd265fef2010-11-30 12:00:53 +0000398static inline u32 msg_destport(struct tipc_msg *m)
399{
400 return msg_word(m, 5);
401}
402
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900403static inline void msg_set_destport(struct tipc_msg *m, u32 p)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100404{
405 msg_set_word(m, 5, p);
406}
407
Allan Stephensd265fef2010-11-30 12:00:53 +0000408static inline u32 msg_mc_netid(struct tipc_msg *m)
409{
410 return msg_word(m, 5);
411}
412
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900413static inline void msg_set_mc_netid(struct tipc_msg *m, u32 p)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100414{
415 msg_set_word(m, 5, p);
416}
417
Allan Stephensd265fef2010-11-30 12:00:53 +0000418static inline int msg_short(struct tipc_msg *m)
419{
Allan Stephens741d9eb2011-05-31 15:03:18 -0400420 return msg_hdr_sz(m) == SHORT_H_SIZE;
Allan Stephensd265fef2010-11-30 12:00:53 +0000421}
422
423static inline u32 msg_orignode(struct tipc_msg *m)
424{
425 if (likely(msg_short(m)))
426 return msg_prevnode(m);
427 return msg_word(m, 6);
428}
429
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900430static inline void msg_set_orignode(struct tipc_msg *m, u32 a)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100431{
432 msg_set_word(m, 6, a);
433}
434
Allan Stephensd265fef2010-11-30 12:00:53 +0000435static inline u32 msg_destnode(struct tipc_msg *m)
436{
437 return msg_word(m, 7);
438}
439
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900440static inline void msg_set_destnode(struct tipc_msg *m, u32 a)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100441{
442 msg_set_word(m, 7, a);
443}
444
Allan Stephensd265fef2010-11-30 12:00:53 +0000445static inline u32 msg_nametype(struct tipc_msg *m)
446{
447 return msg_word(m, 8);
448}
449
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900450static inline void msg_set_nametype(struct tipc_msg *m, u32 n)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100451{
452 msg_set_word(m, 8, n);
453}
454
Allan Stephensd265fef2010-11-30 12:00:53 +0000455static inline u32 msg_nameinst(struct tipc_msg *m)
456{
457 return msg_word(m, 9);
458}
459
460static inline u32 msg_namelower(struct tipc_msg *m)
461{
462 return msg_nameinst(m);
463}
464
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900465static inline void msg_set_namelower(struct tipc_msg *m, u32 n)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100466{
467 msg_set_word(m, 9, n);
468}
469
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900470static inline void msg_set_nameinst(struct tipc_msg *m, u32 n)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100471{
472 msg_set_namelower(m, n);
473}
474
Allan Stephensd265fef2010-11-30 12:00:53 +0000475static inline u32 msg_nameupper(struct tipc_msg *m)
476{
477 return msg_word(m, 10);
478}
479
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900480static inline void msg_set_nameupper(struct tipc_msg *m, u32 n)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100481{
482 msg_set_word(m, 10, n);
483}
484
Per Lidenb97bf3f2006-01-02 19:04:38 +0100485/*
Allan Stephenscc4c4352011-04-08 10:50:52 -0400486 * Constants and routines used to read and write TIPC internal message headers
487 */
Per Lidenb97bf3f2006-01-02 19:04:38 +0100488
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900489/*
Allan Stephenscc4c4352011-04-08 10:50:52 -0400490 * Connection management protocol message types
Per Lidenb97bf3f2006-01-02 19:04:38 +0100491 */
Per Lidenb97bf3f2006-01-02 19:04:38 +0100492#define CONN_PROBE 0
493#define CONN_PROBE_REPLY 1
494#define CONN_ACK 2
495
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900496/*
Allan Stephenscc4c4352011-04-08 10:50:52 -0400497 * Name distributor message types
Per Lidenb97bf3f2006-01-02 19:04:38 +0100498 */
Per Lidenb97bf3f2006-01-02 19:04:38 +0100499#define PUBLICATION 0
500#define WITHDRAWAL 1
501
Allan Stephens92138d12011-04-08 11:04:15 -0400502/*
503 * Segmentation message types
504 */
Allan Stephens92138d12011-04-08 11:04:15 -0400505#define FIRST_FRAGMENT 0
506#define FRAGMENT 1
507#define LAST_FRAGMENT 2
508
509/*
510 * Link management protocol message types
511 */
Allan Stephens92138d12011-04-08 11:04:15 -0400512#define STATE_MSG 0
513#define RESET_MSG 1
514#define ACTIVATE_MSG 2
515
516/*
517 * Changeover tunnel message types
518 */
Jon Paul Maloydff29b12015-04-02 09:33:01 -0400519#define SYNCH_MSG 0
520#define FAILOVER_MSG 1
Allan Stephens92138d12011-04-08 11:04:15 -0400521
522/*
523 * Config protocol message types
524 */
Allan Stephens92138d12011-04-08 11:04:15 -0400525#define DSC_REQ_MSG 0
526#define DSC_RESP_MSG 1
527
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900528/*
Per Lidenb97bf3f2006-01-02 19:04:38 +0100529 * Word 1
530 */
Per Lidenb97bf3f2006-01-02 19:04:38 +0100531static inline u32 msg_seq_gap(struct tipc_msg *m)
532{
Allan Stephensbd784532008-06-04 17:47:30 -0700533 return msg_bits(m, 1, 16, 0x1fff);
Per Lidenb97bf3f2006-01-02 19:04:38 +0100534}
535
536static inline void msg_set_seq_gap(struct tipc_msg *m, u32 n)
537{
Allan Stephensbd784532008-06-04 17:47:30 -0700538 msg_set_bits(m, 1, 16, 0x1fff, n);
Per Lidenb97bf3f2006-01-02 19:04:38 +0100539}
540
Allan Stephensfc0eea62011-10-28 16:26:41 -0400541static inline u32 msg_node_sig(struct tipc_msg *m)
542{
543 return msg_bits(m, 1, 0, 0xffff);
544}
545
546static inline void msg_set_node_sig(struct tipc_msg *m, u32 n)
547{
548 msg_set_bits(m, 1, 0, 0xffff, n);
549}
550
Jon Paul Maloy7764d6e2015-03-13 16:08:05 -0400551static inline u32 msg_node_capabilities(struct tipc_msg *m)
552{
553 return msg_bits(m, 1, 15, 0x1fff);
554}
555
556static inline void msg_set_node_capabilities(struct tipc_msg *m, u32 n)
557{
558 msg_set_bits(m, 1, 15, 0x1fff, n);
559}
560
Jon Paul Maloy8b4ed862015-03-25 12:07:26 -0400561static inline bool msg_dup(struct tipc_msg *m)
562{
Jon Paul Maloydff29b12015-04-02 09:33:01 -0400563 if (likely(msg_user(m) != TUNNEL_PROTOCOL))
Jon Paul Maloy8b4ed862015-03-25 12:07:26 -0400564 return false;
Jon Paul Maloydff29b12015-04-02 09:33:01 -0400565 if (msg_type(m) != SYNCH_MSG)
Jon Paul Maloy8b4ed862015-03-25 12:07:26 -0400566 return false;
567 return true;
568}
Per Lidenb97bf3f2006-01-02 19:04:38 +0100569
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900570/*
Per Lidenb97bf3f2006-01-02 19:04:38 +0100571 * Word 2
572 */
Per Lidenb97bf3f2006-01-02 19:04:38 +0100573static inline u32 msg_dest_domain(struct tipc_msg *m)
574{
575 return msg_word(m, 2);
576}
577
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900578static inline void msg_set_dest_domain(struct tipc_msg *m, u32 n)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100579{
580 msg_set_word(m, 2, n);
581}
582
583static inline u32 msg_bcgap_after(struct tipc_msg *m)
584{
585 return msg_bits(m, 2, 16, 0xffff);
586}
587
588static inline void msg_set_bcgap_after(struct tipc_msg *m, u32 n)
589{
590 msg_set_bits(m, 2, 16, 0xffff, n);
591}
592
593static inline u32 msg_bcgap_to(struct tipc_msg *m)
594{
595 return msg_bits(m, 2, 0, 0xffff);
596}
597
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900598static inline void msg_set_bcgap_to(struct tipc_msg *m, u32 n)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100599{
600 msg_set_bits(m, 2, 0, 0xffff, n);
601}
602
603
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900604/*
Per Lidenb97bf3f2006-01-02 19:04:38 +0100605 * Word 4
606 */
Per Lidenb97bf3f2006-01-02 19:04:38 +0100607static inline u32 msg_last_bcast(struct tipc_msg *m)
608{
609 return msg_bits(m, 4, 16, 0xffff);
610}
611
612static inline void msg_set_last_bcast(struct tipc_msg *m, u32 n)
613{
614 msg_set_bits(m, 4, 16, 0xffff, n);
615}
616
Per Lidenb97bf3f2006-01-02 19:04:38 +0100617static inline void msg_set_fragm_no(struct tipc_msg *m, u32 n)
618{
619 msg_set_bits(m, 4, 16, 0xffff, n);
620}
621
622
623static inline u32 msg_next_sent(struct tipc_msg *m)
624{
625 return msg_bits(m, 4, 0, 0xffff);
626}
627
628static inline void msg_set_next_sent(struct tipc_msg *m, u32 n)
629{
630 msg_set_bits(m, 4, 0, 0xffff, n);
631}
632
Per Lidenb97bf3f2006-01-02 19:04:38 +0100633static inline void msg_set_long_msgno(struct tipc_msg *m, u32 n)
634{
635 msg_set_bits(m, 4, 0, 0xffff, n);
636}
637
638static inline u32 msg_bc_netid(struct tipc_msg *m)
639{
640 return msg_word(m, 4);
641}
642
643static inline void msg_set_bc_netid(struct tipc_msg *m, u32 id)
644{
645 msg_set_word(m, 4, id);
646}
647
648static inline u32 msg_link_selector(struct tipc_msg *m)
649{
650 return msg_bits(m, 4, 0, 1);
651}
652
653static inline void msg_set_link_selector(struct tipc_msg *m, u32 n)
654{
Allan Stephens7eb878e2011-05-25 13:28:27 -0400655 msg_set_bits(m, 4, 0, 1, n);
Per Lidenb97bf3f2006-01-02 19:04:38 +0100656}
657
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900658/*
Per Lidenb97bf3f2006-01-02 19:04:38 +0100659 * Word 5
660 */
Per Lidenb97bf3f2006-01-02 19:04:38 +0100661static inline u32 msg_session(struct tipc_msg *m)
662{
663 return msg_bits(m, 5, 16, 0xffff);
664}
665
666static inline void msg_set_session(struct tipc_msg *m, u32 n)
667{
668 msg_set_bits(m, 5, 16, 0xffff, n);
669}
670
671static inline u32 msg_probe(struct tipc_msg *m)
672{
673 return msg_bits(m, 5, 0, 1);
674}
675
676static inline void msg_set_probe(struct tipc_msg *m, u32 val)
677{
Allan Stephens7eb878e2011-05-25 13:28:27 -0400678 msg_set_bits(m, 5, 0, 1, val);
Per Lidenb97bf3f2006-01-02 19:04:38 +0100679}
680
681static inline char msg_net_plane(struct tipc_msg *m)
682{
683 return msg_bits(m, 5, 1, 7) + 'A';
684}
685
686static inline void msg_set_net_plane(struct tipc_msg *m, char n)
687{
688 msg_set_bits(m, 5, 1, 7, (n - 'A'));
689}
690
691static inline u32 msg_linkprio(struct tipc_msg *m)
692{
693 return msg_bits(m, 5, 4, 0x1f);
694}
695
696static inline void msg_set_linkprio(struct tipc_msg *m, u32 n)
697{
698 msg_set_bits(m, 5, 4, 0x1f, n);
699}
700
701static inline u32 msg_bearer_id(struct tipc_msg *m)
702{
703 return msg_bits(m, 5, 9, 0x7);
704}
705
706static inline void msg_set_bearer_id(struct tipc_msg *m, u32 n)
707{
708 msg_set_bits(m, 5, 9, 0x7, n);
709}
710
711static inline u32 msg_redundant_link(struct tipc_msg *m)
712{
713 return msg_bits(m, 5, 12, 0x1);
714}
715
Allan Stephens77f167f2011-02-28 15:30:20 -0500716static inline void msg_set_redundant_link(struct tipc_msg *m, u32 r)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100717{
Allan Stephens77f167f2011-02-28 15:30:20 -0500718 msg_set_bits(m, 5, 12, 0x1, r);
Per Lidenb97bf3f2006-01-02 19:04:38 +0100719}
720
Allan Stephens3d749a62011-10-07 15:19:11 -0400721static inline char *msg_media_addr(struct tipc_msg *m)
722{
Erik Hugne91e2eb52015-02-27 08:56:57 +0100723 return (char *)&m->hdr[TIPC_MEDIA_INFO_OFFSET];
Allan Stephens3d749a62011-10-07 15:19:11 -0400724}
Per Lidenb97bf3f2006-01-02 19:04:38 +0100725
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900726/*
Per Lidenb97bf3f2006-01-02 19:04:38 +0100727 * Word 9
728 */
Per Lidenb97bf3f2006-01-02 19:04:38 +0100729static inline u32 msg_msgcnt(struct tipc_msg *m)
730{
731 return msg_bits(m, 9, 16, 0xffff);
732}
733
734static inline void msg_set_msgcnt(struct tipc_msg *m, u32 n)
735{
736 msg_set_bits(m, 9, 16, 0xffff, n);
737}
738
739static inline u32 msg_bcast_tag(struct tipc_msg *m)
740{
741 return msg_bits(m, 9, 16, 0xffff);
742}
743
744static inline void msg_set_bcast_tag(struct tipc_msg *m, u32 n)
745{
746 msg_set_bits(m, 9, 16, 0xffff, n);
747}
748
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900749static inline u32 msg_max_pkt(struct tipc_msg *m)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100750{
Eric Dumazeta02cec22010-09-22 20:43:57 +0000751 return msg_bits(m, 9, 16, 0xffff) * 4;
Per Lidenb97bf3f2006-01-02 19:04:38 +0100752}
753
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900754static inline void msg_set_max_pkt(struct tipc_msg *m, u32 n)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100755{
756 msg_set_bits(m, 9, 16, 0xffff, (n / 4));
757}
758
759static inline u32 msg_link_tolerance(struct tipc_msg *m)
760{
761 return msg_bits(m, 9, 0, 0xffff);
762}
763
764static inline void msg_set_link_tolerance(struct tipc_msg *m, u32 n)
765{
766 msg_set_bits(m, 9, 0, 0xffff, n);
767}
768
Ying Xue859fc7c2015-01-09 15:27:01 +0800769struct sk_buff *tipc_buf_acquire(u32 size);
Jon Paul Maloycf2157f2015-03-13 16:08:06 -0400770bool tipc_msg_validate(struct sk_buff *skb);
Jon Paul Maloyc5898632015-02-05 08:36:36 -0500771bool tipc_msg_reverse(u32 own_addr, struct sk_buff *buf, u32 *dnode,
Ying Xue34747532015-01-09 15:27:10 +0800772 int err);
Jon Paul Maloyc5898632015-02-05 08:36:36 -0500773void tipc_msg_init(u32 own_addr, struct tipc_msg *m, u32 user, u32 type,
Ying Xue34747532015-01-09 15:27:10 +0800774 u32 hsize, u32 destnode);
Jon Paul Maloye3a77562015-02-05 08:36:39 -0500775struct sk_buff *tipc_msg_create(uint user, uint type, uint hdr_sz,
776 uint data_sz, u32 dnode, u32 onode,
777 u32 dport, u32 oport, int errcode);
Jon Paul Maloy37e22162014-05-14 05:39:12 -0400778int tipc_buf_append(struct sk_buff **headbuf, struct sk_buff **buf);
Jon Paul Maloy05dcc5a2015-03-13 16:08:10 -0400779bool tipc_msg_bundle(struct sk_buff *bskb, struct sk_buff *skb, u32 mtu);
780
781bool tipc_msg_make_bundle(struct sk_buff **skb, u32 mtu, u32 dnode);
Jon Paul Maloyc637c102015-02-05 08:36:41 -0500782bool tipc_msg_extract(struct sk_buff *skb, struct sk_buff **iskb, int *pos);
Jon Paul Maloyc5898632015-02-05 08:36:36 -0500783int tipc_msg_build(struct tipc_msg *mhdr, struct msghdr *m,
Ying Xue34747532015-01-09 15:27:10 +0800784 int offset, int dsz, int mtu, struct sk_buff_head *list);
Jon Paul Maloye3a77562015-02-05 08:36:39 -0500785bool tipc_msg_lookup_dest(struct net *net, struct sk_buff *skb, u32 *dnode,
786 int *err);
Ying Xuea6ca1092014-11-26 11:41:55 +0800787struct sk_buff *tipc_msg_reassemble(struct sk_buff_head *list);
Jon Paul Maloy078bec82014-07-16 20:41:00 -0400788
Jon Paul Maloye4bf4f72015-05-14 10:46:14 -0400789static inline u16 buf_seqno(struct sk_buff *skb)
790{
791 return msg_seqno(buf_msg(skb));
792}
793
Jon Paul Maloycb1b7282015-02-05 08:36:44 -0500794/* tipc_skb_peek(): peek and reserve first buffer in list
795 * @list: list to be peeked in
796 * Returns pointer to first buffer in list, if any
797 */
798static inline struct sk_buff *tipc_skb_peek(struct sk_buff_head *list,
799 spinlock_t *lock)
800{
801 struct sk_buff *skb;
802
803 spin_lock_bh(lock);
804 skb = skb_peek(list);
805 if (skb)
806 skb_get(skb);
807 spin_unlock_bh(lock);
808 return skb;
809}
810
Jon Paul Maloyc637c102015-02-05 08:36:41 -0500811/* tipc_skb_peek_port(): find a destination port, ignoring all destinations
812 * up to and including 'filter'.
813 * Note: ignoring previously tried destinations minimizes the risk of
814 * contention on the socket lock
815 * @list: list to be peeked in
816 * @filter: last destination to be ignored from search
817 * Returns a destination port number, of applicable.
818 */
819static inline u32 tipc_skb_peek_port(struct sk_buff_head *list, u32 filter)
820{
821 struct sk_buff *skb;
822 u32 dport = 0;
823 bool ignore = true;
824
825 spin_lock_bh(&list->lock);
826 skb_queue_walk(list, skb) {
827 dport = msg_destport(buf_msg(skb));
828 if (!filter || skb_queue_is_last(list, skb))
829 break;
830 if (dport == filter)
831 ignore = false;
832 else if (!ignore)
833 break;
834 }
835 spin_unlock_bh(&list->lock);
836 return dport;
837}
838
839/* tipc_skb_dequeue(): unlink first buffer with dest 'dport' from list
840 * @list: list to be unlinked from
841 * @dport: selection criteria for buffer to unlink
842 */
843static inline struct sk_buff *tipc_skb_dequeue(struct sk_buff_head *list,
844 u32 dport)
845{
846 struct sk_buff *_skb, *tmp, *skb = NULL;
847
848 spin_lock_bh(&list->lock);
849 skb_queue_walk_safe(list, _skb, tmp) {
850 if (msg_destport(buf_msg(_skb)) == dport) {
851 __skb_unlink(_skb, list);
852 skb = _skb;
853 break;
854 }
855 }
856 spin_unlock_bh(&list->lock);
857 return skb;
858}
859
860/* tipc_skb_queue_tail(): add buffer to tail of list;
861 * @list: list to be appended to
862 * @skb: buffer to append. Always appended
863 * @dport: the destination port of the buffer
864 * returns true if dport differs from previous destination
865 */
866static inline bool tipc_skb_queue_tail(struct sk_buff_head *list,
867 struct sk_buff *skb, u32 dport)
868{
869 struct sk_buff *_skb = NULL;
870 bool rv = false;
871
872 spin_lock_bh(&list->lock);
873 _skb = skb_peek_tail(list);
874 if (!_skb || (msg_destport(buf_msg(_skb)) != dport) ||
875 (skb_queue_len(list) > 32))
876 rv = true;
877 __skb_queue_tail(list, skb);
878 spin_unlock_bh(&list->lock);
879 return rv;
880}
881
Per Lidenb97bf3f2006-01-02 19:04:38 +0100882#endif