[deliverable/linux.git] / net / tipc / msg.h

/*
 * net/tipc/msg.h: Include file for TIPC message header routines
 *
 * Copyright (c) 2000-2007, Ericsson AB
 * Copyright (c) 2005-2007, 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 "core.h"

#define TIPC_VERSION              2
#define DATA_LOW                  TIPC_LOW_IMPORTANCE
#define DATA_MEDIUM               TIPC_MEDIUM_IMPORTANCE
#define DATA_HIGH                 TIPC_HIGH_IMPORTANCE
#define DATA_CRITICAL             TIPC_CRITICAL_IMPORTANCE
#define SHORT_H_SIZE              24	/* Connected,in cluster */
#define DIR_MSG_H_SIZE            32	/* Directly addressed messages */
#define CONN_MSG_H_SIZE           36	/* Routed connected msgs*/
#define LONG_H_SIZE               40	/* Named Messages */
#define MCAST_H_SIZE              44	/* Multicast messages */
#define MAX_H_SIZE                60	/* Inclusive full options */
#define MAX_MSG_SIZE (MAX_H_SIZE + TIPC_MAX_USER_MSG_SIZE)
#define LINK_CONFIG               13


/*
		TIPC user data message header format, version 2

	- Fundamental definitions available to privileged TIPC users
	  are located in tipc_msg.h.
	- Remaining definitions available to TIPC internal users appear below.
*/


static inline void msg_set_word(struct tipc_msg *m, u32 w, u32 val)
{
	m->hdr[w] = htonl(val);
}

static inline void msg_set_bits(struct tipc_msg *m, u32 w,
				u32 pos, u32 mask, u32 val)
{
	val = (val & mask) << pos;
	m->hdr[w] &= ~htonl(mask << pos);
	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, 0xf, 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) <= DATA_CRITICAL);
}

static inline void msg_set_user(struct tipc_msg *m, u32 n)
{
	msg_set_bits(m, 0, 25, 0xf, n);
}

static inline void msg_set_importance(struct tipc_msg *m, u32 i)
{
	msg_set_user(m, i);
}

static inline void msg_set_hdr_sz(struct tipc_msg *m,u32 n)
{
	msg_set_bits(m, 0, 21, 0xf, n>>2);
}

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)
{
	msg_set_bits(m, 0, 20, 1, 1);
}

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_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 void msg_set_size(struct tipc_msg *m, u32 sz)
{
	m->hdr[0] = htonl((msg_word(m, 0) & ~0x1ffff) | sz);
}


/*
 * Word 1
 */

static inline void msg_set_type(struct tipc_msg *m, u32 n)
{
	msg_set_bits(m, 1, 29, 0x7, n);
}

static inline void msg_set_errcode(struct tipc_msg *m, u32 err)
{
	msg_set_bits(m, 1, 25, 0xf, err);
}

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 void msg_reset_reroute_cnt(struct tipc_msg *m)
{
	msg_set_bits(m, 1, 21, 0xf, 0);
}

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 u32 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, u32 n)
{
	msg_set_bits(m, 1, 0, 0xffff, n);
}


/*
 * Word 2
 */

static inline u32 msg_ack(struct tipc_msg *m)
{
	return msg_bits(m, 2, 16, 0xffff);
}

static inline void msg_set_ack(struct tipc_msg *m, u32 n)
{
	msg_set_bits(m, 2, 16, 0xffff, n);
}

static inline u32 msg_seqno(struct tipc_msg *m)
{
	return msg_bits(m, 2, 0, 0xffff);
}

static inline void msg_set_seqno(struct tipc_msg *m, u32 n)
{
	msg_set_bits(m, 2, 0, 0xffff, n);
}


/*
 * Words 3-10
 */


static inline void msg_set_prevnode(struct tipc_msg *m, u32 a)
{
	msg_set_word(m, 3, a);
}

static inline void msg_set_origport(struct tipc_msg *m, u32 p)
{
	msg_set_word(m, 4, p);
}

static inline void msg_set_destport(struct tipc_msg *m, u32 p)
{
	msg_set_word(m, 5, p);
}

static inline void msg_set_mc_netid(struct tipc_msg *m, u32 p)
{
	msg_set_word(m, 5, p);
}

static inline void msg_set_orignode(struct tipc_msg *m, u32 a)
{
	msg_set_word(m, 6, a);
}

static inline void msg_set_destnode(struct tipc_msg *m, u32 a)
{
	msg_set_word(m, 7, a);
}

static inline int msg_is_dest(struct tipc_msg *m, u32 d)
{
	return(msg_short(m) || (msg_destnode(m) == d));
}

static inline u32 msg_routed(struct tipc_msg *m)
{
	if (likely(msg_short(m)))
		return 0;
	return(msg_destnode(m) ^ msg_orignode(m)) >> 11;
}

static inline void msg_set_nametype(struct tipc_msg *m, u32 n)
{
	msg_set_word(m, 8, n);
}

static inline u32 msg_transp_seqno(struct tipc_msg *m)
{
	return msg_word(m, 8);
}

static inline void msg_set_timestamp(struct tipc_msg *m, u32 n)
{
	msg_set_word(m, 8, n);
}

static inline u32 msg_timestamp(struct tipc_msg *m)
{
	return msg_word(m, 8);
}

static inline void msg_set_transp_seqno(struct tipc_msg *m, u32 n)
{
	msg_set_word(m, 8, n);
}

static inline void msg_set_namelower(struct tipc_msg *m, u32 n)
{
	msg_set_word(m, 9, n);
}

static inline void msg_set_nameinst(struct tipc_msg *m, u32 n)
{
	msg_set_namelower(m, n);
}

static inline void msg_set_nameupper(struct tipc_msg *m, u32 n)
{
	msg_set_word(m, 10, n);
}

static inline struct tipc_msg *msg_get_wrapped(struct tipc_msg *m)
{
	return (struct tipc_msg *)msg_data(m);
}


