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