blob: 53e425f123430adf1105c1817d41771536bcde2c [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 Maloy37e22162014-05-14 05:39:12 -04004 * Copyright (c) 2000-2007, 2014, 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
Allan Stephensd265fef2010-11-30 12:00:53 +000040#include "bearer.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
Allan Stephens06d82c92008-03-06 15:06:55 -080048
Allan Stephensd265fef2010-11-30 12:00:53 +000049/*
Allan Stephenscc4c4352011-04-08 10:50:52 -040050 * Payload message users are defined in TIPC's public API:
51 * - TIPC_LOW_IMPORTANCE
52 * - TIPC_MEDIUM_IMPORTANCE
53 * - TIPC_HIGH_IMPORTANCE
54 * - TIPC_CRITICAL_IMPORTANCE
55 */
56
57/*
58 * Payload message types
Allan Stephensd265fef2010-11-30 12:00:53 +000059 */
Allan Stephensd265fef2010-11-30 12:00:53 +000060#define TIPC_CONN_MSG 0
61#define TIPC_MCAST_MSG 1
62#define TIPC_NAMED_MSG 2
63#define TIPC_DIRECT_MSG 3
64
Allan Stephenscc4c4352011-04-08 10:50:52 -040065/*
66 * Message header sizes
67 */
Allan Stephens741d9eb2011-05-31 15:03:18 -040068#define SHORT_H_SIZE 24 /* In-cluster basic payload message */
69#define BASIC_H_SIZE 32 /* Basic payload message */
70#define NAMED_H_SIZE 40 /* Named payload message */
71#define MCAST_H_SIZE 44 /* Multicast payload message */
Allan Stephens06d82c92008-03-06 15:06:55 -080072#define INT_H_SIZE 40 /* Internal messages */
73#define MIN_H_SIZE 24 /* Smallest legal TIPC header size */
74#define MAX_H_SIZE 60 /* Largest possible TIPC header size */
75
Per Lidenb97bf3f2006-01-02 19:04:38 +010076#define MAX_MSG_SIZE (MAX_H_SIZE + TIPC_MAX_USER_MSG_SIZE)
Per Lidenb97bf3f2006-01-02 19:04:38 +010077
Allan Stephens3d749a62011-10-07 15:19:11 -040078#define TIPC_MEDIA_ADDR_OFFSET 5
79
Per Lidenb97bf3f2006-01-02 19:04:38 +010080
Allan Stephensd265fef2010-11-30 12:00:53 +000081struct tipc_msg {
82 __be32 hdr[15];
83};
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +090084
Per Lidenb97bf3f2006-01-02 19:04:38 +010085
Allan Stephensd265fef2010-11-30 12:00:53 +000086static inline u32 msg_word(struct tipc_msg *m, u32 pos)
87{
88 return ntohl(m->hdr[pos]);
89}
Per Lidenb97bf3f2006-01-02 19:04:38 +010090
91static inline void msg_set_word(struct tipc_msg *m, u32 w, u32 val)
92{
93 m->hdr[w] = htonl(val);
94}
95
Allan Stephensd265fef2010-11-30 12:00:53 +000096static inline u32 msg_bits(struct tipc_msg *m, u32 w, u32 pos, u32 mask)
97{
98 return (msg_word(m, w) >> pos) & mask;
99}
100
Per Lidenb97bf3f2006-01-02 19:04:38 +0100101static inline void msg_set_bits(struct tipc_msg *m, u32 w,
102 u32 pos, u32 mask, u32 val)
103{
Allan Stephens1f9eda72007-04-24 14:51:55 -0700104 val = (val & mask) << pos;
Al Virobecf3da2008-04-26 22:42:14 -0700105 mask = mask << pos;
106 m->hdr[w] &= ~htonl(mask);
107 m->hdr[w] |= htonl(val);
Per Lidenb97bf3f2006-01-02 19:04:38 +0100108}
109
Allan Stephens40aecb12008-06-04 17:54:48 -0700110static inline void msg_swap_words(struct tipc_msg *msg, u32 a, u32 b)
111{
112 u32 temp = msg->hdr[a];
113
114 msg->hdr[a] = msg->hdr[b];
115 msg->hdr[b] = temp;
116}
117
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900118/*
Per Lidenb97bf3f2006-01-02 19:04:38 +0100119 * Word 0
120 */
Per Lidenb97bf3f2006-01-02 19:04:38 +0100121static inline u32 msg_version(struct tipc_msg *m)
122{
123 return msg_bits(m, 0, 29, 7);
124}
125
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900126static inline void msg_set_version(struct tipc_msg *m)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100127{
Allan Stephens37695422008-03-06 15:07:42 -0800128 msg_set_bits(m, 0, 29, 7, TIPC_VERSION);
Per Lidenb97bf3f2006-01-02 19:04:38 +0100129}
130
131static inline u32 msg_user(struct tipc_msg *m)
132{
133 return msg_bits(m, 0, 25, 0xf);
134}
135
136static inline u32 msg_isdata(struct tipc_msg *m)
137{
Eric Dumazeta02cec22010-09-22 20:43:57 +0000138 return msg_user(m) <= TIPC_CRITICAL_IMPORTANCE;
Per Lidenb97bf3f2006-01-02 19:04:38 +0100139}
140
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900141static inline void msg_set_user(struct tipc_msg *m, u32 n)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100142{
143 msg_set_bits(m, 0, 25, 0xf, n);
144}
145
Allan Stephensd265fef2010-11-30 12:00:53 +0000146static inline u32 msg_importance(struct tipc_msg *m)
147{
148 return msg_bits(m, 0, 25, 0xf);
149}
150
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900151static inline void msg_set_importance(struct tipc_msg *m, u32 i)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100152{
153 msg_set_user(m, i);
154}
155
Allan Stephensd265fef2010-11-30 12:00:53 +0000156static inline u32 msg_hdr_sz(struct tipc_msg *m)
157{
158 return msg_bits(m, 0, 21, 0xf) << 2;
159}
160
Allan Stephens0e659672010-12-31 18:59:32 +0000161static inline void msg_set_hdr_sz(struct tipc_msg *m, u32 n)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100162{
163 msg_set_bits(m, 0, 21, 0xf, n>>2);
164}
165
Allan Stephensd265fef2010-11-30 12:00:53 +0000166static inline u32 msg_size(struct tipc_msg *m)
167{
168 return msg_bits(m, 0, 0, 0x1ffff);
169}
170
171static inline u32 msg_data_sz(struct tipc_msg *m)
172{
173 return msg_size(m) - msg_hdr_sz(m);
174}
175
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900176static inline int msg_non_seq(struct tipc_msg *m)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100177{
178 return msg_bits(m, 0, 20, 1);
179}
180
Allan Stephens40aecb12008-06-04 17:54:48 -0700181static inline void msg_set_non_seq(struct tipc_msg *m, u32 n)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100182{
Allan Stephens40aecb12008-06-04 17:54:48 -0700183 msg_set_bits(m, 0, 20, 1, n);
Per Lidenb97bf3f2006-01-02 19:04:38 +0100184}
185
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900186static inline int msg_dest_droppable(struct tipc_msg *m)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100187{
188 return msg_bits(m, 0, 19, 1);
189}
190
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900191static inline void msg_set_dest_droppable(struct tipc_msg *m, u32 d)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100192{
193 msg_set_bits(m, 0, 19, 1, d);
194}
195
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900196static inline int msg_src_droppable(struct tipc_msg *m)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100197{
198 return msg_bits(m, 0, 18, 1);
199}
200
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900201static inline void msg_set_src_droppable(struct tipc_msg *m, u32 d)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100202{
203 msg_set_bits(m, 0, 18, 1, d);
204}
205
206static inline void msg_set_size(struct tipc_msg *m, u32 sz)
207{
208 m->hdr[0] = htonl((msg_word(m, 0) & ~0x1ffff) | sz);
209}
210
211
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900212/*
Per Lidenb97bf3f2006-01-02 19:04:38 +0100213 * Word 1
214 */
Allan Stephensd265fef2010-11-30 12:00:53 +0000215static inline u32 msg_type(struct tipc_msg *m)
216{
217 return msg_bits(m, 1, 29, 0x7);
218}
219
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900220static inline void msg_set_type(struct tipc_msg *m, u32 n)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100221{
222 msg_set_bits(m, 1, 29, 0x7, n);
223}
224
Allan Stephensd265fef2010-11-30 12:00:53 +0000225static inline u32 msg_named(struct tipc_msg *m)
226{
227 return msg_type(m) == TIPC_NAMED_MSG;
228}
229
230static inline u32 msg_mcast(struct tipc_msg *m)
231{
232 return msg_type(m) == TIPC_MCAST_MSG;
233}
234
235static inline u32 msg_connected(struct tipc_msg *m)
236{
237 return msg_type(m) == TIPC_CONN_MSG;
238}
239
240static inline u32 msg_errcode(struct tipc_msg *m)
241{
242 return msg_bits(m, 1, 25, 0xf);
243}
244
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900245static inline void msg_set_errcode(struct tipc_msg *m, u32 err)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100246{
247 msg_set_bits(m, 1, 25, 0xf, err);
248}
249
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900250static inline u32 msg_reroute_cnt(struct tipc_msg *m)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100251{
252 return msg_bits(m, 1, 21, 0xf);
253}
254
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900255static inline void msg_incr_reroute_cnt(struct tipc_msg *m)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100256{
257 msg_set_bits(m, 1, 21, 0xf, msg_reroute_cnt(m) + 1);
258}
259
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900260static inline void msg_reset_reroute_cnt(struct tipc_msg *m)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100261{
262 msg_set_bits(m, 1, 21, 0xf, 0);
263}
264
265static inline u32 msg_lookup_scope(struct tipc_msg *m)
266{
267 return msg_bits(m, 1, 19, 0x3);
268}
269
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900270static inline void msg_set_lookup_scope(struct tipc_msg *m, u32 n)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100271{
272 msg_set_bits(m, 1, 19, 0x3, n);
273}
274
Per Lidenb97bf3f2006-01-02 19:04:38 +0100275static inline u32 msg_bcast_ack(struct tipc_msg *m)
276{
277 return msg_bits(m, 1, 0, 0xffff);
278}
279
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900280static inline void msg_set_bcast_ack(struct tipc_msg *m, u32 n)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100281{
282 msg_set_bits(m, 1, 0, 0xffff, n);
283}
284
285
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900286/*
Per Lidenb97bf3f2006-01-02 19:04:38 +0100287 * Word 2
288 */
Per Lidenb97bf3f2006-01-02 19:04:38 +0100289static inline u32 msg_ack(struct tipc_msg *m)
290{
291 return msg_bits(m, 2, 16, 0xffff);
292}
293
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900294static inline void msg_set_ack(struct tipc_msg *m, u32 n)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100295{
296 msg_set_bits(m, 2, 16, 0xffff, n);
297}
298
299static inline u32 msg_seqno(struct tipc_msg *m)
300{
301 return msg_bits(m, 2, 0, 0xffff);
302}
303
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900304static inline void msg_set_seqno(struct tipc_msg *m, u32 n)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100305{
306 msg_set_bits(m, 2, 0, 0xffff, n);
307}
308
Allan Stephens40aecb12008-06-04 17:54:48 -0700309/*
Per Lidenb97bf3f2006-01-02 19:04:38 +0100310 * Words 3-10
311 */
Allan Stephensd265fef2010-11-30 12:00:53 +0000312static inline u32 msg_prevnode(struct tipc_msg *m)
313{
314 return msg_word(m, 3);
315}
316
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900317static inline void msg_set_prevnode(struct tipc_msg *m, u32 a)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100318{
319 msg_set_word(m, 3, a);
320}
321
Allan Stephensd265fef2010-11-30 12:00:53 +0000322static inline u32 msg_origport(struct tipc_msg *m)
323{
324 return msg_word(m, 4);
325}
326
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900327static inline void msg_set_origport(struct tipc_msg *m, u32 p)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100328{
329 msg_set_word(m, 4, p);
330}
331
Allan Stephensd265fef2010-11-30 12:00:53 +0000332static inline u32 msg_destport(struct tipc_msg *m)
333{
334 return msg_word(m, 5);
335}
336
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900337static inline void msg_set_destport(struct tipc_msg *m, u32 p)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100338{
339 msg_set_word(m, 5, p);
340}
341
Allan Stephensd265fef2010-11-30 12:00:53 +0000342static inline u32 msg_mc_netid(struct tipc_msg *m)
343{
344 return msg_word(m, 5);
345}
346
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900347static inline void msg_set_mc_netid(struct tipc_msg *m, u32 p)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100348{
349 msg_set_word(m, 5, p);
350}
351
Allan Stephensd265fef2010-11-30 12:00:53 +0000352static inline int msg_short(struct tipc_msg *m)
353{
Allan Stephens741d9eb2011-05-31 15:03:18 -0400354 return msg_hdr_sz(m) == SHORT_H_SIZE;
Allan Stephensd265fef2010-11-30 12:00:53 +0000355}
356
357static inline u32 msg_orignode(struct tipc_msg *m)
358{
359 if (likely(msg_short(m)))
360 return msg_prevnode(m);
361 return msg_word(m, 6);
362}
363
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900364static inline void msg_set_orignode(struct tipc_msg *m, u32 a)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100365{
366 msg_set_word(m, 6, a);
367}
368
Allan Stephensd265fef2010-11-30 12:00:53 +0000369static inline u32 msg_destnode(struct tipc_msg *m)
370{
371 return msg_word(m, 7);
372}
373
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900374static inline void msg_set_destnode(struct tipc_msg *m, u32 a)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100375{
376 msg_set_word(m, 7, a);
377}
378
Allan Stephensd265fef2010-11-30 12:00:53 +0000379static inline u32 msg_nametype(struct tipc_msg *m)
380{
381 return msg_word(m, 8);
382}
383
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900384static inline void msg_set_nametype(struct tipc_msg *m, u32 n)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100385{
386 msg_set_word(m, 8, n);
387}
388
Allan Stephensd265fef2010-11-30 12:00:53 +0000389static inline u32 msg_nameinst(struct tipc_msg *m)
390{
391 return msg_word(m, 9);
392}
393
394static inline u32 msg_namelower(struct tipc_msg *m)
395{
396 return msg_nameinst(m);
397}
398
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900399static inline void msg_set_namelower(struct tipc_msg *m, u32 n)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100400{
401 msg_set_word(m, 9, n);
402}
403
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900404static inline void msg_set_nameinst(struct tipc_msg *m, u32 n)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100405{
406 msg_set_namelower(m, n);
407}
408
Allan Stephensd265fef2010-11-30 12:00:53 +0000409static inline u32 msg_nameupper(struct tipc_msg *m)
410{
411 return msg_word(m, 10);
412}
413
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900414static inline void msg_set_nameupper(struct tipc_msg *m, u32 n)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100415{
416 msg_set_word(m, 10, n);
417}
418
Allan Stephensd265fef2010-11-30 12:00:53 +0000419static inline unchar *msg_data(struct tipc_msg *m)
420{
421 return ((unchar *)m) + msg_hdr_sz(m);
422}
423
Per Lidenb97bf3f2006-01-02 19:04:38 +0100424static inline struct tipc_msg *msg_get_wrapped(struct tipc_msg *m)
425{
426 return (struct tipc_msg *)msg_data(m);
427}
428
Per Lidenb97bf3f2006-01-02 19:04:38 +0100429/*
Allan Stephenscc4c4352011-04-08 10:50:52 -0400430 * Constants and routines used to read and write TIPC internal message headers
431 */
Per Lidenb97bf3f2006-01-02 19:04:38 +0100432
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900433/*
Allan Stephenscc4c4352011-04-08 10:50:52 -0400434 * Internal message users
Per Lidenb97bf3f2006-01-02 19:04:38 +0100435 */
Per Lidenb97bf3f2006-01-02 19:04:38 +0100436#define BCAST_PROTOCOL 5
437#define MSG_BUNDLER 6
438#define LINK_PROTOCOL 7
439#define CONN_MANAGER 8
Allan Stephens51a8e4d2010-12-31 18:59:18 +0000440#define ROUTE_DISTRIBUTOR 9 /* obsoleted */
Per Lidenb97bf3f2006-01-02 19:04:38 +0100441#define CHANGEOVER_PROTOCOL 10
442#define NAME_DISTRIBUTOR 11
443#define MSG_FRAGMENTER 12
444#define LINK_CONFIG 13
Jon Paul Maloy50100a52014-08-22 18:09:07 -0400445#define SOCK_WAKEUP 14 /* pseudo user */
Per Lidenb97bf3f2006-01-02 19:04:38 +0100446
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900447/*
Allan Stephenscc4c4352011-04-08 10:50:52 -0400448 * Connection management protocol message types
Per Lidenb97bf3f2006-01-02 19:04:38 +0100449 */
Per Lidenb97bf3f2006-01-02 19:04:38 +0100450#define CONN_PROBE 0
451#define CONN_PROBE_REPLY 1
452#define CONN_ACK 2
453
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900454/*
Allan Stephenscc4c4352011-04-08 10:50:52 -0400455 * Name distributor message types
Per Lidenb97bf3f2006-01-02 19:04:38 +0100456 */
Per Lidenb97bf3f2006-01-02 19:04:38 +0100457#define PUBLICATION 0
458#define WITHDRAWAL 1
459
Allan Stephens92138d12011-04-08 11:04:15 -0400460/*
461 * Segmentation message types
462 */
Allan Stephens92138d12011-04-08 11:04:15 -0400463#define FIRST_FRAGMENT 0
464#define FRAGMENT 1
465#define LAST_FRAGMENT 2
466
467/*
468 * Link management protocol message types
469 */
Allan Stephens92138d12011-04-08 11:04:15 -0400470#define STATE_MSG 0
471#define RESET_MSG 1
472#define ACTIVATE_MSG 2
473
474/*
475 * Changeover tunnel message types
476 */
477#define DUPLICATE_MSG 0
478#define ORIGINAL_MSG 1
479
480/*
481 * Config protocol message types
482 */
Allan Stephens92138d12011-04-08 11:04:15 -0400483#define DSC_REQ_MSG 0
484#define DSC_RESP_MSG 1
485
Per Lidenb97bf3f2006-01-02 19:04:38 +0100486
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900487/*
Per Lidenb97bf3f2006-01-02 19:04:38 +0100488 * Word 1
489 */
Per Lidenb97bf3f2006-01-02 19:04:38 +0100490static inline u32 msg_seq_gap(struct tipc_msg *m)
491{
Allan Stephensbd784532008-06-04 17:47:30 -0700492 return msg_bits(m, 1, 16, 0x1fff);
Per Lidenb97bf3f2006-01-02 19:04:38 +0100493}
494
495static inline void msg_set_seq_gap(struct tipc_msg *m, u32 n)
496{
Allan Stephensbd784532008-06-04 17:47:30 -0700497 msg_set_bits(m, 1, 16, 0x1fff, n);
Per Lidenb97bf3f2006-01-02 19:04:38 +0100498}
499
Allan Stephensfc0eea62011-10-28 16:26:41 -0400500static inline u32 msg_node_sig(struct tipc_msg *m)
501{
502 return msg_bits(m, 1, 0, 0xffff);
503}
504
505static inline void msg_set_node_sig(struct tipc_msg *m, u32 n)
506{
507 msg_set_bits(m, 1, 0, 0xffff, n);
508}
509
Per Lidenb97bf3f2006-01-02 19:04:38 +0100510
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900511/*
Per Lidenb97bf3f2006-01-02 19:04:38 +0100512 * Word 2
513 */
Per Lidenb97bf3f2006-01-02 19:04:38 +0100514static inline u32 msg_dest_domain(struct tipc_msg *m)
515{
516 return msg_word(m, 2);
517}
518
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900519static inline void msg_set_dest_domain(struct tipc_msg *m, u32 n)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100520{
521 msg_set_word(m, 2, n);
522}
523
524static inline u32 msg_bcgap_after(struct tipc_msg *m)
525{
526 return msg_bits(m, 2, 16, 0xffff);
527}
528
529static inline void msg_set_bcgap_after(struct tipc_msg *m, u32 n)
530{
531 msg_set_bits(m, 2, 16, 0xffff, n);
532}
533
534static inline u32 msg_bcgap_to(struct tipc_msg *m)
535{
536 return msg_bits(m, 2, 0, 0xffff);
537}
538
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900539static inline void msg_set_bcgap_to(struct tipc_msg *m, u32 n)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100540{
541 msg_set_bits(m, 2, 0, 0xffff, n);
542}
543
544
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900545/*
Per Lidenb97bf3f2006-01-02 19:04:38 +0100546 * Word 4
547 */
Per Lidenb97bf3f2006-01-02 19:04:38 +0100548static inline u32 msg_last_bcast(struct tipc_msg *m)
549{
550 return msg_bits(m, 4, 16, 0xffff);
551}
552
553static inline void msg_set_last_bcast(struct tipc_msg *m, u32 n)
554{
555 msg_set_bits(m, 4, 16, 0xffff, n);
556}
557
Per Lidenb97bf3f2006-01-02 19:04:38 +0100558static inline void msg_set_fragm_no(struct tipc_msg *m, u32 n)
559{
560 msg_set_bits(m, 4, 16, 0xffff, n);
561}
562
563
564static inline u32 msg_next_sent(struct tipc_msg *m)
565{
566 return msg_bits(m, 4, 0, 0xffff);
567}
568
569static inline void msg_set_next_sent(struct tipc_msg *m, u32 n)
570{
571 msg_set_bits(m, 4, 0, 0xffff, n);
572}
573
Per Lidenb97bf3f2006-01-02 19:04:38 +0100574static inline void msg_set_long_msgno(struct tipc_msg *m, u32 n)
575{
576 msg_set_bits(m, 4, 0, 0xffff, n);
577}
578
579static inline u32 msg_bc_netid(struct tipc_msg *m)
580{
581 return msg_word(m, 4);
582}
583
584static inline void msg_set_bc_netid(struct tipc_msg *m, u32 id)
585{
586 msg_set_word(m, 4, id);
587}
588
589static inline u32 msg_link_selector(struct tipc_msg *m)
590{
591 return msg_bits(m, 4, 0, 1);
592}
593
594static inline void msg_set_link_selector(struct tipc_msg *m, u32 n)
595{
Allan Stephens7eb878e2011-05-25 13:28:27 -0400596 msg_set_bits(m, 4, 0, 1, n);
Per Lidenb97bf3f2006-01-02 19:04:38 +0100597}
598
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900599/*
Per Lidenb97bf3f2006-01-02 19:04:38 +0100600 * Word 5
601 */
Per Lidenb97bf3f2006-01-02 19:04:38 +0100602static inline u32 msg_session(struct tipc_msg *m)
603{
604 return msg_bits(m, 5, 16, 0xffff);
605}
606
607static inline void msg_set_session(struct tipc_msg *m, u32 n)
608{
609 msg_set_bits(m, 5, 16, 0xffff, n);
610}
611
612static inline u32 msg_probe(struct tipc_msg *m)
613{
614 return msg_bits(m, 5, 0, 1);
615}
616
617static inline void msg_set_probe(struct tipc_msg *m, u32 val)
618{
Allan Stephens7eb878e2011-05-25 13:28:27 -0400619 msg_set_bits(m, 5, 0, 1, val);
Per Lidenb97bf3f2006-01-02 19:04:38 +0100620}
621
622static inline char msg_net_plane(struct tipc_msg *m)
623{
624 return msg_bits(m, 5, 1, 7) + 'A';
625}
626
627static inline void msg_set_net_plane(struct tipc_msg *m, char n)
628{
629 msg_set_bits(m, 5, 1, 7, (n - 'A'));
630}
631
632static inline u32 msg_linkprio(struct tipc_msg *m)
633{
634 return msg_bits(m, 5, 4, 0x1f);
635}
636
637static inline void msg_set_linkprio(struct tipc_msg *m, u32 n)
638{
639 msg_set_bits(m, 5, 4, 0x1f, n);
640}
641
642static inline u32 msg_bearer_id(struct tipc_msg *m)
643{
644 return msg_bits(m, 5, 9, 0x7);
645}
646
647static inline void msg_set_bearer_id(struct tipc_msg *m, u32 n)
648{
649 msg_set_bits(m, 5, 9, 0x7, n);
650}
651
652static inline u32 msg_redundant_link(struct tipc_msg *m)
653{
654 return msg_bits(m, 5, 12, 0x1);
655}
656
Allan Stephens77f167f2011-02-28 15:30:20 -0500657static inline void msg_set_redundant_link(struct tipc_msg *m, u32 r)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100658{
Allan Stephens77f167f2011-02-28 15:30:20 -0500659 msg_set_bits(m, 5, 12, 0x1, r);
Per Lidenb97bf3f2006-01-02 19:04:38 +0100660}
661
Allan Stephens3d749a62011-10-07 15:19:11 -0400662static inline char *msg_media_addr(struct tipc_msg *m)
663{
664 return (char *)&m->hdr[TIPC_MEDIA_ADDR_OFFSET];
665}
Per Lidenb97bf3f2006-01-02 19:04:38 +0100666
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900667/*
Per Lidenb97bf3f2006-01-02 19:04:38 +0100668 * Word 9
669 */
Per Lidenb97bf3f2006-01-02 19:04:38 +0100670static inline u32 msg_msgcnt(struct tipc_msg *m)
671{
672 return msg_bits(m, 9, 16, 0xffff);
673}
674
675static inline void msg_set_msgcnt(struct tipc_msg *m, u32 n)
676{
677 msg_set_bits(m, 9, 16, 0xffff, n);
678}
679
680static inline u32 msg_bcast_tag(struct tipc_msg *m)
681{
682 return msg_bits(m, 9, 16, 0xffff);
683}
684
685static inline void msg_set_bcast_tag(struct tipc_msg *m, u32 n)
686{
687 msg_set_bits(m, 9, 16, 0xffff, n);
688}
689
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900690static inline u32 msg_max_pkt(struct tipc_msg *m)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100691{
Eric Dumazeta02cec22010-09-22 20:43:57 +0000692 return msg_bits(m, 9, 16, 0xffff) * 4;
Per Lidenb97bf3f2006-01-02 19:04:38 +0100693}
694
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900695static inline void msg_set_max_pkt(struct tipc_msg *m, u32 n)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100696{
697 msg_set_bits(m, 9, 16, 0xffff, (n / 4));
698}
699
700static inline u32 msg_link_tolerance(struct tipc_msg *m)
701{
702 return msg_bits(m, 9, 0, 0xffff);
703}
704
705static inline void msg_set_link_tolerance(struct tipc_msg *m, u32 n)
706{
707 msg_set_bits(m, 9, 0, 0xffff, n);
708}
709
Jon Paul Maloy4f1688b2014-06-25 20:41:32 -0500710static inline u32 tipc_msg_tot_importance(struct tipc_msg *m)
711{
712 if ((msg_user(m) == MSG_FRAGMENTER) && (msg_type(m) == FIRST_FRAGMENT))
713 return msg_importance(msg_get_wrapped(m));
714 return msg_importance(m);
715}
716
717static inline u32 msg_tot_origport(struct tipc_msg *m)
718{
719 if ((msg_user(m) == MSG_FRAGMENTER) && (msg_type(m) == FIRST_FRAGMENT))
720 return msg_origport(msg_get_wrapped(m));
721 return msg_origport(m);
722}
723
Jon Paul Maloy8db1bae2014-06-25 20:41:35 -0500724bool tipc_msg_reverse(struct sk_buff *buf, u32 *dnode, int err);
725
Jon Paul Maloy5a379072014-06-25 20:41:36 -0500726int tipc_msg_eval(struct sk_buff *buf, u32 *dnode);
727
Paul Gortmakerae8509c2013-06-17 10:54:47 -0400728void tipc_msg_init(struct tipc_msg *m, u32 user, u32 type, u32 hsize,
729 u32 destnode);
Jon Paul Maloy4f1688b2014-06-25 20:41:32 -0500730
Jon Paul Maloy1dd0bd22014-08-22 18:09:06 -0400731struct sk_buff *tipc_msg_create(uint user, uint type, uint hdr_sz,
732 uint data_sz, u32 dnode, u32 onode,
733 u32 dport, u32 oport, int errcode);
734
Jon Paul Maloy37e22162014-05-14 05:39:12 -0400735int tipc_buf_append(struct sk_buff **headbuf, struct sk_buff **buf);
736
Ying Xue58dc55f2014-11-26 11:41:52 +0800737bool tipc_msg_bundle(struct sk_buff_head *list, struct sk_buff *skb, u32 mtu);
Jon Paul Maloy4f1688b2014-06-25 20:41:32 -0500738
Ying Xue58dc55f2014-11-26 11:41:52 +0800739bool tipc_msg_make_bundle(struct sk_buff_head *list, struct sk_buff *skb,
740 u32 mtu, u32 dnode);
Jon Paul Maloy4f1688b2014-06-25 20:41:32 -0500741
Al Viro45dcc682014-11-15 01:16:27 -0500742int tipc_msg_build(struct tipc_msg *mhdr, struct msghdr *m,
Jon Paul Maloy9fbfb8b2014-07-16 20:41:03 -0400743 int offset, int dsz, int mtu , struct sk_buff **chain);
Jon Paul Maloy067608e2014-06-25 20:41:34 -0500744
Jon Paul Maloy078bec82014-07-16 20:41:00 -0400745struct sk_buff *tipc_msg_reassemble(struct sk_buff *chain);
746
Per Lidenb97bf3f2006-01-02 19:04:38 +0100747#endif