/*
		TIPC internal message header format, version 2

       1 0 9 8 7 6 5 4|3 2 1 0 9 8 7 6|5 4 3 2 1 0 9 8|7 6 5 4 3 2 1 0
      +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
   w0:|vers |msg usr|hdr sz |n|resrv|            packet size          |
      +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
   w1:|m typ|rsv=0|   sequence gap    |       broadcast ack no        |
      +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
   w2:| link level ack no/bc_gap_from |     seq no / bcast_gap_to     |
      +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
   w3:|                       previous node                           |
      +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
   w4:|  next sent broadcast/fragm no | next sent pkt/ fragm msg no   |
      +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
   w5:|          session no           |rsv=0|r|berid|link prio|netpl|p|
      +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
   w6:|                      originating node                         |
      +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
   w7:|                      destination node                         |
      +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
   w8:|                   transport sequence number                   |
      +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
   w9:|   msg count / bcast tag       |       link tolerance          |
      +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
      \                                                               \
      /                     User Specific Data                        /
      \                                                               \
      +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+

      NB: CONN_MANAGER use data message format. LINK_CONFIG has own format.
*/

/*
 * Internal users
 */

#define  BCAST_PROTOCOL       5
#define  MSG_BUNDLER          6
#define  LINK_PROTOCOL        7
#define  CONN_MANAGER         8
#define  ROUTE_DISTRIBUTOR    9
#define  CHANGEOVER_PROTOCOL  10
#define  NAME_DISTRIBUTOR     11
#define  MSG_FRAGMENTER       12
#define  LINK_CONFIG          13
#define  INT_H_SIZE           40
#define  DSC_H_SIZE           40

/*
 *  Connection management protocol messages
 */

#define CONN_PROBE        0
#define CONN_PROBE_REPLY  1
#define CONN_ACK          2

/*
 * Name distributor messages
 */

#define PUBLICATION       0
#define WITHDRAWAL        1


/*
 * Word 1
 */

static inline u32 msg_seq_gap(struct tipc_msg *m)
{
	return msg_bits(m, 1, 16, 0xff);
}

static inline void msg_set_seq_gap(struct tipc_msg *m, u32 n)
{
	msg_set_bits(m, 1, 16, 0xff, n);
}

static inline u32 msg_req_links(struct tipc_msg *m)
{
	return msg_bits(m, 1, 16, 0xfff);
}

static inline void msg_set_req_links(struct tipc_msg *m, u32 n)
{
	msg_set_bits(m, 1, 16, 0xfff, n);
}


/*
 * Word 2
 */

static inline u32 msg_dest_domain(struct tipc_msg *m)
{
	return msg_word(m, 2);
}

static inline void msg_set_dest_domain(struct tipc_msg *m, u32 n)
{
	msg_set_word(m, 2, n);
}

static inline u32 msg_bcgap_after(struct tipc_msg *m)
{
	return msg_bits(m, 2, 16, 0xffff);
}

static inline void msg_set_bcgap_after(struct tipc_msg *m, u32 n)
{
	msg_set_bits(m, 2, 16, 0xffff, n);
}

static inline u32 msg_bcgap_to(struct tipc_msg *m)
{
	return msg_bits(m, 2, 0, 0xffff);
}

static inline void msg_set_bcgap_to(struct tipc_msg *m, u32 n)
{
	msg_set_bits(m, 2, 0, 0xffff, n);
}


/*
 * Word 4
 */

static inline u32 msg_last_bcast(struct tipc_msg *m)
{
	return msg_bits(m, 4, 16, 0xffff);
}

static inline void msg_set_last_bcast(struct tipc_msg *m, u32 n)
{
	msg_set_bits(m, 4, 16, 0xffff, n);
}


static inline u32 msg_fragm_no(struct tipc_msg *m)
{
	return msg_bits(m, 4, 16, 0xffff);
}

static inline void msg_set_fragm_no(struct tipc_msg *m, u32 n)
{
	msg_set_bits(m, 4, 16, 0xffff, n);
}


static inline u32 msg_next_sent(struct tipc_msg *m)
{
	return msg_bits(m, 4, 0, 0xffff);
}

static inline void msg_set_next_sent(struct tipc_msg *m, u32 n)
{
	msg_set_bits(m, 4, 0, 0xffff, n);
}


static inline u32 msg_long_msgno(struct tipc_msg *m)
{
	return msg_bits(m, 4, 0, 0xffff);
}

static inline void msg_set_long_msgno(struct tipc_msg *m, u32 n)
{
	msg_set_bits(m, 4, 0, 0xffff, n);
}

static inline u32 msg_bc_netid(struct tipc_msg *m)
{
	return msg_word(m, 4);
}

static inline void msg_set_bc_netid(struct tipc_msg *m, u32 id)
{
	msg_set_word(m, 4, id);
}

static inline u32 msg_link_selector(struct tipc_msg *m)
{
	return msg_bits(m, 4, 0, 1);
}

static inline void msg_set_link_selector(struct tipc_msg *m, u32 n)
{
	msg_set_bits(m, 4, 0, 1, (n & 1));
}

/*
 * Word 5
 */

static inline u32 msg_session(struct tipc_msg *m)
{
	return msg_bits(m, 5, 16, 0xffff);
}

static inline void msg_set_session(struct tipc_msg *m, u32 n)
{
	msg_set_bits(m, 5, 16, 0xffff, n);
}

static inline u32 msg_probe(struct tipc_msg *m)
{
	return msg_bits(m, 5, 0, 1);
}

static inline void msg_set_probe(struct tipc_msg *m, u32 val)
{
	msg_set_bits(m, 5, 0, 1, (val & 1));
}

static inline char msg_net_plane(struct tipc_msg *m)
{
	return msg_bits(m, 5, 1, 7) + 'A';
}

static inline void msg_set_net_plane(struct tipc_msg *m, char n)
{
	msg_set_bits(m, 5, 1, 7, (n - 'A'));
}

static inline u32 msg_linkprio(struct tipc_msg *m)
{
	return msg_bits(m, 5, 4, 0x1f);
}

