[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-2008, 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 SHORT_H_SIZE              24	/* Connected, in-cluster messages */
#define DIR_MSG_H_SIZE            32	/* Directly addressed messages */
#define LONG_H_SIZE               40	/* Named messages */
#define MCAST_H_SIZE              44	/* Multicast messages */
#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)


/*
		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;
	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 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|      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  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, 0x1fff);
}

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