[mirror_ubuntu-bionic-kernel.git] / include / net / ipx.h

/* SPDX-License-Identifier: GPL-2.0 */
#ifndef _NET_INET_IPX_H_
#define _NET_INET_IPX_H_
/*
 *	The following information is in its entirety obtained from:
 *
 *	Novell 'IPX Router Specification' Version 1.10 
 *		Part No. 107-000029-001
 *
 *	Which is available from ftp.novell.com
 */

#include <linux/netdevice.h>
#include <net/datalink.h>
#include <linux/ipx.h>
#include <linux/list.h>
#include <linux/slab.h>
#include <linux/refcount.h>

struct ipx_address {
	__be32  net;
	__u8    node[IPX_NODE_LEN]; 
	__be16  sock;
};

#define ipx_broadcast_node	"\377\377\377\377\377\377"
#define ipx_this_node           "\0\0\0\0\0\0"

#define IPX_MAX_PPROP_HOPS 8

struct ipxhdr {
	__be16			ipx_checksum __packed;
#define IPX_NO_CHECKSUM	cpu_to_be16(0xFFFF)
	__be16			ipx_pktsize __packed;
	__u8			ipx_tctrl;
	__u8			ipx_type;
#define IPX_TYPE_UNKNOWN	0x00
#define IPX_TYPE_RIP		0x01	/* may also be 0 */
#define IPX_TYPE_SAP		0x04	/* may also be 0 */
#define IPX_TYPE_SPX		0x05	/* SPX protocol */
#define IPX_TYPE_NCP		0x11	/* $lots for docs on this (SPIT) */
#define IPX_TYPE_PPROP		0x14	/* complicated flood fill brdcast */
	struct ipx_address	ipx_dest __packed;
	struct ipx_address	ipx_source __packed;
};

/* From af_ipx.c */
extern int sysctl_ipx_pprop_broadcasting;

static __inline__ struct ipxhdr *ipx_hdr(struct sk_buff *skb)
{
	return (struct ipxhdr *)skb_transport_header(skb);
}

struct ipx_interface {
	/* IPX address */
	__be32			if_netnum;
	unsigned char		if_node[IPX_NODE_LEN];
	refcount_t		refcnt;

	/* physical device info */
	struct net_device	*if_dev;
	struct datalink_proto	*if_dlink;
	__be16			if_dlink_type;

	/* socket support */
	unsigned short		if_sknum;
	struct hlist_head	if_sklist;
	spinlock_t		if_sklist_lock;

	/* administrative overhead */
	int			if_ipx_offset;
	unsigned char		if_internal;
	unsigned char		if_primary;
	
	struct list_head	node; /* node in ipx_interfaces list */
};

struct ipx_route {
	__be32			ir_net;
	struct ipx_interface	*ir_intrfc;
	unsigned char		ir_routed;
	unsigned char		ir_router_node[IPX_NODE_LEN];
	struct list_head	node; /* node in ipx_routes list */
	refcount_t		refcnt;
};

struct ipx_cb {
	u8	ipx_tctrl;
	__be32	ipx_dest_net;
	__be32	ipx_source_net;
	struct {
		__be32 netnum;
		int index;
	} last_hop;
};

#include <net/sock.h>

struct ipx_sock {
	/* struct sock has to be the first member of ipx_sock */
	struct sock		sk;
	struct ipx_address	dest_addr;
	struct ipx_interface	*intrfc;
	__be16			port;
#ifdef CONFIG_IPX_INTERN
	unsigned char		node[IPX_NODE_LEN];
#endif
	unsigned short		type;
	/*
	 * To handle special ncp connection-handling sockets for mars_nwe,
 	 * the connection number must be stored in the socket.
	 */
	unsigned short		ipx_ncp_conn;
};

static inline struct ipx_sock *ipx_sk(struct sock *sk)
{
	return (struct ipx_sock *)sk;
}

#define IPX_SKB_CB(__skb) ((struct ipx_cb *)&((__skb)->cb[0]))

#define IPX_MIN_EPHEMERAL_SOCKET	0x4000
#define IPX_MAX_EPHEMERAL_SOCKET	0x7fff

extern struct list_head ipx_routes;
extern rwlock_t ipx_routes_lock;

extern struct list_head ipx_interfaces;
struct ipx_interface *ipx_interfaces_head(void);
extern spinlock_t ipx_interfaces_lock;

extern struct ipx_interface *ipx_primary_net;

int ipx_proc_init(void);
void ipx_proc_exit(void);

const char *ipx_frame_name(__be16);
const char *ipx_device_name(struct ipx_interface *intrfc);

static __inline__ void ipxitf_hold(struct ipx_interface *intrfc)
{
	refcount_inc(&intrfc->refcnt);
}

