Linux Audio

Check our new training course

Real-Time Linux with PREEMPT_RT training

Feb 18-20, 2025
Register
Loading...
v3.15
  1/*
  2 * net/tipc/msg.h: Include file for TIPC message header routines
  3 *
  4 * Copyright (c) 2000-2007, Ericsson AB
  5 * Copyright (c) 2005-2008, 2010-2011, Wind River Systems
  6 * All rights reserved.
  7 *
  8 * Redistribution and use in source and binary forms, with or without
  9 * modification, are permitted provided that the following conditions are met:
 10 *
 11 * 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.
 19 *
 20 * 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
 34 * POSSIBILITY OF SUCH DAMAGE.
 35 */
 36
 37#ifndef _TIPC_MSG_H
 38#define _TIPC_MSG_H
 39
 40#include "bearer.h"
 
 41
 42/*
 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 */
 47#define TIPC_VERSION              2
 
 48
 49/*
 50 * 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
 59 */
 60#define TIPC_CONN_MSG		0
 61#define TIPC_MCAST_MSG		1
 62#define TIPC_NAMED_MSG		2
 63#define TIPC_DIRECT_MSG		3
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 64
 65/*
 66 * Message header sizes
 67 */
 68#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 */
 
 72#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
 76#define MAX_MSG_SIZE (MAX_H_SIZE + TIPC_MAX_USER_MSG_SIZE)
 
 
 77
 78#define TIPC_MEDIA_ADDR_OFFSET	5
 
 
 
 
 
 
 
 
 
 
 79
 
 80
 81struct tipc_msg {
 82	__be32 hdr[15];
 83};
 84
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 85
 86static inline u32 msg_word(struct tipc_msg *m, u32 pos)
 87{
 88	return ntohl(m->hdr[pos]);
 89}
 90
 91static inline void msg_set_word(struct tipc_msg *m, u32 w, u32 val)
 92{
 93	m->hdr[w] = htonl(val);
 94}
 95
 96static 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
