Linux Audio

Check our new training course

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