static inline void msg_set_linkprio(struct tipc_msg *m, u32 n)
{
	msg_set_bits(m, 5, 4, 0x1f, n);
}

static inline u32 msg_bearer_id(struct tipc_msg *m)
{
	return msg_bits(m, 5, 9, 0x7);
}

static inline void msg_set_bearer_id(struct tipc_msg *m, u32 n)
{
	msg_set_bits(m, 5, 9, 0x7, n);
}

static inline u32 msg_redundant_link(struct tipc_msg *m)
{
	return msg_bits(m, 5, 12, 0x1);
}

static inline void msg_set_redundant_link(struct tipc_msg *m)
{
	msg_set_bits(m, 5, 12, 0x1, 1);
}

static inline void msg_clear_redundant_link(struct tipc_msg *m)
{
	msg_set_bits(m, 5, 12, 0x1, 0);
}


/*
 * Word 9
 */

static inline u32 msg_msgcnt(struct tipc_msg *m)
{
	return msg_bits(m, 9, 16, 0xffff);
}

static inline void msg_set_msgcnt(struct tipc_msg *m, u32 n)
{
	msg_set_bits(m, 9, 16, 0xffff, n);
}

static inline u32 msg_bcast_tag(struct tipc_msg *m)
{
	return msg_bits(m, 9, 16, 0xffff);
}

static inline void msg_set_bcast_tag(struct tipc_msg *m, u32 n)
{
	msg_set_bits(m, 9, 16, 0xffff, n);
}

static inline u32 msg_max_pkt(struct tipc_msg *m)
{
	return (msg_bits(m, 9, 16, 0xffff) * 4);
}

static inline void msg_set_max_pkt(struct tipc_msg *m, u32 n)
{
	msg_set_bits(m, 9, 16, 0xffff, (n / 4));
}

static inline u32 msg_link_tolerance(struct tipc_msg *m)
{
	return msg_bits(m, 9, 0, 0xffff);
}

static inline void msg_set_link_tolerance(struct tipc_msg *m, u32 n)
{
	msg_set_bits(m, 9, 0, 0xffff, n);
}

/*
 * Routing table message data
 */


static inline u32 msg_remote_node(struct tipc_msg *m)
{
	return msg_word(m, msg_hdr_sz(m)/4);
}

static inline void msg_set_remote_node(struct tipc_msg *m, u32 a)
{
	msg_set_word(m, msg_hdr_sz(m)/4, a);
}

static inline void msg_set_dataoctet(struct tipc_msg *m, u32 pos)
{
	msg_data(m)[pos + 4] = 1;
}

/*
 * Segmentation message types
 */

#define FIRST_FRAGMENT     0
#define FRAGMENT           1
#define LAST_FRAGMENT      2

/*
 * Link management protocol message types
 */

#define STATE_MSG       0
#define RESET_MSG       1
#define ACTIVATE_MSG    2

/*
 * Changeover tunnel message types
 */
#define DUPLICATE_MSG    0
#define ORIGINAL_MSG     1

/*
 * Routing table message types
 */
#define EXT_ROUTING_TABLE    0
#define LOCAL_ROUTING_TABLE  1
#define SLAVE_ROUTING_TABLE  2
#define ROUTE_ADDITION       3
#define ROUTE_REMOVAL        4

/*
 * Config protocol message types
 */

#define DSC_REQ_MSG          0
#define DSC_RESP_MSG         1

static inline u32 msg_tot_importance(struct tipc_msg *m)
{
	if (likely(msg_isdata(m))) {
		if (likely(msg_orignode(m) == tipc_own_addr))
			return msg_importance(m);
		return msg_importance(m) + 4;
	}
	if ((msg_user(m) == MSG_FRAGMENTER)  &&
	    (msg_type(m) == FIRST_FRAGMENT))
		return msg_importance(msg_get_wrapped(m));
	return msg_importance(m);
}


static inline void msg_init(struct tipc_msg *m, u32 user, u32 type,
			    u32 err, u32 hsize, u32 destnode)
{
	memset(m, 0, hsize);
	msg_set_version(m);
	msg_set_user(m, user);
	msg_set_hdr_sz(m, hsize);
	msg_set_size(m, hsize);
	msg_set_prevnode(m, tipc_own_addr);
	msg_set_type(m, type);
	msg_set_errcode(m, err);
	if (!msg_short(m)) {
		msg_set_orignode(m, tipc_own_addr);
		msg_set_destnode(m, destnode);
	}
}

/**
 * msg_calc_data_size - determine total data size for message
 */

static inline int msg_calc_data_size(struct iovec const *msg_sect, u32 num_sect)
{
	int dsz = 0;
	int i;

	for (i = 0; i < num_sect; i++)
		dsz += msg_sect[i].iov_len;
	return dsz;
}

/**
 * msg_build - create message using specified header and data
 *
 * Note: Caller must not hold any locks in case copy_from_user() is interrupted!
 *
 * Returns message data size or errno
 */

static inline int msg_build(struct tipc_msg *hdr,
			    struct iovec const *msg_sect, u32 num_sect,
			    int max_size, int usrmem, struct sk_buff** buf)
{
	int dsz, sz, hsz, pos, res, cnt;

	dsz = msg_calc_data_size(msg_sect, num_sect);
	if (unlikely(dsz > TIPC_MAX_USER_MSG_SIZE)) {
		*buf = NULL;
		return -EINVAL;
	}

	pos = hsz = msg_hdr_sz(hdr);
	sz = hsz + dsz;
	msg_set_size(hdr, sz);
	if (unlikely(sz > max_size)) {
		*buf = NULL;
		return dsz;
	}

	*buf = buf_acquire(sz);
	if (!(*buf))
		return -ENOMEM;
	skb_copy_to_linear_data(*buf, hdr, hsz);
	for (res = 1, cnt = 0; res && (cnt < num_sect); cnt++) {
		if (likely(usrmem))
			res = !copy_from_user((*buf)->data + pos,
					      msg_sect[cnt].iov_base,
					      msg_sect[cnt].iov_len);
		else
			skb_copy_to_linear_data_offset(*buf, pos,
						       msg_sect[cnt].iov_base,
						       msg_sect[cnt].iov_len);
		pos += msg_sect[cnt].iov_len;
	}
	if (likely(res))
		return dsz;

	buf_discard(*buf);
	*buf = NULL;
	return -EFAULT;
}

