blob: ad487e8abcc2f2f0bcada4432db6c25e8dbf0dee [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 *
Allan Stephens1f9eda72007-04-24 14:51:55 -07004 * Copyright (c) 2000-2007, Ericsson AB
5 * Copyright (c) 2005-2007, 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
Jon Maloy5f7c3ff2006-01-13 10:45:44 +000040#include "core.h"
Per Lidenb97bf3f2006-01-02 19:04:38 +010041
42#define TIPC_VERSION 2
Allan Stephens06d82c92008-03-06 15:06:55 -080043
44#define SHORT_H_SIZE 24 /* Connected, in-cluster messages */
Per Lidenb97bf3f2006-01-02 19:04:38 +010045#define DIR_MSG_H_SIZE 32 /* Directly addressed messages */
Allan Stephens06d82c92008-03-06 15:06:55 -080046#define LONG_H_SIZE 40 /* Named messages */
Per Lidenb97bf3f2006-01-02 19:04:38 +010047#define MCAST_H_SIZE 44 /* Multicast messages */
Allan Stephens06d82c92008-03-06 15:06:55 -080048#define INT_H_SIZE 40 /* Internal messages */
49#define MIN_H_SIZE 24 /* Smallest legal TIPC header size */
50#define MAX_H_SIZE 60 /* Largest possible TIPC header size */
51
Per Lidenb97bf3f2006-01-02 19:04:38 +010052#define MAX_MSG_SIZE (MAX_H_SIZE + TIPC_MAX_USER_MSG_SIZE)
Per Lidenb97bf3f2006-01-02 19:04:38 +010053
54
55/*
56 TIPC user data message header format, version 2
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +090057
Per Lidenb97bf3f2006-01-02 19:04:38 +010058 - Fundamental definitions available to privileged TIPC users
59 are located in tipc_msg.h.
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +090060 - Remaining definitions available to TIPC internal users appear below.
Per Lidenb97bf3f2006-01-02 19:04:38 +010061*/
62
63
64static inline void msg_set_word(struct tipc_msg *m, u32 w, u32 val)
65{
66 m->hdr[w] = htonl(val);
67}
68
69static inline void msg_set_bits(struct tipc_msg *m, u32 w,
70 u32 pos, u32 mask, u32 val)
71{
Allan Stephens1f9eda72007-04-24 14:51:55 -070072 val = (val & mask) << pos;
Al Virobecf3da2008-04-26 22:42:14 -070073 mask = mask << pos;
74 m->hdr[w] &= ~htonl(mask);
75 m->hdr[w] |= htonl(val);
Per Lidenb97bf3f2006-01-02 19:04:38 +010076}
77
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +090078/*
Per Lidenb97bf3f2006-01-02 19:04:38 +010079 * Word 0
80 */
81
82static inline u32 msg_version(struct tipc_msg *m)
83{
84 return msg_bits(m, 0, 29, 7);
85}
86
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +090087static inline void msg_set_version(struct tipc_msg *m)
Per Lidenb97bf3f2006-01-02 19:04:38 +010088{
Allan Stephens37695422008-03-06 15:07:42 -080089 msg_set_bits(m, 0, 29, 7, TIPC_VERSION);
Per Lidenb97bf3f2006-01-02 19:04:38 +010090}
91
92static inline u32 msg_user(struct tipc_msg *m)
93{
94 return msg_bits(m, 0, 25, 0xf);
95}
96
97static inline u32 msg_isdata(struct tipc_msg *m)
98{
Allan Stephens06d82c92008-03-06 15:06:55 -080099 return (msg_user(m) <= TIPC_CRITICAL_IMPORTANCE);
Per Lidenb97bf3f2006-01-02 19:04:38 +0100100}
101
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900102static inline void msg_set_user(struct tipc_msg *m, u32 n)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100103{
104 msg_set_bits(m, 0, 25, 0xf, n);
105}
106
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900107static inline void msg_set_importance(struct tipc_msg *m, u32 i)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100108{
109 msg_set_user(m, i);
110}
111
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900112static inline void msg_set_hdr_sz(struct tipc_msg *m,u32 n)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100113{
114 msg_set_bits(m, 0, 21, 0xf, n>>2);
115}
116
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900117static inline int msg_non_seq(struct tipc_msg *m)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100118{
119 return msg_bits(m, 0, 20, 1);
120}
121
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900122static inline void msg_set_non_seq(struct tipc_msg *m)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100123{
124 msg_set_bits(m, 0, 20, 1, 1);
125}
126
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900127static inline int msg_dest_droppable(struct tipc_msg *m)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100128{
129 return msg_bits(m, 0, 19, 1);
130}
131
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900132static inline void msg_set_dest_droppable(struct tipc_msg *m, u32 d)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100133{
134 msg_set_bits(m, 0, 19, 1, d);
135}
136
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900137static inline int msg_src_droppable(struct tipc_msg *m)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100138{
139 return msg_bits(m, 0, 18, 1);
140}
141
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900142static inline void msg_set_src_droppable(struct tipc_msg *m, u32 d)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100143{
144 msg_set_bits(m, 0, 18, 1, d);
145}
146
147static inline void msg_set_size(struct tipc_msg *m, u32 sz)
148{
149 m->hdr[0] = htonl((msg_word(m, 0) & ~0x1ffff) | sz);
150}
151
152
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900153/*
Per Lidenb97bf3f2006-01-02 19:04:38 +0100154 * Word 1
155 */
156
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900157static inline void msg_set_type(struct tipc_msg *m, u32 n)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100158{
159 msg_set_bits(m, 1, 29, 0x7, n);
160}
161
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900162static inline void msg_set_errcode(struct tipc_msg *m, u32 err)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100163{
164 msg_set_bits(m, 1, 25, 0xf, err);
165}
166
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900167static inline u32 msg_reroute_cnt(struct tipc_msg *m)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100168{
169 return msg_bits(m, 1, 21, 0xf);
170}
171
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900172static inline void msg_incr_reroute_cnt(struct tipc_msg *m)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100173{
174 msg_set_bits(m, 1, 21, 0xf, msg_reroute_cnt(m) + 1);
175}
176
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900177static inline void msg_reset_reroute_cnt(struct tipc_msg *m)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100178{
179 msg_set_bits(m, 1, 21, 0xf, 0);
180}
181
182static inline u32 msg_lookup_scope(struct tipc_msg *m)
183{
184 return msg_bits(m, 1, 19, 0x3);
185}
186
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900187static inline void msg_set_lookup_scope(struct tipc_msg *m, u32 n)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100188{
189 msg_set_bits(m, 1, 19, 0x3, n);
190}
191
Per Lidenb97bf3f2006-01-02 19:04:38 +0100192static inline u32 msg_bcast_ack(struct tipc_msg *m)
193{
194 return msg_bits(m, 1, 0, 0xffff);
195}
196
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900197static inline void msg_set_bcast_ack(struct tipc_msg *m, u32 n)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100198{
199 msg_set_bits(m, 1, 0, 0xffff, n);
200}
201
202
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900203/*
Per Lidenb97bf3f2006-01-02 19:04:38 +0100204 * Word 2
205 */
206
207static inline u32 msg_ack(struct tipc_msg *m)
208{
209 return msg_bits(m, 2, 16, 0xffff);
210}
211
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900212static inline void msg_set_ack(struct tipc_msg *m, u32 n)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100213{
214 msg_set_bits(m, 2, 16, 0xffff, n);
215}
216
217static inline u32 msg_seqno(struct tipc_msg *m)
218{
219 return msg_bits(m, 2, 0, 0xffff);
220}
221
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900222static inline void msg_set_seqno(struct tipc_msg *m, u32 n)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100223{
224 msg_set_bits(m, 2, 0, 0xffff, n);
225}
226
227
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900228/*
Per Lidenb97bf3f2006-01-02 19:04:38 +0100229 * Words 3-10
230 */
231
232
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900233static inline void msg_set_prevnode(struct tipc_msg *m, u32 a)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100234{
235 msg_set_word(m, 3, a);
236}
237
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900238static inline void msg_set_origport(struct tipc_msg *m, u32 p)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100239{
240 msg_set_word(m, 4, p);
241}
242
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900243static inline void msg_set_destport(struct tipc_msg *m, u32 p)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100244{
245 msg_set_word(m, 5, p);
246}
247
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900248static inline void msg_set_mc_netid(struct tipc_msg *m, u32 p)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100249{
250 msg_set_word(m, 5, p);
251}
252
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900253static inline void msg_set_orignode(struct tipc_msg *m, u32 a)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100254{
255 msg_set_word(m, 6, a);
256}
257
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900258static inline void msg_set_destnode(struct tipc_msg *m, u32 a)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100259{
260 msg_set_word(m, 7, a);
261}
262
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900263static inline int msg_is_dest(struct tipc_msg *m, u32 d)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100264{
265 return(msg_short(m) || (msg_destnode(m) == d));
266}
267
268static inline u32 msg_routed(struct tipc_msg *m)
269{
270 if (likely(msg_short(m)))
271 return 0;
272 return(msg_destnode(m) ^ msg_orignode(m)) >> 11;
273}
274
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900275static inline void msg_set_nametype(struct tipc_msg *m, u32 n)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100276{
277 msg_set_word(m, 8, n);
278}
279
280static inline u32 msg_transp_seqno(struct tipc_msg *m)
281{
282 return msg_word(m, 8);
283}
284
285static inline void msg_set_timestamp(struct tipc_msg *m, u32 n)
286{
287 msg_set_word(m, 8, n);
288}
289
290static inline u32 msg_timestamp(struct tipc_msg *m)
291{
292 return msg_word(m, 8);
293}
294
295static inline void msg_set_transp_seqno(struct tipc_msg *m, u32 n)
296{
297 msg_set_word(m, 8, n);
298}
299
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900300static inline void msg_set_namelower(struct tipc_msg *m, u32 n)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100301{
302 msg_set_word(m, 9, n);
303}
304
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900305static inline void msg_set_nameinst(struct tipc_msg *m, u32 n)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100306{
307 msg_set_namelower(m, n);
308}
309
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900310static inline void msg_set_nameupper(struct tipc_msg *m, u32 n)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100311{
312 msg_set_word(m, 10, n);
313}
314
315static inline struct tipc_msg *msg_get_wrapped(struct tipc_msg *m)
316{
317 return (struct tipc_msg *)msg_data(m);
318}
319
Per Lidenb97bf3f2006-01-02 19:04:38 +0100320
321/*
322 TIPC internal message header format, version 2
323
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900324 1 0 9 8 7 6 5 4|3 2 1 0 9 8 7 6|5 4 3 2 1 0 9 8|7 6 5 4 3 2 1 0
Per Lidenb97bf3f2006-01-02 19:04:38 +0100325 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
326 w0:|vers |msg usr|hdr sz |n|resrv| packet size |
327 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
328 w1:|m typ|rsv=0| sequence gap | broadcast ack no |
329 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
330 w2:| link level ack no/bc_gap_from | seq no / bcast_gap_to |
331 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
332 w3:| previous node |
333 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
334 w4:| next sent broadcast/fragm no | next sent pkt/ fragm msg no |
335 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
336 w5:| session no |rsv=0|r|berid|link prio|netpl|p|
337 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
338 w6:| originating node |
339 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
340 w7:| destination node |
341 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
342 w8:| transport sequence number |
343 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
344 w9:| msg count / bcast tag | link tolerance |
345 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
346 \ \
347 / User Specific Data /
348 \ \
349 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
350
351 NB: CONN_MANAGER use data message format. LINK_CONFIG has own format.
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900352*/
Per Lidenb97bf3f2006-01-02 19:04:38 +0100353
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900354/*
Per Lidenb97bf3f2006-01-02 19:04:38 +0100355 * Internal users
356 */
357
358#define BCAST_PROTOCOL 5
359#define MSG_BUNDLER 6
360#define LINK_PROTOCOL 7
361#define CONN_MANAGER 8
362#define ROUTE_DISTRIBUTOR 9
363#define CHANGEOVER_PROTOCOL 10
364#define NAME_DISTRIBUTOR 11
365#define MSG_FRAGMENTER 12
366#define LINK_CONFIG 13
Per Lidenb97bf3f2006-01-02 19:04:38 +0100367#define DSC_H_SIZE 40
368
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900369/*
Per Lidenb97bf3f2006-01-02 19:04:38 +0100370 * Connection management protocol messages
371 */
372
373#define CONN_PROBE 0
374#define CONN_PROBE_REPLY 1
375#define CONN_ACK 2
376
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900377/*
Per Lidenb97bf3f2006-01-02 19:04:38 +0100378 * Name distributor messages
379 */
380
381#define PUBLICATION 0
382#define WITHDRAWAL 1
383
384
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900385/*
Per Lidenb97bf3f2006-01-02 19:04:38 +0100386 * Word 1
387 */
388
389static inline u32 msg_seq_gap(struct tipc_msg *m)
390{
391 return msg_bits(m, 1, 16, 0xff);
392}
393
394static inline void msg_set_seq_gap(struct tipc_msg *m, u32 n)
395{
396 msg_set_bits(m, 1, 16, 0xff, n);
397}
398
399static inline u32 msg_req_links(struct tipc_msg *m)
400{
401 return msg_bits(m, 1, 16, 0xfff);
402}
403
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900404static inline void msg_set_req_links(struct tipc_msg *m, u32 n)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100405{
406 msg_set_bits(m, 1, 16, 0xfff, n);
407}
408
409
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900410/*
Per Lidenb97bf3f2006-01-02 19:04:38 +0100411 * Word 2
412 */
413
414static inline u32 msg_dest_domain(struct tipc_msg *m)
415{
416 return msg_word(m, 2);
417}
418
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900419static inline void msg_set_dest_domain(struct tipc_msg *m, u32 n)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100420{
421 msg_set_word(m, 2, n);
422}
423
424static inline u32 msg_bcgap_after(struct tipc_msg *m)
425{
426 return msg_bits(m, 2, 16, 0xffff);
427}
428
429static inline void msg_set_bcgap_after(struct tipc_msg *m, u32 n)
430{
431 msg_set_bits(m, 2, 16, 0xffff, n);
432}
433
434static inline u32 msg_bcgap_to(struct tipc_msg *m)
435{
436 return msg_bits(m, 2, 0, 0xffff);
437}
438
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900439static inline void msg_set_bcgap_to(struct tipc_msg *m, u32 n)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100440{
441 msg_set_bits(m, 2, 0, 0xffff, n);
442}
443
444
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900445/*
Per Lidenb97bf3f2006-01-02 19:04:38 +0100446 * Word 4
447 */
448
449static inline u32 msg_last_bcast(struct tipc_msg *m)
450{
451 return msg_bits(m, 4, 16, 0xffff);
452}
453
454static inline void msg_set_last_bcast(struct tipc_msg *m, u32 n)
455{
456 msg_set_bits(m, 4, 16, 0xffff, n);
457}
458
459
460static inline u32 msg_fragm_no(struct tipc_msg *m)
461{
462 return msg_bits(m, 4, 16, 0xffff);
463}
464
465static inline void msg_set_fragm_no(struct tipc_msg *m, u32 n)
466{
467 msg_set_bits(m, 4, 16, 0xffff, n);
468}
469
470
471static inline u32 msg_next_sent(struct tipc_msg *m)
472{
473 return msg_bits(m, 4, 0, 0xffff);
474}
475
476static inline void msg_set_next_sent(struct tipc_msg *m, u32 n)
477{
478 msg_set_bits(m, 4, 0, 0xffff, n);
479}
480
481
482static inline u32 msg_long_msgno(struct tipc_msg *m)
483{
484 return msg_bits(m, 4, 0, 0xffff);
485}
486
487static inline void msg_set_long_msgno(struct tipc_msg *m, u32 n)
488{
489 msg_set_bits(m, 4, 0, 0xffff, n);
490}
491
492static inline u32 msg_bc_netid(struct tipc_msg *m)
493{
494 return msg_word(m, 4);
495}
496
497static inline void msg_set_bc_netid(struct tipc_msg *m, u32 id)
498{
499 msg_set_word(m, 4, id);
500}
501
502static inline u32 msg_link_selector(struct tipc_msg *m)
503{
504 return msg_bits(m, 4, 0, 1);
505}
506
507static inline void msg_set_link_selector(struct tipc_msg *m, u32 n)
508{
509 msg_set_bits(m, 4, 0, 1, (n & 1));
510}
511
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900512/*
Per Lidenb97bf3f2006-01-02 19:04:38 +0100513 * Word 5
514 */
515
516static inline u32 msg_session(struct tipc_msg *m)
517{
518 return msg_bits(m, 5, 16, 0xffff);
519}
520
521static inline void msg_set_session(struct tipc_msg *m, u32 n)
522{
523 msg_set_bits(m, 5, 16, 0xffff, n);
524}
525
526static inline u32 msg_probe(struct tipc_msg *m)
527{
528 return msg_bits(m, 5, 0, 1);
529}
530
531static inline void msg_set_probe(struct tipc_msg *m, u32 val)
532{
533 msg_set_bits(m, 5, 0, 1, (val & 1));
534}
535
536static inline char msg_net_plane(struct tipc_msg *m)
537{
538 return msg_bits(m, 5, 1, 7) + 'A';
539}
540
541static inline void msg_set_net_plane(struct tipc_msg *m, char n)
542{
543 msg_set_bits(m, 5, 1, 7, (n - 'A'));
544}
545
546static inline u32 msg_linkprio(struct tipc_msg *m)
547{
548 return msg_bits(m, 5, 4, 0x1f);
549}
550
551static inline void msg_set_linkprio(struct tipc_msg *m, u32 n)
552{
553 msg_set_bits(m, 5, 4, 0x1f, n);
554}
555
556static inline u32 msg_bearer_id(struct tipc_msg *m)
557{
558 return msg_bits(m, 5, 9, 0x7);
559}
560
561static inline void msg_set_bearer_id(struct tipc_msg *m, u32 n)
562{
563 msg_set_bits(m, 5, 9, 0x7, n);
564}
565
566static inline u32 msg_redundant_link(struct tipc_msg *m)
567{
568 return msg_bits(m, 5, 12, 0x1);
569}
570
571static inline void msg_set_redundant_link(struct tipc_msg *m)
572{
573 msg_set_bits(m, 5, 12, 0x1, 1);
574}
575
576static inline void msg_clear_redundant_link(struct tipc_msg *m)
577{
578 msg_set_bits(m, 5, 12, 0x1, 0);
579}
580
581
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900582/*
Per Lidenb97bf3f2006-01-02 19:04:38 +0100583 * Word 9
584 */
585
586static inline u32 msg_msgcnt(struct tipc_msg *m)
587{
588 return msg_bits(m, 9, 16, 0xffff);
589}
590
591static inline void msg_set_msgcnt(struct tipc_msg *m, u32 n)
592{
593 msg_set_bits(m, 9, 16, 0xffff, n);
594}
595
596static inline u32 msg_bcast_tag(struct tipc_msg *m)
597{
598 return msg_bits(m, 9, 16, 0xffff);
599}
600
601static inline void msg_set_bcast_tag(struct tipc_msg *m, u32 n)
602{
603 msg_set_bits(m, 9, 16, 0xffff, n);
604}
605
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900606static inline u32 msg_max_pkt(struct tipc_msg *m)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100607{
608 return (msg_bits(m, 9, 16, 0xffff) * 4);
609}
610
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900611static inline void msg_set_max_pkt(struct tipc_msg *m, u32 n)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100612{
613 msg_set_bits(m, 9, 16, 0xffff, (n / 4));
614}
615
616static inline u32 msg_link_tolerance(struct tipc_msg *m)
617{
618 return msg_bits(m, 9, 0, 0xffff);
619}
620
621static inline void msg_set_link_tolerance(struct tipc_msg *m, u32 n)
622{
623 msg_set_bits(m, 9, 0, 0xffff, n);
624}
625
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900626/*
Per Lidenb97bf3f2006-01-02 19:04:38 +0100627 * Routing table message data
628 */
629
630
631static inline u32 msg_remote_node(struct tipc_msg *m)
632{
633 return msg_word(m, msg_hdr_sz(m)/4);
634}
635
636static inline void msg_set_remote_node(struct tipc_msg *m, u32 a)
637{
638 msg_set_word(m, msg_hdr_sz(m)/4, a);
639}
640
Per Lidenb97bf3f2006-01-02 19:04:38 +0100641static inline void msg_set_dataoctet(struct tipc_msg *m, u32 pos)
642{
643 msg_data(m)[pos + 4] = 1;
644}
645
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900646/*
Per Lidenb97bf3f2006-01-02 19:04:38 +0100647 * Segmentation message types
648 */
649
650#define FIRST_FRAGMENT 0
651#define FRAGMENT 1
652#define LAST_FRAGMENT 2
653
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900654/*
Per Lidenb97bf3f2006-01-02 19:04:38 +0100655 * Link management protocol message types
656 */
657
658#define STATE_MSG 0
659#define RESET_MSG 1
660#define ACTIVATE_MSG 2
661
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900662/*
Per Lidenb97bf3f2006-01-02 19:04:38 +0100663 * Changeover tunnel message types
664 */
665#define DUPLICATE_MSG 0
666#define ORIGINAL_MSG 1
667
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900668/*
Per Lidenb97bf3f2006-01-02 19:04:38 +0100669 * Routing table message types
670 */
671#define EXT_ROUTING_TABLE 0
672#define LOCAL_ROUTING_TABLE 1
673#define SLAVE_ROUTING_TABLE 2
674#define ROUTE_ADDITION 3
675#define ROUTE_REMOVAL 4
676
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900677/*
Per Lidenb97bf3f2006-01-02 19:04:38 +0100678 * Config protocol message types
679 */
680
681#define DSC_REQ_MSG 0
682#define DSC_RESP_MSG 1
683
684static inline u32 msg_tot_importance(struct tipc_msg *m)
685{
686 if (likely(msg_isdata(m))) {
687 if (likely(msg_orignode(m) == tipc_own_addr))
688 return msg_importance(m);
689 return msg_importance(m) + 4;
690 }
691 if ((msg_user(m) == MSG_FRAGMENTER) &&
692 (msg_type(m) == FIRST_FRAGMENT))
693 return msg_importance(msg_get_wrapped(m));
694 return msg_importance(m);
695}
696
697
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900698static inline void msg_init(struct tipc_msg *m, u32 user, u32 type,
Per Lidenb97bf3f2006-01-02 19:04:38 +0100699 u32 err, u32 hsize, u32 destnode)
700{
701 memset(m, 0, hsize);
702 msg_set_version(m);
703 msg_set_user(m, user);
704 msg_set_hdr_sz(m, hsize);
705 msg_set_size(m, hsize);
706 msg_set_prevnode(m, tipc_own_addr);
707 msg_set_type(m, type);
708 msg_set_errcode(m, err);
709 if (!msg_short(m)) {
710 msg_set_orignode(m, tipc_own_addr);
711 msg_set_destnode(m, destnode);
712 }
713}
714
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900715/**
Per Lidenb97bf3f2006-01-02 19:04:38 +0100716 * msg_calc_data_size - determine total data size for message
717 */
718
719static inline int msg_calc_data_size(struct iovec const *msg_sect, u32 num_sect)
720{
721 int dsz = 0;
722 int i;
723
724 for (i = 0; i < num_sect; i++)
725 dsz += msg_sect[i].iov_len;
726 return dsz;
727}
728
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900729/**
Per Lidenb97bf3f2006-01-02 19:04:38 +0100730 * msg_build - create message using specified header and data
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900731 *
Per Lidenb97bf3f2006-01-02 19:04:38 +0100732 * Note: Caller must not hold any locks in case copy_from_user() is interrupted!
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900733 *
Per Lidenb97bf3f2006-01-02 19:04:38 +0100734 * Returns message data size or errno
735 */
736
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900737static inline int msg_build(struct tipc_msg *hdr,
Per Lidenb97bf3f2006-01-02 19:04:38 +0100738 struct iovec const *msg_sect, u32 num_sect,
739 int max_size, int usrmem, struct sk_buff** buf)
740{
741 int dsz, sz, hsz, pos, res, cnt;
742
743 dsz = msg_calc_data_size(msg_sect, num_sect);
744 if (unlikely(dsz > TIPC_MAX_USER_MSG_SIZE)) {
745 *buf = NULL;
746 return -EINVAL;
747 }
748
749 pos = hsz = msg_hdr_sz(hdr);
750 sz = hsz + dsz;
751 msg_set_size(hdr, sz);
752 if (unlikely(sz > max_size)) {
753 *buf = NULL;
754 return dsz;
755 }
756
757 *buf = buf_acquire(sz);
758 if (!(*buf))
759 return -ENOMEM;
Arnaldo Carvalho de Melo27d7ff42007-03-31 11:55:19 -0300760 skb_copy_to_linear_data(*buf, hdr, hsz);
Per Lidenb97bf3f2006-01-02 19:04:38 +0100761 for (res = 1, cnt = 0; res && (cnt < num_sect); cnt++) {
762 if (likely(usrmem))
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900763 res = !copy_from_user((*buf)->data + pos,
764 msg_sect[cnt].iov_base,
Per Lidenb97bf3f2006-01-02 19:04:38 +0100765 msg_sect[cnt].iov_len);
766 else
Arnaldo Carvalho de Melo27d7ff42007-03-31 11:55:19 -0300767 skb_copy_to_linear_data_offset(*buf, pos,
768 msg_sect[cnt].iov_base,
769 msg_sect[cnt].iov_len);
Per Lidenb97bf3f2006-01-02 19:04:38 +0100770 pos += msg_sect[cnt].iov_len;
771 }
772 if (likely(res))
773 return dsz;
774
775 buf_discard(*buf);
776 *buf = NULL;
777 return -EFAULT;
778}
779
Per Liden4323add2006-01-18 00:38:21 +0100780static inline void msg_set_media_addr(struct tipc_msg *m, struct tipc_media_addr *a)
781{
782 memcpy(&((int *)m)[5], a, sizeof(*a));
783}
Per Lidenb97bf3f2006-01-02 19:04:38 +0100784
Per Liden4323add2006-01-18 00:38:21 +0100785static inline void msg_get_media_addr(struct tipc_msg *m, struct tipc_media_addr *a)
786{
787 memcpy(a, &((int*)m)[5], sizeof(*a));
788}
Per Lidenb97bf3f2006-01-02 19:04:38 +0100789
790#endif