blob: 6c0455caf3028b3c704ee662b48956cc0d4bd74b [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>
Jon Paul Maloyd9992972015-07-16 16:54:31 -040041#include "core.h"
Per Lidenb97bf3f2006-01-02 19:04:38 +010042
Allan Stephenscc4c4352011-04-08 10:50:52 -040043/*
44 * Constants and routines used to read and write TIPC payload message headers
45 *
46 * Note: Some items are also used with TIPC internal message headers
47 */
Per Lidenb97bf3f2006-01-02 19:04:38 +010048#define TIPC_VERSION 2
Jon Paul Maloyc637c102015-02-05 08:36:41 -050049struct plist;
Allan Stephens06d82c92008-03-06 15:06:55 -080050
Allan Stephensd265fef2010-11-30 12:00:53 +000051/*
Allan Stephenscc4c4352011-04-08 10:50:52 -040052 * Payload message users are defined in TIPC's public API:
53 * - TIPC_LOW_IMPORTANCE
54 * - TIPC_MEDIUM_IMPORTANCE
55 * - TIPC_HIGH_IMPORTANCE
56 * - TIPC_CRITICAL_IMPORTANCE
57 */
Jon Paul Maloye3eea1e2015-03-13 16:08:11 -040058#define TIPC_SYSTEM_IMPORTANCE 4
59
Allan Stephenscc4c4352011-04-08 10:50:52 -040060
61/*
62 * Payload message types
Allan Stephensd265fef2010-11-30 12:00:53 +000063 */
Allan Stephensd265fef2010-11-30 12:00:53 +000064#define TIPC_CONN_MSG 0
65#define TIPC_MCAST_MSG 1
66#define TIPC_NAMED_MSG 2
67#define TIPC_DIRECT_MSG 3
68
Allan Stephenscc4c4352011-04-08 10:50:52 -040069/*
Jon Paul Maloye3eea1e2015-03-13 16:08:11 -040070 * Internal message users
71 */
72#define BCAST_PROTOCOL 5
73#define MSG_BUNDLER 6
74#define LINK_PROTOCOL 7
75#define CONN_MANAGER 8
Jon Paul Maloydff29b12015-04-02 09:33:01 -040076#define TUNNEL_PROTOCOL 10
Jon Paul Maloye3eea1e2015-03-13 16:08:11 -040077#define NAME_DISTRIBUTOR 11
78#define MSG_FRAGMENTER 12
79#define LINK_CONFIG 13
80#define SOCK_WAKEUP 14 /* pseudo user */
81
82/*
Allan Stephenscc4c4352011-04-08 10:50:52 -040083 * Message header sizes
84 */
Allan Stephens741d9eb2011-05-31 15:03:18 -040085#define SHORT_H_SIZE 24 /* In-cluster basic payload message */
86#define BASIC_H_SIZE 32 /* Basic payload message */
87#define NAMED_H_SIZE 40 /* Named payload message */
88#define MCAST_H_SIZE 44 /* Multicast payload message */
Allan Stephens06d82c92008-03-06 15:06:55 -080089#define INT_H_SIZE 40 /* Internal messages */
90#define MIN_H_SIZE 24 /* Smallest legal TIPC header size */
91#define MAX_H_SIZE 60 /* Largest possible TIPC header size */
92
Per Lidenb97bf3f2006-01-02 19:04:38 +010093#define MAX_MSG_SIZE (MAX_H_SIZE + TIPC_MAX_USER_MSG_SIZE)
Per Lidenb97bf3f2006-01-02 19:04:38 +010094
Erik Hugne91e2eb52015-02-27 08:56:57 +010095#define TIPC_MEDIA_INFO_OFFSET 5
Allan Stephens3d749a62011-10-07 15:19:11 -040096
Ying Xue859fc7c2015-01-09 15:27:01 +080097struct tipc_skb_cb {
98 void *handle;
99 struct sk_buff *tail;
Jon Paul Maloycf2157f2015-03-13 16:08:06 -0400100 bool validated;
Ying Xue859fc7c2015-01-09 15:27:01 +0800101 bool wakeup_pending;
Ying Xue859fc7c2015-01-09 15:27:01 +0800102 u16 chain_sz;
103 u16 chain_imp;
Jon Paul Maloyc1ab3f1d2015-10-22 08:51:38 -0400104 u16 ackers;
Ying Xue859fc7c2015-01-09 15:27:01 +0800105};
106
107#define TIPC_SKB_CB(__skb) ((struct tipc_skb_cb *)&((__skb)->cb[0]))
108
Allan Stephensd265fef2010-11-30 12:00:53 +0000109struct tipc_msg {
110 __be32 hdr[15];
111};
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900112
Ying Xue859fc7c2015-01-09 15:27:01 +0800113static inline struct tipc_msg *buf_msg(struct sk_buff *skb)
114{
115 return (struct tipc_msg *)skb->data;
116}
117
Allan Stephensd265fef2010-11-30 12:00:53 +0000118static inline u32 msg_word(struct tipc_msg *m, u32 pos)
119{
120 return ntohl(m->hdr[pos]);
121}
Per Lidenb97bf3f2006-01-02 19:04:38 +0100122
123static inline void msg_set_word(struct tipc_msg *m, u32 w, u32 val)
124{
125 m->hdr[w] = htonl(val);
126}
127
Allan Stephensd265fef2010-11-30 12:00:53 +0000128static inline u32 msg_bits(struct tipc_msg *m, u32 w, u32 pos, u32 mask)
129{
130 return (msg_word(m, w) >> pos) & mask;
131}
132
Per Lidenb97bf3f2006-01-02 19:04:38 +0100133static inline void msg_set_bits(struct tipc_msg *m, u32 w,
134 u32 pos, u32 mask, u32 val)
135{
Allan Stephens1f9eda72007-04-24 14:51:55 -0700136 val = (val & mask) << pos;
Al Virobecf3da2008-04-26 22:42:14 -0700137 mask = mask << pos;
138 m->hdr[w] &= ~htonl(mask);
139 m->hdr[w] |= htonl(val);
Per Lidenb97bf3f2006-01-02 19:04:38 +0100140}
141
Allan Stephens40aecb12008-06-04 17:54:48 -0700142static inline void msg_swap_words(struct tipc_msg *msg, u32 a, u32 b)
143{
144 u32 temp = msg->hdr[a];
145
146 msg->hdr[a] = msg->hdr[b];
147 msg->hdr[b] = temp;
148}
149
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900150/*
Per Lidenb97bf3f2006-01-02 19:04:38 +0100151 * Word 0
152 */
Per Lidenb97bf3f2006-01-02 19:04:38 +0100153static inline u32 msg_version(struct tipc_msg *m)
154{
155 return msg_bits(m, 0, 29, 7);
156}
157
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900158static inline void msg_set_version(struct tipc_msg *m)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100159{
Allan Stephens37695422008-03-06 15:07:42 -0800160 msg_set_bits(m, 0, 29, 7, TIPC_VERSION);
Per Lidenb97bf3f2006-01-02 19:04:38 +0100161}
162
163static inline u32 msg_user(struct tipc_msg *m)
164{
165 return msg_bits(m, 0, 25, 0xf);
166}
167
168static inline u32 msg_isdata(struct tipc_msg *m)
169{
Eric Dumazeta02cec22010-09-22 20:43:57 +0000170 return msg_user(m) <= TIPC_CRITICAL_IMPORTANCE;
Per Lidenb97bf3f2006-01-02 19:04:38 +0100171}
172
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900173static inline void msg_set_user(struct tipc_msg *m, u32 n)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100174{
175 msg_set_bits(m, 0, 25, 0xf, n);
176}
177
Allan Stephensd265fef2010-11-30 12:00:53 +0000178static inline u32 msg_hdr_sz(struct tipc_msg *m)
179{
180 return msg_bits(m, 0, 21, 0xf) << 2;
181}
182
Allan Stephens0e659672010-12-31 18:59:32 +0000183static inline void msg_set_hdr_sz(struct tipc_msg *m, u32 n)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100184{
185 msg_set_bits(m, 0, 21, 0xf, n>>2);
186}
187
Allan Stephensd265fef2010-11-30 12:00:53 +0000188static inline u32 msg_size(struct tipc_msg *m)
189{
190 return msg_bits(m, 0, 0, 0x1ffff);
191}
192
193static inline u32 msg_data_sz(struct tipc_msg *m)
194{
195 return msg_size(m) - msg_hdr_sz(m);
196}
197
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900198static inline int msg_non_seq(struct tipc_msg *m)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100199{
200 return msg_bits(m, 0, 20, 1);
201}
202
Allan Stephens40aecb12008-06-04 17:54:48 -0700203static inline void msg_set_non_seq(struct tipc_msg *m, u32 n)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100204{
Allan Stephens40aecb12008-06-04 17:54:48 -0700205 msg_set_bits(m, 0, 20, 1, n);
Per Lidenb97bf3f2006-01-02 19:04:38 +0100206}
207
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900208static inline int msg_dest_droppable(struct tipc_msg *m)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100209{
210 return msg_bits(m, 0, 19, 1);
211}
212
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900213static inline void msg_set_dest_droppable(struct tipc_msg *m, u32 d)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100214{
215 msg_set_bits(m, 0, 19, 1, d);
216}
217
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900218static inline int msg_src_droppable(struct tipc_msg *m)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100219{
220 return msg_bits(m, 0, 18, 1);
221}
222
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900223static inline void msg_set_src_droppable(struct tipc_msg *m, u32 d)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100224{
225 msg_set_bits(m, 0, 18, 1, d);
226}
227
228static inline void msg_set_size(struct tipc_msg *m, u32 sz)
229{
230 m->hdr[0] = htonl((msg_word(m, 0) & ~0x1ffff) | sz);
231}
232
Jon Paul Maloy3127a022015-03-25 12:07:25 -0400233static inline unchar *msg_data(struct tipc_msg *m)
234{
235 return ((unchar *)m) + msg_hdr_sz(m);
236}
237
238static inline struct tipc_msg *msg_get_wrapped(struct tipc_msg *m)
239{
240 return (struct tipc_msg *)msg_data(m);
241}
Per Lidenb97bf3f2006-01-02 19:04:38 +0100242
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900243/*
Per Lidenb97bf3f2006-01-02 19:04:38 +0100244 * Word 1
245 */
Allan Stephensd265fef2010-11-30 12:00:53 +0000246static inline u32 msg_type(struct tipc_msg *m)
247{
248 return msg_bits(m, 1, 29, 0x7);
249}
250
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900251static inline void msg_set_type(struct tipc_msg *m, u32 n)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100252{
253 msg_set_bits(m, 1, 29, 0x7, n);
254}
255
Allan Stephensd265fef2010-11-30 12:00:53 +0000256static inline u32 msg_named(struct tipc_msg *m)
257{
258 return msg_type(m) == TIPC_NAMED_MSG;
259}
260
261static inline u32 msg_mcast(struct tipc_msg *m)
262{
263 return msg_type(m) == TIPC_MCAST_MSG;
264}
265
266static inline u32 msg_connected(struct tipc_msg *m)
267{
268 return msg_type(m) == TIPC_CONN_MSG;
269}
270
271static inline u32 msg_errcode(struct tipc_msg *m)
272{
273 return msg_bits(m, 1, 25, 0xf);
274}
275
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900276static inline void msg_set_errcode(struct tipc_msg *m, u32 err)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100277{
278 msg_set_bits(m, 1, 25, 0xf, err);
279}
280
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900281static inline u32 msg_reroute_cnt(struct tipc_msg *m)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100282{
283 return msg_bits(m, 1, 21, 0xf);
284}
285
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900286static inline void msg_incr_reroute_cnt(struct tipc_msg *m)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100287{
288 msg_set_bits(m, 1, 21, 0xf, msg_reroute_cnt(m) + 1);
289}
290
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900291static inline void msg_reset_reroute_cnt(struct tipc_msg *m)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100292{
293 msg_set_bits(m, 1, 21, 0xf, 0);
294}
295
296static inline u32 msg_lookup_scope(struct tipc_msg *m)
297{
298 return msg_bits(m, 1, 19, 0x3);
299}
300
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900301static inline void msg_set_lookup_scope(struct tipc_msg *m, u32 n)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100302{
303 msg_set_bits(m, 1, 19, 0x3, n);
304}
305
Jon Paul Maloye4bf4f72015-05-14 10:46:14 -0400306static inline u16 msg_bcast_ack(struct tipc_msg *m)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100307{
308 return msg_bits(m, 1, 0, 0xffff);
309}
310
Jon Paul Maloye4bf4f72015-05-14 10:46:14 -0400311static inline void msg_set_bcast_ack(struct tipc_msg *m, u16 n)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100312{
313 msg_set_bits(m, 1, 0, 0xffff, n);
314}
315
316
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900317/*
Per Lidenb97bf3f2006-01-02 19:04:38 +0100318 * Word 2
319 */
Jon Paul Maloye4bf4f72015-05-14 10:46:14 -0400320static inline u16 msg_ack(struct tipc_msg *m)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100321{
322 return msg_bits(m, 2, 16, 0xffff);
323}
324
Jon Paul Maloye4bf4f72015-05-14 10:46:14 -0400325static inline void msg_set_ack(struct tipc_msg *m, u16 n)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100326{
327 msg_set_bits(m, 2, 16, 0xffff, n);
328}
329
Jon Paul Maloye4bf4f72015-05-14 10:46:14 -0400330static inline u16 msg_seqno(struct tipc_msg *m)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100331{
332 return msg_bits(m, 2, 0, 0xffff);
333}
334
Jon Paul Maloye4bf4f72015-05-14 10:46:14 -0400335static inline void msg_set_seqno(struct tipc_msg *m, u16 n)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100336{
337 msg_set_bits(m, 2, 0, 0xffff, n);
338}
339
Allan Stephens40aecb12008-06-04 17:54:48 -0700340/*
Per Lidenb97bf3f2006-01-02 19:04:38 +0100341 * Words 3-10
342 */
Jon Paul Maloye3eea1e2015-03-13 16:08:11 -0400343static inline u32 msg_importance(struct tipc_msg *m)
344{
Jon Paul Maloyf21e8972015-05-14 10:46:17 -0400345 int usr = msg_user(m);
346
347 if (likely((usr <= TIPC_CRITICAL_IMPORTANCE) && !msg_errcode(m)))
348 return usr;
349 if ((usr == MSG_FRAGMENTER) || (usr == MSG_BUNDLER))
Jon Paul Maloydde4b5a2015-10-14 09:23:18 -0400350 return msg_bits(m, 9, 0, 0x7);
Jon Paul Maloye3eea1e2015-03-13 16:08:11 -0400351 return TIPC_SYSTEM_IMPORTANCE;
352}
353
354static inline void msg_set_importance(struct tipc_msg *m, u32 i)
355{
Jon Paul Maloyf21e8972015-05-14 10:46:17 -0400356 int usr = msg_user(m);
357
358 if (likely((usr == MSG_FRAGMENTER) || (usr == MSG_BUNDLER)))
Jon Paul Maloydde4b5a2015-10-14 09:23:18 -0400359 msg_set_bits(m, 9, 0, 0x7, i);
Jon Paul Maloyf21e8972015-05-14 10:46:17 -0400360 else if (i < TIPC_SYSTEM_IMPORTANCE)
Jon Paul Maloye3eea1e2015-03-13 16:08:11 -0400361 msg_set_user(m, i);
362 else
363 pr_warn("Trying to set illegal importance in message\n");
364}
365
Allan Stephensd265fef2010-11-30 12:00:53 +0000366static inline u32 msg_prevnode(struct tipc_msg *m)
367{
368 return msg_word(m, 3);
369}
370
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900371static inline void msg_set_prevnode(struct tipc_msg *m, u32 a)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100372{
373 msg_set_word(m, 3, a);
374}
375
Allan Stephensd265fef2010-11-30 12:00:53 +0000376static inline u32 msg_origport(struct tipc_msg *m)
377{
Jon Paul Maloy3127a022015-03-25 12:07:25 -0400378 if (msg_user(m) == MSG_FRAGMENTER)
379 m = msg_get_wrapped(m);
Allan Stephensd265fef2010-11-30 12:00:53 +0000380 return msg_word(m, 4);
381}
382
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900383static inline void msg_set_origport(struct tipc_msg *m, u32 p)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100384{
385 msg_set_word(m, 4, p);
386}
387
Allan Stephensd265fef2010-11-30 12:00:53 +0000388static inline u32 msg_destport(struct tipc_msg *m)
389{
390 return msg_word(m, 5);
391}
392
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900393static inline void msg_set_destport(struct tipc_msg *m, u32 p)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100394{
395 msg_set_word(m, 5, p);
396}
397
Allan Stephensd265fef2010-11-30 12:00:53 +0000398static inline u32 msg_mc_netid(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_mc_netid(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 int msg_short(struct tipc_msg *m)
409{
Allan Stephens741d9eb2011-05-31 15:03:18 -0400410 return msg_hdr_sz(m) == SHORT_H_SIZE;
Allan Stephensd265fef2010-11-30 12:00:53 +0000411}
412
413static inline u32 msg_orignode(struct tipc_msg *m)
414{
415 if (likely(msg_short(m)))
416 return msg_prevnode(m);
417 return msg_word(m, 6);
418}
419
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900420static inline void msg_set_orignode(struct tipc_msg *m, u32 a)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100421{
422 msg_set_word(m, 6, a);
423}
424
Allan Stephensd265fef2010-11-30 12:00:53 +0000425static inline u32 msg_destnode(struct tipc_msg *m)
426{
427 return msg_word(m, 7);
428}
429
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900430static inline void msg_set_destnode(struct tipc_msg *m, u32 a)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100431{
432 msg_set_word(m, 7, a);
433}
434
Allan Stephensd265fef2010-11-30 12:00:53 +0000435static inline u32 msg_nametype(struct tipc_msg *m)
436{
437 return msg_word(m, 8);
438}
439
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900440static inline void msg_set_nametype(struct tipc_msg *m, u32 n)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100441{
442 msg_set_word(m, 8, n);
443}
444
Allan Stephensd265fef2010-11-30 12:00:53 +0000445static inline u32 msg_nameinst(struct tipc_msg *m)
446{
447 return msg_word(m, 9);
448}
449
450static inline u32 msg_namelower(struct tipc_msg *m)
451{
452 return msg_nameinst(m);
453}
454
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900455static inline void msg_set_namelower(struct tipc_msg *m, u32 n)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100456{
457 msg_set_word(m, 9, n);
458}
459
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900460static inline void msg_set_nameinst(struct tipc_msg *m, u32 n)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100461{
462 msg_set_namelower(m, n);
463}
464
Allan Stephensd265fef2010-11-30 12:00:53 +0000465static inline u32 msg_nameupper(struct tipc_msg *m)
466{
467 return msg_word(m, 10);
468}
469
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900470static inline void msg_set_nameupper(struct tipc_msg *m, u32 n)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100471{
472 msg_set_word(m, 10, n);
473}
474
Per Lidenb97bf3f2006-01-02 19:04:38 +0100475/*
Allan Stephenscc4c4352011-04-08 10:50:52 -0400476 * Constants and routines used to read and write TIPC internal message headers
477 */
Per Lidenb97bf3f2006-01-02 19:04:38 +0100478
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900479/*
Allan Stephenscc4c4352011-04-08 10:50:52 -0400480 * Connection management protocol message types
Per Lidenb97bf3f2006-01-02 19:04:38 +0100481 */
Per Lidenb97bf3f2006-01-02 19:04:38 +0100482#define CONN_PROBE 0
483#define CONN_PROBE_REPLY 1
484#define CONN_ACK 2
485
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900486/*
Allan Stephenscc4c4352011-04-08 10:50:52 -0400487 * Name distributor message types
Per Lidenb97bf3f2006-01-02 19:04:38 +0100488 */
Per Lidenb97bf3f2006-01-02 19:04:38 +0100489#define PUBLICATION 0
490#define WITHDRAWAL 1
491
Allan Stephens92138d12011-04-08 11:04:15 -0400492/*
493 * Segmentation message types
494 */
Allan Stephens92138d12011-04-08 11:04:15 -0400495#define FIRST_FRAGMENT 0
496#define FRAGMENT 1
497#define LAST_FRAGMENT 2
498
499/*
500 * Link management protocol message types
501 */
Allan Stephens92138d12011-04-08 11:04:15 -0400502#define STATE_MSG 0
503#define RESET_MSG 1
504#define ACTIVATE_MSG 2
505
506/*
507 * Changeover tunnel message types
508 */
Jon Paul Maloydff29b12015-04-02 09:33:01 -0400509#define SYNCH_MSG 0
510#define FAILOVER_MSG 1
Allan Stephens92138d12011-04-08 11:04:15 -0400511
512/*
513 * Config protocol message types
514 */
Allan Stephens92138d12011-04-08 11:04:15 -0400515#define DSC_REQ_MSG 0
516#define DSC_RESP_MSG 1
517
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900518/*
Per Lidenb97bf3f2006-01-02 19:04:38 +0100519 * Word 1
520 */
Per Lidenb97bf3f2006-01-02 19:04:38 +0100521static inline u32 msg_seq_gap(struct tipc_msg *m)
522{
Allan Stephensbd784532008-06-04 17:47:30 -0700523 return msg_bits(m, 1, 16, 0x1fff);
Per Lidenb97bf3f2006-01-02 19:04:38 +0100524}
525
526static inline void msg_set_seq_gap(struct tipc_msg *m, u32 n)
527{
Allan Stephensbd784532008-06-04 17:47:30 -0700528 msg_set_bits(m, 1, 16, 0x1fff, n);
Per Lidenb97bf3f2006-01-02 19:04:38 +0100529}
530
Allan Stephensfc0eea62011-10-28 16:26:41 -0400531static inline u32 msg_node_sig(struct tipc_msg *m)
532{
533 return msg_bits(m, 1, 0, 0xffff);
534}
535
536static inline void msg_set_node_sig(struct tipc_msg *m, u32 n)
537{
538 msg_set_bits(m, 1, 0, 0xffff, n);
539}
540
Jon Paul Maloy7764d6e2015-03-13 16:08:05 -0400541static inline u32 msg_node_capabilities(struct tipc_msg *m)
542{
543 return msg_bits(m, 1, 15, 0x1fff);
544}
545
546static inline void msg_set_node_capabilities(struct tipc_msg *m, u32 n)
547{
548 msg_set_bits(m, 1, 15, 0x1fff, n);
549}
550
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900551/*
Per Lidenb97bf3f2006-01-02 19:04:38 +0100552 * Word 2
553 */
Per Lidenb97bf3f2006-01-02 19:04:38 +0100554static inline u32 msg_dest_domain(struct tipc_msg *m)
555{
556 return msg_word(m, 2);
557}
558
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900559static inline void msg_set_dest_domain(struct tipc_msg *m, u32 n)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100560{
561 msg_set_word(m, 2, n);
562}
563
564static inline u32 msg_bcgap_after(struct tipc_msg *m)
565{
566 return msg_bits(m, 2, 16, 0xffff);
567}
568
569static inline void msg_set_bcgap_after(struct tipc_msg *m, u32 n)
570{
571 msg_set_bits(m, 2, 16, 0xffff, n);
572}
573
574static inline u32 msg_bcgap_to(struct tipc_msg *m)
575{
576 return msg_bits(m, 2, 0, 0xffff);
577}
578
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900579static inline void msg_set_bcgap_to(struct tipc_msg *m, u32 n)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100580{
581 msg_set_bits(m, 2, 0, 0xffff, n);
582}
583
584
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900585/*
Per Lidenb97bf3f2006-01-02 19:04:38 +0100586 * Word 4
587 */
Per Lidenb97bf3f2006-01-02 19:04:38 +0100588static inline u32 msg_last_bcast(struct tipc_msg *m)
589{
590 return msg_bits(m, 4, 16, 0xffff);
591}
592
Jon Paul Maloy52666982015-10-22 08:51:41 -0400593static inline u32 msg_bc_snd_nxt(struct tipc_msg *m)
594{
595 return msg_last_bcast(m) + 1;
596}
597
Per Lidenb97bf3f2006-01-02 19:04:38 +0100598static inline void msg_set_last_bcast(struct tipc_msg *m, u32 n)
599{
600 msg_set_bits(m, 4, 16, 0xffff, n);
601}
602
Per Lidenb97bf3f2006-01-02 19:04:38 +0100603static inline void msg_set_fragm_no(struct tipc_msg *m, u32 n)
604{
605 msg_set_bits(m, 4, 16, 0xffff, n);
606}
607
608
Jon Paul Maloy6e498152015-07-30 18:24:19 -0400609static inline u16 msg_next_sent(struct tipc_msg *m)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100610{
611 return msg_bits(m, 4, 0, 0xffff);
612}
613
Jon Paul Maloy6e498152015-07-30 18:24:19 -0400614static inline void msg_set_next_sent(struct tipc_msg *m, u16 n)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100615{
616 msg_set_bits(m, 4, 0, 0xffff, n);
617}
618
Per Lidenb97bf3f2006-01-02 19:04:38 +0100619static inline void msg_set_long_msgno(struct tipc_msg *m, u32 n)
620{
621 msg_set_bits(m, 4, 0, 0xffff, n);
622}
623
624static inline u32 msg_bc_netid(struct tipc_msg *m)
625{
626 return msg_word(m, 4);
627}
628
629static inline void msg_set_bc_netid(struct tipc_msg *m, u32 id)
630{
631 msg_set_word(m, 4, id);
632}
633
634static inline u32 msg_link_selector(struct tipc_msg *m)
635{
636 return msg_bits(m, 4, 0, 1);
637}
638
639static inline void msg_set_link_selector(struct tipc_msg *m, u32 n)
640{
Allan Stephens7eb878e2011-05-25 13:28:27 -0400641 msg_set_bits(m, 4, 0, 1, n);
Per Lidenb97bf3f2006-01-02 19:04:38 +0100642}
643
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900644/*
Per Lidenb97bf3f2006-01-02 19:04:38 +0100645 * Word 5
646 */
Jon Paul Maloyd9992972015-07-16 16:54:31 -0400647static inline u16 msg_session(struct tipc_msg *m)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100648{
649 return msg_bits(m, 5, 16, 0xffff);
650}
651
Jon Paul Maloyd9992972015-07-16 16:54:31 -0400652static inline void msg_set_session(struct tipc_msg *m, u16 n)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100653{
654 msg_set_bits(m, 5, 16, 0xffff, n);
655}
656
657static inline u32 msg_probe(struct tipc_msg *m)
658{
659 return msg_bits(m, 5, 0, 1);
660}
661
662static inline void msg_set_probe(struct tipc_msg *m, u32 val)
663{
Allan Stephens7eb878e2011-05-25 13:28:27 -0400664 msg_set_bits(m, 5, 0, 1, val);
Per Lidenb97bf3f2006-01-02 19:04:38 +0100665}
666
667static inline char msg_net_plane(struct tipc_msg *m)
668{
669 return msg_bits(m, 5, 1, 7) + 'A';
670}
671
672static inline void msg_set_net_plane(struct tipc_msg *m, char n)
673{
674 msg_set_bits(m, 5, 1, 7, (n - 'A'));
675}
676
677static inline u32 msg_linkprio(struct tipc_msg *m)
678{
679 return msg_bits(m, 5, 4, 0x1f);
680}
681
682static inline void msg_set_linkprio(struct tipc_msg *m, u32 n)
683{
684 msg_set_bits(m, 5, 4, 0x1f, n);
685}
686
687static inline u32 msg_bearer_id(struct tipc_msg *m)
688{
689 return msg_bits(m, 5, 9, 0x7);
690}
691
692static inline void msg_set_bearer_id(struct tipc_msg *m, u32 n)
693{
694 msg_set_bits(m, 5, 9, 0x7, n);
695}
696
697static inline u32 msg_redundant_link(struct tipc_msg *m)
698{
699 return msg_bits(m, 5, 12, 0x1);
700}
701
Allan Stephens77f167f2011-02-28 15:30:20 -0500702static inline void msg_set_redundant_link(struct tipc_msg *m, u32 r)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100703{
Allan Stephens77f167f2011-02-28 15:30:20 -0500704 msg_set_bits(m, 5, 12, 0x1, r);
Per Lidenb97bf3f2006-01-02 19:04:38 +0100705}
706
Jon Paul Maloy634696b2016-04-15 13:33:03 -0400707static inline u32 msg_peer_stopping(struct tipc_msg *m)
708{
709 return msg_bits(m, 5, 13, 0x1);
710}
711
712static inline void msg_set_peer_stopping(struct tipc_msg *m, u32 s)
713{
714 msg_set_bits(m, 5, 13, 0x1, s);
715}
716
Jon Paul Maloy06bd2b12016-10-27 18:51:55 -0400717static inline bool msg_bc_ack_invalid(struct tipc_msg *m)
718{
719 switch (msg_user(m)) {
720 case BCAST_PROTOCOL:
721 case NAME_DISTRIBUTOR:
722 case LINK_PROTOCOL:
723 return msg_bits(m, 5, 14, 0x1);
724 default:
725 return false;
726 }
727}
728
729static inline void msg_set_bc_ack_invalid(struct tipc_msg *m, bool invalid)
730{
731 msg_set_bits(m, 5, 14, 0x1, invalid);
732}
733
Allan Stephens3d749a62011-10-07 15:19:11 -0400734static inline char *msg_media_addr(struct tipc_msg *m)
735{
Erik Hugne91e2eb52015-02-27 08:56:57 +0100736 return (char *)&m->hdr[TIPC_MEDIA_INFO_OFFSET];
Allan Stephens3d749a62011-10-07 15:19:11 -0400737}
Per Lidenb97bf3f2006-01-02 19:04:38 +0100738
Jon Paul Maloy02d11ca2016-09-01 13:52:49 -0400739static inline u32 msg_bc_gap(struct tipc_msg *m)
740{
741 return msg_bits(m, 8, 0, 0x3ff);
742}
743
744static inline void msg_set_bc_gap(struct tipc_msg *m, u32 n)
745{
746 msg_set_bits(m, 8, 0, 0x3ff, n);
747}
748
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900749/*
Per Lidenb97bf3f2006-01-02 19:04:38 +0100750 * Word 9
751 */
Jon Paul Maloy6e498152015-07-30 18:24:19 -0400752static inline u16 msg_msgcnt(struct tipc_msg *m)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100753{
754 return msg_bits(m, 9, 16, 0xffff);
755}
756
Jon Paul Maloy6e498152015-07-30 18:24:19 -0400757static inline void msg_set_msgcnt(struct tipc_msg *m, u16 n)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100758{
759 msg_set_bits(m, 9, 16, 0xffff, n);
760}
761
Jon Paul Maloy10724cc2016-05-02 11:58:47 -0400762static inline u32 msg_conn_ack(struct tipc_msg *m)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100763{
764 return msg_bits(m, 9, 16, 0xffff);
765}
766
Jon Paul Maloy10724cc2016-05-02 11:58:47 -0400767static inline void msg_set_conn_ack(struct tipc_msg *m, u32 n)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100768{
769 msg_set_bits(m, 9, 16, 0xffff, n);
770}
771
Jon Paul Maloy10724cc2016-05-02 11:58:47 -0400772static inline u32 msg_adv_win(struct tipc_msg *m)
773{
774 return msg_bits(m, 9, 0, 0xffff);
775}
776
777static inline void msg_set_adv_win(struct tipc_msg *m, u32 n)
778{
779 msg_set_bits(m, 9, 0, 0xffff, n);
780}
781
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900782static inline u32 msg_max_pkt(struct tipc_msg *m)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100783{
Eric Dumazeta02cec22010-09-22 20:43:57 +0000784 return msg_bits(m, 9, 16, 0xffff) * 4;
Per Lidenb97bf3f2006-01-02 19:04:38 +0100785}
786
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900787static inline void msg_set_max_pkt(struct tipc_msg *m, u32 n)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100788{
789 msg_set_bits(m, 9, 16, 0xffff, (n / 4));
790}
791
792static inline u32 msg_link_tolerance(struct tipc_msg *m)
793{
794 return msg_bits(m, 9, 0, 0xffff);
795}
796
797static inline void msg_set_link_tolerance(struct tipc_msg *m, u32 n)
798{
799 msg_set_bits(m, 9, 0, 0xffff, n);
800}
801
Jon Paul Maloy6e498152015-07-30 18:24:19 -0400802static inline bool msg_peer_link_is_up(struct tipc_msg *m)
Jon Paul Maloyd9992972015-07-16 16:54:31 -0400803{
804 if (likely(msg_user(m) != LINK_PROTOCOL))
805 return true;
Jon Paul Maloy6e498152015-07-30 18:24:19 -0400806 if (msg_type(m) == STATE_MSG)
807 return true;
808 return false;
Jon Paul Maloyd9992972015-07-16 16:54:31 -0400809}
810
Jon Paul Maloy6e498152015-07-30 18:24:19 -0400811static inline bool msg_peer_node_is_up(struct tipc_msg *m)
Jon Paul Maloy1a20cc22015-07-16 16:54:30 -0400812{
Jon Paul Maloy6e498152015-07-30 18:24:19 -0400813 if (msg_peer_link_is_up(m))
814 return true;
Jon Paul Maloy1a20cc22015-07-16 16:54:30 -0400815 return msg_redundant_link(m);
816}
817
Jon Paul Maloy5b7066c2016-04-07 10:09:14 -0400818static inline bool msg_is_reset(struct tipc_msg *hdr)
819{
820 return (msg_user(hdr) == LINK_PROTOCOL) && (msg_type(hdr) == RESET_MSG);
821}
822
Parthasarathy Bhuvaragan9f8ffe42017-01-13 15:46:25 +0100823struct sk_buff *tipc_buf_acquire(u32 size, gfp_t gfp);
Jon Paul Maloycf2157f2015-03-13 16:08:06 -0400824bool tipc_msg_validate(struct sk_buff *skb);
Jon Paul Maloybcd3ffd2015-07-22 10:11:19 -0400825bool tipc_msg_reverse(u32 own_addr, struct sk_buff **skb, int err);
Jon Paul Maloyc5898632015-02-05 08:36:36 -0500826void tipc_msg_init(u32 own_addr, struct tipc_msg *m, u32 user, u32 type,
Ying Xue34747532015-01-09 15:27:10 +0800827 u32 hsize, u32 destnode);
Jon Paul Maloye3a77562015-02-05 08:36:39 -0500828struct sk_buff *tipc_msg_create(uint user, uint type, uint hdr_sz,
829 uint data_sz, u32 dnode, u32 onode,
830 u32 dport, u32 oport, int errcode);
Jon Paul Maloy37e22162014-05-14 05:39:12 -0400831int tipc_buf_append(struct sk_buff **headbuf, struct sk_buff **buf);
Jon Paul Maloydd3f9e72015-05-14 10:46:18 -0400832bool tipc_msg_bundle(struct sk_buff *skb, struct tipc_msg *msg, u32 mtu);
833bool tipc_msg_make_bundle(struct sk_buff **skb, struct tipc_msg *msg,
834 u32 mtu, u32 dnode);
Jon Paul Maloyc637c102015-02-05 08:36:41 -0500835bool tipc_msg_extract(struct sk_buff *skb, struct sk_buff **iskb, int *pos);
Jon Paul Maloyc5898632015-02-05 08:36:36 -0500836int tipc_msg_build(struct tipc_msg *mhdr, struct msghdr *m,
Ying Xue34747532015-01-09 15:27:10 +0800837 int offset, int dsz, int mtu, struct sk_buff_head *list);
Jon Paul Maloycda36962015-07-22 10:11:20 -0400838bool tipc_msg_lookup_dest(struct net *net, struct sk_buff *skb, int *err);
Jon Paul Maloy2f566122015-10-22 08:51:39 -0400839bool tipc_msg_reassemble(struct sk_buff_head *list, struct sk_buff_head *rcvq);
Jon Paul Maloy8306f992015-10-15 14:52:43 -0400840void __tipc_skb_queue_sorted(struct sk_buff_head *list, u16 seqno,
841 struct sk_buff *skb);
Jon Paul Maloy078bec82014-07-16 20:41:00 -0400842
Jon Paul Maloye4bf4f72015-05-14 10:46:14 -0400843static inline u16 buf_seqno(struct sk_buff *skb)
844{
845 return msg_seqno(buf_msg(skb));
846}
847
Jon Paul Maloycb1b7282015-02-05 08:36:44 -0500848/* tipc_skb_peek(): peek and reserve first buffer in list
849 * @list: list to be peeked in
850 * Returns pointer to first buffer in list, if any
851 */
852static inline struct sk_buff *tipc_skb_peek(struct sk_buff_head *list,
853 spinlock_t *lock)
854{
855 struct sk_buff *skb;
856
857 spin_lock_bh(lock);
858 skb = skb_peek(list);
859 if (skb)
860 skb_get(skb);
861 spin_unlock_bh(lock);
862 return skb;
863}
864
Jon Paul Maloyc637c102015-02-05 08:36:41 -0500865/* tipc_skb_peek_port(): find a destination port, ignoring all destinations
866 * up to and including 'filter'.
867 * Note: ignoring previously tried destinations minimizes the risk of
868 * contention on the socket lock
869 * @list: list to be peeked in
870 * @filter: last destination to be ignored from search
871 * Returns a destination port number, of applicable.
872 */
873static inline u32 tipc_skb_peek_port(struct sk_buff_head *list, u32 filter)
874{
875 struct sk_buff *skb;
876 u32 dport = 0;
877 bool ignore = true;
878
879 spin_lock_bh(&list->lock);
880 skb_queue_walk(list, skb) {
881 dport = msg_destport(buf_msg(skb));
882 if (!filter || skb_queue_is_last(list, skb))
883 break;
884 if (dport == filter)
885 ignore = false;
886 else if (!ignore)
887 break;
888 }
889 spin_unlock_bh(&list->lock);
890 return dport;
891}
892
893/* tipc_skb_dequeue(): unlink first buffer with dest 'dport' from list
894 * @list: list to be unlinked from
895 * @dport: selection criteria for buffer to unlink
896 */
897static inline struct sk_buff *tipc_skb_dequeue(struct sk_buff_head *list,
898 u32 dport)
899{
900 struct sk_buff *_skb, *tmp, *skb = NULL;
901
902 spin_lock_bh(&list->lock);
903 skb_queue_walk_safe(list, _skb, tmp) {
904 if (msg_destport(buf_msg(_skb)) == dport) {
905 __skb_unlink(_skb, list);
906 skb = _skb;
907 break;
908 }
909 }
910 spin_unlock_bh(&list->lock);
911 return skb;
912}
913
Jon Paul Maloy598411d2015-07-30 18:24:23 -0400914/* tipc_skb_queue_splice_tail - append an skb list to lock protected list
915 * @list: the new list to append. Not lock protected
916 * @head: target list. Lock protected.
917 */
918static inline void tipc_skb_queue_splice_tail(struct sk_buff_head *list,
919 struct sk_buff_head *head)
920{
921 spin_lock_bh(&head->lock);
922 skb_queue_splice_tail(list, head);
923 spin_unlock_bh(&head->lock);
924}
925
926/* tipc_skb_queue_splice_tail_init - merge two lock protected skb lists
927 * @list: the new list to add. Lock protected. Will be reinitialized
928 * @head: target list. Lock protected.
929 */
930static inline void tipc_skb_queue_splice_tail_init(struct sk_buff_head *list,
931 struct sk_buff_head *head)
932{
933 struct sk_buff_head tmp;
934
935 __skb_queue_head_init(&tmp);
936
937 spin_lock_bh(&list->lock);
938 skb_queue_splice_tail_init(list, &tmp);
939 spin_unlock_bh(&list->lock);
940 tipc_skb_queue_splice_tail(&tmp, head);
941}
942
Per Lidenb97bf3f2006-01-02 19:04:38 +0100943#endif