static inline void msg_set_media_addr(struct tipc_msg *m, struct tipc_media_addr *a)
{
	memcpy(&((int *)m)[5], a, sizeof(*a));
}

static inline void msg_get_media_addr(struct tipc_msg *m, struct tipc_media_addr *a)
{
	memcpy(a, &((int*)m)[5], sizeof(*a));
}

#endif
Commit	Line	Data
b97bf3fd PL	1	/*
b97bf3fd PL	2	* net/tipc/msg.h: Include file for TIPC message header routines
c4307285	3	*
1f9eda7e AS	4	* Copyright (c) 2000-2007, Ericsson AB
1f9eda7e AS	5	* Copyright (c) 2005-2007, Wind River Systems
b97bf3fd PL	6	* All rights reserved.
b97bf3fd PL	7	*
9ea1fd3c	8	* Redistribution and use in source and binary forms, with or without
b97bf3fd PL	9	* modification, are permitted provided that the following conditions are met:
b97bf3fd PL	10	*
9ea1fd3c PL	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.
b97bf3fd	19	*
9ea1fd3c PL	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
b97bf3fd PL	34	* POSSIBILITY OF SUCH DAMAGE.
	35	*/
	36
	37	#ifndef _TIPC_MSG_H
	38	#define _TIPC_MSG_H
	39
5f7c3ff6	40	#include "core.h"
b97bf3fd PL	41
	42	#define TIPC_VERSION 2
	43	#define DATA_LOW TIPC_LOW_IMPORTANCE
	44	#define DATA_MEDIUM TIPC_MEDIUM_IMPORTANCE
	45	#define DATA_HIGH TIPC_HIGH_IMPORTANCE
	46	#define DATA_CRITICAL TIPC_CRITICAL_IMPORTANCE
	47	#define SHORT_H_SIZE 24 /* Connected,in cluster */
	48	#define DIR_MSG_H_SIZE 32 /* Directly addressed messages */
	49	#define CONN_MSG_H_SIZE 36 /* Routed connected msgs*/
	50	#define LONG_H_SIZE 40 /* Named Messages */
	51	#define MCAST_H_SIZE 44 /* Multicast messages */
	52	#define MAX_H_SIZE 60 /* Inclusive full options */
	53	#define MAX_MSG_SIZE (MAX_H_SIZE + TIPC_MAX_USER_MSG_SIZE)
	54	#define LINK_CONFIG 13
	55
	56
	57	/*
	58	TIPC user data message header format, version 2
c4307285	59
b97bf3fd PL	60	- Fundamental definitions available to privileged TIPC users
b97bf3fd PL	61	are located in tipc_msg.h.
c4307285	62	- Remaining definitions available to TIPC internal users appear below.
b97bf3fd PL	63	*/
	64
	65
	66	static inline void msg_set_word(struct tipc_msg *m, u32 w, u32 val)
	67	{
	68	m->hdr[w] = htonl(val);
	69	}
	70
	71	static inline void msg_set_bits(struct tipc_msg *m, u32 w,
	72	u32 pos, u32 mask, u32 val)
	73	{
1f9eda7e	74	val = (val & mask) << pos;
582ee43d AV	75	m->hdr[w] &= ~htonl(mask << pos);
582ee43d AV	76	m->hdr[w] \|= htonl(val);
b97bf3fd PL	77	}
b97bf3fd PL	78
c4307285	79	/*
b97bf3fd PL	80	* Word 0
	81	*/
	82
	83	static inline u32 msg_version(struct tipc_msg *m)
	84	{
	85	return msg_bits(m, 0, 29, 7);
	86	}
	87
c4307285	88	static inline void msg_set_version(struct tipc_msg *m)
b97bf3fd PL	89	{
	90	msg_set_bits(m, 0, 29, 0xf, TIPC_VERSION);
	91	}
	92
	93	static inline u32 msg_user(struct tipc_msg *m)
	94	{
	95	return msg_bits(m, 0, 25, 0xf);
	96	}
	97
	98	static inline u32 msg_isdata(struct tipc_msg *m)
	99	{
	100	return (msg_user(m) <= DATA_CRITICAL);
	101	}
	102
c4307285	103	static inline void msg_set_user(struct tipc_msg *m, u32 n)
b97bf3fd PL	104	{
	105	msg_set_bits(m, 0, 25, 0xf, n);
	106	}
	107
c4307285	108	static inline void msg_set_importance(struct tipc_msg *m, u32 i)
b97bf3fd PL	109	{
	110	msg_set_user(m, i);
	111	}
	112
c4307285	113	static inline void msg_set_hdr_sz(struct tipc_msg *m,u32 n)
b97bf3fd PL	114	{
	115	msg_set_bits(m, 0, 21, 0xf, n>>2);
	116	}
	117
c4307285	118	static inline int msg_non_seq(struct tipc_msg *m)
b97bf3fd PL	119	{
	120	return msg_bits(m, 0, 20, 1);
	121	}
	122
c4307285	123	static inline void msg_set_non_seq(struct tipc_msg *m)
b97bf3fd PL	124	{
	125	msg_set_bits(m, 0, 20, 1, 1);
	126	}
	127
c4307285	128	static inline int msg_dest_droppable(struct tipc_msg *m)
b97bf3fd PL	129	{
	130	return msg_bits(m, 0, 19, 1);
	131	}
	132
c4307285	133	static inline void msg_set_dest_droppable(struct tipc_msg *m, u32 d)
b97bf3fd PL	134	{
	135	msg_set_bits(m, 0, 19, 1, d);
	136	}
	137
