mirror of
https://github.com/adulau/aha.git
synced 2024-12-29 04:06:22 +00:00
[TIPC] Moved configuration interface into tipc_config.h
Restored the old tipc_config.h to get a cleaner division between the interfaces used by normal TIPC users and TIPC administration utilities. Signed-off-by: Per Liden <per.liden@nospam.ericsson.com>
This commit is contained in:
parent
b70e4f45a8
commit
ea714ccda5
5 changed files with 456 additions and 412 deletions
|
@ -1,5 +1,5 @@
|
|||
/*
|
||||
* include/linux/tipc.h: Include file for TIPC users
|
||||
* include/linux/tipc.h: Include file for TIPC socket interface
|
||||
*
|
||||
* Copyright (c) 2003-2005, Ericsson Research Canada
|
||||
* Copyright (c) 2005, Wind River Systems
|
||||
|
@ -35,8 +35,6 @@
|
|||
#define _LINUX_TIPC_H_
|
||||
|
||||
#include <linux/types.h>
|
||||
#include <linux/string.h>
|
||||
#include <asm/byteorder.h>
|
||||
|
||||
/*
|
||||
* TIPC addressing primitives
|
||||
|
@ -84,7 +82,7 @@ static inline unsigned int tipc_node(__u32 addr)
|
|||
* Application-accessible port name types
|
||||
*/
|
||||
|
||||
#define TIPC_NET_EVENTS 0 /* network event subscription name type */
|
||||
#define TIPC_CFG_SRV 0 /* configuration service name type */
|
||||
#define TIPC_TOP_SRV 1 /* topology service name type */
|
||||
#define TIPC_RESERVED_TYPES 64 /* lowest user-publishable name type */
|
||||
|
||||
|
@ -144,7 +142,6 @@ struct tipc_subscr {
|
|||
char usr_handle[8]; /* available for subscriber use */
|
||||
};
|
||||
|
||||
|
||||
#define TIPC_PUBLISHED 1 /* publication event */
|
||||
#define TIPC_WITHDRAWN 2 /* withdraw event */
|
||||
#define TIPC_SUBSCR_TIMEOUT 3 /* subscription timeout event */
|
||||
|
@ -209,389 +206,4 @@ struct sockaddr_tipc {
|
|||
#define TIPC_DEST_DROPPABLE 129 /* Default: based on socket type */
|
||||
#define TIPC_CONN_TIMEOUT 130 /* Default: 8000 (ms) */
|
||||
|
||||
/*
|
||||
* Bearer
|
||||
*/
|
||||
|
||||
/* Identifiers of supported TIPC media types */
|
||||
|
||||
#define TIPC_MEDIA_TYPE_ETH 1
|
||||
|
||||
/* Maximum sizes of TIPC bearer-related names (including terminating NUL) */
|
||||
|
||||
#define TIPC_MAX_MEDIA_NAME 16 /* format = media */
|
||||
#define TIPC_MAX_IF_NAME 16 /* format = interface */
|
||||
#define TIPC_MAX_BEARER_NAME 32 /* format = media:interface */
|
||||
#define TIPC_MAX_LINK_NAME 60 /* format = Z.C.N:interface-Z.C.N:interface */
|
||||
|
||||
struct tipc_media_addr {
|
||||
__u32 type;
|
||||
union {
|
||||
__u8 eth_addr[6]; /* Ethernet bearer */
|
||||
#if 0
|
||||
/* Prototypes for other possible bearer types */
|
||||
|
||||
struct {
|
||||
__u16 sin_family;
|
||||
__u16 sin_port;
|
||||
struct {
|
||||
__u32 s_addr;
|
||||
} sin_addr;
|
||||
char pad[4];
|
||||
} addr_in; /* IP-based bearer */
|
||||
__u16 sock_descr; /* generic socket bearer */
|
||||
#endif
|
||||
} dev_addr;
|
||||
};
|
||||
|
||||
|
||||
/* Link priority limits (range from 0 to # priorities - 1) */
|
||||
|
||||
#define TIPC_NUM_LINK_PRI 32
|
||||
|
||||
/* Link tolerance limits (min, default, max), in ms */
|
||||
|
||||
#define TIPC_MIN_LINK_TOL 50
|
||||
#define TIPC_DEF_LINK_TOL 1500
|
||||
#define TIPC_MAX_LINK_TOL 30000
|
||||
|
||||
/* Link window limits (min, default, max), in packets */
|
||||
|
||||
#define TIPC_MIN_LINK_WIN 16
|
||||
#define TIPC_DEF_LINK_WIN 50
|
||||
#define TIPC_MAX_LINK_WIN 150
|
||||
|
||||
/*
|
||||
* Configuration
|
||||
*
|
||||
* All configuration management messaging involves sending a request message
|
||||
* to the TIPC configuration service on a node, which sends a reply message
|
||||
* back. (In the future multi-message replies may be supported.)
|
||||
*
|
||||
* Both request and reply messages consist of a transport header and payload.
|
||||
* The transport header contains info about the desired operation;
|
||||
* the payload consists of zero or more type/length/value (TLV) items
|
||||
* which specify parameters or results for the operation.
|
||||
*
|
||||
* For many operations, the request and reply messages have a fixed number
|
||||
* of TLVs (usually zero or one); however, some reply messages may return
|
||||
* a variable number of TLVs. A failed request is denoted by the presence
|
||||
* of an "error string" TLV in the reply message instead of the TLV(s) the
|
||||
* reply should contain if the request succeeds.
|
||||
*/
|
||||
|
||||
#define TIPC_CFG_SRV 0 /* configuration service name type */
|
||||
|
||||
/*
|
||||
* Public commands:
|
||||
* May be issued by any process.
|
||||
* Accepted by own node, or by remote node only if remote management enabled.
|
||||
*/
|
||||
|
||||
#define TIPC_CMD_NOOP 0x0000 /* tx none, rx none */
|
||||
#define TIPC_CMD_GET_NODES 0x0001 /* tx net_addr, rx node_info(s) */
|
||||
#define TIPC_CMD_GET_MEDIA_NAMES 0x0002 /* tx none, rx media_name(s) */
|
||||
#define TIPC_CMD_GET_BEARER_NAMES 0x0003 /* tx none, rx bearer_name(s) */
|
||||
#define TIPC_CMD_GET_LINKS 0x0004 /* tx net_addr, rx link_info(s) */
|
||||
#define TIPC_CMD_SHOW_NAME_TABLE 0x0005 /* tx name_tbl_query, rx ultra_string */
|
||||
#define TIPC_CMD_SHOW_PORTS 0x0006 /* tx none, rx ultra_string */
|
||||
#define TIPC_CMD_SHOW_LINK_STATS 0x000B /* tx link_name, rx ultra_string */
|
||||
|
||||
#if 0
|
||||
#define TIPC_CMD_SHOW_PORT_STATS 0x0008 /* tx port_ref, rx ultra_string */
|
||||
#define TIPC_CMD_RESET_PORT_STATS 0x0009 /* tx port_ref, rx none */
|
||||
#define TIPC_CMD_GET_ROUTES 0x000A /* tx ?, rx ? */
|
||||
#define TIPC_CMD_GET_LINK_PEER 0x000D /* tx link_name, rx ? */
|
||||
#endif
|
||||
|
||||
/*
|
||||
* Protected commands:
|
||||
* May only be issued by "network administration capable" process.
|
||||
* Accepted by own node, or by remote node only if remote management enabled
|
||||
* and this node is zone manager.
|
||||
*/
|
||||
|
||||
#define TIPC_CMD_GET_REMOTE_MNG 0x4003 /* tx none, rx unsigned */
|
||||
#define TIPC_CMD_GET_MAX_PORTS 0x4004 /* tx none, rx unsigned */
|
||||
#define TIPC_CMD_GET_MAX_PUBL 0x4005 /* tx none, rx unsigned */
|
||||
#define TIPC_CMD_GET_MAX_SUBSCR 0x4006 /* tx none, rx unsigned */
|
||||
#define TIPC_CMD_GET_MAX_ZONES 0x4007 /* tx none, rx unsigned */
|
||||
#define TIPC_CMD_GET_MAX_CLUSTERS 0x4008 /* tx none, rx unsigned */
|
||||
#define TIPC_CMD_GET_MAX_NODES 0x4009 /* tx none, rx unsigned */
|
||||
#define TIPC_CMD_GET_MAX_SLAVES 0x400A /* tx none, rx unsigned */
|
||||
#define TIPC_CMD_GET_NETID 0x400B /* tx none, rx unsigned */
|
||||
|
||||
#define TIPC_CMD_ENABLE_BEARER 0x4101 /* tx bearer_config, rx none */
|
||||
#define TIPC_CMD_DISABLE_BEARER 0x4102 /* tx bearer_name, rx none */
|
||||
#define TIPC_CMD_SET_LINK_TOL 0x4107 /* tx link_config, rx none */
|
||||
#define TIPC_CMD_SET_LINK_PRI 0x4108 /* tx link_config, rx none */
|
||||
#define TIPC_CMD_SET_LINK_WINDOW 0x4109 /* tx link_config, rx none */
|
||||
#define TIPC_CMD_SET_LOG_SIZE 0x410A /* tx unsigned, rx none */
|
||||
#define TIPC_CMD_DUMP_LOG 0x410B /* tx none, rx ultra_string */
|
||||
#define TIPC_CMD_RESET_LINK_STATS 0x410C /* tx link_name, rx none */
|
||||
|
||||
#if 0
|
||||
#define TIPC_CMD_CREATE_LINK 0x4103 /* tx link_create, rx none */
|
||||
#define TIPC_CMD_REMOVE_LINK 0x4104 /* tx link_name, rx none */
|
||||
#define TIPC_CMD_BLOCK_LINK 0x4105 /* tx link_name, rx none */
|
||||
#define TIPC_CMD_UNBLOCK_LINK 0x4106 /* tx link_name, rx none */
|
||||
#endif
|
||||
|
||||
/*
|
||||
* Private commands:
|
||||
* May only be issued by "network administration capable" process.
|
||||
* Accepted by own node only; cannot be used on a remote node.
|
||||
*/
|
||||
|
||||
#define TIPC_CMD_SET_NODE_ADDR 0x8001 /* tx net_addr, rx none */
|
||||
#if 0
|
||||
#define TIPC_CMD_SET_ZONE_MASTER 0x8002 /* tx none, rx none */
|
||||
#endif
|
||||
#define TIPC_CMD_SET_REMOTE_MNG 0x8003 /* tx unsigned, rx none */
|
||||
#define TIPC_CMD_SET_MAX_PORTS 0x8004 /* tx unsigned, rx none */
|
||||
#define TIPC_CMD_SET_MAX_PUBL 0x8005 /* tx unsigned, rx none */
|
||||
#define TIPC_CMD_SET_MAX_SUBSCR 0x8006 /* tx unsigned, rx none */
|
||||
#define TIPC_CMD_SET_MAX_ZONES 0x8007 /* tx unsigned, rx none */
|
||||
#define TIPC_CMD_SET_MAX_CLUSTERS 0x8008 /* tx unsigned, rx none */
|
||||
#define TIPC_CMD_SET_MAX_NODES 0x8009 /* tx unsigned, rx none */
|
||||
#define TIPC_CMD_SET_MAX_SLAVES 0x800A /* tx unsigned, rx none */
|
||||
#define TIPC_CMD_SET_NETID 0x800B /* tx unsigned, rx none */
|
||||
|
||||
/*
|
||||
* TLV types defined for TIPC
|
||||
*/
|
||||
|
||||
#define TIPC_TLV_NONE 0 /* no TLV present */
|
||||
#define TIPC_TLV_VOID 1 /* empty TLV (0 data bytes)*/
|
||||
#define TIPC_TLV_UNSIGNED 2 /* 32-bit integer */
|
||||
#define TIPC_TLV_STRING 3 /* char[128] (max) */
|
||||
#define TIPC_TLV_LARGE_STRING 4 /* char[2048] (max) */
|
||||
#define TIPC_TLV_ULTRA_STRING 5 /* char[32768] (max) */
|
||||
|
||||
#define TIPC_TLV_ERROR_STRING 16 /* char[128] containing "error code" */
|
||||
#define TIPC_TLV_NET_ADDR 17 /* 32-bit integer denoting <Z.C.N> */
|
||||
#define TIPC_TLV_MEDIA_NAME 18 /* char[MAX_MEDIA_NAME] */
|
||||
#define TIPC_TLV_BEARER_NAME 19 /* char[MAX_BEARER_NAME] */
|
||||
#define TIPC_TLV_LINK_NAME 20 /* char[MAX_LINK_NAME] */
|
||||
#define TIPC_TLV_NODE_INFO 21 /* struct tipc_node_info */
|
||||
#define TIPC_TLV_LINK_INFO 22 /* struct tipc_link_info */
|
||||
#define TIPC_TLV_BEARER_CONFIG 23 /* struct tipc_bearer_config */
|
||||
#define TIPC_TLV_LINK_CONFIG 24 /* struct tipc_link_config */
|
||||
#define TIPC_TLV_NAME_TBL_QUERY 25 /* struct tipc_name_table_query */
|
||||
#define TIPC_TLV_PORT_REF 26 /* 32-bit port reference */
|
||||
|
||||
struct tipc_node_info {
|
||||
__u32 addr; /* network address of node */
|
||||
__u32 up; /* 0=down, 1= up */
|
||||
};
|
||||
|
||||
struct tipc_link_info {
|
||||
__u32 dest; /* network address of peer node */
|
||||
__u32 up; /* 0=down, 1=up */
|
||||
char str[TIPC_MAX_LINK_NAME]; /* link name */
|
||||
};
|
||||
|
||||
struct tipc_bearer_config {
|
||||
__u32 priority; /* Range [1,31]. Override per link */
|
||||
__u32 detect_scope;
|
||||
char name[TIPC_MAX_BEARER_NAME];
|
||||
};
|
||||
|
||||
struct tipc_link_config {
|
||||
__u32 value;
|
||||
char name[TIPC_MAX_LINK_NAME];
|
||||
};
|
||||
|
||||
#define TIPC_NTQ_ALLTYPES 0x80000000
|
||||
|
||||
struct tipc_name_table_query {
|
||||
__u32 depth; /* 1:type, 2:+name info, 3:+port info, 4+:+debug info */
|
||||
__u32 type; /* {t,l,u} info ignored if high bit of "depth" is set */
|
||||
__u32 lowbound; /* (i.e. displays all entries of name table) */
|
||||
__u32 upbound;
|
||||
};
|
||||
|
||||
/*
|
||||
* The error string TLV is a null-terminated string describing the cause
|
||||
* of the request failure. To simplify error processing (and to save space)
|
||||
* the first character of the string can be a special error code character
|
||||
* (lying by the range 0x80 to 0xFF) which represents a pre-defined reason.
|
||||
*/
|
||||
|
||||
#define TIPC_CFG_TLV_ERROR "\x80" /* request contains incorrect TLV(s) */
|
||||
#define TIPC_CFG_NOT_NET_ADMIN "\x81" /* must be network administrator */
|
||||
#define TIPC_CFG_NOT_ZONE_MSTR "\x82" /* must be zone master */
|
||||
#define TIPC_CFG_NO_REMOTE "\x83" /* remote management not enabled */
|
||||
#define TIPC_CFG_NOT_SUPPORTED "\x84" /* request is not supported by TIPC */
|
||||
#define TIPC_CFG_INVALID_VALUE "\x85" /* request has invalid argument value */
|
||||
|
||||
#if 0
|
||||
/* prototypes TLV structures for proposed commands */
|
||||
struct tipc_link_create {
|
||||
__u32 domain;
|
||||
struct tipc_media_addr peer_addr;
|
||||
char bearer_name[MAX_BEARER_NAME];
|
||||
};
|
||||
|
||||
struct tipc_route_info {
|
||||
__u32 dest;
|
||||
__u32 router;
|
||||
};
|
||||
#endif
|
||||
|
||||
/*
|
||||
* A TLV consists of a descriptor, followed by the TLV value.
|
||||
* TLV descriptor fields are stored in network byte order;
|
||||
* TLV values must also be stored in network byte order (where applicable).
|
||||
* TLV descriptors must be aligned to addresses which are multiple of 4,
|
||||
* so up to 3 bytes of padding may exist at the end of the TLV value area.
|
||||
* There must not be any padding between the TLV descriptor and its value.
|
||||
*/
|
||||
|
||||
struct tlv_desc {
|
||||
__u16 tlv_len; /* TLV length (descriptor + value) */
|
||||
__u16 tlv_type; /* TLV identifier */
|
||||
};
|
||||
|
||||
#define TLV_ALIGNTO 4
|
||||
|
||||
#define TLV_ALIGN(datalen) (((datalen)+(TLV_ALIGNTO-1)) & ~(TLV_ALIGNTO-1))
|
||||
#define TLV_LENGTH(datalen) (sizeof(struct tlv_desc) + (datalen))
|
||||
#define TLV_SPACE(datalen) (TLV_ALIGN(TLV_LENGTH(datalen)))
|
||||
#define TLV_DATA(tlv) ((void *)((char *)(tlv) + TLV_LENGTH(0)))
|
||||
|
||||
static inline int TLV_OK(const void *tlv, __u16 space)
|
||||
{
|
||||
/*
|
||||
* Would also like to check that "tlv" is a multiple of 4,
|
||||
* but don't know how to do this in a portable way.
|
||||
* - Tried doing (!(tlv & (TLV_ALIGNTO-1))), but GCC compiler
|
||||
* won't allow binary "&" with a pointer.
|
||||
* - Tried casting "tlv" to integer type, but causes warning about size
|
||||
* mismatch when pointer is bigger than chosen type (int, long, ...).
|
||||
*/
|
||||
|
||||
return (space >= TLV_SPACE(0)) &&
|
||||
(ntohs(((struct tlv_desc *)tlv)->tlv_len) <= space);
|
||||
}
|
||||
|
||||
static inline int TLV_CHECK(const void *tlv, __u16 space, __u16 exp_type)
|
||||
{
|
||||
return TLV_OK(tlv, space) &&
|
||||
(ntohs(((struct tlv_desc *)tlv)->tlv_type) == exp_type);
|
||||
}
|
||||
|
||||
static inline int TLV_SET(void *tlv, __u16 type, void *data, __u16 len)
|
||||
{
|
||||
struct tlv_desc *tlv_ptr;
|
||||
int tlv_len;
|
||||
|
||||
tlv_len = TLV_LENGTH(len);
|
||||
tlv_ptr = (struct tlv_desc *)tlv;
|
||||
tlv_ptr->tlv_type = htons(type);
|
||||
tlv_ptr->tlv_len = htons(tlv_len);
|
||||
if (len && data)
|
||||
memcpy(TLV_DATA(tlv_ptr), data, tlv_len);
|
||||
return TLV_SPACE(len);
|
||||
}
|
||||
|
||||
/*
|
||||
* A TLV list descriptor simplifies processing of messages
|
||||
* containing multiple TLVs.
|
||||
*/
|
||||
|
||||
struct tlv_list_desc {
|
||||
struct tlv_desc *tlv_ptr; /* ptr to current TLV */
|
||||
__u32 tlv_space; /* # bytes from curr TLV to list end */
|
||||
};
|
||||
|
||||
static inline void TLV_LIST_INIT(struct tlv_list_desc *list,
|
||||
void *data, __u32 space)
|
||||
{
|
||||
list->tlv_ptr = (struct tlv_desc *)data;
|
||||
list->tlv_space = space;
|
||||
}
|
||||
|
||||
static inline int TLV_LIST_EMPTY(struct tlv_list_desc *list)
|
||||
{
|
||||
return (list->tlv_space == 0);
|
||||
}
|
||||
|
||||
static inline int TLV_LIST_CHECK(struct tlv_list_desc *list, __u16 exp_type)
|
||||
{
|
||||
return TLV_CHECK(list->tlv_ptr, list->tlv_space, exp_type);
|
||||
}
|
||||
|
||||
static inline void *TLV_LIST_DATA(struct tlv_list_desc *list)
|
||||
{
|
||||
return TLV_DATA(list->tlv_ptr);
|
||||
}
|
||||
|
||||
static inline void TLV_LIST_STEP(struct tlv_list_desc *list)
|
||||
{
|
||||
__u16 tlv_space = TLV_ALIGN(ntohs(list->tlv_ptr->tlv_len));
|
||||
|
||||
list->tlv_ptr = (struct tlv_desc *)((char *)list->tlv_ptr + tlv_space);
|
||||
list->tlv_space -= tlv_space;
|
||||
}
|
||||
|
||||
/*
|
||||
* Configuration messages exchanged via NETLINK_GENERIC use the following
|
||||
* family id, name, version and command.
|
||||
*/
|
||||
#define TIPC_GENL_NAME "TIPC"
|
||||
#define TIPC_GENL_VERSION 0x1
|
||||
#define TIPC_GENL_CMD 0x1
|
||||
|
||||
/*
|
||||
* TIPC specific header used in NETLINK_GENERIC requests.
|
||||
*/
|
||||
struct tipc_genlmsghdr {
|
||||
__u32 dest; /* Destination address */
|
||||
__u16 cmd; /* Command */
|
||||
__u16 reserved; /* Unused */
|
||||
};
|
||||
|
||||
#define TIPC_GENL_HDRLEN NLMSG_ALIGN(sizeof(struct tipc_genlmsghdr))
|
||||
|
||||
/*
|
||||
* Configuration messages exchanged via TIPC sockets use the TIPC configuration
|
||||
* message header, which is defined below. This structure is analogous
|
||||
* to the Netlink message header, but fields are stored in network byte order
|
||||
* and no padding is permitted between the header and the message data
|
||||
* that follows.
|
||||
*/
|
||||
|
||||
struct tipc_cfg_msg_hdr
|
||||
{
|
||||
__u32 tcm_len; /* Message length (including header) */
|
||||
__u16 tcm_type; /* Command type */
|
||||
__u16 tcm_flags; /* Additional flags */
|
||||
char tcm_reserved[8]; /* Unused */
|
||||
};
|
||||
|
||||
#define TCM_F_REQUEST 0x1 /* Flag: Request message */
|
||||
#define TCM_F_MORE 0x2 /* Flag: Message to be continued */
|
||||
|
||||
#define TCM_ALIGN(datalen) (((datalen)+3) & ~3)
|
||||
#define TCM_LENGTH(datalen) (sizeof(struct tipc_cfg_msg_hdr) + datalen)
|
||||
#define TCM_SPACE(datalen) (TCM_ALIGN(TCM_LENGTH(datalen)))
|
||||
#define TCM_DATA(tcm_hdr) ((void *)((char *)(tcm_hdr) + TCM_LENGTH(0)))
|
||||
|
||||
static inline int TCM_SET(void *msg, __u16 cmd, __u16 flags,
|
||||
void *data, __u16 data_len)
|
||||
{
|
||||
struct tipc_cfg_msg_hdr *tcm_hdr;
|
||||
int msg_len;
|
||||
|
||||
msg_len = TCM_LENGTH(data_len);
|
||||
tcm_hdr = (struct tipc_cfg_msg_hdr *)msg;
|
||||
tcm_hdr->tcm_len = htonl(msg_len);
|
||||
tcm_hdr->tcm_type = htons(cmd);
|
||||
tcm_hdr->tcm_flags = htons(flags);
|
||||
if (data_len && data)
|
||||
memcpy(TCM_DATA(msg), data, data_len);
|
||||
return TCM_SPACE(data_len);
|
||||
}
|
||||
|
||||
#endif
|
||||
|
|
404
include/linux/tipc_config.h
Normal file
404
include/linux/tipc_config.h
Normal file
|
@ -0,0 +1,404 @@
|
|||
/*
|
||||
* include/linux/tipc_config.h: Include file for TIPC configuration interface
|
||||
*
|
||||
* Copyright (c) 2003-2005, Ericsson Research Canada
|
||||
* Copyright (c) 2005, Wind River Systems
|
||||
* Copyright (c) 2005-2006, Ericsson AB
|
||||
* All rights reserved.
|
||||
*
|
||||
* Redistribution and use in source and binary forms, with or without
|
||||
* modification, are permitted provided that the following conditions are met:
|
||||
*
|
||||
* Redistributions of source code must retain the above copyright notice, this
|
||||
* list of conditions and the following disclaimer.
|
||||
* 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.
|
||||
* 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.
|
||||
*
|
||||
* 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 _LINUX_TIPC_CONFIG_H_
|
||||
#define _LINUX_TIPC_CONFIG_H_
|
||||
|
||||
#include <linux/types.h>
|
||||
#include <linux/string.h>
|
||||
#include <asm/byteorder.h>
|
||||
|
||||
/*
|
||||
* Configuration
|
||||
*
|
||||
* All configuration management messaging involves sending a request message
|
||||
* to the TIPC configuration service on a node, which sends a reply message
|
||||
* back. (In the future multi-message replies may be supported.)
|
||||
*
|
||||
* Both request and reply messages consist of a transport header and payload.
|
||||
* The transport header contains info about the desired operation;
|
||||
* the payload consists of zero or more type/length/value (TLV) items
|
||||
* which specify parameters or results for the operation.
|
||||
*
|
||||
* For many operations, the request and reply messages have a fixed number
|
||||
* of TLVs (usually zero or one); however, some reply messages may return
|
||||
* a variable number of TLVs. A failed request is denoted by the presence
|
||||
* of an "error string" TLV in the reply message instead of the TLV(s) the
|
||||
* reply should contain if the request succeeds.
|
||||
*/
|
||||
|
||||
/*
|
||||
* Public commands:
|
||||
* May be issued by any process.
|
||||
* Accepted by own node, or by remote node only if remote management enabled.
|
||||
*/
|
||||
|
||||
#define TIPC_CMD_NOOP 0x0000 /* tx none, rx none */
|
||||
#define TIPC_CMD_GET_NODES 0x0001 /* tx net_addr, rx node_info(s) */
|
||||
#define TIPC_CMD_GET_MEDIA_NAMES 0x0002 /* tx none, rx media_name(s) */
|
||||
#define TIPC_CMD_GET_BEARER_NAMES 0x0003 /* tx none, rx bearer_name(s) */
|
||||
#define TIPC_CMD_GET_LINKS 0x0004 /* tx net_addr, rx link_info(s) */
|
||||
#define TIPC_CMD_SHOW_NAME_TABLE 0x0005 /* tx name_tbl_query, rx ultra_string */
|
||||
#define TIPC_CMD_SHOW_PORTS 0x0006 /* tx none, rx ultra_string */
|
||||
#define TIPC_CMD_SHOW_LINK_STATS 0x000B /* tx link_name, rx ultra_string */
|
||||
|
||||
#if 0
|
||||
#define TIPC_CMD_SHOW_PORT_STATS 0x0008 /* tx port_ref, rx ultra_string */
|
||||
#define TIPC_CMD_RESET_PORT_STATS 0x0009 /* tx port_ref, rx none */
|
||||
#define TIPC_CMD_GET_ROUTES 0x000A /* tx ?, rx ? */
|
||||
#define TIPC_CMD_GET_LINK_PEER 0x000D /* tx link_name, rx ? */
|
||||
#endif
|
||||
|
||||
/*
|
||||
* Protected commands:
|
||||
* May only be issued by "network administration capable" process.
|
||||
* Accepted by own node, or by remote node only if remote management enabled
|
||||
* and this node is zone manager.
|
||||
*/
|
||||
|
||||
#define TIPC_CMD_GET_REMOTE_MNG 0x4003 /* tx none, rx unsigned */
|
||||
#define TIPC_CMD_GET_MAX_PORTS 0x4004 /* tx none, rx unsigned */
|
||||
#define TIPC_CMD_GET_MAX_PUBL 0x4005 /* tx none, rx unsigned */
|
||||
#define TIPC_CMD_GET_MAX_SUBSCR 0x4006 /* tx none, rx unsigned */
|
||||
#define TIPC_CMD_GET_MAX_ZONES 0x4007 /* tx none, rx unsigned */
|
||||
#define TIPC_CMD_GET_MAX_CLUSTERS 0x4008 /* tx none, rx unsigned */
|
||||
#define TIPC_CMD_GET_MAX_NODES 0x4009 /* tx none, rx unsigned */
|
||||
#define TIPC_CMD_GET_MAX_SLAVES 0x400A /* tx none, rx unsigned */
|
||||
#define TIPC_CMD_GET_NETID 0x400B /* tx none, rx unsigned */
|
||||
|
||||
#define TIPC_CMD_ENABLE_BEARER 0x4101 /* tx bearer_config, rx none */
|
||||
#define TIPC_CMD_DISABLE_BEARER 0x4102 /* tx bearer_name, rx none */
|
||||
#define TIPC_CMD_SET_LINK_TOL 0x4107 /* tx link_config, rx none */
|
||||
#define TIPC_CMD_SET_LINK_PRI 0x4108 /* tx link_config, rx none */
|
||||
#define TIPC_CMD_SET_LINK_WINDOW 0x4109 /* tx link_config, rx none */
|
||||
#define TIPC_CMD_SET_LOG_SIZE 0x410A /* tx unsigned, rx none */
|
||||
#define TIPC_CMD_DUMP_LOG 0x410B /* tx none, rx ultra_string */
|
||||
#define TIPC_CMD_RESET_LINK_STATS 0x410C /* tx link_name, rx none */
|
||||
|
||||
#if 0
|
||||
#define TIPC_CMD_CREATE_LINK 0x4103 /* tx link_create, rx none */
|
||||
#define TIPC_CMD_REMOVE_LINK 0x4104 /* tx link_name, rx none */
|
||||
#define TIPC_CMD_BLOCK_LINK 0x4105 /* tx link_name, rx none */
|
||||
#define TIPC_CMD_UNBLOCK_LINK 0x4106 /* tx link_name, rx none */
|
||||
#endif
|
||||
|
||||
/*
|
||||
* Private commands:
|
||||
* May only be issued by "network administration capable" process.
|
||||
* Accepted by own node only; cannot be used on a remote node.
|
||||
*/
|
||||
|
||||
#define TIPC_CMD_SET_NODE_ADDR 0x8001 /* tx net_addr, rx none */
|
||||
#if 0
|
||||
#define TIPC_CMD_SET_ZONE_MASTER 0x8002 /* tx none, rx none */
|
||||
#endif
|
||||
#define TIPC_CMD_SET_REMOTE_MNG 0x8003 /* tx unsigned, rx none */
|
||||
#define TIPC_CMD_SET_MAX_PORTS 0x8004 /* tx unsigned, rx none */
|
||||
#define TIPC_CMD_SET_MAX_PUBL 0x8005 /* tx unsigned, rx none */
|
||||
#define TIPC_CMD_SET_MAX_SUBSCR 0x8006 /* tx unsigned, rx none */
|
||||
#define TIPC_CMD_SET_MAX_ZONES 0x8007 /* tx unsigned, rx none */
|
||||
#define TIPC_CMD_SET_MAX_CLUSTERS 0x8008 /* tx unsigned, rx none */
|
||||
#define TIPC_CMD_SET_MAX_NODES 0x8009 /* tx unsigned, rx none */
|
||||
#define TIPC_CMD_SET_MAX_SLAVES 0x800A /* tx unsigned, rx none */
|
||||
#define TIPC_CMD_SET_NETID 0x800B /* tx unsigned, rx none */
|
||||
|
||||
/*
|
||||
* TLV types defined for TIPC
|
||||
*/
|
||||
|
||||
#define TIPC_TLV_NONE 0 /* no TLV present */
|
||||
#define TIPC_TLV_VOID 1 /* empty TLV (0 data bytes)*/
|
||||
#define TIPC_TLV_UNSIGNED 2 /* 32-bit integer */
|
||||
#define TIPC_TLV_STRING 3 /* char[128] (max) */
|
||||
#define TIPC_TLV_LARGE_STRING 4 /* char[2048] (max) */
|
||||
#define TIPC_TLV_ULTRA_STRING 5 /* char[32768] (max) */
|
||||
|
||||
#define TIPC_TLV_ERROR_STRING 16 /* char[128] containing "error code" */
|
||||
#define TIPC_TLV_NET_ADDR 17 /* 32-bit integer denoting <Z.C.N> */
|
||||
#define TIPC_TLV_MEDIA_NAME 18 /* char[TIPC_MAX_MEDIA_NAME] */
|
||||
#define TIPC_TLV_BEARER_NAME 19 /* char[TIPC_MAX_BEARER_NAME] */
|
||||
#define TIPC_TLV_LINK_NAME 20 /* char[TIPC_MAX_LINK_NAME] */
|
||||
#define TIPC_TLV_NODE_INFO 21 /* struct tipc_node_info */
|
||||
#define TIPC_TLV_LINK_INFO 22 /* struct tipc_link_info */
|
||||
#define TIPC_TLV_BEARER_CONFIG 23 /* struct tipc_bearer_config */
|
||||
#define TIPC_TLV_LINK_CONFIG 24 /* struct tipc_link_config */
|
||||
#define TIPC_TLV_NAME_TBL_QUERY 25 /* struct tipc_name_table_query */
|
||||
#define TIPC_TLV_PORT_REF 26 /* 32-bit port reference */
|
||||
|
||||
/*
|
||||
* Maximum sizes of TIPC bearer-related names (including terminating NUL)
|
||||
*/
|
||||
|
||||
#define TIPC_MAX_MEDIA_NAME 16 /* format = media */
|
||||
#define TIPC_MAX_IF_NAME 16 /* format = interface */
|
||||
#define TIPC_MAX_BEARER_NAME 32 /* format = media:interface */
|
||||
#define TIPC_MAX_LINK_NAME 60 /* format = Z.C.N:interface-Z.C.N:interface */
|
||||
|
||||
/*
|
||||
* Link priority limits (range from 0 to # priorities - 1)
|
||||
*/
|
||||
|
||||
#define TIPC_NUM_LINK_PRI 32
|
||||
|
||||
/*
|
||||
* Link tolerance limits (min, default, max), in ms
|
||||
*/
|
||||
|
||||
#define TIPC_MIN_LINK_TOL 50
|
||||
#define TIPC_DEF_LINK_TOL 1500
|
||||
#define TIPC_MAX_LINK_TOL 30000
|
||||
|
||||
/*
|
||||
* Link window limits (min, default, max), in packets
|
||||
*/
|
||||
|
||||
#define TIPC_MIN_LINK_WIN 16
|
||||
#define TIPC_DEF_LINK_WIN 50
|
||||
#define TIPC_MAX_LINK_WIN 150
|
||||
|
||||
|
||||
struct tipc_node_info {
|
||||
__u32 addr; /* network address of node */
|
||||
__u32 up; /* 0=down, 1= up */
|
||||
};
|
||||
|
||||
struct tipc_link_info {
|
||||
__u32 dest; /* network address of peer node */
|
||||
__u32 up; /* 0=down, 1=up */
|
||||
char str[TIPC_MAX_LINK_NAME]; /* link name */
|
||||
};
|
||||
|
||||
struct tipc_bearer_config {
|
||||
__u32 priority; /* Range [1,31]. Override per link */
|
||||
__u32 detect_scope;
|
||||
char name[TIPC_MAX_BEARER_NAME];
|
||||
};
|
||||
|
||||
struct tipc_link_config {
|
||||
__u32 value;
|
||||
char name[TIPC_MAX_LINK_NAME];
|
||||
};
|
||||
|
||||
#define TIPC_NTQ_ALLTYPES 0x80000000
|
||||
|
||||
struct tipc_name_table_query {
|
||||
__u32 depth; /* 1:type, 2:+name info, 3:+port info, 4+:+debug info */
|
||||
__u32 type; /* {t,l,u} info ignored if high bit of "depth" is set */
|
||||
__u32 lowbound; /* (i.e. displays all entries of name table) */
|
||||
__u32 upbound;
|
||||
};
|
||||
|
||||
/*
|
||||
* The error string TLV is a null-terminated string describing the cause
|
||||
* of the request failure. To simplify error processing (and to save space)
|
||||
* the first character of the string can be a special error code character
|
||||
* (lying by the range 0x80 to 0xFF) which represents a pre-defined reason.
|
||||
*/
|
||||
|
||||
#define TIPC_CFG_TLV_ERROR "\x80" /* request contains incorrect TLV(s) */
|
||||
#define TIPC_CFG_NOT_NET_ADMIN "\x81" /* must be network administrator */
|
||||
#define TIPC_CFG_NOT_ZONE_MSTR "\x82" /* must be zone master */
|
||||
#define TIPC_CFG_NO_REMOTE "\x83" /* remote management not enabled */
|
||||
#define TIPC_CFG_NOT_SUPPORTED "\x84" /* request is not supported by TIPC */
|
||||
#define TIPC_CFG_INVALID_VALUE "\x85" /* request has invalid argument value */
|
||||
|
||||
#if 0
|
||||
/* prototypes TLV structures for proposed commands */
|
||||
struct tipc_link_create {
|
||||
__u32 domain;
|
||||
struct tipc_media_addr peer_addr;
|
||||
char bearer_name[TIPC_MAX_BEARER_NAME];
|
||||
};
|
||||
|
||||
struct tipc_route_info {
|
||||
__u32 dest;
|
||||
__u32 router;
|
||||
};
|
||||
#endif
|
||||
|
||||
/*
|
||||
* A TLV consists of a descriptor, followed by the TLV value.
|
||||
* TLV descriptor fields are stored in network byte order;
|
||||
* TLV values must also be stored in network byte order (where applicable).
|
||||
* TLV descriptors must be aligned to addresses which are multiple of 4,
|
||||
* so up to 3 bytes of padding may exist at the end of the TLV value area.
|
||||
* There must not be any padding between the TLV descriptor and its value.
|
||||
*/
|
||||
|
||||
struct tlv_desc {
|
||||
__u16 tlv_len; /* TLV length (descriptor + value) */
|
||||
__u16 tlv_type; /* TLV identifier */
|
||||
};
|
||||
|
||||
#define TLV_ALIGNTO 4
|
||||
|
||||
#define TLV_ALIGN(datalen) (((datalen)+(TLV_ALIGNTO-1)) & ~(TLV_ALIGNTO-1))
|
||||
#define TLV_LENGTH(datalen) (sizeof(struct tlv_desc) + (datalen))
|
||||
#define TLV_SPACE(datalen) (TLV_ALIGN(TLV_LENGTH(datalen)))
|
||||
#define TLV_DATA(tlv) ((void *)((char *)(tlv) + TLV_LENGTH(0)))
|
||||
|
||||
static inline int TLV_OK(const void *tlv, __u16 space)
|
||||
{
|
||||
/*
|
||||
* Would also like to check that "tlv" is a multiple of 4,
|
||||
* but don't know how to do this in a portable way.
|
||||
* - Tried doing (!(tlv & (TLV_ALIGNTO-1))), but GCC compiler
|
||||
* won't allow binary "&" with a pointer.
|
||||
* - Tried casting "tlv" to integer type, but causes warning about size
|
||||
* mismatch when pointer is bigger than chosen type (int, long, ...).
|
||||
*/
|
||||
|
||||
return (space >= TLV_SPACE(0)) &&
|
||||
(ntohs(((struct tlv_desc *)tlv)->tlv_len) <= space);
|
||||
}
|
||||
|
||||
static inline int TLV_CHECK(const void *tlv, __u16 space, __u16 exp_type)
|
||||
{
|
||||
return TLV_OK(tlv, space) &&
|
||||
(ntohs(((struct tlv_desc *)tlv)->tlv_type) == exp_type);
|
||||
}
|
||||
|
||||
static inline int TLV_SET(void *tlv, __u16 type, void *data, __u16 len)
|
||||
{
|
||||
struct tlv_desc *tlv_ptr;
|
||||
int tlv_len;
|
||||
|
||||
tlv_len = TLV_LENGTH(len);
|
||||
tlv_ptr = (struct tlv_desc *)tlv;
|
||||
tlv_ptr->tlv_type = htons(type);
|
||||
tlv_ptr->tlv_len = htons(tlv_len);
|
||||
if (len && data)
|
||||
memcpy(TLV_DATA(tlv_ptr), data, tlv_len);
|
||||
return TLV_SPACE(len);
|
||||
}
|
||||
|
||||
/*
|
||||
* A TLV list descriptor simplifies processing of messages
|
||||
* containing multiple TLVs.
|
||||
*/
|
||||
|
||||
struct tlv_list_desc {
|
||||
struct tlv_desc *tlv_ptr; /* ptr to current TLV */
|
||||
__u32 tlv_space; /* # bytes from curr TLV to list end */
|
||||
};
|
||||
|
||||
static inline void TLV_LIST_INIT(struct tlv_list_desc *list,
|
||||
void *data, __u32 space)
|
||||
{
|
||||
list->tlv_ptr = (struct tlv_desc *)data;
|
||||
list->tlv_space = space;
|
||||
}
|
||||
|
||||
static inline int TLV_LIST_EMPTY(struct tlv_list_desc *list)
|
||||
{
|
||||
return (list->tlv_space == 0);
|
||||
}
|
||||
|
||||
static inline int TLV_LIST_CHECK(struct tlv_list_desc *list, __u16 exp_type)
|
||||
{
|
||||
return TLV_CHECK(list->tlv_ptr, list->tlv_space, exp_type);
|
||||
}
|
||||
|
||||
static inline void *TLV_LIST_DATA(struct tlv_list_desc *list)
|
||||
{
|
||||
return TLV_DATA(list->tlv_ptr);
|
||||
}
|
||||
|
||||
static inline void TLV_LIST_STEP(struct tlv_list_desc *list)
|
||||
{
|
||||
__u16 tlv_space = TLV_ALIGN(ntohs(list->tlv_ptr->tlv_len));
|
||||
|
||||
list->tlv_ptr = (struct tlv_desc *)((char *)list->tlv_ptr + tlv_space);
|
||||
list->tlv_space -= tlv_space;
|
||||
}
|
||||
|
||||
/*
|
||||
* Configuration messages exchanged via NETLINK_GENERIC use the following
|
||||
* family id, name, version and command.
|
||||
*/
|
||||
#define TIPC_GENL_NAME "TIPC"
|
||||
#define TIPC_GENL_VERSION 0x1
|
||||
#define TIPC_GENL_CMD 0x1
|
||||
|
||||
/*
|
||||
* TIPC specific header used in NETLINK_GENERIC requests.
|
||||
*/
|
||||
struct tipc_genlmsghdr {
|
||||
__u32 dest; /* Destination address */
|
||||
__u16 cmd; /* Command */
|
||||
__u16 reserved; /* Unused */
|
||||
};
|
||||
|
||||
#define TIPC_GENL_HDRLEN NLMSG_ALIGN(sizeof(struct tipc_genlmsghdr))
|
||||
|
||||
/*
|
||||
* Configuration messages exchanged via TIPC sockets use the TIPC configuration
|
||||
* message header, which is defined below. This structure is analogous
|
||||
* to the Netlink message header, but fields are stored in network byte order
|
||||
* and no padding is permitted between the header and the message data
|
||||
* that follows.
|
||||
*/
|
||||
|
||||
struct tipc_cfg_msg_hdr
|
||||
{
|
||||
__u32 tcm_len; /* Message length (including header) */
|
||||
__u16 tcm_type; /* Command type */
|
||||
__u16 tcm_flags; /* Additional flags */
|
||||
char tcm_reserved[8]; /* Unused */
|
||||
};
|
||||
|
||||
#define TCM_F_REQUEST 0x1 /* Flag: Request message */
|
||||
#define TCM_F_MORE 0x2 /* Flag: Message to be continued */
|
||||
|
||||
#define TCM_ALIGN(datalen) (((datalen)+3) & ~3)
|
||||
#define TCM_LENGTH(datalen) (sizeof(struct tipc_cfg_msg_hdr) + datalen)
|
||||
#define TCM_SPACE(datalen) (TCM_ALIGN(TCM_LENGTH(datalen)))
|
||||
#define TCM_DATA(tcm_hdr) ((void *)((char *)(tcm_hdr) + TCM_LENGTH(0)))
|
||||
|
||||
static inline int TCM_SET(void *msg, __u16 cmd, __u16 flags,
|
||||
void *data, __u16 data_len)
|
||||
{
|
||||
struct tipc_cfg_msg_hdr *tcm_hdr;
|
||||
int msg_len;
|
||||
|
||||
msg_len = TCM_LENGTH(data_len);
|
||||
tcm_hdr = (struct tipc_cfg_msg_hdr *)msg;
|
||||
tcm_hdr->tcm_len = htonl(msg_len);
|
||||
tcm_hdr->tcm_type = htons(cmd);
|
||||
tcm_hdr->tcm_flags = htons(flags);
|
||||
if (data_len && data)
|
||||
memcpy(TCM_DATA(msg), data, data_len);
|
||||
return TCM_SPACE(data_len);
|
||||
}
|
||||
|
||||
#endif
|
|
@ -36,10 +36,36 @@
|
|||
|
||||
#ifdef __KERNEL__
|
||||
|
||||
#include <linux/tipc.h>
|
||||
#include <linux/tipc_config.h>
|
||||
#include <linux/skbuff.h>
|
||||
#include <linux/spinlock.h>
|
||||
|
||||
/*
|
||||
* Identifiers of supported TIPC media types
|
||||
*/
|
||||
|
||||
#define TIPC_MEDIA_TYPE_ETH 1
|
||||
|
||||
struct tipc_media_addr {
|
||||
__u32 type;
|
||||
union {
|
||||
__u8 eth_addr[6]; /* Ethernet bearer */
|
||||
#if 0
|
||||
/* Prototypes for other possible bearer types */
|
||||
|
||||
struct {
|
||||
__u16 sin_family;
|
||||
__u16 sin_port;
|
||||
struct {
|
||||
__u32 s_addr;
|
||||
} sin_addr;
|
||||
char pad[4];
|
||||
} addr_in; /* IP-based bearer */
|
||||
__u16 sock_descr; /* generic socket bearer */
|
||||
#endif
|
||||
} dev_addr;
|
||||
};
|
||||
|
||||
/**
|
||||
* struct tipc_bearer - TIPC bearer info available to privileged users
|
||||
* @usr_handle: pointer to additional user-defined information about bearer
|
||||
|
|
|
@ -37,6 +37,7 @@
|
|||
/* ---------------------------------------------------------------------- */
|
||||
|
||||
#include <linux/tipc.h>
|
||||
#include <linux/tipc_config.h>
|
||||
#include "link.h"
|
||||
|
||||
struct sk_buff *cfg_reply_alloc(int payload_size);
|
||||
|
|
|
@ -48,6 +48,7 @@
|
|||
#include <net/sock.h>
|
||||
|
||||
#include <linux/tipc.h>
|
||||
#include <linux/tipc_config.h>
|
||||
#include <net/tipc/tipc_msg.h>
|
||||
#include <net/tipc/tipc_port.h>
|
||||
|
||||
|
|
Loading…
Reference in a new issue