101static inline void msg_set_bits(struct tipc_msg *m, u32 w,
102				u32 pos, u32 mask, u32 val)
103{
104	val = (val & mask) << pos;
105	mask = mask << pos;
106	m->hdr[w] &= ~htonl(mask);
107	m->hdr[w] |= htonl(val);
108}
109
110static 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
118/*
119 * Word 0
120 */
121static inline u32 msg_version(struct tipc_msg *m)
122{
123	return msg_bits(m, 0, 29, 7);
124}
125
126static inline void msg_set_version(struct tipc_msg *m)
127{
128	msg_set_bits(m, 0, 29, 7, TIPC_VERSION);
129}
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{
138	return msg_user(m) <= TIPC_CRITICAL_IMPORTANCE;
139}
140
141static inline void msg_set_user(struct tipc_msg *m, u32 n)
142{
143	msg_set_bits(m, 0, 25, 0xf, n);
144}
145
146static inline u32 msg_importance(struct tipc_msg *m)
147{
148	return msg_bits(m, 0, 25, 0xf);
149}
150
151static inline void msg_set_importance(struct tipc_msg *m, u32 i)
152{
153	msg_set_user(m, i);
154}
155
156static inline u32 msg_hdr_sz(struct tipc_msg *m)
157{
158	return msg_bits(m, 0, 21, 0xf) << 2;
159}
160
161static inline void msg_set_hdr_sz(struct tipc_msg *m, u32 n)
162{
163	msg_set_bits(m, 0, 21, 0xf, n>>2);
164}
165
166static 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
176static inline int msg_non_seq(struct tipc_msg *m)
177{
178	return msg_bits(m, 0, 20, 1);
179}
180
181static inline void msg_set_non_seq(struct tipc_msg *m, u32 n)
182{
183	msg_set_bits(m, 0, 20, 1, n);
184}
185
 
 
 
 
 
 
 
 
 
 
186static inline int msg_dest_droppable(struct tipc_msg *m)
187{
188	return msg_bits(m, 0, 19, 1);
189}
190
191static inline void msg_set_dest_droppable(struct tipc_msg *m, u32 d)
192{
193	msg_set_bits(m, 0, 19, 1, d);
194}
195
 
 
 
 
 
 
 
 
 
 
196static inline int msg_src_droppable(struct tipc_msg *m)
197{
198	return msg_bits(m, 0, 18, 1);
199}
200
201static inline void msg_set_src_droppable(struct tipc_msg *m, u32 d)
202{
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
212/*
213 * Word 1
214 */
215static inline u32 msg_type(struct tipc_msg *m)
216{
217	return msg_bits(m, 1, 29, 0x7);
218}
219
220static inline void msg_set_type(struct tipc_msg *m, u32 n)
221{
222	msg_set_bits(m, 1, 29, 0x7, n);
223}
224
 
 
 
 
 
 
 
 
 
 
 
 
225static 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
245static inline void msg_set_errcode(struct tipc_msg *m, u32 err)
246{
247	msg_set_bits(m, 1, 25, 0xf, err);
248}
249
250static inline u32 msg_reroute_cnt(struct tipc_msg *m)
251{
252	return msg_bits(m, 1, 21, 0xf);
253}
254
255static inline void msg_incr_reroute_cnt(struct tipc_msg *m)
256{
257	msg_set_bits(m, 1, 21, 0xf, msg_reroute_cnt(m) + 1);
258}
259
260static inline void msg_reset_reroute_cnt(struct tipc_msg *m)
261{
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
270static inline void msg_set_lookup_scope(struct tipc_msg *m, u32 n)
271{
272	msg_set_bits(m, 1, 19, 0x3, n);
273}
274
275static inline u32 msg_bcast_ack(struct tipc_msg *m)
276{
277	return msg_bits(m, 1, 0, 0xffff);
278}
279
280static inline void msg_set_bcast_ack(struct tipc_msg *m, u32 n)
281{
282	msg_set_bits(m, 1, 0, 0xffff, n);
283}
284
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
285
286/*
287 * Word 2
288 */
289static inline u32 msg_ack(struct tipc_msg *m)
290{
291	return msg_bits(m, 2, 16, 0xffff);
292}
293
294static inline void msg_set_ack(struct tipc_msg *m, u32 n)
295{
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
304static inline void msg_set_seqno(struct tipc_msg *m, u32 n)
305{
306	msg_set_bits(m, 2, 0, 0xffff, n);
307}
308
309/*
310 * Words 3-10
311 */
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
312static inline u32 msg_prevnode(struct tipc_msg *m)
313{
314	return msg_word(m, 3);
315}
316
317static inline void msg_set_prevnode(struct tipc_msg *m, u32 a)
318{
319	msg_set_word(m, 3, a);
320}
321
322static inline u32 msg_origport(struct tipc_msg *m)
323{
 
 
324	return msg_word(m, 4);
325}
326
327static inline void msg_set_origport(struct tipc_msg *m, u32 p)
328{
329	msg_set_word(m, 4, p);
330}
331
332static inline u32 msg_destport(struct tipc_msg *m)
333{
334	return msg_word(m, 5);
335}
336
337static inline void msg_set_destport(struct tipc_msg *m, u32 p)
338{
339	msg_set_word(m, 5, p);
340}
341
342static inline u32 msg_mc_netid(struct tipc_msg *m)
343{
344	return msg_word(m, 5);
345}
346
347static inline void msg_set_mc_netid(struct tipc_msg *m, u32 p)
348{
349	msg_set_word(m, 5, p);
350}
351
352static inline int msg_short(struct tipc_msg *m)
353{
354	return msg_hdr_sz(m) == SHORT_H_SIZE;
355}
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
364static inline void msg_set_orignode(struct tipc_msg *m, u32 a)
365{
366	msg_set_word(m, 6, a);
367}
368
369static inline u32 msg_destnode(struct tipc_msg *m)
370{
371	return msg_word(m, 7);
372}
373
374static inline void msg_set_destnode(struct tipc_msg *m, u32 a)
375{
376	msg_set_word(m, 7, a);
377}
378
379static inline u32 msg_nametype(struct tipc_msg *m)
380{
381	return msg_word(m, 8);
382}
383
384static inline void msg_set_nametype(struct tipc_msg *m, u32 n)
385{
386	msg_set_word(m, 8, n);
387}
388
389static 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
399static inline void msg_set_namelower(struct tipc_msg *m, u32 n)
400{
401	msg_set_word(m, 9, n);
402}
403
404static inline void msg_set_nameinst(struct tipc_msg *m, u32 n)
405{
406	msg_set_namelower(m, n);
407}
408
409static inline u32 msg_nameupper(struct tipc_msg *m)
410{
411	return msg_word(m, 10);
412}
413
414static inline void msg_set_nameupper(struct tipc_msg *m, u32 n)
415{
416	msg_set_word(m, 10, n);
417}
418
419static inline unchar *msg_data(struct tipc_msg *m)
420{
421	return ((unchar *)m) + msg_hdr_sz(m);
422}
423
424static inline struct tipc_msg *msg_get_wrapped(struct tipc_msg *m)
425{
426	return (struct tipc_msg *)msg_data(m);
427}
428
429/*
430 * Constants and routines used to read and write TIPC internal message headers
431 */
432
433/*
434 * Internal message users
435 */
436#define  BCAST_PROTOCOL       5
437#define  MSG_BUNDLER          6
438#define  LINK_PROTOCOL        7
439#define  CONN_MANAGER         8
440#define  ROUTE_DISTRIBUTOR    9		/* obsoleted */
441#define  CHANGEOVER_PROTOCOL  10
442#define  NAME_DISTRIBUTOR     11
443#define  MSG_FRAGMENTER       12
444#define  LINK_CONFIG          13
445
446/*
447 *  Connection management protocol message types
448 */
449#define CONN_PROBE        0
450#define CONN_PROBE_REPLY  1
451#define CONN_ACK          2
452
453/*
454 * Name distributor message types
455 */
456#define PUBLICATION       0
457#define WITHDRAWAL        1
458
459/*
460 * Segmentation message types
461 */
462#define FIRST_FRAGMENT		0
463#define FRAGMENT		1
464#define LAST_FRAGMENT		2
465
466/*
467 * Link management protocol message types
468 */
469#define STATE_MSG		0
470#define RESET_MSG		1
471#define ACTIVATE_MSG		2
472
473/*
474 * Changeover tunnel message types
475 */
476#define DUPLICATE_MSG		0
477#define ORIGINAL_MSG		1
478
479/*
480 * Config protocol message types
481 */
482#define DSC_REQ_MSG		0
483#define DSC_RESP_MSG		1
 
 
484
 
 
 
 
 
 
 
 
 
485
486/*
487 * Word 1
488 */
489static inline u32 msg_seq_gap(struct tipc_msg *m)
490{
491	return msg_bits(m, 1, 16, 0x1fff);
492}
493
494static inline void msg_set_seq_gap(struct tipc_msg *m, u32 n)
495{
496	msg_set_bits(m, 1, 16, 0x1fff, n);
497}
498
499static inline u32 msg_node_sig(struct tipc_msg *m)
500{
501	return msg_bits(m, 1, 0, 0xffff);
502}
503
504static inline void msg_set_node_sig(struct tipc_msg *m, u32 n)
505{
506	msg_set_bits(m, 1, 0, 0xffff, n);
507}
508
 
 
 
 
 
 
 
 
 
509
510/*
511 * Word 2
512 */
513static inline u32 msg_dest_domain(struct tipc_msg *m)
514{
515	return msg_word(m, 2);
516}
517
518static inline void msg_set_dest_domain(struct tipc_msg *m, u32 n)
519{
520	msg_set_word(m, 2, n);
521}
522
523static inline u32 msg_bcgap_after(struct tipc_msg *m)
524{
525	return msg_bits(m, 2, 16, 0xffff);
526}
527
528static inline void msg_set_bcgap_after(struct tipc_msg *m, u32 n)
529{
530	msg_set_bits(m, 2, 16, 0xffff, n);
531}
532
533static inline u32 msg_bcgap_to(struct tipc_msg *m)
534{
535	return msg_bits(m, 2, 0, 0xffff);
536}
537
538static inline void msg_set_bcgap_to(struct tipc_msg *m, u32 n)
539{
540	msg_set_bits(m, 2, 0, 0xffff, n);
541}
542
543
544/*
545 * Word 4
546 */
547static inline u32 msg_last_bcast(struct tipc_msg *m)
548{
549	return msg_bits(m, 4, 16, 0xffff);
550}
551
 
 
 
 
 
552static inline void msg_set_last_bcast(struct tipc_msg *m, u32 n)
553{
554	msg_set_bits(m, 4, 16, 0xffff, n);
555}
556
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
557static inline void msg_set_fragm_no(struct tipc_msg *m, u32 n)
558{
559	msg_set_bits(m, 4, 16, 0xffff, n);
560}
561
562
563static inline u32 msg_next_sent(struct tipc_msg *m)
564{
565	return msg_bits(m, 4, 0, 0xffff);
566}
567
568static inline void msg_set_next_sent(struct tipc_msg *m, u32 n)
569{
570	msg_set_bits(m, 4, 0, 0xffff, n);
571}
572
573static inline void msg_set_long_msgno(struct tipc_msg *m, u32 n)
574{
575	msg_set_bits(m, 4, 0, 0xffff, n);
576}
577
578static inline u32 msg_bc_netid(struct tipc_msg *m)
579{
580	return msg_word(m, 4);
581}
582
583static inline void msg_set_bc_netid(struct tipc_msg *m, u32 id)
584{
585	msg_set_word(m, 4, id);
586}
587
588static inline u32 msg_link_selector(struct tipc_msg *m)
589{
 
 
590	return msg_bits(m, 4, 0, 1);
591}
592
593static inline void msg_set_link_selector(struct tipc_msg *m, u32 n)
594{
595	msg_set_bits(m, 4, 0, 1, n);
596}
597
598/*
599 * Word 5
600 */
601static inline u32 msg_session(struct tipc_msg *m)
602{
603	return msg_bits(m, 5, 16, 0xffff);
604}
605
606static inline void msg_set_session(struct tipc_msg *m, u32 n)
607{
608	msg_set_bits(m, 5, 16, 0xffff, n);
609}
610
611static inline u32 msg_probe(struct tipc_msg *m)
612{
613	return msg_bits(m, 5, 0, 1);
614}
615
616static inline void msg_set_probe(struct tipc_msg *m, u32 val)
617{
618	msg_set_bits(m, 5, 0, 1, val);
619}
620
621static inline char msg_net_plane(struct tipc_msg *m)
622{
623	return msg_bits(m, 5, 1, 7) + 'A';
624}
625
626static inline void msg_set_net_plane(struct tipc_msg *m, char n)
627{
628	msg_set_bits(m, 5, 1, 7, (n - 'A'));
629}
630
631static inline u32 msg_linkprio(struct tipc_msg *m)
632{
633	return msg_bits(m, 5, 4, 0x1f);
634}
635
636static inline void msg_set_linkprio(struct tipc_msg *m, u32 n)
637{
638	msg_set_bits(m, 5, 4, 0x1f, n);
639}
640
641static inline u32 msg_bearer_id(struct tipc_msg *m)
642{
643	return msg_bits(m, 5, 9, 0x7);
644}
645
646static inline void msg_set_bearer_id(struct tipc_msg *m, u32 n)
647{
648	msg_set_bits(m, 5, 9, 0x7, n);
649}
650
651static inline u32 msg_redundant_link(struct tipc_msg *m)
652{
653	return msg_bits(m, 5, 12, 0x1);
654}
655
656static inline void msg_set_redundant_link(struct tipc_msg *m, u32 r)
657{
658	msg_set_bits(m, 5, 12, 0x1, r);
659}
660
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
661static inline char *msg_media_addr(struct tipc_msg *m)
662{
663	return (char *)&m->hdr[TIPC_MEDIA_ADDR_OFFSET];
 
 
 
 
 
 
 
 
 
 
664}
665
666/*
667 * Word 9
668 */
669static inline u32 msg_msgcnt(struct tipc_msg *m)
670{
671	return msg_bits(m, 9, 16, 0xffff);
672}
673
674static inline void msg_set_msgcnt(struct tipc_msg *m, u32 n)
675{
676	msg_set_bits(m, 9, 16, 0xffff, n);
677}
678
679static inline u32 msg_bcast_tag(struct tipc_msg *m)
680{
681	return msg_bits(m, 9, 16, 0xffff);
682}
683
684static inline void msg_set_bcast_tag(struct tipc_msg *m, u32 n)
685{
686	msg_set_bits(m, 9, 16, 0xffff, n);
687}
688
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
689static inline u32 msg_max_pkt(struct tipc_msg *m)
690{
691	return msg_bits(m, 9, 16, 0xffff) * 4;
692}
693
694static inline void msg_set_max_pkt(struct tipc_msg *m, u32 n)
695{
696	msg_set_bits(m, 9, 16, 0xffff, (n / 4));
697}
698
699static inline u32 msg_link_tolerance(struct tipc_msg *m)
700{
701	return msg_bits(m, 9, 0, 0xffff);
702}
703
704static inline void msg_set_link_tolerance(struct tipc_msg *m, u32 n)
705{
706	msg_set_bits(m, 9, 0, 0xffff, n);
707}
708
709u32 tipc_msg_tot_importance(struct tipc_msg *m);
710void tipc_msg_init(struct tipc_msg *m, u32 user, u32 type, u32 hsize,
711		   u32 destnode);
712int tipc_msg_build(struct tipc_msg *hdr, struct iovec const *msg_sect,
713		   unsigned int len, int max_size, struct sk_buff **buf);
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
714#endif
v5.4
   1/*
   2 * net/tipc/msg.h: Include file for TIPC message header routines
   3 *
   4 * Copyright (c) 2000-2007, 2014-2017 Ericsson AB
   5 * Copyright (c) 2005-2008, 2010-2011, Wind River Systems
   6 * All rights reserved.
   7 *
   8 * Redistribution and use in source and binary forms, with or without
   9 * modification, are permitted provided that the following conditions are met:
  10 *
  11 * 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.
  19 *
  20 * 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
  34 * POSSIBILITY OF SUCH DAMAGE.
  35 */
  36
  37#ifndef _TIPC_MSG_H
  38#define _TIPC_MSG_H
  39
  40#include <linux/tipc.h>
  41#include "core.h"
  42
  43/*
  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 */
  48#define TIPC_VERSION              2
  49struct plist;
  50
  51/*
  52 * 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 */
  58#define TIPC_SYSTEM_IMPORTANCE	4
  59
  60
  61/*
  62 * Payload message types
  63 */
  64#define TIPC_CONN_MSG           0
  65#define TIPC_MCAST_MSG          1
  66#define TIPC_NAMED_MSG          2
  67#define TIPC_DIRECT_MSG         3
  68#define TIPC_GRP_MEMBER_EVT     4
  69#define TIPC_GRP_BCAST_MSG      5
  70#define TIPC_GRP_MCAST_MSG      6
  71#define TIPC_GRP_UCAST_MSG      7
  72
  73/*
  74 * Internal message users
  75 */
  76#define  BCAST_PROTOCOL       5
  77#define  MSG_BUNDLER          6
  78#define  LINK_PROTOCOL        7
  79#define  CONN_MANAGER         8
  80#define  GROUP_PROTOCOL       9
  81#define  TUNNEL_PROTOCOL      10
  82#define  NAME_DISTRIBUTOR     11
  83#define  MSG_FRAGMENTER       12
  84#define  LINK_CONFIG          13
  85#define  SOCK_WAKEUP          14       /* pseudo user */
  86#define  TOP_SRV              15       /* pseudo user */
  87
  88/*
  89 * Message header sizes
  90 */
  91#define SHORT_H_SIZE              24	/* In-cluster basic payload message */
  92#define BASIC_H_SIZE              32	/* Basic payload message */
  93#define NAMED_H_SIZE              40	/* Named payload message */
  94#define MCAST_H_SIZE              44	/* Multicast payload message */
  95#define GROUP_H_SIZE              44	/* Group payload message */
  96#define INT_H_SIZE                40	/* Internal messages */
  97#define MIN_H_SIZE                24	/* Smallest legal TIPC header size */
  98#define MAX_H_SIZE                60	/* Largest possible TIPC header size */
  99
 100#define MAX_MSG_SIZE (MAX_H_SIZE + TIPC_MAX_USER_MSG_SIZE)
 101#define FB_MTU                  3744
 102#define TIPC_MEDIA_INFO_OFFSET	5
 103
 104struct tipc_skb_cb {
 105	struct sk_buff *tail;
 106	unsigned long nxt_retr;
 107	unsigned long retr_stamp;
 108	u32 bytes_read;
 109	u32 orig_member;
 110	u16 chain_imp;
 111	u16 ackers;
 112	u16 retr_cnt;
 113	bool validated;
 114};
 115
 116#define TIPC_SKB_CB(__skb) ((struct tipc_skb_cb *)&((__skb)->cb[0]))
 117
 118struct tipc_msg {
 119	__be32 hdr[15];
 120};
 121
 122/* struct tipc_gap_ack - TIPC Gap ACK block
 123 * @ack: seqno of the last consecutive packet in link deferdq
 124 * @gap: number of gap packets since the last ack
 125 *
 126 * E.g:
 127 *       link deferdq: 1 2 3 4      10 11      13 14 15       20
 128 * --> Gap ACK blocks:      <4, 5>,   <11, 1>,      <15, 4>, <20, 0>
 129 */
 130struct tipc_gap_ack {
 131	__be16 ack;
 132	__be16 gap;
 133};
 134
 135/* struct tipc_gap_ack_blks
 136 * @len: actual length of the record
 137 * @gack_cnt: number of Gap ACK blocks in the record
 138 * @gacks: array of Gap ACK blocks
 139 */
 140struct tipc_gap_ack_blks {
 141	__be16 len;
 142	u8 gack_cnt;
 143	u8 reserved;
 144	struct tipc_gap_ack gacks[];
 145};
 146
 147#define tipc_gap_ack_blks_sz(n) (sizeof(struct tipc_gap_ack_blks) + \
 148				 sizeof(struct tipc_gap_ack) * (n))
 149
 150#define MAX_GAP_ACK_BLKS	32
 151#define MAX_GAP_ACK_BLKS_SZ	tipc_gap_ack_blks_sz(MAX_GAP_ACK_BLKS)
 152
 153static inline struct tipc_msg *buf_msg(struct sk_buff *skb)
 154{
 155	return (struct tipc_msg *)skb->data;
 156}
 157
 158static inline u32 msg_word(struct tipc_msg *m, u32 pos)
 159{
 160	return ntohl(m->hdr[pos]);
 161}
 162
 163static inline void msg_set_word(struct tipc_msg *m, u32 w, u32 val)
 164{
 165	m->hdr[w] = htonl(val);
 166}
 167
 168static inline u32 msg_bits(struct tipc_msg *m, u32 w, u32 pos, u32 mask)
 169{
 170	return (msg_word(m, w) >> pos) & mask;
 171}
 172
 173static inline void msg_set_bits(struct tipc_msg *m, u32 w,
 174				u32 pos, u32 mask, u32 val)
 175{
 176	val = (val & mask) << pos;
 177	mask = mask << pos;
 178	m->hdr[w] &= ~htonl(mask);
 179	m->hdr[w] |= htonl(val);
 180}
 181
 182static inline void msg_swap_words(struct tipc_msg *msg, u32 a, u32 b)
 183{
 184	u32 temp = msg->hdr[a];
 185
 186	msg->hdr[a] = msg->hdr[b];
 187	msg->hdr[b] = temp;
 188}
 189
 190/*
 191 * Word 0
 192 */
 193static inline u32 msg_version(struct tipc_msg *m)
 194{
 195	return msg_bits(m, 0, 29, 7);
 196}
 197
 198static inline void msg_set_version(struct tipc_msg *m)
 199{
 200	msg_set_bits(m, 0, 29, 7, TIPC_VERSION);
 201}
 202
 203static inline u32 msg_user(struct tipc_msg *m)
 204{
 205	return msg_bits(m, 0, 25, 0xf);
 206}
 207
 208static inline u32 msg_isdata(struct tipc_msg *m)
 209{
 210	return msg_user(m) <= TIPC_CRITICAL_IMPORTANCE;
 211}
 212
 213static inline void msg_set_user(struct tipc_msg *m, u32 n)
 214{
 215	msg_set_bits(m, 0, 25, 0xf, n);
 216}
 217
 
 
 
 
 
 
 
 
 
 
 218static inline u32 msg_hdr_sz(struct tipc_msg *m)
 219{
 220	return msg_bits(m, 0, 21, 0xf) << 2;
 221}
 222
 223static inline void msg_set_hdr_sz(struct tipc_msg *m, u32 n)
 224{
 225	msg_set_bits(m, 0, 21, 0xf, n>>2);
 226}
 227
 228static inline u32 msg_size(struct tipc_msg *m)
 229{
 230	return msg_bits(m, 0, 0, 0x1ffff);
 231}
 232
 233static inline u32 msg_blocks(struct tipc_msg *m)
 234{
 235	return (msg_size(m) / 1024) + 1;
 236}
 237
 238static inline u32 msg_data_sz(struct tipc_msg *m)
 239{
 240	return msg_size(m) - msg_hdr_sz(m);
 241}
 242
 243static inline int msg_non_seq(struct tipc_msg *m)
 244{
 245	return msg_bits(m, 0, 20, 1);
 246}
 247
 248static inline void msg_set_non_seq(struct tipc_msg *m, u32 n)
 249{
 250	msg_set_bits(m, 0, 20, 1, n);
 251}
 252
 253static inline int msg_is_syn(struct tipc_msg *m)
 254{
 255	return msg_bits(m, 0, 17, 1);
 256}
 257
 258static inline void msg_set_syn(struct tipc_msg *m, u32 d)
 259{
 260	msg_set_bits(m, 0, 17, 1, d);
 261}
 262
 263static inline int msg_dest_droppable(struct tipc_msg *m)
 264{
 265	return msg_bits(m, 0, 19, 1);
 266}
 267
 268static inline void msg_set_dest_droppable(struct tipc_msg *m, u32 d)
 269{
 270	msg_set_bits(m, 0, 19, 1, d);
 271}
 272
 273static inline int msg_is_keepalive(struct tipc_msg *m)
 274{
 275	return msg_bits(m, 0, 19, 1);
 276}
 277
 278static inline void msg_set_is_keepalive(struct tipc_msg *m, u32 d)
 279{
 280	msg_set_bits(m, 0, 19, 1, d);
 281}
 282
 283static inline int msg_src_droppable(struct tipc_msg *m)
 284{
 285	return msg_bits(m, 0, 18, 1);
 286}
 287
 288static inline void msg_set_src_droppable(struct tipc_msg *m, u32 d)
 289{
 290	msg_set_bits(m, 0, 18, 1, d);
 291}
 292
 293static inline bool msg_is_rcast(struct tipc_msg *m)
 294{
 295	return msg_bits(m, 0, 18, 0x1);
 296}
 297
 298static inline void msg_set_is_rcast(struct tipc_msg *m, bool d)
 299{
 300	msg_set_bits(m, 0, 18, 0x1, d);
 301}
 302
 303static inline void msg_set_size(struct tipc_msg *m, u32 sz)
 304{
 305	m->hdr[0] = htonl((msg_word(m, 0) & ~0x1ffff) | sz);
 306}
 307
 308static inline unchar *msg_data(struct tipc_msg *m)
 309{
 310	return ((unchar *)m) + msg_hdr_sz(m);
 311}
 312
 313static inline struct tipc_msg *msg_inner_hdr(struct tipc_msg *m)
 314{
 315	return (struct tipc_msg *)msg_data(m);
 316}
 317
 318/*
 319 * Word 1
 320 */
 321static inline u32 msg_type(struct tipc_msg *m)
 322{
 323	return msg_bits(m, 1, 29, 0x7);
 324}
 325
 326static inline void msg_set_type(struct tipc_msg *m, u32 n)
 327{
 328	msg_set_bits(m, 1, 29, 0x7, n);
 329}
 330
 331static inline int msg_in_group(struct tipc_msg *m)
 332{
 333	int mtyp = msg_type(m);
 334
 335	return mtyp >= TIPC_GRP_MEMBER_EVT && mtyp <= TIPC_GRP_UCAST_MSG;
 336}
 337
 338static inline bool msg_is_grp_evt(struct tipc_msg *m)
 339{
 340	return msg_type(m) == TIPC_GRP_MEMBER_EVT;
 341}
 342
 343static inline u32 msg_named(struct tipc_msg *m)
 344{
 345	return msg_type(m) == TIPC_NAMED_MSG;
 346}
 347
 348static inline u32 msg_mcast(struct tipc_msg *m)
 349{
 350	int mtyp = msg_type(m);
 351
 352	return ((mtyp == TIPC_MCAST_MSG) || (mtyp == TIPC_GRP_BCAST_MSG) ||
 353		(mtyp == TIPC_GRP_MCAST_MSG));
 354}
 355
 356static inline u32 msg_connected(struct tipc_msg *m)
 357{
 358	return msg_type(m) == TIPC_CONN_MSG;
 359}
 360
 361static inline u32 msg_errcode(struct tipc_msg *m)
 362{
 363	return msg_bits(m, 1, 25, 0xf);
 364}
 365
 366static inline void msg_set_errcode(struct tipc_msg *m, u32 err)
 367{
 368	msg_set_bits(m, 1, 25, 0xf, err);
 369}
 370
 371static inline u32 msg_reroute_cnt(struct tipc_msg *m)
 372{
 373	return msg_bits(m, 1, 21, 0xf);
 374}
 375
 376static inline void msg_incr_reroute_cnt(struct tipc_msg *m)
 377{
 378	msg_set_bits(m, 1, 21, 0xf, msg_reroute_cnt(m) + 1);
 379}
 380
 381static inline void msg_reset_reroute_cnt(struct tipc_msg *m)
 382{
 383	msg_set_bits(m, 1, 21, 0xf, 0);
 384}
 385
 386static inline u32 msg_lookup_scope(struct tipc_msg *m)
 387{
 388	return msg_bits(m, 1, 19, 0x3);
 389}
 390
 391static inline void msg_set_lookup_scope(struct tipc_msg *m, u32 n)
 392{
 393	msg_set_bits(m, 1, 19, 0x3, n);
 394}
 395
 396static inline u16 msg_bcast_ack(struct tipc_msg *m)
 397{
 398	return msg_bits(m, 1, 0, 0xffff);
 399}
 400
 401static inline void msg_set_bcast_ack(struct tipc_msg *m, u16 n)
 402{
 403	msg_set_bits(m, 1, 0, 0xffff, n);
 404}
 405
 406/* Note: reusing bits in word 1 for ACTIVATE_MSG only, to re-synch
 407 * link peer session number
 408 */
 409static inline bool msg_dest_session_valid(struct tipc_msg *m)
 410{
 411	return msg_bits(m, 1, 16, 0x1);
 412}
 413
 414static inline void msg_set_dest_session_valid(struct tipc_msg *m, bool valid)
 415{
 416	msg_set_bits(m, 1, 16, 0x1, valid);
 417}
 418
 419static inline u16 msg_dest_session(struct tipc_msg *m)
 420{
 421	return msg_bits(m, 1, 0, 0xffff);
 422}
 423
 424static inline void msg_set_dest_session(struct tipc_msg *m, u16 n)
 425{
 426	msg_set_bits(m, 1, 0, 0xffff, n);
 427}
 428
 429/*
 430 * Word 2
 431 */
 432static inline u16 msg_ack(struct tipc_msg *m)
 433{
 434	return msg_bits(m, 2, 16, 0xffff);
 435}
 436
 437static inline void msg_set_ack(struct tipc_msg *m, u16 n)
 438{
 439	msg_set_bits(m, 2, 16, 0xffff, n);
 440}
 441
 442static inline u16 msg_seqno(struct tipc_msg *m)
 443{
 444	return msg_bits(m, 2, 0, 0xffff);
 445}
 446
 447static inline void msg_set_seqno(struct tipc_msg *m, u16 n)
 448{
 449	msg_set_bits(m, 2, 0, 0xffff, n);
 450}
 451
 452/*
 453 * Words 3-10
 454 */
 455static inline u32 msg_importance(struct tipc_msg *m)
 456{
 457	int usr = msg_user(m);
 458
 459	if (likely((usr <= TIPC_CRITICAL_IMPORTANCE) && !msg_errcode(m)))
 460		return usr;
 461	if ((usr == MSG_FRAGMENTER) || (usr == MSG_BUNDLER))
 462		return msg_bits(m, 9, 0, 0x7);
 463	return TIPC_SYSTEM_IMPORTANCE;
 464}
 465
 466static inline void msg_set_importance(struct tipc_msg *m, u32 i)
 467{
 468	int usr = msg_user(m);
 469
 470	if (likely((usr == MSG_FRAGMENTER) || (usr == MSG_BUNDLER)))
 471		msg_set_bits(m, 9, 0, 0x7, i);
 472	else if (i < TIPC_SYSTEM_IMPORTANCE)
 473		msg_set_user(m, i);
 474	else
 475		pr_warn("Trying to set illegal importance in message\n");
 476}
 477
 478static inline u32 msg_prevnode(struct tipc_msg *m)
 479{
 480	return msg_word(m, 3);
 481}
 482
 483static inline void msg_set_prevnode(struct tipc_msg *m, u32 a)
 484{
 485	msg_set_word(m, 3, a);
 486}
 487
 488static inline u32 msg_origport(struct tipc_msg *m)
 489{
 490	if (msg_user(m) == MSG_FRAGMENTER)
 491		m = msg_inner_hdr(m);
 492	return msg_word(m, 4);
 493}
 494
 495static inline void msg_set_origport(struct tipc_msg *m, u32 p)
 496{
 497	msg_set_word(m, 4, p);
 498}
 499
 500static inline u32 msg_destport(struct tipc_msg *m)
 501{
 502	return msg_word(m, 5);
 503}
 504
 505static inline void msg_set_destport(struct tipc_msg *m, u32 p)
 506{
 507	msg_set_word(m, 5, p);
 508}
 509
 510static inline u32 msg_mc_netid(struct tipc_msg *m)
 511{
 512	return msg_word(m, 5);
 513}
 514
 515static inline void msg_set_mc_netid(struct tipc_msg *m, u32 p)
 516{
 517	msg_set_word(m, 5, p);
 518}
 519
 520static inline int msg_short(struct tipc_msg *m)
 521{
 522	return msg_hdr_sz(m) == SHORT_H_SIZE;
 523}
 524
 525static inline u32 msg_orignode(struct tipc_msg *m)
 526{
 527	if (likely(msg_short(m)))
 528		return msg_prevnode(m);
 529	return msg_word(m, 6);
 530}
 531
 532static inline void msg_set_orignode(struct tipc_msg *m, u32 a)
 533{
 534	msg_set_word(m, 6, a);
 535}
 536
 537static inline u32 msg_destnode(struct tipc_msg *m)
 538{
 539	return msg_word(m, 7);
 540}
 541
 542static inline void msg_set_destnode(struct tipc_msg *m, u32 a)
 543{
 544	msg_set_word(m, 7, a);
 545}
 546
 547static inline u32 msg_nametype(struct tipc_msg *m)
 548{
 549	return msg_word(m, 8);
 550}
 551
 552static inline void msg_set_nametype(struct tipc_msg *m, u32 n)
 553{
 554	msg_set_word(m, 8, n);
 555}
 556
 557static inline u32 msg_nameinst(struct tipc_msg *m)
 558{
 559	return msg_word(m, 9);
 560}
 561
 562static inline u32 msg_namelower(struct tipc_msg *m)
 563{
 564	return msg_nameinst(m);
 565}
 566
 567static inline void msg_set_namelower(struct tipc_msg *m, u32 n)
 568{
 569	msg_set_word(m, 9, n);
 570}
 571
 572static inline void msg_set_nameinst(struct tipc_msg *m, u32 n)
 573{
 574	msg_set_namelower(m, n);
 575}
 576
 577static inline u32 msg_nameupper(struct tipc_msg *m)
 578{
 579	return msg_word(m, 10);
 580}
 581
 582static inline void msg_set_nameupper(struct tipc_msg *m, u32 n)
 583{
 584	msg_set_word(m, 10, n);
 585}
 586
 
 
 
 
 
 
 
 
 
 
 587/*
 588 * Constants and routines used to read and write TIPC internal message headers
 589 */
 590
 591/*
 
 
 
 
 
 
 
 
 
 
 
 
 
 592 *  Connection management protocol message types
 593 */
 594#define CONN_PROBE        0
 595#define CONN_PROBE_REPLY  1
 596#define CONN_ACK          2
 597
 598/*
 599 * Name distributor message types
 600 */
 601#define PUBLICATION       0
 602#define WITHDRAWAL        1
 603
 604/*
 605 * Segmentation message types
 606 */
 607#define FIRST_FRAGMENT		0
 608#define FRAGMENT		1
 609#define LAST_FRAGMENT		2
 610
 611/*
 612 * Link management protocol message types
 613 */
 614#define STATE_MSG		0
 615#define RESET_MSG		1
 616#define ACTIVATE_MSG		2
 617
 618/*
 619 * Changeover tunnel message types
 620 */
 621#define SYNCH_MSG		0
 622#define FAILOVER_MSG		1
 623
 624/*
 625 * Config protocol message types
 626 */
 627#define DSC_REQ_MSG		0
 628#define DSC_RESP_MSG		1
 629#define DSC_TRIAL_MSG		2
 630#define DSC_TRIAL_FAIL_MSG	3
 631
 632/*
 633 * Group protocol message types
 634 */
 635#define GRP_JOIN_MSG         0
 636#define GRP_LEAVE_MSG        1
 637#define GRP_ADV_MSG          2
 638#define GRP_ACK_MSG          3
 639#define GRP_RECLAIM_MSG      4
 640#define GRP_REMIT_MSG        5
 641
 642/*
 643 * Word 1
 644 */
 645static inline u32 msg_seq_gap(struct tipc_msg *m)
 646{
 647	return msg_bits(m, 1, 16, 0x1fff);
 648}
 649
 650static inline void msg_set_seq_gap(struct tipc_msg *m, u32 n)
 651{
 652	msg_set_bits(m, 1, 16, 0x1fff, n);
 653}
 654
 655static inline u32 msg_node_sig(struct tipc_msg *m)
 656{
 657	return msg_bits(m, 1, 0, 0xffff);
 658}
 659
 660static inline void msg_set_node_sig(struct tipc_msg *m, u32 n)
 661{
 662	msg_set_bits(m, 1, 0, 0xffff, n);
 663}
 664
 665static inline u32 msg_node_capabilities(struct tipc_msg *m)
 666{
 667	return msg_bits(m, 1, 15, 0x1fff);
 668}
 669
 670static inline void msg_set_node_capabilities(struct tipc_msg *m, u32 n)
 671{
 672	msg_set_bits(m, 1, 15, 0x1fff, n);
 673}
 674
 675/*
 676 * Word 2
 677 */
 678static inline u32 msg_dest_domain(struct tipc_msg *m)
 679{
 680	return msg_word(m, 2);
 681}
 682
 683static inline void msg_set_dest_domain(struct tipc_msg *m, u32 n)
 684{
 685	msg_set_word(m, 2, n);
 686}
 687
 688static inline u32 msg_bcgap_after(struct tipc_msg *m)
 689{
 690	return msg_bits(m, 2, 16, 0xffff);
 691}
 692
 693static inline void msg_set_bcgap_after(struct tipc_msg *m, u32 n)
 694{
 695	msg_set_bits(m, 2, 16, 0xffff, n);
 696}
 697
 698static inline u32 msg_bcgap_to(struct tipc_msg *m)
 699{
 700	return msg_bits(m, 2, 0, 0xffff);
 701}
 702
 703static inline void msg_set_bcgap_to(struct tipc_msg *m, u32 n)
 704{
 705	msg_set_bits(m, 2, 0, 0xffff, n);
 706}
 707
 
 708/*
 709 * Word 4
 710 */
 711static inline u32 msg_last_bcast(struct tipc_msg *m)
 712{
 713	return msg_bits(m, 4, 16, 0xffff);
 714}
 715
 716static inline u32 msg_bc_snd_nxt(struct tipc_msg *m)
 717{
 718	return msg_last_bcast(m) + 1;
 719}
 720
 721static inline void msg_set_last_bcast(struct tipc_msg *m, u32 n)
 722{
 723	msg_set_bits(m, 4, 16, 0xffff, n);
 724}
 725
 726static inline u32 msg_nof_fragms(struct tipc_msg *m)
 727{
 728	return msg_bits(m, 4, 0, 0xffff);
 729}
 730
 731static inline void msg_set_nof_fragms(struct tipc_msg *m, u32 n)
 732{
 733	msg_set_bits(m, 4, 0, 0xffff, n);
 734}
 735
 736static inline u32 msg_fragm_no(struct tipc_msg *m)
 737{
 738	return msg_bits(m, 4, 16, 0xffff);
 739}
 740
 741static inline void msg_set_fragm_no(struct tipc_msg *m, u32 n)
 742{
 743	msg_set_bits(m, 4, 16, 0xffff, n);
 744}
 745
 746static inline u16 msg_next_sent(struct tipc_msg *m)
 
 747{
 748	return msg_bits(m, 4, 0, 0xffff);
 749}
 750
 751static inline void msg_set_next_sent(struct tipc_msg *m, u16 n)
 752{
 753	msg_set_bits(m, 4, 0, 0xffff, n);
 754}
 755
 756static inline void msg_set_long_msgno(struct tipc_msg *m, u32 n)
 757{
 758	msg_set_bits(m, 4, 0, 0xffff, n);
 759}
 760
 761static inline u32 msg_bc_netid(struct tipc_msg *m)
 762{
 763	return msg_word(m, 4);
 764}
 765
 766static inline void msg_set_bc_netid(struct tipc_msg *m, u32 id)
 767{
 768	msg_set_word(m, 4, id);
 769}
 770
 771static inline u32 msg_link_selector(struct tipc_msg *m)
 772{
 773	if (msg_user(m) == MSG_FRAGMENTER)
 774		m = (void *)msg_data(m);
 775	return msg_bits(m, 4, 0, 1);
 776}
 777
 
 
 
 
 
 778/*
 779 * Word 5
 780 */
 781static inline u16 msg_session(struct tipc_msg *m)
 782{
 783	return msg_bits(m, 5, 16, 0xffff);
 784}
 785
 786static inline void msg_set_session(struct tipc_msg *m, u16 n)
 787{
 788	msg_set_bits(m, 5, 16, 0xffff, n);
 789}
 790
 791static inline u32 msg_probe(struct tipc_msg *m)
 792{
 793	return msg_bits(m, 5, 0, 1);
 794}
 795
 796static inline void msg_set_probe(struct tipc_msg *m, u32 val)
 797{
 798	msg_set_bits(m, 5, 0, 1, val);
 799}
 800
 801static inline char msg_net_plane(struct tipc_msg *m)
 802{
 803	return msg_bits(m, 5, 1, 7) + 'A';
 804}
 805
 806static inline void msg_set_net_plane(struct tipc_msg *m, char n)
 807{
 808	msg_set_bits(m, 5, 1, 7, (n - 'A'));
 809}
 810
 811static inline u32 msg_linkprio(struct tipc_msg *m)
 812{
 813	return msg_bits(m, 5, 4, 0x1f);
 814}
 815
 816static inline void msg_set_linkprio(struct tipc_msg *m, u32 n)
 817{
 818	msg_set_bits(m, 5, 4, 0x1f, n);
 819}
 820
 821static inline u32 msg_bearer_id(struct tipc_msg *m)
 822{
 823	return msg_bits(m, 5, 9, 0x7);
 824}
 825
 826static inline void msg_set_bearer_id(struct tipc_msg *m, u32 n)
 827{
 828	msg_set_bits(m, 5, 9, 0x7, n);
 829}
 830
 831static inline u32 msg_redundant_link(struct tipc_msg *m)
 832{
 833	return msg_bits(m, 5, 12, 0x1);
 834}
 835
 836static inline void msg_set_redundant_link(struct tipc_msg *m, u32 r)
 837{
 838	msg_set_bits(m, 5, 12, 0x1, r);
 839}
 840
 841static inline u32 msg_peer_stopping(struct tipc_msg *m)
 842{
 843	return msg_bits(m, 5, 13, 0x1);
 844}
 845
 846static inline void msg_set_peer_stopping(struct tipc_msg *m, u32 s)
 847{
 848	msg_set_bits(m, 5, 13, 0x1, s);
 849}
 850
 851static inline bool msg_bc_ack_invalid(struct tipc_msg *m)
 852{
 853	switch (msg_user(m)) {
 854	case BCAST_PROTOCOL:
 855	case NAME_DISTRIBUTOR:
 856	case LINK_PROTOCOL:
 857		return msg_bits(m, 5, 14, 0x1);
 858	default:
 859		return false;
 860	}
 861}
 862
 863static inline void msg_set_bc_ack_invalid(struct tipc_msg *m, bool invalid)
 864{
 865	msg_set_bits(m, 5, 14, 0x1, invalid);
 866}
 867
 868static inline char *msg_media_addr(struct tipc_msg *m)
 869{
 870	return (char *)&m->hdr[TIPC_MEDIA_INFO_OFFSET];
 871}
 872
 873static inline u32 msg_bc_gap(struct tipc_msg *m)
 874{
 875	return msg_bits(m, 8, 0, 0x3ff);
 876}
 877
 878static inline void msg_set_bc_gap(struct tipc_msg *m, u32 n)
 879{
 880	msg_set_bits(m, 8, 0, 0x3ff, n);
 881}
 882
 883/*
 884 * Word 9
 885 */
 886static inline u16 msg_msgcnt(struct tipc_msg *m)
 887{
 888	return msg_bits(m, 9, 16, 0xffff);
 889}
 890
 891static inline void msg_set_msgcnt(struct tipc_msg *m, u16 n)
 892{
 893	msg_set_bits(m, 9, 16, 0xffff, n);
 894}
 895
 896static inline u16 msg_syncpt(struct tipc_msg *m)
 897{
 898	return msg_bits(m, 9, 16, 0xffff);
 899}
 900
 901static inline void msg_set_syncpt(struct tipc_msg *m, u16 n)
 902{
 903	msg_set_bits(m, 9, 16, 0xffff, n);
 904}
 905
 906static inline u32 msg_conn_ack(struct tipc_msg *m)
 907{
 908	return msg_bits(m, 9, 16, 0xffff);
 909}
 910
 911static inline void msg_set_conn_ack(struct tipc_msg *m, u32 n)
 912{
 913	msg_set_bits(m, 9, 16, 0xffff, n);
 914}
 915
 916static inline u16 msg_adv_win(struct tipc_msg *m)
 917{
 918	return msg_bits(m, 9, 0, 0xffff);
 919}
 920
 921static inline void msg_set_adv_win(struct tipc_msg *m, u16 n)
 922{
 923	msg_set_bits(m, 9, 0, 0xffff, n);
 924}
 925
 926static inline u32 msg_max_pkt(struct tipc_msg *m)
 927{
 928	return msg_bits(m, 9, 16, 0xffff) * 4;
 929}
 930
 931static inline void msg_set_max_pkt(struct tipc_msg *m, u32 n)
 932{
 933	msg_set_bits(m, 9, 16, 0xffff, (n / 4));
 934}
 935
 936static inline u32 msg_link_tolerance(struct tipc_msg *m)
 937{
 938	return msg_bits(m, 9, 0, 0xffff);
 939}
 940
 941static inline void msg_set_link_tolerance(struct tipc_msg *m, u32 n)
 942{
 943	msg_set_bits(m, 9, 0, 0xffff, n);
 944}
 945
 946static inline u16 msg_grp_bc_syncpt(struct tipc_msg *m)
 947{
 948	return msg_bits(m, 9, 16, 0xffff);
 949}
 950
 951static inline void msg_set_grp_bc_syncpt(struct tipc_msg *m, u16 n)
 952{
 953	msg_set_bits(m, 9, 16, 0xffff, n);
 954}
 955
 956static inline u16 msg_grp_bc_acked(struct tipc_msg *m)
 957{
 958	return msg_bits(m, 9, 16, 0xffff);
 959}
 960
 961static inline void msg_set_grp_bc_acked(struct tipc_msg *m, u16 n)
 962{
 963	msg_set_bits(m, 9, 16, 0xffff, n);
 964}
 965
 966static inline u16 msg_grp_remitted(struct tipc_msg *m)
 967{
 968	return msg_bits(m, 9, 16, 0xffff);
 969}
 970
 971static inline void msg_set_grp_remitted(struct tipc_msg *m, u16 n)
 972{
 973	msg_set_bits(m, 9, 16, 0xffff, n);
 974}
 975
 976/* Word 10
 977 */
 978static inline u16 msg_grp_evt(struct tipc_msg *m)
 979{
 980	return msg_bits(m, 10, 0, 0x3);
 981}
 982
 983static inline void msg_set_grp_evt(struct tipc_msg *m, int n)
 984{
 985	msg_set_bits(m, 10, 0, 0x3, n);
 986}
 987
 988static inline u16 msg_grp_bc_ack_req(struct tipc_msg *m)
 989{
 990	return msg_bits(m, 10, 0, 0x1);
 991}
 992
 993static inline void msg_set_grp_bc_ack_req(struct tipc_msg *m, bool n)
 994{
 995	msg_set_bits(m, 10, 0, 0x1, n);
 996}
 997
 998static inline u16 msg_grp_bc_seqno(struct tipc_msg *m)
 999{
1000	return msg_bits(m, 10, 16, 0xffff);
1001}
1002
1003static inline void msg_set_grp_bc_seqno(struct tipc_msg *m, u32 n)
1004{
1005	msg_set_bits(m, 10, 16, 0xffff, n);
1006}
1007
1008static inline bool msg_peer_link_is_up(struct tipc_msg *m)
1009{
1010	if (likely(msg_user(m) != LINK_PROTOCOL))
1011		return true;
1012	if (msg_type(m) == STATE_MSG)
1013		return true;
1014	return false;
1015}
1016
1017static inline bool msg_peer_node_is_up(struct tipc_msg *m)
1018{
1019	if (msg_peer_link_is_up(m))
1020		return true;
1021	return msg_redundant_link(m);
1022}
1023
1024static inline bool msg_is_reset(struct tipc_msg *hdr)
1025{
1026	return (msg_user(hdr) == LINK_PROTOCOL) && (msg_type(hdr) == RESET_MSG);
1027}
1028
1029static inline u32 msg_sugg_node_addr(struct tipc_msg *m)
1030{
1031	return msg_word(m, 14);
1032}
1033
1034static inline void msg_set_sugg_node_addr(struct tipc_msg *m, u32 n)
1035{
1036	msg_set_word(m, 14, n);
1037}
1038
1039static inline void msg_set_node_id(struct tipc_msg *hdr, u8 *id)
1040{
1041	memcpy(msg_data(hdr), id, 16);
1042}
1043
1044static inline u8 *msg_node_id(struct tipc_msg *hdr)
1045{
1046	return (u8 *)msg_data(hdr);
1047}
1048
1049struct sk_buff *tipc_buf_acquire(u32 size, gfp_t gfp);
1050bool tipc_msg_validate(struct sk_buff **_skb);
1051bool tipc_msg_reverse(u32 own_addr, struct sk_buff **skb, int err);
1052void tipc_skb_reject(struct net *net, int err, struct sk_buff *skb,
1053		     struct sk_buff_head *xmitq);
1054void tipc_msg_init(u32 own_addr, struct tipc_msg *m, u32 user, u32 type,
1055		   u32 hsize, u32 destnode);
1056struct sk_buff *tipc_msg_create(uint user, uint type, uint hdr_sz,
1057				uint data_sz, u32 dnode, u32 onode,
1058				u32 dport, u32 oport, int errcode);
1059int tipc_buf_append(struct sk_buff **headbuf, struct sk_buff **buf);
1060bool tipc_msg_bundle(struct sk_buff *skb, struct tipc_msg *msg, u32 mtu);
1061bool tipc_msg_make_bundle(struct sk_buff **skb, struct tipc_msg *msg,
1062			  u32 mtu, u32 dnode);
1063bool tipc_msg_extract(struct sk_buff *skb, struct sk_buff **iskb, int *pos);
1064int tipc_msg_fragment(struct sk_buff *skb, const struct tipc_msg *hdr,
1065		      int pktmax, struct sk_buff_head *frags);
1066int tipc_msg_build(struct tipc_msg *mhdr, struct msghdr *m,
1067		   int offset, int dsz, int mtu, struct sk_buff_head *list);
1068bool tipc_msg_lookup_dest(struct net *net, struct sk_buff *skb, int *err);
1069bool tipc_msg_assemble(struct sk_buff_head *list);
1070bool tipc_msg_reassemble(struct sk_buff_head *list, struct sk_buff_head *rcvq);
1071bool tipc_msg_pskb_copy(u32 dst, struct sk_buff_head *msg,
1072			struct sk_buff_head *cpy);
1073void __tipc_skb_queue_sorted(struct sk_buff_head *list, u16 seqno,
1074			     struct sk_buff *skb);
1075bool tipc_msg_skb_clone(struct sk_buff_head *msg, struct sk_buff_head *cpy);
1076
1077static inline u16 buf_seqno(struct sk_buff *skb)
1078{
1079	return msg_seqno(buf_msg(skb));
1080}
1081
1082static inline int buf_roundup_len(struct sk_buff *skb)
1083{
1084	return (skb->len / 1024 + 1) * 1024;
1085}
1086
1087/* tipc_skb_peek(): peek and reserve first buffer in list
1088 * @list: list to be peeked in
1089 * Returns pointer to first buffer in list, if any
1090 */
1091static inline struct sk_buff *tipc_skb_peek(struct sk_buff_head *list,
1092					    spinlock_t *lock)
1093{
1094	struct sk_buff *skb;
1095
1096	spin_lock_bh(lock);
1097	skb = skb_peek(list);
1098	if (skb)
1099		skb_get(skb);
1100	spin_unlock_bh(lock);
1101	return skb;
1102}
1103
1104/* tipc_skb_peek_port(): find a destination port, ignoring all destinations
1105 *                       up to and including 'filter'.
1106 * Note: ignoring previously tried destinations minimizes the risk of
1107 *       contention on the socket lock
1108 * @list: list to be peeked in
1109 * @filter: last destination to be ignored from search
1110 * Returns a destination port number, of applicable.
1111 */
1112static inline u32 tipc_skb_peek_port(struct sk_buff_head *list, u32 filter)
1113{
1114	struct sk_buff *skb;
1115	u32 dport = 0;
1116	bool ignore = true;
1117
1118	spin_lock_bh(&list->lock);
1119	skb_queue_walk(list, skb) {
1120		dport = msg_destport(buf_msg(skb));
1121		if (!filter || skb_queue_is_last(list, skb))
1122			break;
1123		if (dport == filter)
1124			ignore = false;
1125		else if (!ignore)
1126			break;
1127	}
1128	spin_unlock_bh(&list->lock);
1129	return dport;
1130}
1131
1132/* tipc_skb_dequeue(): unlink first buffer with dest 'dport' from list
1133 * @list: list to be unlinked from
1134 * @dport: selection criteria for buffer to unlink
1135 */
1136static inline struct sk_buff *tipc_skb_dequeue(struct sk_buff_head *list,
1137					       u32 dport)
1138{
1139	struct sk_buff *_skb, *tmp, *skb = NULL;
1140
1141	spin_lock_bh(&list->lock);
1142	skb_queue_walk_safe(list, _skb, tmp) {
1143		if (msg_destport(buf_msg(_skb)) == dport) {
1144			__skb_unlink(_skb, list);
1145			skb = _skb;
1146			break;
1147		}
1148	}
1149	spin_unlock_bh(&list->lock);
1150	return skb;
1151}
1152
1153/* tipc_skb_queue_splice_tail - append an skb list to lock protected list
1154 * @list: the new list to append. Not lock protected
1155 * @head: target list. Lock protected.
1156 */
1157static inline void tipc_skb_queue_splice_tail(struct sk_buff_head *list,
1158					      struct sk_buff_head *head)
1159{
1160	spin_lock_bh(&head->lock);
1161	skb_queue_splice_tail(list, head);
1162	spin_unlock_bh(&head->lock);
1163}
1164
1165/* tipc_skb_queue_splice_tail_init - merge two lock protected skb lists
1166 * @list: the new list to add. Lock protected. Will be reinitialized
1167 * @head: target list. Lock protected.
1168 */
1169static inline void tipc_skb_queue_splice_tail_init(struct sk_buff_head *list,
1170						   struct sk_buff_head *head)
1171{
1172	struct sk_buff_head tmp;
1173
1174	__skb_queue_head_init(&tmp);
1175
1176	spin_lock_bh(&list->lock);
1177	skb_queue_splice_tail_init(list, &tmp);
1178	spin_unlock_bh(&list->lock);
1179	tipc_skb_queue_splice_tail(&tmp, head);
1180}
1181
1182/* __tipc_skb_dequeue() - dequeue the head skb according to expected seqno
1183 * @list: list to be dequeued from
1184 * @seqno: seqno of the expected msg
1185 *
1186 * returns skb dequeued from the list if its seqno is less than or equal to
1187 * the expected one, otherwise the skb is still hold
1188 *
1189 * Note: must be used with appropriate locks held only
1190 */
1191static inline struct sk_buff *__tipc_skb_dequeue(struct sk_buff_head *list,
1192						 u16 seqno)
1193{
1194	struct sk_buff *skb = skb_peek(list);
1195
1196	if (skb && less_eq(buf_seqno(skb), seqno)) {
1197		__skb_unlink(skb, list);
1198		return skb;
1199	}
1200	return NULL;
1201}
1202
1203#endif