c4307285	138	static inline int msg_src_droppable(struct tipc_msg *m)
b97bf3fd PL	139	{
	140	return msg_bits(m, 0, 18, 1);
	141	}
	142
c4307285	143	static inline void msg_set_src_droppable(struct tipc_msg *m, u32 d)
b97bf3fd PL	144	{
	145	msg_set_bits(m, 0, 18, 1, d);
	146	}
	147
	148	static inline void msg_set_size(struct tipc_msg *m, u32 sz)
	149	{
	150	m->hdr[0] = htonl((msg_word(m, 0) & ~0x1ffff) \| sz);
	151	}
	152
	153
c4307285	154	/*
b97bf3fd PL	155	* Word 1
	156	*/
	157
c4307285	158	static inline void msg_set_type(struct tipc_msg *m, u32 n)
b97bf3fd PL	159	{
	160	msg_set_bits(m, 1, 29, 0x7, n);
	161	}
	162
c4307285	163	static inline void msg_set_errcode(struct tipc_msg *m, u32 err)
b97bf3fd PL	164	{
	165	msg_set_bits(m, 1, 25, 0xf, err);
	166	}
	167
c4307285	168	static inline u32 msg_reroute_cnt(struct tipc_msg *m)
b97bf3fd PL	169	{
	170	return msg_bits(m, 1, 21, 0xf);
	171	}
	172
c4307285	173	static inline void msg_incr_reroute_cnt(struct tipc_msg *m)
b97bf3fd PL	174	{
	175	msg_set_bits(m, 1, 21, 0xf, msg_reroute_cnt(m) + 1);
	176	}
	177
c4307285	178	static inline void msg_reset_reroute_cnt(struct tipc_msg *m)
b97bf3fd PL	179	{
	180	msg_set_bits(m, 1, 21, 0xf, 0);
	181	}
	182
	183	static inline u32 msg_lookup_scope(struct tipc_msg *m)
	184	{
	185	return msg_bits(m, 1, 19, 0x3);
	186	}
	187
c4307285	188	static inline void msg_set_lookup_scope(struct tipc_msg *m, u32 n)
b97bf3fd PL	189	{
	190	msg_set_bits(m, 1, 19, 0x3, n);
	191	}
	192
b97bf3fd PL	193	static inline u32 msg_bcast_ack(struct tipc_msg *m)
	194	{
	195	return msg_bits(m, 1, 0, 0xffff);
	196	}
	197
c4307285	198	static inline void msg_set_bcast_ack(struct tipc_msg *m, u32 n)
b97bf3fd PL	199	{
	200	msg_set_bits(m, 1, 0, 0xffff, n);
	201	}
	202
	203
c4307285	204	/*
b97bf3fd PL	205	* Word 2
	206	*/
	207
	208	static inline u32 msg_ack(struct tipc_msg *m)
	209	{
	210	return msg_bits(m, 2, 16, 0xffff);
	211	}
	212
c4307285	213	static inline void msg_set_ack(struct tipc_msg *m, u32 n)
b97bf3fd PL	214	{
	215	msg_set_bits(m, 2, 16, 0xffff, n);
	216	}
	217
	218	static inline u32 msg_seqno(struct tipc_msg *m)
	219	{
	220	return msg_bits(m, 2, 0, 0xffff);
	221	}
	222
c4307285	223	static inline void msg_set_seqno(struct tipc_msg *m, u32 n)
b97bf3fd PL	224	{
	225	msg_set_bits(m, 2, 0, 0xffff, n);
	226	}
	227
	228
c4307285	229	/*
b97bf3fd PL	230	* Words 3-10
	231	*/
	232
	233
c4307285	234	static inline void msg_set_prevnode(struct tipc_msg *m, u32 a)
b97bf3fd PL	235	{
	236	msg_set_word(m, 3, a);
	237	}
	238
c4307285	239	static inline void msg_set_origport(struct tipc_msg *m, u32 p)
b97bf3fd PL	240	{
	241	msg_set_word(m, 4, p);
	242	}
	243
c4307285	244	static inline void msg_set_destport(struct tipc_msg *m, u32 p)
b97bf3fd PL	245	{
	246	msg_set_word(m, 5, p);
	247	}
	248
c4307285	249	static inline void msg_set_mc_netid(struct tipc_msg *m, u32 p)
b97bf3fd PL	250	{
	251	msg_set_word(m, 5, p);
	252	}
	253
c4307285	254	static inline void msg_set_orignode(struct tipc_msg *m, u32 a)
b97bf3fd PL	255	{
	256	msg_set_word(m, 6, a);
	257	}
	258
c4307285	259	static inline void msg_set_destnode(struct tipc_msg *m, u32 a)
b97bf3fd PL	260	{
	261	msg_set_word(m, 7, a);
	262	}
	263
c4307285	264	static inline int msg_is_dest(struct tipc_msg *m, u32 d)
b97bf3fd PL	265	{
	266	return(msg_short(m) \|\| (msg_destnode(m) == d));
	267	}
	268
	269	static inline u32 msg_routed(struct tipc_msg *m)
	270	{
	271	if (likely(msg_short(m)))
	272	return 0;
	273	return(msg_destnode(m) ^ msg_orignode(m)) >> 11;
	274	}
	275
c4307285	276	static inline void msg_set_nametype(struct tipc_msg *m, u32 n)
b97bf3fd PL	277	{
	278	msg_set_word(m, 8, n);
	279	}
	280
	281	static inline u32 msg_transp_seqno(struct tipc_msg *m)
	282	{
	283	return msg_word(m, 8);
	284	}
	285
	286	static inline void msg_set_timestamp(struct tipc_msg *m, u32 n)
	287	{
	288	msg_set_word(m, 8, n);
	289	}
	290
	291	static inline u32 msg_timestamp(struct tipc_msg *m)
	292	{
	293	return msg_word(m, 8);
	294	}
	295
	296	static inline void msg_set_transp_seqno(struct tipc_msg *m, u32 n)
	297	{
	298	msg_set_word(m, 8, n);
	299	}
	300
