blob: f7ea95458c6f02440f04e06367d794da5f5d4d5d [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
Ying Xue1da46562015-01-09 15:27:07 +080040#include <linux/tipc.h>
Per Lidenb97bf3f2006-01-02 19:04:38 +010041
Allan Stephenscc4c4352011-04-08 10:50:52 -040042/*
43 * Constants and routines used to read and write TIPC payload message headers
44 *
45 * Note: Some items are also used with TIPC internal message headers
46 */
Per Lidenb97bf3f2006-01-02 19:04:38 +010047#define TIPC_VERSION 2
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
Ying Xue859fc7c2015-01-09 15:27:01 +080080/**
81 * TIPC message buffer code
82 *
83 * TIPC message buffer headroom reserves space for the worst-case
84 * link-level device header (in case the message is sent off-node).
85 *
86 * Note: Headroom should be a multiple of 4 to ensure the TIPC header fields
87 * are word aligned for quicker access
88 */
89#define BUF_HEADROOM LL_MAX_HEADER
90
91struct tipc_skb_cb {
92 void *handle;
93 struct sk_buff *tail;
94 bool deferred;
95 bool wakeup_pending;
96 bool bundling;
97 u16 chain_sz;
98 u16 chain_imp;
99};
100
101#define TIPC_SKB_CB(__skb) ((struct tipc_skb_cb *)&((__skb)->cb[0]))
102
Allan Stephensd265fef2010-11-30 12:00:53 +0000103struct tipc_msg {
104 __be32 hdr[15];
105};
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900106
Ying Xue859fc7c2015-01-09 15:27:01 +0800107static inline struct tipc_msg *buf_msg(struct sk_buff *skb)
108{
109 return (struct tipc_msg *)skb->data;
110}
111
Allan Stephensd265fef2010-11-30 12:00:53 +0000112static inline u32 msg_word(struct tipc_msg *m, u32 pos)
113{
114 return ntohl(m->hdr[pos]);
115}
Per Lidenb97bf3f2006-01-02 19:04:38 +0100116
117static inline void msg_set_word(struct tipc_msg *m, u32 w, u32 val)
118{
119 m->hdr[w] = htonl(val);
120}
121
Allan Stephensd265fef2010-11-30 12:00:53 +0000122static inline u32 msg_bits(struct tipc_msg *m, u32 w, u32 pos, u32 mask)
123{
124 return (msg_word(m, w) >> pos) & mask;
125}
126
Per Lidenb97bf3f2006-01-02 19:04:38 +0100127static inline void msg_set_bits(struct tipc_msg *m, u32 w,
128 u32 pos, u32 mask, u32 val)
129{
Allan Stephens1f9eda72007-04-24 14:51:55 -0700130 val = (val & mask) << pos;
Al Virobecf3da2008-04-26 22:42:14 -0700131 mask = mask << pos;
132 m->hdr[w] &= ~htonl(mask);
133 m->hdr[w] |= htonl(val);
Per Lidenb97bf3f2006-01-02 19:04:38 +0100134}
135
Allan Stephens40aecb12008-06-04 17:54:48 -0700136static inline void msg_swap_words(struct tipc_msg *msg, u32 a, u32 b)
137{
138 u32 temp = msg->hdr[a];
139
140 msg->hdr[a] = msg->hdr[b];
141 msg->hdr[b] = temp;
142}
143
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900144/*
Per Lidenb97bf3f2006-01-02 19:04:38 +0100145 * Word 0
146 */
Per Lidenb97bf3f2006-01-02 19:04:38 +0100147static inline u32 msg_version(struct tipc_msg *m)
148{
149 return msg_bits(m, 0, 29, 7);
150}
151
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900152static inline void msg_set_version(struct tipc_msg *m)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100153{
Allan Stephens37695422008-03-06 15:07:42 -0800154 msg_set_bits(m, 0, 29, 7, TIPC_VERSION);
Per Lidenb97bf3f2006-01-02 19:04:38 +0100155}
156
157static inline u32 msg_user(struct tipc_msg *m)
158{
159 return msg_bits(m, 0, 25, 0xf);
160}
161
162static inline u32 msg_isdata(struct tipc_msg *m)
163{
Eric Dumazeta02cec22010-09-22 20:43:57 +0000164 return msg_user(m) <= TIPC_CRITICAL_IMPORTANCE;
Per Lidenb97bf3f2006-01-02 19:04:38 +0100165}
166
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900167static inline void msg_set_user(struct tipc_msg *m, u32 n)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100168{
169 msg_set_bits(m, 0, 25, 0xf, n);
170}
171
Allan Stephensd265fef2010-11-30 12:00:53 +0000172static inline u32 msg_importance(struct tipc_msg *m)
173{
174 return msg_bits(m, 0, 25, 0xf);
175}
176
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900177static inline void msg_set_importance(struct tipc_msg *m, u32 i)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100178{
179 msg_set_user(m, i);
180}
181
Allan Stephensd265fef2010-11-30 12:00:53 +0000182static inline u32 msg_hdr_sz(struct tipc_msg *m)
183{
184 return msg_bits(m, 0, 21, 0xf) << 2;
185}
186
Allan Stephens0e659672010-12-31 18:59:32 +0000187static inline void msg_set_hdr_sz(struct tipc_msg *m, u32 n)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100188{
189 msg_set_bits(m, 0, 21, 0xf, n>>2);
190}
191
Allan Stephensd265fef2010-11-30 12:00:53 +0000192static inline u32 msg_size(struct tipc_msg *m)
193{
194 return msg_bits(m, 0, 0, 0x1ffff);
195}
196
197static inline u32 msg_data_sz(struct tipc_msg *m)
198{
199 return msg_size(m) - msg_hdr_sz(m);
200}
201
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900202static inline int msg_non_seq(struct tipc_msg *m)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100203{
204 return msg_bits(m, 0, 20, 1);
205}
206
Allan Stephens40aecb12008-06-04 17:54:48 -0700207static inline void msg_set_non_seq(struct tipc_msg *m, u32 n)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100208{
Allan Stephens40aecb12008-06-04 17:54:48 -0700209 msg_set_bits(m, 0, 20, 1, n);
Per Lidenb97bf3f2006-01-02 19:04:38 +0100210}
211
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900212static inline int msg_dest_droppable(struct tipc_msg *m)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100213{
214 return msg_bits(m, 0, 19, 1);
215}
216
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900217static inline void msg_set_dest_droppable(struct tipc_msg *m, u32 d)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100218{
219 msg_set_bits(m, 0, 19, 1, d);
220}
221
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900222static inline int msg_src_droppable(struct tipc_msg *m)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100223{
224 return msg_bits(m, 0, 18, 1);
225}
226
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900227static inline void msg_set_src_droppable(struct tipc_msg *m, u32 d)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100228{
229 msg_set_bits(m, 0, 18, 1, d);
230}
231
232static inline void msg_set_size(struct tipc_msg *m, u32 sz)
233{
234 m->hdr[0] = htonl((msg_word(m, 0) & ~0x1ffff) | sz);
235}
236
237
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900238/*
Per Lidenb97bf3f2006-01-02 19:04:38 +0100239 * Word 1
240 */
Allan Stephensd265fef2010-11-30 12:00:53 +0000241static inline u32 msg_type(struct tipc_msg *m)
242{
243 return msg_bits(m, 1, 29, 0x7);
244}
245
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900246static inline void msg_set_type(struct tipc_msg *m, u32 n)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100247{
248 msg_set_bits(m, 1, 29, 0x7, n);
249}
250
Allan Stephensd265fef2010-11-30 12:00:53 +0000251static inline u32 msg_named(struct tipc_msg *m)
252{
253 return msg_type(m) == TIPC_NAMED_MSG;
254}
255
256static inline u32 msg_mcast(struct tipc_msg *m)
257{
258 return msg_type(m) == TIPC_MCAST_MSG;
259}
260
261static inline u32 msg_connected(struct tipc_msg *m)
262{
263 return msg_type(m) == TIPC_CONN_MSG;
264}
265
266static inline u32 msg_errcode(struct tipc_msg *m)
267{
268 return msg_bits(m, 1, 25, 0xf);
269}
270
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900271static inline void msg_set_errcode(struct tipc_msg *m, u32 err)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100272{
273 msg_set_bits(m, 1, 25, 0xf, err);
274}
275
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900276static inline u32 msg_reroute_cnt(struct tipc_msg *m)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100277{
278 return msg_bits(m, 1, 21, 0xf);
279}
280
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900281static inline void msg_incr_reroute_cnt(struct tipc_msg *m)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100282{
283 msg_set_bits(m, 1, 21, 0xf, msg_reroute_cnt(m) + 1);
284}
285
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900286static inline void msg_reset_reroute_cnt(struct tipc_msg *m)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100287{
288 msg_set_bits(m, 1, 21, 0xf, 0);
289}
290
291static inline u32 msg_lookup_scope(struct tipc_msg *m)
292{
293 return msg_bits(m, 1, 19, 0x3);
294}
295
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900296static inline void msg_set_lookup_scope(struct tipc_msg *m, u32 n)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100297{
298 msg_set_bits(m, 1, 19, 0x3, n);
299}
300
Per Lidenb97bf3f2006-01-02 19:04:38 +0100301static inline u32 msg_bcast_ack(struct tipc_msg *m)
302{
303 return msg_bits(m, 1, 0, 0xffff);
304}
305
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900306static inline void msg_set_bcast_ack(struct tipc_msg *m, u32 n)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100307{
308 msg_set_bits(m, 1, 0, 0xffff, n);
309}
310
311
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900312/*
Per Lidenb97bf3f2006-01-02 19:04:38 +0100313 * Word 2
314 */
Per Lidenb97bf3f2006-01-02 19:04:38 +0100315static inline u32 msg_ack(struct tipc_msg *m)
316{
317 return msg_bits(m, 2, 16, 0xffff);
318}
319
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900320static inline void msg_set_ack(struct tipc_msg *m, u32 n)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100321{
322 msg_set_bits(m, 2, 16, 0xffff, n);
323}
324
325static inline u32 msg_seqno(struct tipc_msg *m)
326{
327 return msg_bits(m, 2, 0, 0xffff);
328}
329
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900330static inline void msg_set_seqno(struct tipc_msg *m, u32 n)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100331{
332 msg_set_bits(m, 2, 0, 0xffff, n);
333}
334
Allan Stephens40aecb12008-06-04 17:54:48 -0700335/*
Per Lidenb97bf3f2006-01-02 19:04:38 +0100336 * Words 3-10
337 */
Allan Stephensd265fef2010-11-30 12:00:53 +0000338static inline u32 msg_prevnode(struct tipc_msg *m)
339{
340 return msg_word(m, 3);
341}
342
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900343static inline void msg_set_prevnode(struct tipc_msg *m, u32 a)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100344{
345 msg_set_word(m, 3, a);
346}
347
Allan Stephensd265fef2010-11-30 12:00:53 +0000348static inline u32 msg_origport(struct tipc_msg *m)
349{
350 return msg_word(m, 4);
351}
352
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900353static inline void msg_set_origport(struct tipc_msg *m, u32 p)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100354{
355 msg_set_word(m, 4, p);
356}
357
Allan Stephensd265fef2010-11-30 12:00:53 +0000358static inline u32 msg_destport(struct tipc_msg *m)
359{
360 return msg_word(m, 5);
361}
362
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900363static inline void msg_set_destport(struct tipc_msg *m, u32 p)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100364{
365 msg_set_word(m, 5, p);
366}
367
Allan Stephensd265fef2010-11-30 12:00:53 +0000368static inline u32 msg_mc_netid(struct tipc_msg *m)
369{
370 return msg_word(m, 5);
371}
372
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900373static inline void msg_set_mc_netid(struct tipc_msg *m, u32 p)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100374{
375 msg_set_word(m, 5, p);
376}
377
Allan Stephensd265fef2010-11-30 12:00:53 +0000378static inline int msg_short(struct tipc_msg *m)
379{
Allan Stephens741d9eb2011-05-31 15:03:18 -0400380 return msg_hdr_sz(m) == SHORT_H_SIZE;
Allan Stephensd265fef2010-11-30 12:00:53 +0000381}
382
383static inline u32 msg_orignode(struct tipc_msg *m)
384{
385 if (likely(msg_short(m)))
386 return msg_prevnode(m);
387 return msg_word(m, 6);
388}
389
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900390static inline void msg_set_orignode(struct tipc_msg *m, u32 a)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100391{
392 msg_set_word(m, 6, a);
393}
394
Allan Stephensd265fef2010-11-30 12:00:53 +0000395static inline u32 msg_destnode(struct tipc_msg *m)
396{
397 return msg_word(m, 7);
398}
399
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900400static inline void msg_set_destnode(struct tipc_msg *m, u32 a)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100401{
402 msg_set_word(m, 7, a);
403}
404
Allan Stephensd265fef2010-11-30 12:00:53 +0000405static inline u32 msg_nametype(struct tipc_msg *m)
406{
407 return msg_word(m, 8);
408}
409
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900410static inline void msg_set_nametype(struct tipc_msg *m, u32 n)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100411{
412 msg_set_word(m, 8, n);
413}
414
Allan Stephensd265fef2010-11-30 12:00:53 +0000415static inline u32 msg_nameinst(struct tipc_msg *m)
416{
417 return msg_word(m, 9);
418}
419
420static inline u32 msg_namelower(struct tipc_msg *m)
421{
422 return msg_nameinst(m);
423}
424
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900425static inline void msg_set_namelower(struct tipc_msg *m, u32 n)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100426{
427 msg_set_word(m, 9, n);
428}
429
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900430static inline void msg_set_nameinst(struct tipc_msg *m, u32 n)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100431{
432 msg_set_namelower(m, n);
433}
434
Allan Stephensd265fef2010-11-30 12:00:53 +0000435static inline u32 msg_nameupper(struct tipc_msg *m)
436{
437 return msg_word(m, 10);
438}
439
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900440static inline void msg_set_nameupper(struct tipc_msg *m, u32 n)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100441{
442 msg_set_word(m, 10, n);
443}
444
Allan Stephensd265fef2010-11-30 12:00:53 +0000445static inline unchar *msg_data(struct tipc_msg *m)
446{
447 return ((unchar *)m) + msg_hdr_sz(m);
448}
449
Per Lidenb97bf3f2006-01-02 19:04:38 +0100450static inline struct tipc_msg *msg_get_wrapped(struct tipc_msg *m)
451{
452 return (struct tipc_msg *)msg_data(m);
453}
454
Per Lidenb97bf3f2006-01-02 19:04:38 +0100455/*
Allan Stephenscc4c4352011-04-08 10:50:52 -0400456 * Constants and routines used to read and write TIPC internal message headers
457 */
Per Lidenb97bf3f2006-01-02 19:04:38 +0100458
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900459/*
Allan Stephenscc4c4352011-04-08 10:50:52 -0400460 * Internal message users
Per Lidenb97bf3f2006-01-02 19:04:38 +0100461 */
Per Lidenb97bf3f2006-01-02 19:04:38 +0100462#define BCAST_PROTOCOL 5
463#define MSG_BUNDLER 6
464#define LINK_PROTOCOL 7
465#define CONN_MANAGER 8
Allan Stephens51a8e4d2010-12-31 18:59:18 +0000466#define ROUTE_DISTRIBUTOR 9 /* obsoleted */
Per Lidenb97bf3f2006-01-02 19:04:38 +0100467#define CHANGEOVER_PROTOCOL 10
468#define NAME_DISTRIBUTOR 11
469#define MSG_FRAGMENTER 12
470#define LINK_CONFIG 13
Jon Paul Maloy50100a52014-08-22 18:09:07 -0400471#define SOCK_WAKEUP 14 /* pseudo user */
Per Lidenb97bf3f2006-01-02 19:04:38 +0100472
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900473/*
Allan Stephenscc4c4352011-04-08 10:50:52 -0400474 * Connection management protocol message types
Per Lidenb97bf3f2006-01-02 19:04:38 +0100475 */
Per Lidenb97bf3f2006-01-02 19:04:38 +0100476#define CONN_PROBE 0
477#define CONN_PROBE_REPLY 1
478#define CONN_ACK 2
479
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900480/*
Allan Stephenscc4c4352011-04-08 10:50:52 -0400481 * Name distributor message types
Per Lidenb97bf3f2006-01-02 19:04:38 +0100482 */
Per Lidenb97bf3f2006-01-02 19:04:38 +0100483#define PUBLICATION 0
484#define WITHDRAWAL 1
485
Allan Stephens92138d12011-04-08 11:04:15 -0400486/*
487 * Segmentation message types
488 */
Allan Stephens92138d12011-04-08 11:04:15 -0400489#define FIRST_FRAGMENT 0
490#define FRAGMENT 1
491#define LAST_FRAGMENT 2
492
493/*
494 * Link management protocol message types
495 */
Allan Stephens92138d12011-04-08 11:04:15 -0400496#define STATE_MSG 0
497#define RESET_MSG 1
498#define ACTIVATE_MSG 2
499
500/*
501 * Changeover tunnel message types
502 */
503#define DUPLICATE_MSG 0
504#define ORIGINAL_MSG 1
505
506/*
507 * Config protocol message types
508 */
Allan Stephens92138d12011-04-08 11:04:15 -0400509#define DSC_REQ_MSG 0
510#define DSC_RESP_MSG 1
511
Per Lidenb97bf3f2006-01-02 19:04:38 +0100512
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900513/*
Per Lidenb97bf3f2006-01-02 19:04:38 +0100514 * Word 1
515 */
Per Lidenb97bf3f2006-01-02 19:04:38 +0100516static inline u32 msg_seq_gap(struct tipc_msg *m)
517{
Allan Stephensbd784532008-06-04 17:47:30 -0700518 return msg_bits(m, 1, 16, 0x1fff);
Per Lidenb97bf3f2006-01-02 19:04:38 +0100519}
520
521static inline void msg_set_seq_gap(struct tipc_msg *m, u32 n)
522{
Allan Stephensbd784532008-06-04 17:47:30 -0700523 msg_set_bits(m, 1, 16, 0x1fff, n);
Per Lidenb97bf3f2006-01-02 19:04:38 +0100524}
525
Allan Stephensfc0eea62011-10-28 16:26:41 -0400526static inline u32 msg_node_sig(struct tipc_msg *m)
527{
528 return msg_bits(m, 1, 0, 0xffff);
529}
530
531static inline void msg_set_node_sig(struct tipc_msg *m, u32 n)
532{
533 msg_set_bits(m, 1, 0, 0xffff, n);
534}
535
Per Lidenb97bf3f2006-01-02 19:04:38 +0100536
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900537/*
Per Lidenb97bf3f2006-01-02 19:04:38 +0100538 * Word 2
539 */
Per Lidenb97bf3f2006-01-02 19:04:38 +0100540static inline u32 msg_dest_domain(struct tipc_msg *m)
541{
542 return msg_word(m, 2);
543}
544
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900545static inline void msg_set_dest_domain(struct tipc_msg *m, u32 n)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100546{
547 msg_set_word(m, 2, n);
548}
549
550static inline u32 msg_bcgap_after(struct tipc_msg *m)
551{
552 return msg_bits(m, 2, 16, 0xffff);
553}
554
555static inline void msg_set_bcgap_after(struct tipc_msg *m, u32 n)
556{
557 msg_set_bits(m, 2, 16, 0xffff, n);
558}
559
560static inline u32 msg_bcgap_to(struct tipc_msg *m)
561{
562 return msg_bits(m, 2, 0, 0xffff);
563}
564
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900565static inline void msg_set_bcgap_to(struct tipc_msg *m, u32 n)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100566{
567 msg_set_bits(m, 2, 0, 0xffff, n);
568}
569
570
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900571/*
Per Lidenb97bf3f2006-01-02 19:04:38 +0100572 * Word 4
573 */
Per Lidenb97bf3f2006-01-02 19:04:38 +0100574static inline u32 msg_last_bcast(struct tipc_msg *m)
575{
576 return msg_bits(m, 4, 16, 0xffff);
577}
578
579static inline void msg_set_last_bcast(struct tipc_msg *m, u32 n)
580{
581 msg_set_bits(m, 4, 16, 0xffff, n);
582}
583
Per Lidenb97bf3f2006-01-02 19:04:38 +0100584static inline void msg_set_fragm_no(struct tipc_msg *m, u32 n)
585{
586 msg_set_bits(m, 4, 16, 0xffff, n);
587}
588
589
590static inline u32 msg_next_sent(struct tipc_msg *m)
591{
592 return msg_bits(m, 4, 0, 0xffff);
593}
594
595static inline void msg_set_next_sent(struct tipc_msg *m, u32 n)
596{
597 msg_set_bits(m, 4, 0, 0xffff, n);
598}
599
Per Lidenb97bf3f2006-01-02 19:04:38 +0100600static inline void msg_set_long_msgno(struct tipc_msg *m, u32 n)
601{
602 msg_set_bits(m, 4, 0, 0xffff, n);
603}
604
605static inline u32 msg_bc_netid(struct tipc_msg *m)
606{
607 return msg_word(m, 4);
608}
609
610static inline void msg_set_bc_netid(struct tipc_msg *m, u32 id)
611{
612 msg_set_word(m, 4, id);
613}
614
615static inline u32 msg_link_selector(struct tipc_msg *m)
616{
617 return msg_bits(m, 4, 0, 1);
618}
619
620static inline void msg_set_link_selector(struct tipc_msg *m, u32 n)
621{
Allan Stephens7eb878e2011-05-25 13:28:27 -0400622 msg_set_bits(m, 4, 0, 1, n);
Per Lidenb97bf3f2006-01-02 19:04:38 +0100623}
624
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900625/*
Per Lidenb97bf3f2006-01-02 19:04:38 +0100626 * Word 5
627 */
Per Lidenb97bf3f2006-01-02 19:04:38 +0100628static inline u32 msg_session(struct tipc_msg *m)
629{
630 return msg_bits(m, 5, 16, 0xffff);
631}
632
633static inline void msg_set_session(struct tipc_msg *m, u32 n)
634{
635 msg_set_bits(m, 5, 16, 0xffff, n);
636}
637
638static inline u32 msg_probe(struct tipc_msg *m)
639{
640 return msg_bits(m, 5, 0, 1);
641}
642
643static inline void msg_set_probe(struct tipc_msg *m, u32 val)
644{
Allan Stephens7eb878e2011-05-25 13:28:27 -0400645 msg_set_bits(m, 5, 0, 1, val);
Per Lidenb97bf3f2006-01-02 19:04:38 +0100646}
647
648static inline char msg_net_plane(struct tipc_msg *m)
649{
650 return msg_bits(m, 5, 1, 7) + 'A';
651}
652
653static inline void msg_set_net_plane(struct tipc_msg *m, char n)
654{
655 msg_set_bits(m, 5, 1, 7, (n - 'A'));
656}
657
658static inline u32 msg_linkprio(struct tipc_msg *m)
659{
660 return msg_bits(m, 5, 4, 0x1f);
661}
662
663static inline void msg_set_linkprio(struct tipc_msg *m, u32 n)
664{
665 msg_set_bits(m, 5, 4, 0x1f, n);
666}
667
668static inline u32 msg_bearer_id(struct tipc_msg *m)
669{
670 return msg_bits(m, 5, 9, 0x7);
671}
672
673static inline void msg_set_bearer_id(struct tipc_msg *m, u32 n)
674{
675 msg_set_bits(m, 5, 9, 0x7, n);
676}
677
678static inline u32 msg_redundant_link(struct tipc_msg *m)
679{
680 return msg_bits(m, 5, 12, 0x1);
681}
682
Allan Stephens77f167f2011-02-28 15:30:20 -0500683static inline void msg_set_redundant_link(struct tipc_msg *m, u32 r)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100684{
Allan Stephens77f167f2011-02-28 15:30:20 -0500685 msg_set_bits(m, 5, 12, 0x1, r);
Per Lidenb97bf3f2006-01-02 19:04:38 +0100686}
687
Allan Stephens3d749a62011-10-07 15:19:11 -0400688static inline char *msg_media_addr(struct tipc_msg *m)
689{
690 return (char *)&m->hdr[TIPC_MEDIA_ADDR_OFFSET];
691}
Per Lidenb97bf3f2006-01-02 19:04:38 +0100692
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900693/*
Per Lidenb97bf3f2006-01-02 19:04:38 +0100694 * Word 9
695 */
Per Lidenb97bf3f2006-01-02 19:04:38 +0100696static inline u32 msg_msgcnt(struct tipc_msg *m)
697{
698 return msg_bits(m, 9, 16, 0xffff);
699}
700
701static inline void msg_set_msgcnt(struct tipc_msg *m, u32 n)
702{
703 msg_set_bits(m, 9, 16, 0xffff, n);
704}
705
706static inline u32 msg_bcast_tag(struct tipc_msg *m)
707{
708 return msg_bits(m, 9, 16, 0xffff);
709}
710
711static inline void msg_set_bcast_tag(struct tipc_msg *m, u32 n)
712{
713 msg_set_bits(m, 9, 16, 0xffff, n);
714}
715
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900716static inline u32 msg_max_pkt(struct tipc_msg *m)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100717{
Eric Dumazeta02cec22010-09-22 20:43:57 +0000718 return msg_bits(m, 9, 16, 0xffff) * 4;
Per Lidenb97bf3f2006-01-02 19:04:38 +0100719}
720
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900721static inline void msg_set_max_pkt(struct tipc_msg *m, u32 n)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100722{
723 msg_set_bits(m, 9, 16, 0xffff, (n / 4));
724}
725
726static inline u32 msg_link_tolerance(struct tipc_msg *m)
727{
728 return msg_bits(m, 9, 0, 0xffff);
729}
730
731static inline void msg_set_link_tolerance(struct tipc_msg *m, u32 n)
732{
733 msg_set_bits(m, 9, 0, 0xffff, n);
734}
735
Jon Paul Maloy4f1688b2014-06-25 20:41:32 -0500736static inline u32 tipc_msg_tot_importance(struct tipc_msg *m)
737{
738 if ((msg_user(m) == MSG_FRAGMENTER) && (msg_type(m) == FIRST_FRAGMENT))
739 return msg_importance(msg_get_wrapped(m));
740 return msg_importance(m);
741}
742
743static inline u32 msg_tot_origport(struct tipc_msg *m)
744{
745 if ((msg_user(m) == MSG_FRAGMENTER) && (msg_type(m) == FIRST_FRAGMENT))
746 return msg_origport(msg_get_wrapped(m));
747 return msg_origport(m);
748}
749
Ying Xue859fc7c2015-01-09 15:27:01 +0800750struct sk_buff *tipc_buf_acquire(u32 size);
Jon Paul Maloyc5898632015-02-05 08:36:36 -0500751bool tipc_msg_reverse(u32 own_addr, struct sk_buff *buf, u32 *dnode,
Ying Xue34747532015-01-09 15:27:10 +0800752 int err);
Ying Xue4ac1c8d2015-01-09 15:27:09 +0800753int tipc_msg_eval(struct net *net, struct sk_buff *buf, u32 *dnode);
Jon Paul Maloyc5898632015-02-05 08:36:36 -0500754void tipc_msg_init(u32 own_addr, struct tipc_msg *m, u32 user, u32 type,
Ying Xue34747532015-01-09 15:27:10 +0800755 u32 hsize, u32 destnode);
Jon Paul Maloyc5898632015-02-05 08:36:36 -0500756struct sk_buff *tipc_msg_create(uint user, uint type,
Ying Xue34747532015-01-09 15:27:10 +0800757 uint hdr_sz, uint data_sz, u32 dnode,
758 u32 onode, u32 dport, u32 oport, int errcode);
Jon Paul Maloy37e22162014-05-14 05:39:12 -0400759int tipc_buf_append(struct sk_buff **headbuf, struct sk_buff **buf);
Ying Xue58dc55f2014-11-26 11:41:52 +0800760bool tipc_msg_bundle(struct sk_buff_head *list, struct sk_buff *skb, u32 mtu);
Jon Paul Maloyc5898632015-02-05 08:36:36 -0500761bool tipc_msg_make_bundle(struct sk_buff_head *list,
Ying Xue34747532015-01-09 15:27:10 +0800762 struct sk_buff *skb, u32 mtu, u32 dnode);
Jon Paul Maloyc5898632015-02-05 08:36:36 -0500763int tipc_msg_build(struct tipc_msg *mhdr, struct msghdr *m,
Ying Xue34747532015-01-09 15:27:10 +0800764 int offset, int dsz, int mtu, struct sk_buff_head *list);
Ying Xuea6ca1092014-11-26 11:41:55 +0800765struct sk_buff *tipc_msg_reassemble(struct sk_buff_head *list);
Jon Paul Maloy078bec82014-07-16 20:41:00 -0400766
Per Lidenb97bf3f2006-01-02 19:04:38 +0100767#endif