blob: 6ca2366f3a53011ac347e54ac091793c52e75774 [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{
355 if (unlikely(msg_user(m) == MSG_FRAGMENTER))
356 return msg_bits(m, 5, 13, 0x7);
357 if (likely(msg_isdata(m) && !msg_errcode(m)))
358 return msg_user(m);
359 return TIPC_SYSTEM_IMPORTANCE;
360}
361
362static inline void msg_set_importance(struct tipc_msg *m, u32 i)
363{
364 if (unlikely(msg_user(m) == MSG_FRAGMENTER))
365 msg_set_bits(m, 5, 13, 0x7, i);
366 else if (likely(i < TIPC_SYSTEM_IMPORTANCE))
367 msg_set_user(m, i);
368 else
369 pr_warn("Trying to set illegal importance in message\n");
370}
371
Allan Stephensd265fef2010-11-30 12:00:53 +0000372static inline u32 msg_prevnode(struct tipc_msg *m)
373{
374 return msg_word(m, 3);
375}
376
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900377static inline void msg_set_prevnode(struct tipc_msg *m, u32 a)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100378{
379 msg_set_word(m, 3, a);
380}
381
Allan Stephensd265fef2010-11-30 12:00:53 +0000382static inline u32 msg_origport(struct tipc_msg *m)
383{
Jon Paul Maloy3127a022015-03-25 12:07:25 -0400384 if (msg_user(m) == MSG_FRAGMENTER)
385 m = msg_get_wrapped(m);
Allan Stephensd265fef2010-11-30 12:00:53 +0000386 return msg_word(m, 4);
387}
388
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900389static inline void msg_set_origport(struct tipc_msg *m, u32 p)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100390{
391 msg_set_word(m, 4, p);
392}
393
Allan Stephensd265fef2010-11-30 12:00:53 +0000394static inline u32 msg_destport(struct tipc_msg *m)
395{
396 return msg_word(m, 5);
397}
398
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900399static inline void msg_set_destport(struct tipc_msg *m, u32 p)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100400{
401 msg_set_word(m, 5, p);
402}
403
Allan Stephensd265fef2010-11-30 12:00:53 +0000404static inline u32 msg_mc_netid(struct tipc_msg *m)
405{
406 return msg_word(m, 5);
407}
408
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900409static inline void msg_set_mc_netid(struct tipc_msg *m, u32 p)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100410{
411 msg_set_word(m, 5, p);
412}
413
Allan Stephensd265fef2010-11-30 12:00:53 +0000414static inline int msg_short(struct tipc_msg *m)
415{
Allan Stephens741d9eb2011-05-31 15:03:18 -0400416 return msg_hdr_sz(m) == SHORT_H_SIZE;
Allan Stephensd265fef2010-11-30 12:00:53 +0000417}
418
419static inline u32 msg_orignode(struct tipc_msg *m)
420{
421 if (likely(msg_short(m)))
422 return msg_prevnode(m);
423 return msg_word(m, 6);
424}
425
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900426static inline void msg_set_orignode(struct tipc_msg *m, u32 a)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100427{
428 msg_set_word(m, 6, a);
429}
430
Allan Stephensd265fef2010-11-30 12:00:53 +0000431static inline u32 msg_destnode(struct tipc_msg *m)
432{
433 return msg_word(m, 7);
434}
435
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900436static inline void msg_set_destnode(struct tipc_msg *m, u32 a)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100437{
438 msg_set_word(m, 7, a);
439}
440
Allan Stephensd265fef2010-11-30 12:00:53 +0000441static inline u32 msg_nametype(struct tipc_msg *m)
442{
443 return msg_word(m, 8);
444}
445
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900446static inline void msg_set_nametype(struct tipc_msg *m, u32 n)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100447{
448 msg_set_word(m, 8, n);
449}
450
Allan Stephensd265fef2010-11-30 12:00:53 +0000451static inline u32 msg_nameinst(struct tipc_msg *m)
452{
453 return msg_word(m, 9);
454}
455
456static inline u32 msg_namelower(struct tipc_msg *m)
457{
458 return msg_nameinst(m);
459}
460
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900461static inline void msg_set_namelower(struct tipc_msg *m, u32 n)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100462{
463 msg_set_word(m, 9, n);
464}
465
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900466static inline void msg_set_nameinst(struct tipc_msg *m, u32 n)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100467{
468 msg_set_namelower(m, n);
469}
470
Allan Stephensd265fef2010-11-30 12:00:53 +0000471static inline u32 msg_nameupper(struct tipc_msg *m)
472{
473 return msg_word(m, 10);
474}
475
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900476static inline void msg_set_nameupper(struct tipc_msg *m, u32 n)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100477{
478 msg_set_word(m, 10, n);
479}
480
Per Lidenb97bf3f2006-01-02 19:04:38 +0100481/*
Allan Stephenscc4c4352011-04-08 10:50:52 -0400482 * Constants and routines used to read and write TIPC internal message headers
483 */
Per Lidenb97bf3f2006-01-02 19:04:38 +0100484
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900485/*
Allan Stephenscc4c4352011-04-08 10:50:52 -0400486 * Connection management protocol message types
Per Lidenb97bf3f2006-01-02 19:04:38 +0100487 */
Per Lidenb97bf3f2006-01-02 19:04:38 +0100488#define CONN_PROBE 0
489#define CONN_PROBE_REPLY 1
490#define CONN_ACK 2
491
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900492/*
Allan Stephenscc4c4352011-04-08 10:50:52 -0400493 * Name distributor message types
Per Lidenb97bf3f2006-01-02 19:04:38 +0100494 */
Per Lidenb97bf3f2006-01-02 19:04:38 +0100495#define PUBLICATION 0
496#define WITHDRAWAL 1
497
Allan Stephens92138d12011-04-08 11:04:15 -0400498/*
499 * Segmentation message types
500 */
Allan Stephens92138d12011-04-08 11:04:15 -0400501#define FIRST_FRAGMENT 0
502#define FRAGMENT 1
503#define LAST_FRAGMENT 2
504
505/*
506 * Link management protocol message types
507 */
Allan Stephens92138d12011-04-08 11:04:15 -0400508#define STATE_MSG 0
509#define RESET_MSG 1
510#define ACTIVATE_MSG 2
511
512/*
513 * Changeover tunnel message types
514 */
Jon Paul Maloydff29b12015-04-02 09:33:01 -0400515#define SYNCH_MSG 0
516#define FAILOVER_MSG 1
Allan Stephens92138d12011-04-08 11:04:15 -0400517
518/*
519 * Config protocol message types
520 */
Allan Stephens92138d12011-04-08 11:04:15 -0400521#define DSC_REQ_MSG 0
522#define DSC_RESP_MSG 1
523
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900524/*
Per Lidenb97bf3f2006-01-02 19:04:38 +0100525 * Word 1
526 */
Per Lidenb97bf3f2006-01-02 19:04:38 +0100527static inline u32 msg_seq_gap(struct tipc_msg *m)
528{
Allan Stephensbd784532008-06-04 17:47:30 -0700529 return msg_bits(m, 1, 16, 0x1fff);
Per Lidenb97bf3f2006-01-02 19:04:38 +0100530}
531
532static inline void msg_set_seq_gap(struct tipc_msg *m, u32 n)
533{
Allan Stephensbd784532008-06-04 17:47:30 -0700534 msg_set_bits(m, 1, 16, 0x1fff, n);
Per Lidenb97bf3f2006-01-02 19:04:38 +0100535}
536
Allan Stephensfc0eea62011-10-28 16:26:41 -0400537static inline u32 msg_node_sig(struct tipc_msg *m)
538{
539 return msg_bits(m, 1, 0, 0xffff);
540}
541
542static inline void msg_set_node_sig(struct tipc_msg *m, u32 n)
543{
544 msg_set_bits(m, 1, 0, 0xffff, n);
545}
546
Jon Paul Maloy7764d6e2015-03-13 16:08:05 -0400547static inline u32 msg_node_capabilities(struct tipc_msg *m)
548{
549 return msg_bits(m, 1, 15, 0x1fff);
550}
551
552static inline void msg_set_node_capabilities(struct tipc_msg *m, u32 n)
553{
554 msg_set_bits(m, 1, 15, 0x1fff, n);
555}
556
Jon Paul Maloy8b4ed862015-03-25 12:07:26 -0400557static inline bool msg_dup(struct tipc_msg *m)
558{
Jon Paul Maloydff29b12015-04-02 09:33:01 -0400559 if (likely(msg_user(m) != TUNNEL_PROTOCOL))
Jon Paul Maloy8b4ed862015-03-25 12:07:26 -0400560 return false;
Jon Paul Maloydff29b12015-04-02 09:33:01 -0400561 if (msg_type(m) != SYNCH_MSG)
Jon Paul Maloy8b4ed862015-03-25 12:07:26 -0400562 return false;
563 return true;
564}
Per Lidenb97bf3f2006-01-02 19:04:38 +0100565
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900566/*
Per Lidenb97bf3f2006-01-02 19:04:38 +0100567 * Word 2
568 */
Per Lidenb97bf3f2006-01-02 19:04:38 +0100569static inline u32 msg_dest_domain(struct tipc_msg *m)
570{
571 return msg_word(m, 2);
572}
573
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900574static inline void msg_set_dest_domain(struct tipc_msg *m, u32 n)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100575{
576 msg_set_word(m, 2, n);
577}
578
579static inline u32 msg_bcgap_after(struct tipc_msg *m)
580{
581 return msg_bits(m, 2, 16, 0xffff);
582}
583
584static inline void msg_set_bcgap_after(struct tipc_msg *m, u32 n)
585{
586 msg_set_bits(m, 2, 16, 0xffff, n);
587}
588
589static inline u32 msg_bcgap_to(struct tipc_msg *m)
590{
591 return msg_bits(m, 2, 0, 0xffff);
592}
593
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900594static inline void msg_set_bcgap_to(struct tipc_msg *m, u32 n)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100595{
596 msg_set_bits(m, 2, 0, 0xffff, n);
597}
598
599
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900600/*
Per Lidenb97bf3f2006-01-02 19:04:38 +0100601 * Word 4
602 */
Per Lidenb97bf3f2006-01-02 19:04:38 +0100603static inline u32 msg_last_bcast(struct tipc_msg *m)
604{
605 return msg_bits(m, 4, 16, 0xffff);
606}
607
608static inline void msg_set_last_bcast(struct tipc_msg *m, u32 n)
609{
610 msg_set_bits(m, 4, 16, 0xffff, n);
611}
612
Per Lidenb97bf3f2006-01-02 19:04:38 +0100613static inline void msg_set_fragm_no(struct tipc_msg *m, u32 n)
614{
615 msg_set_bits(m, 4, 16, 0xffff, n);
616}
617
618
619static inline u32 msg_next_sent(struct tipc_msg *m)
620{
621 return msg_bits(m, 4, 0, 0xffff);
622}
623
624static inline void msg_set_next_sent(struct tipc_msg *m, u32 n)
625{
626 msg_set_bits(m, 4, 0, 0xffff, n);
627}
628
Per Lidenb97bf3f2006-01-02 19:04:38 +0100629static inline void msg_set_long_msgno(struct tipc_msg *m, u32 n)
630{
631 msg_set_bits(m, 4, 0, 0xffff, n);
632}
633
634static inline u32 msg_bc_netid(struct tipc_msg *m)
635{
636 return msg_word(m, 4);
637}
638
639static inline void msg_set_bc_netid(struct tipc_msg *m, u32 id)
640{
641 msg_set_word(m, 4, id);
642}
643
644static inline u32 msg_link_selector(struct tipc_msg *m)
645{
646 return msg_bits(m, 4, 0, 1);
647}
648
649static inline void msg_set_link_selector(struct tipc_msg *m, u32 n)
650{
Allan Stephens7eb878e2011-05-25 13:28:27 -0400651 msg_set_bits(m, 4, 0, 1, n);
Per Lidenb97bf3f2006-01-02 19:04:38 +0100652}
653
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900654/*
Per Lidenb97bf3f2006-01-02 19:04:38 +0100655 * Word 5
656 */
Per Lidenb97bf3f2006-01-02 19:04:38 +0100657static inline u32 msg_session(struct tipc_msg *m)
658{
659 return msg_bits(m, 5, 16, 0xffff);
660}
661
662static inline void msg_set_session(struct tipc_msg *m, u32 n)
663{
664 msg_set_bits(m, 5, 16, 0xffff, n);
665}
666
667static inline u32 msg_probe(struct tipc_msg *m)
668{
669 return msg_bits(m, 5, 0, 1);
670}
671
672static inline void msg_set_probe(struct tipc_msg *m, u32 val)
673{
Allan Stephens7eb878e2011-05-25 13:28:27 -0400674 msg_set_bits(m, 5, 0, 1, val);
Per Lidenb97bf3f2006-01-02 19:04:38 +0100675}
676
677static inline char msg_net_plane(struct tipc_msg *m)
678{
679 return msg_bits(m, 5, 1, 7) + 'A';
680}
681
682static inline void msg_set_net_plane(struct tipc_msg *m, char n)
683{
684 msg_set_bits(m, 5, 1, 7, (n - 'A'));
685}
686
687static inline u32 msg_linkprio(struct tipc_msg *m)
688{
689 return msg_bits(m, 5, 4, 0x1f);
690}
691
692static inline void msg_set_linkprio(struct tipc_msg *m, u32 n)
693{
694 msg_set_bits(m, 5, 4, 0x1f, n);
695}
696
697static inline u32 msg_bearer_id(struct tipc_msg *m)
698{
699 return msg_bits(m, 5, 9, 0x7);
700}
701
702static inline void msg_set_bearer_id(struct tipc_msg *m, u32 n)
703{
704 msg_set_bits(m, 5, 9, 0x7, n);
705}
706
707static inline u32 msg_redundant_link(struct tipc_msg *m)
708{
709 return msg_bits(m, 5, 12, 0x1);
710}
711
Allan Stephens77f167f2011-02-28 15:30:20 -0500712static inline void msg_set_redundant_link(struct tipc_msg *m, u32 r)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100713{
Allan Stephens77f167f2011-02-28 15:30:20 -0500714 msg_set_bits(m, 5, 12, 0x1, r);
Per Lidenb97bf3f2006-01-02 19:04:38 +0100715}
716
Allan Stephens3d749a62011-10-07 15:19:11 -0400717static inline char *msg_media_addr(struct tipc_msg *m)
718{
Erik Hugne91e2eb52015-02-27 08:56:57 +0100719 return (char *)&m->hdr[TIPC_MEDIA_INFO_OFFSET];
Allan Stephens3d749a62011-10-07 15:19:11 -0400720}
Per Lidenb97bf3f2006-01-02 19:04:38 +0100721
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900722/*
Per Lidenb97bf3f2006-01-02 19:04:38 +0100723 * Word 9
724 */
Per Lidenb97bf3f2006-01-02 19:04:38 +0100725static inline u32 msg_msgcnt(struct tipc_msg *m)
726{
727 return msg_bits(m, 9, 16, 0xffff);
728}
729
730static inline void msg_set_msgcnt(struct tipc_msg *m, u32 n)
731{
732 msg_set_bits(m, 9, 16, 0xffff, n);
733}
734
735static inline u32 msg_bcast_tag(struct tipc_msg *m)
736{
737 return msg_bits(m, 9, 16, 0xffff);
738}
739
740static inline void msg_set_bcast_tag(struct tipc_msg *m, u32 n)
741{
742 msg_set_bits(m, 9, 16, 0xffff, n);
743}
744
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900745static inline u32 msg_max_pkt(struct tipc_msg *m)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100746{
Eric Dumazeta02cec22010-09-22 20:43:57 +0000747 return msg_bits(m, 9, 16, 0xffff) * 4;
Per Lidenb97bf3f2006-01-02 19:04:38 +0100748}
749
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900750static inline void msg_set_max_pkt(struct tipc_msg *m, u32 n)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100751{
752 msg_set_bits(m, 9, 16, 0xffff, (n / 4));
753}
754
755static inline u32 msg_link_tolerance(struct tipc_msg *m)
756{
757 return msg_bits(m, 9, 0, 0xffff);
758}
759
760static inline void msg_set_link_tolerance(struct tipc_msg *m, u32 n)
761{
762 msg_set_bits(m, 9, 0, 0xffff, n);
763}
764
Ying Xue859fc7c2015-01-09 15:27:01 +0800765struct sk_buff *tipc_buf_acquire(u32 size);
Jon Paul Maloycf2157f2015-03-13 16:08:06 -0400766bool tipc_msg_validate(struct sk_buff *skb);
Jon Paul Maloyc5898632015-02-05 08:36:36 -0500767bool tipc_msg_reverse(u32 own_addr, struct sk_buff *buf, u32 *dnode,
Ying Xue34747532015-01-09 15:27:10 +0800768 int err);
Jon Paul Maloyc5898632015-02-05 08:36:36 -0500769void tipc_msg_init(u32 own_addr, struct tipc_msg *m, u32 user, u32 type,
Ying Xue34747532015-01-09 15:27:10 +0800770 u32 hsize, u32 destnode);
Jon Paul Maloye3a77562015-02-05 08:36:39 -0500771struct sk_buff *tipc_msg_create(uint user, uint type, uint hdr_sz,
772 uint data_sz, u32 dnode, u32 onode,
773 u32 dport, u32 oport, int errcode);
Jon Paul Maloy37e22162014-05-14 05:39:12 -0400774int tipc_buf_append(struct sk_buff **headbuf, struct sk_buff **buf);
Jon Paul Maloy05dcc5a2015-03-13 16:08:10 -0400775bool tipc_msg_bundle(struct sk_buff *bskb, struct sk_buff *skb, u32 mtu);
776
777bool tipc_msg_make_bundle(struct sk_buff **skb, u32 mtu, u32 dnode);
Jon Paul Maloyc637c102015-02-05 08:36:41 -0500778bool tipc_msg_extract(struct sk_buff *skb, struct sk_buff **iskb, int *pos);
Jon Paul Maloyc5898632015-02-05 08:36:36 -0500779int tipc_msg_build(struct tipc_msg *mhdr, struct msghdr *m,
Ying Xue34747532015-01-09 15:27:10 +0800780 int offset, int dsz, int mtu, struct sk_buff_head *list);
Jon Paul Maloye3a77562015-02-05 08:36:39 -0500781bool tipc_msg_lookup_dest(struct net *net, struct sk_buff *skb, u32 *dnode,
782 int *err);
Ying Xuea6ca1092014-11-26 11:41:55 +0800783struct sk_buff *tipc_msg_reassemble(struct sk_buff_head *list);
Jon Paul Maloy078bec82014-07-16 20:41:00 -0400784
Jon Paul Maloye4bf4f72015-05-14 10:46:14 -0400785static inline u16 buf_seqno(struct sk_buff *skb)
786{
787 return msg_seqno(buf_msg(skb));
788}
789
Jon Paul Maloycb1b7282015-02-05 08:36:44 -0500790/* tipc_skb_peek(): peek and reserve first buffer in list
791 * @list: list to be peeked in
792 * Returns pointer to first buffer in list, if any
793 */
794static inline struct sk_buff *tipc_skb_peek(struct sk_buff_head *list,
795 spinlock_t *lock)
796{
797 struct sk_buff *skb;
798
799 spin_lock_bh(lock);
800 skb = skb_peek(list);
801 if (skb)
802 skb_get(skb);
803 spin_unlock_bh(lock);
804 return skb;
805}
806
Jon Paul Maloyc637c102015-02-05 08:36:41 -0500807/* tipc_skb_peek_port(): find a destination port, ignoring all destinations
808 * up to and including 'filter'.
809 * Note: ignoring previously tried destinations minimizes the risk of
810 * contention on the socket lock
811 * @list: list to be peeked in
812 * @filter: last destination to be ignored from search
813 * Returns a destination port number, of applicable.
814 */
815static inline u32 tipc_skb_peek_port(struct sk_buff_head *list, u32 filter)
816{
817 struct sk_buff *skb;
818 u32 dport = 0;
819 bool ignore = true;
820
821 spin_lock_bh(&list->lock);
822 skb_queue_walk(list, skb) {
823 dport = msg_destport(buf_msg(skb));
824 if (!filter || skb_queue_is_last(list, skb))
825 break;
826 if (dport == filter)
827 ignore = false;
828 else if (!ignore)
829 break;
830 }
831 spin_unlock_bh(&list->lock);
832 return dport;
833}
834
835/* tipc_skb_dequeue(): unlink first buffer with dest 'dport' from list
836 * @list: list to be unlinked from
837 * @dport: selection criteria for buffer to unlink
838 */
839static inline struct sk_buff *tipc_skb_dequeue(struct sk_buff_head *list,
840 u32 dport)
841{
842 struct sk_buff *_skb, *tmp, *skb = NULL;
843
844 spin_lock_bh(&list->lock);
845 skb_queue_walk_safe(list, _skb, tmp) {
846 if (msg_destport(buf_msg(_skb)) == dport) {
847 __skb_unlink(_skb, list);
848 skb = _skb;
849 break;
850 }
851 }
852 spin_unlock_bh(&list->lock);
853 return skb;
854}
855
856/* tipc_skb_queue_tail(): add buffer to tail of list;
857 * @list: list to be appended to
858 * @skb: buffer to append. Always appended
859 * @dport: the destination port of the buffer
860 * returns true if dport differs from previous destination
861 */
862static inline bool tipc_skb_queue_tail(struct sk_buff_head *list,
863 struct sk_buff *skb, u32 dport)
864{
865 struct sk_buff *_skb = NULL;
866 bool rv = false;
867
868 spin_lock_bh(&list->lock);
869 _skb = skb_peek_tail(list);
870 if (!_skb || (msg_destport(buf_msg(_skb)) != dport) ||
871 (skb_queue_len(list) > 32))
872 rv = true;
873 __skb_queue_tail(list, skb);
874 spin_unlock_bh(&list->lock);
875 return rv;
876}
877
Per Lidenb97bf3f2006-01-02 19:04:38 +0100878#endif