c4307285	301	static inline void msg_set_namelower(struct tipc_msg *m, u32 n)
b97bf3fd PL	302	{
	303	msg_set_word(m, 9, n);
	304	}
	305
c4307285	306	static inline void msg_set_nameinst(struct tipc_msg *m, u32 n)
b97bf3fd PL	307	{
	308	msg_set_namelower(m, n);
	309	}
	310
c4307285	311	static inline void msg_set_nameupper(struct tipc_msg *m, u32 n)
b97bf3fd PL	312	{
	313	msg_set_word(m, 10, n);
	314	}
	315
	316	static inline struct tipc_msg msg_get_wrapped(struct tipc_msg m)
	317	{
	318	return (struct tipc_msg *)msg_data(m);
	319	}
	320
b97bf3fd PL	321
	322	/*
	323	TIPC internal message header format, version 2
	324
c4307285	325	1 0 9 8 7 6 5 4\|3 2 1 0 9 8 7 6\|5 4 3 2 1 0 9 8\|7 6 5 4 3 2 1 0
b97bf3fd PL	326	+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
	327	w0:\|vers \|msg usr\|hdr sz \|n\|resrv\| packet size \|
	328	+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
	329	w1:\|m typ\|rsv=0\| sequence gap \| broadcast ack no \|
	330	+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
	331	w2:\| link level ack no/bc_gap_from \| seq no / bcast_gap_to \|
	332	+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
	333	w3:\| previous node \|
	334	+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
	335	w4:\| next sent broadcast/fragm no \| next sent pkt/ fragm msg no \|
	336	+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
	337	w5:\| session no \|rsv=0\|r\|berid\|link prio\|netpl\|p\|
	338	+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
	339	w6:\| originating node \|
	340	+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
	341	w7:\| destination node \|
	342	+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
	343	w8:\| transport sequence number \|
	344	+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
	345	w9:\| msg count / bcast tag \| link tolerance \|
	346	+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
	347	\ \
	348	/ User Specific Data /
	349	\ \
	350	+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
	351
	352	NB: CONN_MANAGER use data message format. LINK_CONFIG has own format.
c4307285	353	*/
b97bf3fd	354
c4307285	355	/*
b97bf3fd PL	356	* Internal users
	357	*/
	358
	359	#define BCAST_PROTOCOL 5
	360	#define MSG_BUNDLER 6
	361	#define LINK_PROTOCOL 7
	362	#define CONN_MANAGER 8
	363	#define ROUTE_DISTRIBUTOR 9
	364	#define CHANGEOVER_PROTOCOL 10
	365	#define NAME_DISTRIBUTOR 11
	366	#define MSG_FRAGMENTER 12
	367	#define LINK_CONFIG 13
	368	#define INT_H_SIZE 40
	369	#define DSC_H_SIZE 40
	370
c4307285	371	/*
b97bf3fd PL	372	* Connection management protocol messages
	373	*/
	374
	375	#define CONN_PROBE 0
	376	#define CONN_PROBE_REPLY 1
	377	#define CONN_ACK 2
	378
c4307285	379	/*
b97bf3fd PL	380	* Name distributor messages
	381	*/
	382
	383	#define PUBLICATION 0
	384	#define WITHDRAWAL 1
	385
	386
c4307285	387	/*
b97bf3fd PL	388	* Word 1
	389	*/
	390
	391	static inline u32 msg_seq_gap(struct tipc_msg *m)
	392	{
	393	return msg_bits(m, 1, 16, 0xff);
	394	}
	395
	396	static inline void msg_set_seq_gap(struct tipc_msg *m, u32 n)
	397	{
	398	msg_set_bits(m, 1, 16, 0xff, n);
	399	}
	400
	401	static inline u32 msg_req_links(struct tipc_msg *m)
	402	{
	403	return msg_bits(m, 1, 16, 0xfff);
	404	}
	405
c4307285	406	static inline void msg_set_req_links(struct tipc_msg *m, u32 n)
b97bf3fd PL	407	{
	408	msg_set_bits(m, 1, 16, 0xfff, n);
	409	}
	410
	411
c4307285	412	/*
b97bf3fd PL	413	* Word 2
	414	*/
	415
	416	static inline u32 msg_dest_domain(struct tipc_msg *m)
	417	{
	418	return msg_word(m, 2);
	419	}
	420
c4307285	421	static inline void msg_set_dest_domain(struct tipc_msg *m, u32 n)
b97bf3fd PL	422	{
	423	msg_set_word(m, 2, n);
	424	}
	425
	426	static inline u32 msg_bcgap_after(struct tipc_msg *m)
	427	{
	428	return msg_bits(m, 2, 16, 0xffff);
	429	}
	430
	431	static inline void msg_set_bcgap_after(struct tipc_msg *m, u32 n)
	432	{
	433	msg_set_bits(m, 2, 16, 0xffff, n);
	434	}
	435
	436	static inline u32 msg_bcgap_to(struct tipc_msg *m)
	437	{
	438	return msg_bits(m, 2, 0, 0xffff);
	439	}
	440
c4307285	441	static inline void msg_set_bcgap_to(struct tipc_msg *m, u32 n)
b97bf3fd PL	442	{
	443	msg_set_bits(m, 2, 0, 0xffff, n);
	444	}
	445
	446
