blob: 55778a0aebf3706f2c559528f6a482c4077197bb [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 +080097/**
98 * TIPC message buffer code
99 *
100 * TIPC message buffer headroom reserves space for the worst-case
101 * link-level device header (in case the message is sent off-node).
102 *
103 * Note: Headroom should be a multiple of 4 to ensure the TIPC header fields
104 * are word aligned for quicker access
105 */
Erik Hugned0f91932015-03-05 10:23:49 +0100106#define BUF_HEADROOM (LL_MAX_HEADER + 48)
Ying Xue859fc7c2015-01-09 15:27:01 +0800107
108struct tipc_skb_cb {
109 void *handle;
110 struct sk_buff *tail;
Jon Paul Maloycf2157f2015-03-13 16:08:06 -0400111 bool validated;
Ying Xue859fc7c2015-01-09 15:27:01 +0800112 bool wakeup_pending;
Ying Xue859fc7c2015-01-09 15:27:01 +0800113 u16 chain_sz;
114 u16 chain_imp;
Jon Paul Maloyc1ab3f1d2015-10-22 08:51:38 -0400115 u16 ackers;
Ying Xue859fc7c2015-01-09 15:27:01 +0800116};
117
118#define TIPC_SKB_CB(__skb) ((struct tipc_skb_cb *)&((__skb)->cb[0]))
119
Allan Stephensd265fef2010-11-30 12:00:53 +0000120struct tipc_msg {
121 __be32 hdr[15];
122};
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900123
Ying Xue859fc7c2015-01-09 15:27:01 +0800124static inline struct tipc_msg *buf_msg(struct sk_buff *skb)
125{
126 return (struct tipc_msg *)skb->data;
127}
128
Allan Stephensd265fef2010-11-30 12:00:53 +0000129static inline u32 msg_word(struct tipc_msg *m, u32 pos)
130{
131 return ntohl(m->hdr[pos]);
132}
Per Lidenb97bf3f2006-01-02 19:04:38 +0100133
134static inline void msg_set_word(struct tipc_msg *m, u32 w, u32 val)
135{
136 m->hdr[w] = htonl(val);
137}
138
Allan Stephensd265fef2010-11-30 12:00:53 +0000139static inline u32 msg_bits(struct tipc_msg *m, u32 w, u32 pos, u32 mask)
140{
141 return (msg_word(m, w) >> pos) & mask;
142}
143
Per Lidenb97bf3f2006-01-02 19:04:38 +0100144static inline void msg_set_bits(struct tipc_msg *m, u32 w,
145 u32 pos, u32 mask, u32 val)
146{
Allan Stephens1f9eda72007-04-24 14:51:55 -0700147 val = (val & mask) << pos;
Al Virobecf3da2008-04-26 22:42:14 -0700148 mask = mask << pos;
149 m->hdr[w] &= ~htonl(mask);
150 m->hdr[w] |= htonl(val);
Per Lidenb97bf3f2006-01-02 19:04:38 +0100151}
152
Allan Stephens40aecb12008-06-04 17:54:48 -0700153static inline void msg_swap_words(struct tipc_msg *msg, u32 a, u32 b)
154{
155 u32 temp = msg->hdr[a];
156
157 msg->hdr[a] = msg->hdr[b];
158 msg->hdr[b] = temp;
159}
160
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900161/*
Per Lidenb97bf3f2006-01-02 19:04:38 +0100162 * Word 0
163 */
Per Lidenb97bf3f2006-01-02 19:04:38 +0100164static inline u32 msg_version(struct tipc_msg *m)
165{
166 return msg_bits(m, 0, 29, 7);
167}
168
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900169static inline void msg_set_version(struct tipc_msg *m)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100170{
Allan Stephens37695422008-03-06 15:07:42 -0800171 msg_set_bits(m, 0, 29, 7, TIPC_VERSION);
Per Lidenb97bf3f2006-01-02 19:04:38 +0100172}
173
174static inline u32 msg_user(struct tipc_msg *m)
175{
176 return msg_bits(m, 0, 25, 0xf);
177}
178
179static inline u32 msg_isdata(struct tipc_msg *m)
180{
Eric Dumazeta02cec22010-09-22 20:43:57 +0000181 return msg_user(m) <= TIPC_CRITICAL_IMPORTANCE;
Per Lidenb97bf3f2006-01-02 19:04:38 +0100182}
183
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900184static inline void msg_set_user(struct tipc_msg *m, u32 n)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100185{
186 msg_set_bits(m, 0, 25, 0xf, n);
187}
188
Allan Stephensd265fef2010-11-30 12:00:53 +0000189static inline u32 msg_hdr_sz(struct tipc_msg *m)
190{
191 return msg_bits(m, 0, 21, 0xf) << 2;
192}
193
Allan Stephens0e659672010-12-31 18:59:32 +0000194static inline void msg_set_hdr_sz(struct tipc_msg *m, u32 n)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100195{
196 msg_set_bits(m, 0, 21, 0xf, n>>2);
197}
198
Allan Stephensd265fef2010-11-30 12:00:53 +0000199static inline u32 msg_size(struct tipc_msg *m)
200{
201 return msg_bits(m, 0, 0, 0x1ffff);
202}
203
204static inline u32 msg_data_sz(struct tipc_msg *m)
205{
206 return msg_size(m) - msg_hdr_sz(m);
207}
208
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900209static inline int msg_non_seq(struct tipc_msg *m)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100210{
211 return msg_bits(m, 0, 20, 1);
212}
213
Allan Stephens40aecb12008-06-04 17:54:48 -0700214static inline void msg_set_non_seq(struct tipc_msg *m, u32 n)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100215{
Allan Stephens40aecb12008-06-04 17:54:48 -0700216 msg_set_bits(m, 0, 20, 1, n);
Per Lidenb97bf3f2006-01-02 19:04:38 +0100217}
218
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900219static inline int msg_dest_droppable(struct tipc_msg *m)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100220{
221 return msg_bits(m, 0, 19, 1);
222}
223
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900224static inline void msg_set_dest_droppable(struct tipc_msg *m, u32 d)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100225{
226 msg_set_bits(m, 0, 19, 1, d);
227}
228
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900229static inline int msg_src_droppable(struct tipc_msg *m)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100230{
231 return msg_bits(m, 0, 18, 1);
232}
233
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900234static inline void msg_set_src_droppable(struct tipc_msg *m, u32 d)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100235{
236 msg_set_bits(m, 0, 18, 1, d);
237}
238
239static inline void msg_set_size(struct tipc_msg *m, u32 sz)
240{
241 m->hdr[0] = htonl((msg_word(m, 0) & ~0x1ffff) | sz);
242}
243
Jon Paul Maloy3127a022015-03-25 12:07:25 -0400244static inline unchar *msg_data(struct tipc_msg *m)
245{
246 return ((unchar *)m) + msg_hdr_sz(m);
247}
248
249static inline struct tipc_msg *msg_get_wrapped(struct tipc_msg *m)
250{
251 return (struct tipc_msg *)msg_data(m);
252}
Per Lidenb97bf3f2006-01-02 19:04:38 +0100253
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900254/*
Per Lidenb97bf3f2006-01-02 19:04:38 +0100255 * Word 1
256 */
Allan Stephensd265fef2010-11-30 12:00:53 +0000257static inline u32 msg_type(struct tipc_msg *m)
258{
259 return msg_bits(m, 1, 29, 0x7);
260}
261
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900262static inline void msg_set_type(struct tipc_msg *m, u32 n)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100263{
264 msg_set_bits(m, 1, 29, 0x7, n);
265}
266
Allan Stephensd265fef2010-11-30 12:00:53 +0000267static inline u32 msg_named(struct tipc_msg *m)
268{
269 return msg_type(m) == TIPC_NAMED_MSG;
270}
271
272static inline u32 msg_mcast(struct tipc_msg *m)
273{
274 return msg_type(m) == TIPC_MCAST_MSG;
275}
276
277static inline u32 msg_connected(struct tipc_msg *m)
278{
279 return msg_type(m) == TIPC_CONN_MSG;
280}
281
282static inline u32 msg_errcode(struct tipc_msg *m)
283{
284 return msg_bits(m, 1, 25, 0xf);
285}
286
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900287static inline void msg_set_errcode(struct tipc_msg *m, u32 err)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100288{
289 msg_set_bits(m, 1, 25, 0xf, err);
290}
291
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900292static inline u32 msg_reroute_cnt(struct tipc_msg *m)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100293{
294 return msg_bits(m, 1, 21, 0xf);
295}
296
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900297static inline void msg_incr_reroute_cnt(struct tipc_msg *m)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100298{
299 msg_set_bits(m, 1, 21, 0xf, msg_reroute_cnt(m) + 1);
300}
301
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900302static inline void msg_reset_reroute_cnt(struct tipc_msg *m)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100303{
304 msg_set_bits(m, 1, 21, 0xf, 0);
305}
306
307static inline u32 msg_lookup_scope(struct tipc_msg *m)
308{
309 return msg_bits(m, 1, 19, 0x3);
310}
311
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900312static inline void msg_set_lookup_scope(struct tipc_msg *m, u32 n)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100313{
314 msg_set_bits(m, 1, 19, 0x3, n);
315}
316
Jon Paul Maloye4bf4f72015-05-14 10:46:14 -0400317static inline u16 msg_bcast_ack(struct tipc_msg *m)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100318{
319 return msg_bits(m, 1, 0, 0xffff);
320}
321
Jon Paul Maloye4bf4f72015-05-14 10:46:14 -0400322static inline void msg_set_bcast_ack(struct tipc_msg *m, u16 n)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100323{
324 msg_set_bits(m, 1, 0, 0xffff, n);
325}
326
327
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900328/*
Per Lidenb97bf3f2006-01-02 19:04:38 +0100329 * Word 2
330 */
Jon Paul Maloye4bf4f72015-05-14 10:46:14 -0400331static inline u16 msg_ack(struct tipc_msg *m)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100332{
333 return msg_bits(m, 2, 16, 0xffff);
334}
335
Jon Paul Maloye4bf4f72015-05-14 10:46:14 -0400336static inline void msg_set_ack(struct tipc_msg *m, u16 n)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100337{
338 msg_set_bits(m, 2, 16, 0xffff, n);
339}
340
Jon Paul Maloye4bf4f72015-05-14 10:46:14 -0400341static inline u16 msg_seqno(struct tipc_msg *m)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100342{
343 return msg_bits(m, 2, 0, 0xffff);
344}
345
Jon Paul Maloye4bf4f72015-05-14 10:46:14 -0400346static inline void msg_set_seqno(struct tipc_msg *m, u16 n)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100347{
348 msg_set_bits(m, 2, 0, 0xffff, n);
349}
350
Allan Stephens40aecb12008-06-04 17:54:48 -0700351/*
Per Lidenb97bf3f2006-01-02 19:04:38 +0100352 * Words 3-10
353 */
Jon Paul Maloye3eea1e2015-03-13 16:08:11 -0400354static inline u32 msg_importance(struct tipc_msg *m)
355{
Jon Paul Maloyf21e8972015-05-14 10:46:17 -0400356 int usr = msg_user(m);
357
358 if (likely((usr <= TIPC_CRITICAL_IMPORTANCE) && !msg_errcode(m)))
359 return usr;
360 if ((usr == MSG_FRAGMENTER) || (usr == MSG_BUNDLER))
Jon Paul Maloydde4b5a2015-10-14 09:23:18 -0400361 return msg_bits(m, 9, 0, 0x7);
Jon Paul Maloye3eea1e2015-03-13 16:08:11 -0400362 return TIPC_SYSTEM_IMPORTANCE;
363}
364
365static inline void msg_set_importance(struct tipc_msg *m, u32 i)
366{
Jon Paul Maloyf21e8972015-05-14 10:46:17 -0400367 int usr = msg_user(m);
368
369 if (likely((usr == MSG_FRAGMENTER) || (usr == MSG_BUNDLER)))
Jon Paul Maloydde4b5a2015-10-14 09:23:18 -0400370 msg_set_bits(m, 9, 0, 0x7, i);
Jon Paul Maloyf21e8972015-05-14 10:46:17 -0400371 else if (i < TIPC_SYSTEM_IMPORTANCE)
Jon Paul Maloye3eea1e2015-03-13 16:08:11 -0400372 msg_set_user(m, i);
373 else
374 pr_warn("Trying to set illegal importance in message\n");
375}
376
Allan Stephensd265fef2010-11-30 12:00:53 +0000377static inline u32 msg_prevnode(struct tipc_msg *m)
378{
379 return msg_word(m, 3);
380}
381
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900382static inline void msg_set_prevnode(struct tipc_msg *m, u32 a)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100383{
384 msg_set_word(m, 3, a);
385}
386
Allan Stephensd265fef2010-11-30 12:00:53 +0000387static inline u32 msg_origport(struct tipc_msg *m)
388{
Jon Paul Maloy3127a022015-03-25 12:07:25 -0400389 if (msg_user(m) == MSG_FRAGMENTER)
390 m = msg_get_wrapped(m);
Allan Stephensd265fef2010-11-30 12:00:53 +0000391 return msg_word(m, 4);
392}
393
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900394static inline void msg_set_origport(struct tipc_msg *m, u32 p)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100395{
396 msg_set_word(m, 4, p);
397}
398
Allan Stephensd265fef2010-11-30 12:00:53 +0000399static inline u32 msg_destport(struct tipc_msg *m)
400{
401 return msg_word(m, 5);
402}
403
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900404static inline void msg_set_destport(struct tipc_msg *m, u32 p)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100405{
406 msg_set_word(m, 5, p);
407}
408
Allan Stephensd265fef2010-11-30 12:00:53 +0000409static inline u32 msg_mc_netid(struct tipc_msg *m)
410{
411 return msg_word(m, 5);
412}
413
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900414static inline void msg_set_mc_netid(struct tipc_msg *m, u32 p)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100415{
416 msg_set_word(m, 5, p);
417}
418
Allan Stephensd265fef2010-11-30 12:00:53 +0000419static inline int msg_short(struct tipc_msg *m)
420{
Allan Stephens741d9eb2011-05-31 15:03:18 -0400421 return msg_hdr_sz(m) == SHORT_H_SIZE;
Allan Stephensd265fef2010-11-30 12:00:53 +0000422}
423
424static inline u32 msg_orignode(struct tipc_msg *m)
425{
426 if (likely(msg_short(m)))
427 return msg_prevnode(m);
428 return msg_word(m, 6);
429}
430
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900431static inline void msg_set_orignode(struct tipc_msg *m, u32 a)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100432{
433 msg_set_word(m, 6, a);
434}
435
Allan Stephensd265fef2010-11-30 12:00:53 +0000436static inline u32 msg_destnode(struct tipc_msg *m)
437{
438 return msg_word(m, 7);
439}
440
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900441static inline void msg_set_destnode(struct tipc_msg *m, u32 a)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100442{
443 msg_set_word(m, 7, a);
444}
445
Allan Stephensd265fef2010-11-30 12:00:53 +0000446static inline u32 msg_nametype(struct tipc_msg *m)
447{
448 return msg_word(m, 8);
449}
450
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900451static inline void msg_set_nametype(struct tipc_msg *m, u32 n)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100452{
453 msg_set_word(m, 8, n);
454}
455
Allan Stephensd265fef2010-11-30 12:00:53 +0000456static inline u32 msg_nameinst(struct tipc_msg *m)
457{
458 return msg_word(m, 9);
459}
460
461static inline u32 msg_namelower(struct tipc_msg *m)
462{
463 return msg_nameinst(m);
464}
465
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900466static inline void msg_set_namelower(struct tipc_msg *m, u32 n)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100467{
468 msg_set_word(m, 9, n);
469}
470
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900471static inline void msg_set_nameinst(struct tipc_msg *m, u32 n)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100472{
473 msg_set_namelower(m, n);
474}
475
Allan Stephensd265fef2010-11-30 12:00:53 +0000476static inline u32 msg_nameupper(struct tipc_msg *m)
477{
478 return msg_word(m, 10);
479}
480
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900481static inline void msg_set_nameupper(struct tipc_msg *m, u32 n)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100482{
483 msg_set_word(m, 10, n);
484}
485
Per Lidenb97bf3f2006-01-02 19:04:38 +0100486/*
Allan Stephenscc4c4352011-04-08 10:50:52 -0400487 * Constants and routines used to read and write TIPC internal message headers
488 */
Per Lidenb97bf3f2006-01-02 19:04:38 +0100489
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900490/*
Allan Stephenscc4c4352011-04-08 10:50:52 -0400491 * Connection management protocol message types
Per Lidenb97bf3f2006-01-02 19:04:38 +0100492 */
Per Lidenb97bf3f2006-01-02 19:04:38 +0100493#define CONN_PROBE 0
494#define CONN_PROBE_REPLY 1
495#define CONN_ACK 2
496
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900497/*
Allan Stephenscc4c4352011-04-08 10:50:52 -0400498 * Name distributor message types
Per Lidenb97bf3f2006-01-02 19:04:38 +0100499 */
Per Lidenb97bf3f2006-01-02 19:04:38 +0100500#define PUBLICATION 0
501#define WITHDRAWAL 1
502
Allan Stephens92138d12011-04-08 11:04:15 -0400503/*
504 * Segmentation message types
505 */
Allan Stephens92138d12011-04-08 11:04:15 -0400506#define FIRST_FRAGMENT 0
507#define FRAGMENT 1
508#define LAST_FRAGMENT 2
509
510/*
511 * Link management protocol message types
512 */
Allan Stephens92138d12011-04-08 11:04:15 -0400513#define STATE_MSG 0
514#define RESET_MSG 1
515#define ACTIVATE_MSG 2
516
517/*
518 * Changeover tunnel message types
519 */
Jon Paul Maloydff29b12015-04-02 09:33:01 -0400520#define SYNCH_MSG 0
521#define FAILOVER_MSG 1
Allan Stephens92138d12011-04-08 11:04:15 -0400522
523/*
524 * Config protocol message types
525 */
Allan Stephens92138d12011-04-08 11:04:15 -0400526#define DSC_REQ_MSG 0
527#define DSC_RESP_MSG 1
528
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900529/*
Per Lidenb97bf3f2006-01-02 19:04:38 +0100530 * Word 1
531 */
Per Lidenb97bf3f2006-01-02 19:04:38 +0100532static inline u32 msg_seq_gap(struct tipc_msg *m)
533{
Allan Stephensbd784532008-06-04 17:47:30 -0700534 return msg_bits(m, 1, 16, 0x1fff);
Per Lidenb97bf3f2006-01-02 19:04:38 +0100535}
536
537static inline void msg_set_seq_gap(struct tipc_msg *m, u32 n)
538{
Allan Stephensbd784532008-06-04 17:47:30 -0700539 msg_set_bits(m, 1, 16, 0x1fff, n);
Per Lidenb97bf3f2006-01-02 19:04:38 +0100540}
541
Allan Stephensfc0eea62011-10-28 16:26:41 -0400542static inline u32 msg_node_sig(struct tipc_msg *m)
543{
544 return msg_bits(m, 1, 0, 0xffff);
545}
546
547static inline void msg_set_node_sig(struct tipc_msg *m, u32 n)
548{
549 msg_set_bits(m, 1, 0, 0xffff, n);
550}
551
Jon Paul Maloy7764d6e2015-03-13 16:08:05 -0400552static inline u32 msg_node_capabilities(struct tipc_msg *m)
553{
554 return msg_bits(m, 1, 15, 0x1fff);
555}
556
557static inline void msg_set_node_capabilities(struct tipc_msg *m, u32 n)
558{
559 msg_set_bits(m, 1, 15, 0x1fff, n);
560}
561
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900562/*
Per Lidenb97bf3f2006-01-02 19:04:38 +0100563 * Word 2
564 */
Per Lidenb97bf3f2006-01-02 19:04:38 +0100565static inline u32 msg_dest_domain(struct tipc_msg *m)
566{
567 return msg_word(m, 2);
568}
569
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900570static inline void msg_set_dest_domain(struct tipc_msg *m, u32 n)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100571{
572 msg_set_word(m, 2, n);
573}
574
575static inline u32 msg_bcgap_after(struct tipc_msg *m)
576{
577 return msg_bits(m, 2, 16, 0xffff);
578}
579
580static inline void msg_set_bcgap_after(struct tipc_msg *m, u32 n)
581{
582 msg_set_bits(m, 2, 16, 0xffff, n);
583}
584
585static inline u32 msg_bcgap_to(struct tipc_msg *m)
586{
587 return msg_bits(m, 2, 0, 0xffff);
588}
589
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900590static inline void msg_set_bcgap_to(struct tipc_msg *m, u32 n)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100591{
592 msg_set_bits(m, 2, 0, 0xffff, n);
593}
594
595
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900596/*
Per Lidenb97bf3f2006-01-02 19:04:38 +0100597 * Word 4
598 */
Per Lidenb97bf3f2006-01-02 19:04:38 +0100599static inline u32 msg_last_bcast(struct tipc_msg *m)
600{
601 return msg_bits(m, 4, 16, 0xffff);
602}
603
Jon Paul Maloy52666982015-10-22 08:51:41 -0400604static inline u32 msg_bc_snd_nxt(struct tipc_msg *m)
605{
606 return msg_last_bcast(m) + 1;
607}
608
Per Lidenb97bf3f2006-01-02 19:04:38 +0100609static inline void msg_set_last_bcast(struct tipc_msg *m, u32 n)
610{
611 msg_set_bits(m, 4, 16, 0xffff, n);
612}
613
Per Lidenb97bf3f2006-01-02 19:04:38 +0100614static inline void msg_set_fragm_no(struct tipc_msg *m, u32 n)
615{
616 msg_set_bits(m, 4, 16, 0xffff, n);
617}
618
619
Jon Paul Maloy6e498152015-07-30 18:24:19 -0400620static inline u16 msg_next_sent(struct tipc_msg *m)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100621{
622 return msg_bits(m, 4, 0, 0xffff);
623}
624
Jon Paul Maloy6e498152015-07-30 18:24:19 -0400625static inline void msg_set_next_sent(struct tipc_msg *m, u16 n)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100626{
627 msg_set_bits(m, 4, 0, 0xffff, n);
628}
629
Per Lidenb97bf3f2006-01-02 19:04:38 +0100630static inline void msg_set_long_msgno(struct tipc_msg *m, u32 n)
631{
632 msg_set_bits(m, 4, 0, 0xffff, n);
633}
634
635static inline u32 msg_bc_netid(struct tipc_msg *m)
636{
637 return msg_word(m, 4);
638}
639
640static inline void msg_set_bc_netid(struct tipc_msg *m, u32 id)
641{
642 msg_set_word(m, 4, id);
643}
644
645static inline u32 msg_link_selector(struct tipc_msg *m)
646{
647 return msg_bits(m, 4, 0, 1);
648}
649
650static inline void msg_set_link_selector(struct tipc_msg *m, u32 n)
651{
Allan Stephens7eb878e2011-05-25 13:28:27 -0400652 msg_set_bits(m, 4, 0, 1, n);
Per Lidenb97bf3f2006-01-02 19:04:38 +0100653}
654
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900655/*
Per Lidenb97bf3f2006-01-02 19:04:38 +0100656 * Word 5
657 */
Jon Paul Maloyd9992972015-07-16 16:54:31 -0400658static inline u16 msg_session(struct tipc_msg *m)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100659{
660 return msg_bits(m, 5, 16, 0xffff);
661}
662
Jon Paul Maloyd9992972015-07-16 16:54:31 -0400663static inline void msg_set_session(struct tipc_msg *m, u16 n)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100664{
665 msg_set_bits(m, 5, 16, 0xffff, n);
666}
667
668static inline u32 msg_probe(struct tipc_msg *m)
669{
670 return msg_bits(m, 5, 0, 1);
671}
672
673static inline void msg_set_probe(struct tipc_msg *m, u32 val)
674{
Allan Stephens7eb878e2011-05-25 13:28:27 -0400675 msg_set_bits(m, 5, 0, 1, val);
Per Lidenb97bf3f2006-01-02 19:04:38 +0100676}
677
678static inline char msg_net_plane(struct tipc_msg *m)
679{
680 return msg_bits(m, 5, 1, 7) + 'A';
681}
682
683static inline void msg_set_net_plane(struct tipc_msg *m, char n)
684{
685 msg_set_bits(m, 5, 1, 7, (n - 'A'));
686}
687
688static inline u32 msg_linkprio(struct tipc_msg *m)
689{
690 return msg_bits(m, 5, 4, 0x1f);
691}
692
693static inline void msg_set_linkprio(struct tipc_msg *m, u32 n)
694{
695 msg_set_bits(m, 5, 4, 0x1f, n);
696}
697
698static inline u32 msg_bearer_id(struct tipc_msg *m)
699{
700 return msg_bits(m, 5, 9, 0x7);
701}
702
703static inline void msg_set_bearer_id(struct tipc_msg *m, u32 n)
704{
705 msg_set_bits(m, 5, 9, 0x7, n);
706}
707
708static inline u32 msg_redundant_link(struct tipc_msg *m)
709{
710 return msg_bits(m, 5, 12, 0x1);
711}
712
Allan Stephens77f167f2011-02-28 15:30:20 -0500713static inline void msg_set_redundant_link(struct tipc_msg *m, u32 r)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100714{
Allan Stephens77f167f2011-02-28 15:30:20 -0500715 msg_set_bits(m, 5, 12, 0x1, r);
Per Lidenb97bf3f2006-01-02 19:04:38 +0100716}
717
Allan Stephens3d749a62011-10-07 15:19:11 -0400718static inline char *msg_media_addr(struct tipc_msg *m)
719{
Erik Hugne91e2eb52015-02-27 08:56:57 +0100720 return (char *)&m->hdr[TIPC_MEDIA_INFO_OFFSET];
Allan Stephens3d749a62011-10-07 15:19:11 -0400721}
Per Lidenb97bf3f2006-01-02 19:04:38 +0100722
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900723/*
Per Lidenb97bf3f2006-01-02 19:04:38 +0100724 * Word 9
725 */
Jon Paul Maloy6e498152015-07-30 18:24:19 -0400726static inline u16 msg_msgcnt(struct tipc_msg *m)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100727{
728 return msg_bits(m, 9, 16, 0xffff);
729}
730
Jon Paul Maloy6e498152015-07-30 18:24:19 -0400731static inline void msg_set_msgcnt(struct tipc_msg *m, u16 n)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100732{
733 msg_set_bits(m, 9, 16, 0xffff, n);
734}
735
736static inline u32 msg_bcast_tag(struct tipc_msg *m)
737{
738 return msg_bits(m, 9, 16, 0xffff);
739}
740
741static inline void msg_set_bcast_tag(struct tipc_msg *m, u32 n)
742{
743 msg_set_bits(m, 9, 16, 0xffff, n);
744}
745
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900746static inline u32 msg_max_pkt(struct tipc_msg *m)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100747{
Eric Dumazeta02cec22010-09-22 20:43:57 +0000748 return msg_bits(m, 9, 16, 0xffff) * 4;
Per Lidenb97bf3f2006-01-02 19:04:38 +0100749}
750
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900751static inline void msg_set_max_pkt(struct tipc_msg *m, u32 n)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100752{
753 msg_set_bits(m, 9, 16, 0xffff, (n / 4));
754}
755
756static inline u32 msg_link_tolerance(struct tipc_msg *m)
757{
758 return msg_bits(m, 9, 0, 0xffff);
759}
760
761static inline void msg_set_link_tolerance(struct tipc_msg *m, u32 n)
762{
763 msg_set_bits(m, 9, 0, 0xffff, n);
764}
765
Jon Paul Maloy6e498152015-07-30 18:24:19 -0400766static inline bool msg_peer_link_is_up(struct tipc_msg *m)
Jon Paul Maloyd9992972015-07-16 16:54:31 -0400767{
768 if (likely(msg_user(m) != LINK_PROTOCOL))
769 return true;
Jon Paul Maloy6e498152015-07-30 18:24:19 -0400770 if (msg_type(m) == STATE_MSG)
771 return true;
772 return false;
Jon Paul Maloyd9992972015-07-16 16:54:31 -0400773}
774
Jon Paul Maloy6e498152015-07-30 18:24:19 -0400775static inline bool msg_peer_node_is_up(struct tipc_msg *m)
Jon Paul Maloy1a20cc22015-07-16 16:54:30 -0400776{
Jon Paul Maloy6e498152015-07-30 18:24:19 -0400777 if (msg_peer_link_is_up(m))
778 return true;
Jon Paul Maloy1a20cc22015-07-16 16:54:30 -0400779 return msg_redundant_link(m);
780}
781
Ying Xue859fc7c2015-01-09 15:27:01 +0800782struct sk_buff *tipc_buf_acquire(u32 size);
Jon Paul Maloycf2157f2015-03-13 16:08:06 -0400783bool tipc_msg_validate(struct sk_buff *skb);
Jon Paul Maloybcd3ffd2015-07-22 10:11:19 -0400784bool tipc_msg_reverse(u32 own_addr, struct sk_buff **skb, int err);
Jon Paul Maloyc5898632015-02-05 08:36:36 -0500785void tipc_msg_init(u32 own_addr, struct tipc_msg *m, u32 user, u32 type,
Ying Xue34747532015-01-09 15:27:10 +0800786 u32 hsize, u32 destnode);
Jon Paul Maloye3a77562015-02-05 08:36:39 -0500787struct sk_buff *tipc_msg_create(uint user, uint type, uint hdr_sz,
788 uint data_sz, u32 dnode, u32 onode,
789 u32 dport, u32 oport, int errcode);
Jon Paul Maloy37e22162014-05-14 05:39:12 -0400790int tipc_buf_append(struct sk_buff **headbuf, struct sk_buff **buf);
Jon Paul Maloydd3f9e72015-05-14 10:46:18 -0400791bool tipc_msg_bundle(struct sk_buff *skb, struct tipc_msg *msg, u32 mtu);
792bool tipc_msg_make_bundle(struct sk_buff **skb, struct tipc_msg *msg,
793 u32 mtu, u32 dnode);
Jon Paul Maloyc637c102015-02-05 08:36:41 -0500794bool tipc_msg_extract(struct sk_buff *skb, struct sk_buff **iskb, int *pos);
Jon Paul Maloyc5898632015-02-05 08:36:36 -0500795int tipc_msg_build(struct tipc_msg *mhdr, struct msghdr *m,
Ying Xue34747532015-01-09 15:27:10 +0800796 int offset, int dsz, int mtu, struct sk_buff_head *list);
Jon Paul Maloycda36962015-07-22 10:11:20 -0400797bool tipc_msg_lookup_dest(struct net *net, struct sk_buff *skb, int *err);
Jon Paul Maloy2f566122015-10-22 08:51:39 -0400798bool tipc_msg_reassemble(struct sk_buff_head *list, struct sk_buff_head *rcvq);
Jon Paul Maloy8306f992015-10-15 14:52:43 -0400799void __tipc_skb_queue_sorted(struct sk_buff_head *list, u16 seqno,
800 struct sk_buff *skb);
Jon Paul Maloy078bec82014-07-16 20:41:00 -0400801
Jon Paul Maloye4bf4f72015-05-14 10:46:14 -0400802static inline u16 buf_seqno(struct sk_buff *skb)
803{
804 return msg_seqno(buf_msg(skb));
805}
806
Jon Paul Maloycb1b7282015-02-05 08:36:44 -0500807/* tipc_skb_peek(): peek and reserve first buffer in list
808 * @list: list to be peeked in
809 * Returns pointer to first buffer in list, if any
810 */
811static inline struct sk_buff *tipc_skb_peek(struct sk_buff_head *list,
812 spinlock_t *lock)
813{
814 struct sk_buff *skb;
815
816 spin_lock_bh(lock);
817 skb = skb_peek(list);
818 if (skb)
819 skb_get(skb);
820 spin_unlock_bh(lock);
821 return skb;
822}
823
Jon Paul Maloyc637c102015-02-05 08:36:41 -0500824/* tipc_skb_peek_port(): find a destination port, ignoring all destinations
825 * up to and including 'filter'.
826 * Note: ignoring previously tried destinations minimizes the risk of
827 * contention on the socket lock
828 * @list: list to be peeked in
829 * @filter: last destination to be ignored from search
830 * Returns a destination port number, of applicable.
831 */
832static inline u32 tipc_skb_peek_port(struct sk_buff_head *list, u32 filter)
833{
834 struct sk_buff *skb;
835 u32 dport = 0;
836 bool ignore = true;
837
838 spin_lock_bh(&list->lock);
839 skb_queue_walk(list, skb) {
840 dport = msg_destport(buf_msg(skb));
841 if (!filter || skb_queue_is_last(list, skb))
842 break;
843 if (dport == filter)
844 ignore = false;
845 else if (!ignore)
846 break;
847 }
848 spin_unlock_bh(&list->lock);
849 return dport;
850}
851
852/* tipc_skb_dequeue(): unlink first buffer with dest 'dport' from list
853 * @list: list to be unlinked from
854 * @dport: selection criteria for buffer to unlink
855 */
856static inline struct sk_buff *tipc_skb_dequeue(struct sk_buff_head *list,
857 u32 dport)
858{
859 struct sk_buff *_skb, *tmp, *skb = NULL;
860
861 spin_lock_bh(&list->lock);
862 skb_queue_walk_safe(list, _skb, tmp) {
863 if (msg_destport(buf_msg(_skb)) == dport) {
864 __skb_unlink(_skb, list);
865 skb = _skb;
866 break;
867 }
868 }
869 spin_unlock_bh(&list->lock);
870 return skb;
871}
872
Jon Paul Maloy598411d2015-07-30 18:24:23 -0400873/* tipc_skb_queue_splice_tail - append an skb list to lock protected list
874 * @list: the new list to append. Not lock protected
875 * @head: target list. Lock protected.
876 */
877static inline void tipc_skb_queue_splice_tail(struct sk_buff_head *list,
878 struct sk_buff_head *head)
879{
880 spin_lock_bh(&head->lock);
881 skb_queue_splice_tail(list, head);
882 spin_unlock_bh(&head->lock);
883}
884
885/* tipc_skb_queue_splice_tail_init - merge two lock protected skb lists
886 * @list: the new list to add. Lock protected. Will be reinitialized
887 * @head: target list. Lock protected.
888 */
889static inline void tipc_skb_queue_splice_tail_init(struct sk_buff_head *list,
890 struct sk_buff_head *head)
891{
892 struct sk_buff_head tmp;
893
894 __skb_queue_head_init(&tmp);
895
896 spin_lock_bh(&list->lock);
897 skb_queue_splice_tail_init(list, &tmp);
898 spin_unlock_bh(&list->lock);
899 tipc_skb_queue_splice_tail(&tmp, head);
900}
901
Per Lidenb97bf3f2006-01-02 19:04:38 +0100902#endif