void ipxitf_down(struct ipx_interface *intrfc);
struct ipx_interface *ipxitf_find_using_net(__be32 net);
int ipxitf_send(struct ipx_interface *intrfc, struct sk_buff *skb, char *node);
__be16 ipx_cksum(struct ipxhdr *packet, int length);
int ipxrtr_add_route(__be32 network, struct ipx_interface *intrfc,
		     unsigned char *node);
void ipxrtr_del_routes(struct ipx_interface *intrfc);
int ipxrtr_route_packet(struct sock *sk, struct sockaddr_ipx *usipx,
			struct msghdr *msg, size_t len, int noblock);
int ipxrtr_route_skb(struct sk_buff *skb);
struct ipx_route *ipxrtr_lookup(__be32 net);
int ipxrtr_ioctl(unsigned int cmd, void __user *arg);

static __inline__ void ipxitf_put(struct ipx_interface *intrfc)
{
	if (refcount_dec_and_test(&intrfc->refcnt))
		ipxitf_down(intrfc);
}

static __inline__ void ipxrtr_hold(struct ipx_route *rt)
{
	        refcount_inc(&rt->refcnt);
}

static __inline__ void ipxrtr_put(struct ipx_route *rt)
{
	        if (refcount_dec_and_test(&rt->refcnt))
			                kfree(rt);
}
#endif /* _NET_INET_IPX_H_ */
Commit	Line	Data
b2441318	1	/* SPDX-License-Identifier: GPL-2.0 */
1da177e4 LT	2	#ifndef _NET_INET_IPX_H_
	3	#define _NET_INET_IPX_H_
	4	/*
	5	* The following information is in its entirety obtained from:
	6	*
	7	* Novell 'IPX Router Specification' Version 1.10
	8	* Part No. 107-000029-001
	9	*
	10	* Which is available from ftp.novell.com
	11	*/
	12
	13	#include <linux/netdevice.h>
	14	#include <net/datalink.h>
	15	#include <linux/ipx.h>
	16	#include <linux/list.h>
5a0e3ad6	17	#include <linux/slab.h>
d25189ca	18	#include <linux/refcount.h>
1da177e4 LT	19
1da177e4 LT	20	struct ipx_address {
4833ed09	21	__be32 net;
1da177e4	22	__u8 node[IPX_NODE_LEN];
4833ed09	23	__be16 sock;
1da177e4 LT	24	};
	25
	26	#define ipx_broadcast_node "\377\377\377\377\377\377"
	27	#define ipx_this_node "\0\0\0\0\0\0"
	28
	29	#define IPX_MAX_PPROP_HOPS 8
	30
	31	struct ipxhdr {
bc10502d	32	__be16 ipx_checksum __packed;
f3a7c66b	33	#define IPX_NO_CHECKSUM cpu_to_be16(0xFFFF)
bc10502d	34	__be16 ipx_pktsize __packed;
1da177e4 LT	35	__u8 ipx_tctrl;
	36	__u8 ipx_type;
	37	#define IPX_TYPE_UNKNOWN 0x00
	38	#define IPX_TYPE_RIP 0x01 /* may also be 0 */
	39	#define IPX_TYPE_SAP 0x04 /* may also be 0 */
	40	#define IPX_TYPE_SPX 0x05 /* SPX protocol */
	41	#define IPX_TYPE_NCP 0x11 /* $lots for docs on this (SPIT) */
	42	#define IPX_TYPE_PPROP 0x14 /* complicated flood fill brdcast */
bc10502d ED	43	struct ipx_address ipx_dest __packed;
bc10502d ED	44	struct ipx_address ipx_source __packed;
1da177e4 LT	45	};
1da177e4 LT	46
5e96d788 FF	47	/* From af_ipx.c */
	48	extern int sysctl_ipx_pprop_broadcasting;
	49