c4307285	447	/*
b97bf3fd PL	448	* Word 4
	449	*/
	450
	451	static inline u32 msg_last_bcast(struct tipc_msg *m)
	452	{
	453	return msg_bits(m, 4, 16, 0xffff);
	454	}
	455
	456	static inline void msg_set_last_bcast(struct tipc_msg *m, u32 n)
	457	{
	458	msg_set_bits(m, 4, 16, 0xffff, n);
	459	}
	460
	461
	462	static inline u32 msg_fragm_no(struct tipc_msg *m)
	463	{
	464	return msg_bits(m, 4, 16, 0xffff);
	465	}
	466
	467	static inline void msg_set_fragm_no(struct tipc_msg *m, u32 n)
	468	{
	469	msg_set_bits(m, 4, 16, 0xffff, n);
	470	}
	471
	472
	473	static inline u32 msg_next_sent(struct tipc_msg *m)
	474	{
	475	return msg_bits(m, 4, 0, 0xffff);
	476	}
	477
	478	static inline void msg_set_next_sent(struct tipc_msg *m, u32 n)
	479	{
	480	msg_set_bits(m, 4, 0, 0xffff, n);
	481	}
	482
	483
	484	static inline u32 msg_long_msgno(struct tipc_msg *m)
	485	{
	486	return msg_bits(m, 4, 0, 0xffff);
	487	}
	488
	489	static inline void msg_set_long_msgno(struct tipc_msg *m, u32 n)
	490	{
	491	msg_set_bits(m, 4, 0, 0xffff, n);
	492	}
	493
	494	static inline u32 msg_bc_netid(struct tipc_msg *m)
	495	{
	496	return msg_word(m, 4);
	497	}
	498
	499	static inline void msg_set_bc_netid(struct tipc_msg *m, u32 id)
	500	{
	501	msg_set_word(m, 4, id);
	502	}
	503
	504	static inline u32 msg_link_selector(struct tipc_msg *m)
	505	{
	506	return msg_bits(m, 4, 0, 1);
	507	}
	508
	509	static inline void msg_set_link_selector(struct tipc_msg *m, u32 n)
	510	{
	511	msg_set_bits(m, 4, 0, 1, (n & 1));
512	}
513
c4307285	514	/*
b97bf3fd PL	515	* Word 5
	516	*/
	517
	518	static inline u32 msg_session(struct tipc_msg *m)
	519	{
	520	return msg_bits(m, 5, 16, 0xffff);
	521	}
	522
	523	static inline void msg_set_session(struct tipc_msg *m, u32 n)
	524	{
	525	msg_set_bits(m, 5, 16, 0xffff, n);
	526	}
	527
	528	static inline u32 msg_probe(struct tipc_msg *m)
	529	{
	530	return msg_bits(m, 5, 0, 1);
	531	}
	532
	533	static inline void msg_set_probe(struct tipc_msg *m, u32 val)
	534	{
	535	msg_set_bits(m, 5, 0, 1, (val & 1));
	536	}
	537
	538	static inline char msg_net_plane(struct tipc_msg *m)
	539	{
	540	return msg_bits(m, 5, 1, 7) + 'A';
	541	}
	542
	543	static inline void msg_set_net_plane(struct tipc_msg *m, char n)
	544	{
	545	msg_set_bits(m, 5, 1, 7, (n - 'A'));
	546	}
	547
	548	static inline u32 msg_linkprio(struct tipc_msg *m)
	549	{
	550	return msg_bits(m, 5, 4, 0x1f);
	551	}
	552
	553	static inline void msg_set_linkprio(struct tipc_msg *m, u32 n)
	554	{
	555	msg_set_bits(m, 5, 4, 0x1f, n);
	556	}
	557
	558	static inline u32 msg_bearer_id(struct tipc_msg *m)
	559	{
	560	return msg_bits(m, 5, 9, 0x7);
	561	}
	562
	563	static inline void msg_set_bearer_id(struct tipc_msg *m, u32 n)
	564	{
	565	msg_set_bits(m, 5, 9, 0x7, n);
	566	}
	567
	568	static inline u32 msg_redundant_link(struct tipc_msg *m)
	569	{
	570	return msg_bits(m, 5, 12, 0x1);
	571	}
	572
	573	static inline void msg_set_redundant_link(struct tipc_msg *m)
	574	{
	575	msg_set_bits(m, 5, 12, 0x1, 1);
	576	}
	577
	578	static inline void msg_clear_redundant_link(struct tipc_msg *m)
579	{
580	msg_set_bits(m, 5, 12, 0x1, 0);
581	}
582
583
c4307285	584	/*
b97bf3fd PL	585	* Word 9
	586	*/
	587
	588	static inline u32 msg_msgcnt(struct tipc_msg *m)
	589	{
	590	return msg_bits(m, 9, 16, 0xffff);
	591	}
	592
	593	static inline void msg_set_msgcnt(struct tipc_msg *m, u32 n)
	594	{
	595	msg_set_bits(m, 9, 16, 0xffff, n);
	596	}
	597
	598	static inline u32 msg_bcast_tag(struct tipc_msg *m)
	599	{
	600	return msg_bits(m, 9, 16, 0xffff);
	601	}
	602
	603	static inline void msg_set_bcast_tag(struct tipc_msg *m, u32 n)
	604	{
	605	msg_set_bits(m, 9, 16, 0xffff, n);
	606	}
	607
c4307285	608	static inline u32 msg_max_pkt(struct tipc_msg *m)
b97bf3fd PL	609	{
	610	return (msg_bits(m, 9, 16, 0xffff) * 4);
	611	}
	612
c4307285	613	static inline void msg_set_max_pkt(struct tipc_msg *m, u32 n)
b97bf3fd PL	614	{
	615	msg_set_bits(m, 9, 16, 0xffff, (n / 4));
	616	}
	617
	618	static inline u32 msg_link_tolerance(struct tipc_msg *m)
	619	{
	620	return msg_bits(m, 9, 0, 0xffff);
	621	}
	622
	623	static inline void msg_set_link_tolerance(struct tipc_msg *m, u32 n)
	624	{
	625	msg_set_bits(m, 9, 0, 0xffff, n);
	626	}
	627
c4307285	628	/*
b97bf3fd PL	629	* Routing table message data
	630	*/
	631
	632
	633	static inline u32 msg_remote_node(struct tipc_msg *m)
	634	{
	635	return msg_word(m, msg_hdr_sz(m)/4);
	636	}
	637
	638	static inline void msg_set_remote_node(struct tipc_msg *m, u32 a)
	639	{
	640	msg_set_word(m, msg_hdr_sz(m)/4, a);
	641	}
	642
