1310 lines · 28.9 KB · C
RawDownload
/* * net/tipc/msg.h: Include file for TIPC message header routines * * Copyright (c) 2000-2007, 2014-2017 Ericsson AB * Copyright (c) 2005-2008, 2010-2011, Wind River Systems * All rights reserved. * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions are met: * * 1. Redistributions of source code must retain the above copyright *    notice, this list of conditions and the following disclaimer. * 2. Redistributions in binary form must reproduce the above copyright *    notice, this list of conditions and the following disclaimer in the *    documentation and/or other materials provided with the distribution. * 3. Neither the names of the copyright holders nor the names of its *    contributors may be used to endorse or promote products derived from *    this software without specific prior written permission. * * Alternatively, this software may be distributed under the terms of the * GNU General Public License ("GPL") version 2 as published by the Free * Software Foundation. * * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE * POSSIBILITY OF SUCH DAMAGE. */ #ifndef _TIPC_MSG_H#define _TIPC_MSG_H #include <linux/tipc.h>#include "core.h" /* * Constants and routines used to read and write TIPC payload message headers * * Note: Some items are also used with TIPC internal message headers */#define TIPC_VERSION              2struct plist; /* * Payload message users are defined in TIPC's public API: * - TIPC_LOW_IMPORTANCE * - TIPC_MEDIUM_IMPORTANCE * - TIPC_HIGH_IMPORTANCE * - TIPC_CRITICAL_IMPORTANCE */#define TIPC_SYSTEM_IMPORTANCE	4  /* * Payload message types */#define TIPC_CONN_MSG           0#define TIPC_MCAST_MSG          1#define TIPC_NAMED_MSG          2#define TIPC_DIRECT_MSG         3#define TIPC_GRP_MEMBER_EVT     4#define TIPC_GRP_BCAST_MSG      5#define TIPC_GRP_MCAST_MSG      6#define TIPC_GRP_UCAST_MSG      7 /* * Internal message users */#define  BCAST_PROTOCOL       5#define  MSG_BUNDLER          6#define  LINK_PROTOCOL        7#define  CONN_MANAGER         8#define  GROUP_PROTOCOL       9#define  TUNNEL_PROTOCOL      10#define  NAME_DISTRIBUTOR     11#define  MSG_FRAGMENTER       12#define  LINK_CONFIG          13#define  MSG_CRYPTO           14#define  SOCK_WAKEUP          14       /* pseudo user */#define  TOP_SRV              15       /* pseudo user */ /* * Message header sizes */#define SHORT_H_SIZE              24	/* In-cluster basic payload message */#define BASIC_H_SIZE              32	/* Basic payload message */#define NAMED_H_SIZE              40	/* Named payload message */#define MCAST_H_SIZE              44	/* Multicast payload message */#define GROUP_H_SIZE              44	/* Group payload message */#define INT_H_SIZE                40	/* Internal messages */#define MIN_H_SIZE                24	/* Smallest legal TIPC header size */#define MAX_H_SIZE                60	/* Largest possible TIPC header size */ #define MAX_MSG_SIZE (MAX_H_SIZE + TIPC_MAX_USER_MSG_SIZE)#define TIPC_MEDIA_INFO_OFFSET	5 extern const int one_page_mtu; struct tipc_skb_cb {	union {		struct {			struct sk_buff *tail;			unsigned long nxt_retr;			unsigned long retr_stamp;			u32 bytes_read;			u32 orig_member;			u16 chain_imp;			u16 ackers;			u16 retr_cnt;		} __packed;#ifdef CONFIG_TIPC_CRYPTO		struct {			struct tipc_crypto *rx;			struct tipc_aead *last;			u8 recurs;		} tx_clone_ctx __packed;#endif	} __packed;	union {		struct {			u8 validated:1;#ifdef CONFIG_TIPC_CRYPTO			u8 encrypted:1;			u8 decrypted:1;#define SKB_PROBING	1#define SKB_GRACING	2			u8 xmit_type:2;			u8 tx_clone_deferred:1;#endif		};		u8 flags;	};	u8 reserved;#ifdef CONFIG_TIPC_CRYPTO	void *crypto_ctx;#endif} __packed; #define TIPC_SKB_CB(__skb) ((struct tipc_skb_cb *)&((__skb)->cb[0])) struct tipc_msg {	__be32 hdr[15];}; /* struct tipc_gap_ack - TIPC Gap ACK block * @ack: seqno of the last consecutive packet in link deferdq * @gap: number of gap packets since the last ack * * E.g: *       link deferdq: 1 2 3 4      10 11      13 14 15       20 * --> Gap ACK blocks:      <4, 5>,   <11, 1>,      <15, 4>, <20, 0> */struct tipc_gap_ack {	__be16 ack;	__be16 gap;}; /* struct tipc_gap_ack_blks * @len: actual length of the record * @ugack_cnt: number of Gap ACK blocks for unicast (following the broadcast *             ones) * @start_index: starting index for "valid" broadcast Gap ACK blocks * @bgack_cnt: number of Gap ACK blocks for broadcast in the record * @gacks: array of Gap ACK blocks * *  31                       16 15                        0 * +-------------+-------------+-------------+-------------+ * |  bgack_cnt  |  ugack_cnt  |            len            | * +-------------+-------------+-------------+-------------+  - * |            gap            |            ack            |   | * +-------------+-------------+-------------+-------------+    > bc gacks * :                           :                           :   | * +-------------+-------------+-------------+-------------+  - * |            gap            |            ack            |   | * +-------------+-------------+-------------+-------------+    > uc gacks * :                           :                           :   | * +-------------+-------------+-------------+-------------+  - */struct tipc_gap_ack_blks {	__be16 len;	union {		u8 ugack_cnt;		u8 start_index;	};	u8 bgack_cnt;	struct tipc_gap_ack gacks[];}; #define MAX_GAP_ACK_BLKS	128#define MAX_GAP_ACK_BLKS_SZ	(sizeof(struct tipc_gap_ack_blks) + \				 sizeof(struct tipc_gap_ack) * MAX_GAP_ACK_BLKS) static inline struct tipc_msg *buf_msg(struct sk_buff *skb){	return (struct tipc_msg *)skb->data;} static inline u32 msg_word(struct tipc_msg *m, u32 pos){	return ntohl(m->hdr[pos]);} static inline void msg_set_word(struct tipc_msg *m, u32 w, u32 val){	m->hdr[w] = htonl(val);} static inline u32 msg_bits(struct tipc_msg *m, u32 w, u32 pos, u32 mask){	return (msg_word(m, w) >> pos) & mask;} static inline void msg_set_bits(struct tipc_msg *m, u32 w,				u32 pos, u32 mask, u32 val){	val = (val & mask) << pos;	mask = mask << pos;	m->hdr[w] &= ~htonl(mask);	m->hdr[w] |= htonl(val);} /* * Word 0 */static inline u32 msg_version(struct tipc_msg *m){	return msg_bits(m, 0, 29, 7);} static inline void msg_set_version(struct tipc_msg *m){	msg_set_bits(m, 0, 29, 7, TIPC_VERSION);} static inline u32 msg_user(struct tipc_msg *m){	return msg_bits(m, 0, 25, 0xf);} static inline u32 msg_isdata(struct tipc_msg *m){	return msg_user(m) <= TIPC_CRITICAL_IMPORTANCE;} static inline void msg_set_user(struct tipc_msg *m, u32 n){	msg_set_bits(m, 0, 25, 0xf, n);} static inline u32 msg_hdr_sz(struct tipc_msg *m){	return msg_bits(m, 0, 21, 0xf) << 2;} static inline void msg_set_hdr_sz(struct tipc_msg *m, u32 n){	msg_set_bits(m, 0, 21, 0xf, n>>2);} static inline u32 msg_size(struct tipc_msg *m){	return msg_bits(m, 0, 0, 0x1ffff);} static inline u32 msg_blocks(struct tipc_msg *m){	return (msg_size(m) / 1024) + 1;} static inline u32 msg_data_sz(struct tipc_msg *m){	return msg_size(m) - msg_hdr_sz(m);} static inline int msg_non_seq(struct tipc_msg *m){	return msg_bits(m, 0, 20, 1);} static inline void msg_set_non_seq(struct tipc_msg *m, u32 n){	msg_set_bits(m, 0, 20, 1, n);} static inline int msg_is_syn(struct tipc_msg *m){	return msg_bits(m, 0, 17, 1);} static inline void msg_set_syn(struct tipc_msg *m, u32 d){	msg_set_bits(m, 0, 17, 1, d);} static inline int msg_dest_droppable(struct tipc_msg *m){	return msg_bits(m, 0, 19, 1);} static inline void msg_set_dest_droppable(struct tipc_msg *m, u32 d){	msg_set_bits(m, 0, 19, 1, d);} static inline int msg_is_keepalive(struct tipc_msg *m){	return msg_bits(m, 0, 19, 1);} static inline void msg_set_is_keepalive(struct tipc_msg *m, u32 d){	msg_set_bits(m, 0, 19, 1, d);} static inline int msg_src_droppable(struct tipc_msg *m){	return msg_bits(m, 0, 18, 1);} static inline void msg_set_src_droppable(struct tipc_msg *m, u32 d){	msg_set_bits(m, 0, 18, 1, d);} static inline int msg_ack_required(struct tipc_msg *m){	return msg_bits(m, 0, 18, 1);} static inline void msg_set_ack_required(struct tipc_msg *m){	msg_set_bits(m, 0, 18, 1, 1);} static inline int msg_nagle_ack(struct tipc_msg *m){	return msg_bits(m, 0, 18, 1);} static inline void msg_set_nagle_ack(struct tipc_msg *m){	msg_set_bits(m, 0, 18, 1, 1);} static inline bool msg_is_rcast(struct tipc_msg *m){	return msg_bits(m, 0, 18, 0x1);} static inline void msg_set_is_rcast(struct tipc_msg *m, bool d){	msg_set_bits(m, 0, 18, 0x1, d);} static inline void msg_set_size(struct tipc_msg *m, u32 sz){	m->hdr[0] = htonl((msg_word(m, 0) & ~0x1ffff) | sz);} static inline unchar *msg_data(struct tipc_msg *m){	return ((unchar *)m) + msg_hdr_sz(m);} static inline struct tipc_msg *msg_inner_hdr(struct tipc_msg *m){	return (struct tipc_msg *)msg_data(m);} /* * Word 1 */static inline u32 msg_type(struct tipc_msg *m){	return msg_bits(m, 1, 29, 0x7);} static inline void msg_set_type(struct tipc_msg *m, u32 n){	msg_set_bits(m, 1, 29, 0x7, n);} static inline int msg_in_group(struct tipc_msg *m){	int mtyp = msg_type(m); 	return mtyp >= TIPC_GRP_MEMBER_EVT && mtyp <= TIPC_GRP_UCAST_MSG;} static inline bool msg_is_grp_evt(struct tipc_msg *m){	return msg_type(m) == TIPC_GRP_MEMBER_EVT;} static inline u32 msg_named(struct tipc_msg *m){	return msg_type(m) == TIPC_NAMED_MSG;} static inline u32 msg_mcast(struct tipc_msg *m){	int mtyp = msg_type(m); 	return ((mtyp == TIPC_MCAST_MSG) || (mtyp == TIPC_GRP_BCAST_MSG) ||		(mtyp == TIPC_GRP_MCAST_MSG));} static inline u32 msg_connected(struct tipc_msg *m){	return msg_type(m) == TIPC_CONN_MSG;} static inline u32 msg_direct(struct tipc_msg *m){	return msg_type(m) == TIPC_DIRECT_MSG;} static inline u32 msg_errcode(struct tipc_msg *m){	return msg_bits(m, 1, 25, 0xf);} static inline void msg_set_errcode(struct tipc_msg *m, u32 err){	msg_set_bits(m, 1, 25, 0xf, err);} static inline void msg_set_bulk(struct tipc_msg *m){	msg_set_bits(m, 1, 28, 0x1, 1);} static inline u32 msg_is_bulk(struct tipc_msg *m){	return msg_bits(m, 1, 28, 0x1);} static inline void msg_set_last_bulk(struct tipc_msg *m){	msg_set_bits(m, 1, 27, 0x1, 1);} static inline u32 msg_is_last_bulk(struct tipc_msg *m){	return msg_bits(m, 1, 27, 0x1);} static inline void msg_set_non_legacy(struct tipc_msg *m){	msg_set_bits(m, 1, 26, 0x1, 1);} static inline u32 msg_is_legacy(struct tipc_msg *m){	return !msg_bits(m, 1, 26, 0x1);} static inline u32 msg_reroute_cnt(struct tipc_msg *m){	return msg_bits(m, 1, 21, 0xf);} static inline void msg_incr_reroute_cnt(struct tipc_msg *m){	msg_set_bits(m, 1, 21, 0xf, msg_reroute_cnt(m) + 1);} static inline u32 msg_lookup_scope(struct tipc_msg *m){	return msg_bits(m, 1, 19, 0x3);} static inline void msg_set_lookup_scope(struct tipc_msg *m, u32 n){	msg_set_bits(m, 1, 19, 0x3, n);} static inline u16 msg_bcast_ack(struct tipc_msg *m){	return msg_bits(m, 1, 0, 0xffff);} static inline void msg_set_bcast_ack(struct tipc_msg *m, u16 n){	msg_set_bits(m, 1, 0, 0xffff, n);} /* Note: reusing bits in word 1 for ACTIVATE_MSG only, to re-synch * link peer session number */static inline bool msg_dest_session_valid(struct tipc_msg *m){	return msg_bits(m, 1, 16, 0x1);

Lines 1–500 of 1310.