1da177e4 LT	50	static __inline__ struct ipxhdr ipx_hdr(struct sk_buff skb)
1da177e4 LT	51	{
9c70220b	52	return (struct ipxhdr *)skb_transport_header(skb);
1da177e4 LT	53	}
	54
	55	struct ipx_interface {
	56	/* IPX address */
4833ed09	57	__be32 if_netnum;
1da177e4	58	unsigned char if_node[IPX_NODE_LEN];
d25189ca	59	refcount_t refcnt;
1da177e4 LT	60
	61	/* physical device info */
	62	struct net_device *if_dev;
	63	struct datalink_proto *if_dlink;
4833ed09	64	__be16 if_dlink_type;
1da177e4 LT	65
	66	/* socket support */
	67	unsigned short if_sknum;
	68	struct hlist_head if_sklist;
	69	spinlock_t if_sklist_lock;
	70
	71	/* administrative overhead */
	72	int if_ipx_offset;
	73	unsigned char if_internal;
	74	unsigned char if_primary;
	75
	76	struct list_head node; /* node in ipx_interfaces list */
	77	};
	78
	79	struct ipx_route {
4833ed09	80	__be32 ir_net;
1da177e4 LT	81	struct ipx_interface *ir_intrfc;
	82	unsigned char ir_routed;
	83	unsigned char ir_router_node[IPX_NODE_LEN];
	84	struct list_head node; /* node in ipx_routes list */
16f73c96	85	refcount_t refcnt;
1da177e4 LT	86	};
1da177e4 LT	87
1da177e4 LT	88	struct ipx_cb {
1da177e4 LT	89	u8 ipx_tctrl;
4833ed09 AV	90	__be32 ipx_dest_net;
4833ed09 AV	91	__be32 ipx_source_net;
1da177e4	92	struct {
4833ed09	93	__be32 netnum;
1da177e4 LT	94	int index;
	95	} last_hop;
	96	};
	97
	98	#include <net/sock.h>
	99
	100	struct ipx_sock {
	101	/* struct sock has to be the first member of ipx_sock */
	102	struct sock sk;
	103	struct ipx_address dest_addr;
	104	struct ipx_interface *intrfc;
4833ed09	105	__be16 port;
1da177e4 LT	106	#ifdef CONFIG_IPX_INTERN
	107	unsigned char node[IPX_NODE_LEN];
	108	#endif
	109	unsigned short type;
	110	/*
	111	* To handle special ncp connection-handling sockets for mars_nwe,
	112	* the connection number must be stored in the socket.
	113	*/
	114	unsigned short ipx_ncp_conn;
	115	};
	116
	117	static inline struct ipx_sock ipx_sk(struct sock sk)
	118	{
	119	return (struct ipx_sock *)sk;
	120	}
	121
	122	#define IPX_SKB_CB(__skb) ((struct ipx_cb *)&((__skb)->cb[0]))
1da177e4 LT	123
	124	#define IPX_MIN_EPHEMERAL_SOCKET 0x4000
	125	#define IPX_MAX_EPHEMERAL_SOCKET 0x7fff
	126
	127	extern struct list_head ipx_routes;
	128	extern rwlock_t ipx_routes_lock;
	129
	130	extern struct list_head ipx_interfaces;
9d03626a	131	struct ipx_interface *ipx_interfaces_head(void);
1da177e4 LT	132	extern spinlock_t ipx_interfaces_lock;
	133
	134	extern struct ipx_interface *ipx_primary_net;
	135
9d03626a JP	136	int ipx_proc_init(void);
9d03626a JP	137	void ipx_proc_exit(void);
1da177e4	138
9d03626a JP	139	const char *ipx_frame_name(__be16);
9d03626a JP	140	const char ipx_device_name(struct ipx_interface intrfc);
1da177e4 LT	141
	142	static __inline__ void ipxitf_hold(struct ipx_interface *intrfc)
	143	{
d25189ca	144	refcount_inc(&intrfc->refcnt);
1da177e4 LT	145	}
1da177e4 LT	146
9d03626a	147	void ipxitf_down(struct ipx_interface *intrfc);
493cc5e5 RK	148	struct ipx_interface *ipxitf_find_using_net(__be32 net);
	149	int ipxitf_send(struct ipx_interface intrfc, struct sk_buff skb, char *node);
	150	__be16 ipx_cksum(struct ipxhdr *packet, int length);
578efbc1 RK	151	int ipxrtr_add_route(__be32 network, struct ipx_interface *intrfc,
	152	unsigned char *node);
	153	void ipxrtr_del_routes(struct ipx_interface *intrfc);
	154	int ipxrtr_route_packet(struct sock sk, struct sockaddr_ipx usipx,
e1693718	155	struct msghdr *msg, size_t len, int noblock);
578efbc1 RK	156	int ipxrtr_route_skb(struct sk_buff *skb);
	157	struct ipx_route *ipxrtr_lookup(__be32 net);
	158	int ipxrtr_ioctl(unsigned int cmd, void __user *arg);
1da177e4 LT	159
	160	static __inline__ void ipxitf_put(struct ipx_interface *intrfc)
	161	{
d25189ca	162	if (refcount_dec_and_test(&intrfc->refcnt))
1da177e4 LT	163	ipxitf_down(intrfc);
	164	}
	165
	166	static __inline__ void ipxrtr_hold(struct ipx_route *rt)
	167	{
16f73c96	168	refcount_inc(&rt->refcnt);
1da177e4 LT	169	}
	170
	171	static __inline__ void ipxrtr_put(struct ipx_route *rt)
	172	{
16f73c96	173	if (refcount_dec_and_test(&rt->refcnt))
1da177e4 LT	174	kfree(rt);
	175	}
	176	#endif /* _NET_INET_IPX_H_ */