b97bf3fd PL	643	static inline void msg_set_dataoctet(struct tipc_msg *m, u32 pos)
	644	{
	645	msg_data(m)[pos + 4] = 1;
	646	}
	647
c4307285	648	/*
b97bf3fd PL	649	* Segmentation message types
	650	*/
	651
	652	#define FIRST_FRAGMENT 0
	653	#define FRAGMENT 1
	654	#define LAST_FRAGMENT 2
	655
c4307285	656	/*
b97bf3fd PL	657	* Link management protocol message types
	658	*/
	659
	660	#define STATE_MSG 0
	661	#define RESET_MSG 1
	662	#define ACTIVATE_MSG 2
	663
c4307285	664	/*
b97bf3fd PL	665	* Changeover tunnel message types
	666	*/
	667	#define DUPLICATE_MSG 0
	668	#define ORIGINAL_MSG 1
	669
c4307285	670	/*
b97bf3fd PL	671	* Routing table message types
	672	*/
	673	#define EXT_ROUTING_TABLE 0
	674	#define LOCAL_ROUTING_TABLE 1
	675	#define SLAVE_ROUTING_TABLE 2
	676	#define ROUTE_ADDITION 3
	677	#define ROUTE_REMOVAL 4
	678
c4307285	679	/*
b97bf3fd PL	680	* Config protocol message types
	681	*/
	682
	683	#define DSC_REQ_MSG 0
	684	#define DSC_RESP_MSG 1
	685
	686	static inline u32 msg_tot_importance(struct tipc_msg *m)
	687	{
	688	if (likely(msg_isdata(m))) {
	689	if (likely(msg_orignode(m) == tipc_own_addr))
	690	return msg_importance(m);
	691	return msg_importance(m) + 4;
	692	}
	693	if ((msg_user(m) == MSG_FRAGMENTER) &&
	694	(msg_type(m) == FIRST_FRAGMENT))
	695	return msg_importance(msg_get_wrapped(m));
	696	return msg_importance(m);
	697	}
	698
	699
c4307285	700	static inline void msg_init(struct tipc_msg *m, u32 user, u32 type,
b97bf3fd PL	701	u32 err, u32 hsize, u32 destnode)
	702	{
	703	memset(m, 0, hsize);
	704	msg_set_version(m);
	705	msg_set_user(m, user);
	706	msg_set_hdr_sz(m, hsize);
	707	msg_set_size(m, hsize);
	708	msg_set_prevnode(m, tipc_own_addr);
	709	msg_set_type(m, type);
	710	msg_set_errcode(m, err);
	711	if (!msg_short(m)) {
	712	msg_set_orignode(m, tipc_own_addr);
	713	msg_set_destnode(m, destnode);
	714	}
	715	}
	716
c4307285	717	/**
b97bf3fd PL	718	* msg_calc_data_size - determine total data size for message
	719	*/
	720
	721	static inline int msg_calc_data_size(struct iovec const *msg_sect, u32 num_sect)
	722	{
	723	int dsz = 0;
	724	int i;
	725
	726	for (i = 0; i < num_sect; i++)
	727	dsz += msg_sect[i].iov_len;
	728	return dsz;
	729	}
	730
c4307285	731	/**
b97bf3fd	732	* msg_build - create message using specified header and data
c4307285	733	*
b97bf3fd	734	* Note: Caller must not hold any locks in case copy_from_user() is interrupted!
c4307285	735	*
b97bf3fd PL	736	* Returns message data size or errno
	737	*/
	738
c4307285	739	static inline int msg_build(struct tipc_msg *hdr,
b97bf3fd PL	740	struct iovec const *msg_sect, u32 num_sect,
	741	int max_size, int usrmem, struct sk_buff** buf)
	742	{
	743	int dsz, sz, hsz, pos, res, cnt;
	744
	745	dsz = msg_calc_data_size(msg_sect, num_sect);
	746	if (unlikely(dsz > TIPC_MAX_USER_MSG_SIZE)) {
	747	*buf = NULL;
	748	return -EINVAL;
	749	}
	750
	751	pos = hsz = msg_hdr_sz(hdr);
	752	sz = hsz + dsz;
	753	msg_set_size(hdr, sz);
	754	if (unlikely(sz > max_size)) {
	755	*buf = NULL;
	756	return dsz;
	757	}
	758
	759	*buf = buf_acquire(sz);
	760	if (!(*buf))
	761	return -ENOMEM;
27d7ff46	762	skb_copy_to_linear_data(*buf, hdr, hsz);
b97bf3fd PL	763	for (res = 1, cnt = 0; res && (cnt < num_sect); cnt++) {
b97bf3fd PL	764	if (likely(usrmem))
c4307285 YH	765	res = !copy_from_user((*buf)->data + pos,
c4307285 YH	766	msg_sect[cnt].iov_base,
b97bf3fd PL	767	msg_sect[cnt].iov_len);
b97bf3fd PL	768	else
27d7ff46 ACM	769	skb_copy_to_linear_data_offset(*buf, pos,
	770	msg_sect[cnt].iov_base,
	771	msg_sect[cnt].iov_len);
b97bf3fd PL	772	pos += msg_sect[cnt].iov_len;
	773	}
	774	if (likely(res))
	775	return dsz;
	776
	777	buf_discard(*buf);
	778	*buf = NULL;
	779	return -EFAULT;
	780	}
	781
4323add6 PL	782	static inline void msg_set_media_addr(struct tipc_msg m, struct tipc_media_addr a)
	783	{
	784	memcpy(&((int )m)[5], a, sizeof(a));
	785	}
b97bf3fd	786
4323add6 PL	787	static inline void msg_get_media_addr(struct tipc_msg m, struct tipc_media_addr a)
	788	{
	789	memcpy(a, &((int)m)[5], sizeof(a));
	790	}
b97bf3fd PL	791
b97bf3fd PL	792	#endif