Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
tjh.dev
kernel
os
linux
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 /* Connected, in-cluster messages */
72#define DIR_MSG_H_SIZE 32 /* Directly addressed messages */
73#define LONG_H_SIZE 40 /* Named messages */
74#define MCAST_H_SIZE 44 /* Multicast messages */
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 * TIPC may utilize the "link ack #" and "link seq #" fields of a short
315 * message header to hold the destination node for the message, since the
316 * normal "dest node" field isn't present. This cache is only referenced
317 * when required, so populating the cache of a longer message header is
318 * harmless (as long as the header has the two link sequence fields present).
319 *
320 * Note: Host byte order is OK here, since the info never goes off-card.
321 */
322
323static inline u32 msg_destnode_cache(struct tipc_msg *m)
324{
325 return m->hdr[2];
326}
327
328static inline void msg_set_destnode_cache(struct tipc_msg *m, u32 dnode)
329{
330 m->hdr[2] = dnode;
331}
332
333/*
334 * Words 3-10
335 */
336
337
338static inline u32 msg_prevnode(struct tipc_msg *m)
339{
340 return msg_word(m, 3);
341}
342
343static inline void msg_set_prevnode(struct tipc_msg *m, u32 a)
344{
345 msg_set_word(m, 3, a);
346}
347
348static inline u32 msg_origport(struct tipc_msg *m)
349{
350 return msg_word(m, 4);
351}
352
353static inline void msg_set_origport(struct tipc_msg *m, u32 p)
354{
355 msg_set_word(m, 4, p);
356}
357
358static inline u32 msg_destport(struct tipc_msg *m)
359{
360 return msg_word(m, 5);
361}
362
363static inline void msg_set_destport(struct tipc_msg *m, u32 p)
364{
365 msg_set_word(m, 5, p);
366}
367
368static inline u32 msg_mc_netid(struct tipc_msg *m)
369{
370 return msg_word(m, 5);
371}
372
373static inline void msg_set_mc_netid(struct tipc_msg *m, u32 p)
374{
375 msg_set_word(m, 5, p);
376}
377
378static inline int msg_short(struct tipc_msg *m)
379{
380 return msg_hdr_sz(m) == 24;
381}
382
383static inline u32 msg_orignode(struct tipc_msg *m)
384{
385 if (likely(msg_short(m)))
386 return msg_prevnode(m);
387 return msg_word(m, 6);
388}
389
390static inline void msg_set_orignode(struct tipc_msg *m, u32 a)
391{
392 msg_set_word(m, 6, a);
393}
394
395static inline u32 msg_destnode(struct tipc_msg *m)
396{
397 return msg_word(m, 7);
398}
399
400static inline void msg_set_destnode(struct tipc_msg *m, u32 a)
401{
402 msg_set_word(m, 7, a);
403}
404
405static inline int msg_is_dest(struct tipc_msg *m, u32 d)
406{
407 return msg_short(m) || (msg_destnode(m) == d);
408}
409
410static inline u32 msg_nametype(struct tipc_msg *m)
411{
412 return msg_word(m, 8);
413}
414
415static inline void msg_set_nametype(struct tipc_msg *m, u32 n)
416{
417 msg_set_word(m, 8, n);
418}
419
420static inline u32 msg_nameinst(struct tipc_msg *m)
421{
422 return msg_word(m, 9);
423}
424
425static inline u32 msg_namelower(struct tipc_msg *m)
426{
427 return msg_nameinst(m);
428}
429
430static inline void msg_set_namelower(struct tipc_msg *m, u32 n)
431{
432 msg_set_word(m, 9, n);
433}
434
435static inline void msg_set_nameinst(struct tipc_msg *m, u32 n)
436{
437 msg_set_namelower(m, n);
438}
439
440static inline u32 msg_nameupper(struct tipc_msg *m)
441{
442 return msg_word(m, 10);
443}
444
445static inline void msg_set_nameupper(struct tipc_msg *m, u32 n)
446{
447 msg_set_word(m, 10, n);
448}
449
450static inline unchar *msg_data(struct tipc_msg *m)
451{
452 return ((unchar *)m) + msg_hdr_sz(m);
453}
454
455static inline struct tipc_msg *msg_get_wrapped(struct tipc_msg *m)
456{
457 return (struct tipc_msg *)msg_data(m);
458}
459
460
461/*
462 * Constants and routines used to read and write TIPC internal message headers
463 */
464
465/*
466 * Internal message users
467 */
468
469#define BCAST_PROTOCOL 5
470#define MSG_BUNDLER 6
471#define LINK_PROTOCOL 7
472#define CONN_MANAGER 8
473#define ROUTE_DISTRIBUTOR 9 /* obsoleted */
474#define CHANGEOVER_PROTOCOL 10
475#define NAME_DISTRIBUTOR 11
476#define MSG_FRAGMENTER 12
477#define LINK_CONFIG 13
478
479/*
480 * Connection management protocol message types
481 */
482
483#define CONN_PROBE 0
484#define CONN_PROBE_REPLY 1
485#define CONN_ACK 2
486
487/*
488 * Name distributor message types
489 */
490
491#define PUBLICATION 0
492#define WITHDRAWAL 1
493
494/*
495 * Segmentation message types
496 */
497
498#define FIRST_FRAGMENT 0
499#define FRAGMENT 1
500#define LAST_FRAGMENT 2
501
502/*
503 * Link management protocol message types
504 */
505
506#define STATE_MSG 0
507#define RESET_MSG 1
508#define ACTIVATE_MSG 2
509
510/*
511 * Changeover tunnel message types
512 */
513#define DUPLICATE_MSG 0
514#define ORIGINAL_MSG 1
515
516/*
517 * Config protocol message types
518 */
519
520#define DSC_REQ_MSG 0
521#define DSC_RESP_MSG 1
522
523
524/*
525 * Word 1
526 */
527
528static inline u32 msg_seq_gap(struct tipc_msg *m)
529{
530 return msg_bits(m, 1, 16, 0x1fff);
531}
532
533static inline void msg_set_seq_gap(struct tipc_msg *m, u32 n)
534{
535 msg_set_bits(m, 1, 16, 0x1fff, n);
536}
537
538
539/*
540 * Word 2
541 */
542
543static inline u32 msg_dest_domain(struct tipc_msg *m)
544{
545 return msg_word(m, 2);
546}
547
548static inline void msg_set_dest_domain(struct tipc_msg *m, u32 n)
549{
550 msg_set_word(m, 2, n);
551}
552
553static inline u32 msg_bcgap_after(struct tipc_msg *m)
554{
555 return msg_bits(m, 2, 16, 0xffff);
556}
557
558static inline void msg_set_bcgap_after(struct tipc_msg *m, u32 n)
559{
560 msg_set_bits(m, 2, 16, 0xffff, n);
561}
562
563static inline u32 msg_bcgap_to(struct tipc_msg *m)
564{
565 return msg_bits(m, 2, 0, 0xffff);
566}
567
568static inline void msg_set_bcgap_to(struct tipc_msg *m, u32 n)
569{
570 msg_set_bits(m, 2, 0, 0xffff, n);
571}
572
573
574/*
575 * Word 4
576 */
577
578static inline u32 msg_last_bcast(struct tipc_msg *m)
579{
580 return msg_bits(m, 4, 16, 0xffff);
581}
582
583static inline void msg_set_last_bcast(struct tipc_msg *m, u32 n)
584{
585 msg_set_bits(m, 4, 16, 0xffff, n);
586}
587
588
589static inline u32 msg_fragm_no(struct tipc_msg *m)
590{
591 return msg_bits(m, 4, 16, 0xffff);
592}
593
594static inline void msg_set_fragm_no(struct tipc_msg *m, u32 n)
595{
596 msg_set_bits(m, 4, 16, 0xffff, n);
597}
598
599
600static inline u32 msg_next_sent(struct tipc_msg *m)
601{
602 return msg_bits(m, 4, 0, 0xffff);
603}
604
605static inline void msg_set_next_sent(struct tipc_msg *m, u32 n)
606{
607 msg_set_bits(m, 4, 0, 0xffff, n);
608}
609
610
611static inline u32 msg_long_msgno(struct tipc_msg *m)
612{
613 return msg_bits(m, 4, 0, 0xffff);
614}
615
616static inline void msg_set_long_msgno(struct tipc_msg *m, u32 n)
617{
618 msg_set_bits(m, 4, 0, 0xffff, n);
619}
620
621static inline u32 msg_bc_netid(struct tipc_msg *m)
622{
623 return msg_word(m, 4);
624}
625
626static inline void msg_set_bc_netid(struct tipc_msg *m, u32 id)
627{
628 msg_set_word(m, 4, id);
629}
630
631static inline u32 msg_link_selector(struct tipc_msg *m)
632{
633 return msg_bits(m, 4, 0, 1);
634}
635
636static inline void msg_set_link_selector(struct tipc_msg *m, u32 n)
637{
638 msg_set_bits(m, 4, 0, 1, (n & 1));
639}
640
641/*
642 * Word 5
643 */
644
645static inline u32 msg_session(struct tipc_msg *m)
646{
647 return msg_bits(m, 5, 16, 0xffff);
648}
649
650static inline void msg_set_session(struct tipc_msg *m, u32 n)
651{
652 msg_set_bits(m, 5, 16, 0xffff, n);
653}
654
655static inline u32 msg_probe(struct tipc_msg *m)
656{
657 return msg_bits(m, 5, 0, 1);
658}
659
660static inline void msg_set_probe(struct tipc_msg *m, u32 val)
661{
662 msg_set_bits(m, 5, 0, 1, (val & 1));
663}
664
665static inline char msg_net_plane(struct tipc_msg *m)
666{
667 return msg_bits(m, 5, 1, 7) + 'A';
668}
669
670static inline void msg_set_net_plane(struct tipc_msg *m, char n)
671{
672 msg_set_bits(m, 5, 1, 7, (n - 'A'));
673}
674
675static inline u32 msg_linkprio(struct tipc_msg *m)
676{
677 return msg_bits(m, 5, 4, 0x1f);
678}
679
680static inline void msg_set_linkprio(struct tipc_msg *m, u32 n)
681{
682 msg_set_bits(m, 5, 4, 0x1f, n);
683}
684
685static inline u32 msg_bearer_id(struct tipc_msg *m)
686{
687 return msg_bits(m, 5, 9, 0x7);
688}
689
690static inline void msg_set_bearer_id(struct tipc_msg *m, u32 n)
691{
692 msg_set_bits(m, 5, 9, 0x7, n);
693}
694
695static inline u32 msg_redundant_link(struct tipc_msg *m)
696{
697 return msg_bits(m, 5, 12, 0x1);
698}
699
700static inline void msg_set_redundant_link(struct tipc_msg *m, u32 r)
701{
702 msg_set_bits(m, 5, 12, 0x1, r);
703}
704
705
706/*
707 * Word 9
708 */
709
710static inline u32 msg_msgcnt(struct tipc_msg *m)
711{
712 return msg_bits(m, 9, 16, 0xffff);
713}
714
715static inline void msg_set_msgcnt(struct tipc_msg *m, u32 n)
716{
717 msg_set_bits(m, 9, 16, 0xffff, n);
718}
719
720static inline u32 msg_bcast_tag(struct tipc_msg *m)
721{
722 return msg_bits(m, 9, 16, 0xffff);
723}
724
725static inline void msg_set_bcast_tag(struct tipc_msg *m, u32 n)
726{
727 msg_set_bits(m, 9, 16, 0xffff, n);
728}
729
730static inline u32 msg_max_pkt(struct tipc_msg *m)
731{
732 return msg_bits(m, 9, 16, 0xffff) * 4;
733}
734
735static inline void msg_set_max_pkt(struct tipc_msg *m, u32 n)
736{
737 msg_set_bits(m, 9, 16, 0xffff, (n / 4));
738}
739
740static inline u32 msg_link_tolerance(struct tipc_msg *m)
741{
742 return msg_bits(m, 9, 0, 0xffff);
743}
744
745static inline void msg_set_link_tolerance(struct tipc_msg *m, u32 n)
746{
747 msg_set_bits(m, 9, 0, 0xffff, n);
748}
749
750u32 tipc_msg_tot_importance(struct tipc_msg *m);
751void tipc_msg_init(struct tipc_msg *m, u32 user, u32 type,
752 u32 hsize, u32 destnode);
753int tipc_msg_build(struct tipc_msg *hdr, struct iovec const *msg_sect,
754 u32 num_sect, unsigned int total_len,
755 int max_size, int usrmem, struct sk_buff **buf);
756
757static inline void msg_set_media_addr(struct tipc_msg *m, struct tipc_media_addr *a)
758{
759 memcpy(&((int *)m)[5], a, sizeof(*a));
760}
761
762static inline void msg_get_media_addr(struct tipc_msg *m, struct tipc_media_addr *a)
763{
764 memcpy(a, &((int *)m)[5], sizeof(*a));
765}
766
767#endif