[apple/xnu.git] / bsd / netat / atp.h

/*
 * Copyright (c) 2000 Apple Computer, Inc. All rights reserved.
 *
 * @APPLE_LICENSE_HEADER_START@
 * 
 * The contents of this file constitute Original Code as defined in and
 * are subject to the Apple Public Source License Version 1.1 (the
 * "License").  You may not use this file except in compliance with the
 * License.  Please obtain a copy of the License at
 * http://www.apple.com/publicsource and read it before using this file.
 * 
 * This Original Code and all software distributed under the License are
 * distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, EITHER
 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT.  Please see the
 * License for the specific language governing rights and limitations
 * under the License.
 * 
 * @APPLE_LICENSE_HEADER_END@
 */
/*
 *
 * ORIGINS: 82
 *
 * (C) COPYRIGHT Apple Computer, Inc. 1992-1996
 * All Rights Reserved
 *
 */                                                                   

/* Definitions for ATP protocol and streams module, per 
 * AppleTalk Transaction Protocol documentation from
 * `Inside AppleTalk', July 14, 1986.
 */

/*
 *	Copyright (c) 1988, 1989 Apple Computer, Inc. 
 *
 *	The information contained herein is subject to change without
 *	notice and  should not be  construed as a commitment by Apple
 *	Computer, Inc. Apple Computer, Inc. assumes no responsibility
 *	for any errors that may appear.
 *
 *	Confidential and Proprietary to Apple Computer, Inc.
 */

#ifndef _NETAT_ATP_H_
#define _NETAT_ATP_H_
#include <sys/appleapiopts.h>

#ifdef __APPLE_API_OBSOLETE

/* ATP function codes */

#define ATP_CMD_TREQ		0x01	/* TRequest packet  */
#define ATP_CMD_TRESP		0x02	/* TResponse packet */
#define ATP_CMD_TREL		0x03	/* TRelease packet  */

/* Miscellaneous definitions */

#define	ATP_DEF_RETRIES     8	/* Default for maximum retry count */
#define	ATP_DEF_INTERVAL    2	/* Default for retry interval in seconds */

#define ATP_TRESP_MAX       8	/* Maximum number of Tresp pkts */

#define ATP_HDR_SIZE        8  	/* Size of the ATP header */
#define ATP_DATA_SIZE       578  	/* Maximum size of the ATP data area */

/* Consts for asynch support */
#define	ATP_ASYNCH_REQ	1
#define	ATP_ASYNCH_RESP	2

/* Timer values for XO release timers */
#define	ATP_XO_DEF_REL_TIME	0
#define	ATP_XO_30SEC		0
#define	ATP_XO_1MIN		1
#define	ATP_XO_2MIN		2
#define	ATP_XO_4MIN		3
#define	ATP_XO_8MIN		4

typedef struct {
        unsigned       cmd : 2,
                       xo : 1,
                       eom : 1,
                       sts : 1,
                       xo_relt : 3;
        u_char         bitmap;
	ua_short       tid;
        ua_long        user_bytes;
        u_char         data[ATP_DATA_SIZE];
} at_atp_t;

#define ATP_ATP_HDR(c) ((at_atp_t *)(&((at_ddp_t *)(c))->data[0]))

#define TOTAL_ATP_HDR_SIZE    (ATP_HDR_SIZE+DDP_X_HDR_SIZE)
#define ATP_CLEAR_CONTROL(c)  (*(char *)(c) = 0)

/* ATP ioctl interface */

/* Structure for the atp_set_default call */

#define	ATP_INFINITE_RETRIES	0xffffffff	/* means retry forever
						 * in the def_retries field
					 	 */

struct atp_set_default {
	u_int	def_retries;		/* number of retries for a request */
	u_int	def_rate;		/* retry rate (in seconds/100) NB: the
					 * system may not be able to resolve
					 * delays of 100th of a second but will
					 * instead make a 'best effort'
					 */
	struct atpBDS *def_bdsp; /*  BDS structure associated with this req */
	u_int	def_BDSlen;	/* size of BDS structure */
};


/* Return header from requests */

struct atp_result {
	u_short		count;		/* the number of packets */
	u_short		hdr;		/* offset to header in buffer */
	u_short 	offset[8];	/* offset to the Nth packet in the buffer */
	u_short		len[8];		/* length of the Nth packet */
};

struct atpBDS {
	ua_short	bdsBuffSz;
	ua_long		bdsBuffAddr;
	ua_short	bdsDataSz;
	unsigned char	bdsUserData[4];
};


typedef struct {
        u_short        at_atpreq_type;
        at_inet_t      at_atpreq_to;
        u_char         at_atpreq_treq_user_bytes[4];
        u_char         *at_atpreq_treq_data;
        u_short        at_atpreq_treq_length;
        u_char         at_atpreq_treq_bitmap;
        u_char         at_atpreq_xo;
        u_char         at_atpreq_xo_relt;
        u_short        at_atpreq_retry_timeout;
        u_short        at_atpreq_maximum_retries;
        u_char         at_atpreq_tresp_user_bytes[ATP_TRESP_MAX][4];
        u_char         *at_atpreq_tresp_data[ATP_TRESP_MAX];
        u_short        at_atpreq_tresp_lengths[ATP_TRESP_MAX];
        u_long         at_atpreq_debug[4];
        u_short        at_atpreq_tid;
        u_char         at_atpreq_tresp_bitmap;
        u_char         at_atpreq_tresp_eom_seqno;
        u_char         at_atpreq_got_trel;
} at_atpreq;


/* The ATP module ioctl commands */

#define AT_ATP_CANCEL_REQUEST		(('|'<<8)|1)
#define AT_ATP_ISSUE_REQUEST		(('|'<<8)|2) /* ALO */
#define AT_ATP_ISSUE_REQUEST_DEF	(('|'<<8)|3) /* XO */
#define AT_ATP_ISSUE_REQUEST_DEF_NOTE	(('|'<<8)|4) /* XO & nowait -- not needed*/
#define AT_ATP_ISSUE_REQUEST_NOTE	(('|'<<8)|5) /* ALO & nowait */
#define AT_ATP_GET_POLL			(('|'<<8)|6)
#define AT_ATP_RELEASE_RESPONSE		(('|'<<8)|7)
#define AT_ATP_REQUEST_COMPLETE		(('|'<<8)|8)
#define AT_ATP_SEND_FULL_RESPONSE	(('|'<<8)|9) /* not used */
#define AT_ATP_BIND_REQ			(('|'<<8)|10)
#define AT_ATP_GET_CHANID		(('|'<<8)|11)
#define AT_ATP_PEEK			(('|'<<8)|12)
#define AT_ATP_ISSUE_REQUEST_TICKLE 	(('|'<<8)|13) /* ALO & nowait */

/* These macros don't really depend here, but since they're used only by the
 * old ATP and old PAP, they're put here.  Unisoft PAP includes this file.
 */
#define	R16(x)		UAS_VALUE(x)
#define	W16(x,v)	UAS_ASSIGN(x, v)
#define	C16(x,v)	UAS_UAS(x, v)

/*
 * these are the dispatch codes for
 * the new atp_control system call
 */
#define ATP_SENDREQUEST  0
#define ATP_GETRESPONSE  1
#define ATP_SENDRESPONSE 2
#define ATP_GETREQUEST   3

#ifdef KERNEL_PRIVATE


/*
 *	Stuff for accessing protocol headers 
 */
#define AT_DDP_HDR(m) ((at_ddp_t *)(gbuf_rptr(m)))
#define AT_ATP_HDR(m) ((at_atp_t *)(&((at_ddp_t *)(gbuf_rptr(m)))->data[0]))

/*
 *	Masks for accessing/manipulating the bitmap field in atp headers
 */

#ifdef ATP_DECLARE
unsigned char atp_mask [] = {
	0x01, 0x02, 0x04, 0x08, 
	0x10, 0x20, 0x40, 0x80, 
};

unsigned char atp_lomask [] = {
	0x00, 0x01, 0x03, 0x07, 
	0x0f, 0x1f, 0x3f, 0x7f, 
	0xff
};
#else
extern unsigned char atp_mask [];
extern unsigned char atp_lomask [];
#endif /* ATP_DECLARE */

/*
 *	doubly linked queue types and primitives
 */

#define ATP_Q_ENTER(hdr, object, entry) {					\
		if ((hdr).head) {						\
			(hdr).head->entry.prev = (object);			\
			(object)->entry.next = (hdr).head;			\
		} else {							\
			(hdr).tail = (object);					\
			(object)->entry.next = NULL;				\
		}								\
		(object)->entry.prev = NULL;					\
		(hdr).head = (object);						\
	}

#define ATP_Q_APPEND(hdr, object, entry) {					\
		if ((hdr).head) {						\
			(hdr).tail->entry.next = (object);			\
			(object)->entry.prev = (hdr).tail;			\
		} else {							\
			(hdr).head = (object);					\
			(object)->entry.prev = NULL;				\
		}								\
		(object)->entry.next = NULL;					\
		(hdr).tail = (object);						\
	}

#define ATP_Q_REMOVE(hdr, object, entry) {					\
		if ((object)->entry.prev) {					\
			(object)->entry.prev->entry.next = (object)->entry.next;\
		} else {							\
			(hdr).head = (object)->entry.next;			\
		}								\
		if ((object)->entry.next) {					\
			(object)->entry.next->entry.prev = (object)->entry.prev;\
		} else {							\
			(hdr).tail = (object)->entry.prev;			\
		}								\
	}

struct atp_rcb_qhead {
	struct atp_rcb 	*head;
	struct atp_rcb 	*tail;
};

struct atp_rcb_q {
	struct atp_rcb *prev;
	struct atp_rcb *next;
};

struct atp_trans_qhead {
	struct atp_trans *head;
	struct atp_trans *tail;
};

struct atp_trans_q {
	struct atp_trans *prev;
	struct atp_trans *next;
};

/*
 *	Locally saved remote node address
 */

struct atp_socket {
	u_short		net;
	at_node		node;
	at_socket	socket;
};

/*
 *	transaction control block (local context at requester end)
 */

struct atp_trans {
	struct atp_trans_q	tr_list;		/* trans list */
	struct atp_state	*tr_queue;		/* state data structure */
	gbuf_t			*tr_xmt;		/* message being sent */
	gbuf_t			*tr_rcv[8];		/* message being rcvd */
	unsigned int		tr_retry;		/* # retries left */
	unsigned int		tr_timeout;		/* timer interval */
	char			tr_state;		/* current state */
	char			tr_rsp_wait;		/* waiting for transaction response */
	char 			filler[2];
	unsigned char		tr_xo;			/* execute once transaction */
	unsigned char		tr_bitmap;		/* requested bitmask */
	unsigned short		tr_tid;			/* transaction id */
	struct atp_socket	tr_socket;		/* the remote socket id */
	struct atp_trans_q	tr_snd_wait;		/* list of transactions waiting
							   for space to send a msg */
	at_socket		tr_local_socket;
	at_node			tr_local_node;
	at_net			tr_local_net;
	gbuf_t                  *tr_bdsp;               /* bds structure pointer */
	unsigned int		tr_tmo_delta;
	void 				(*tr_tmo_func)();
	struct atp_trans	*tr_tmo_next;
	struct atp_trans	*tr_tmo_prev;
	atlock_t tr_lock;
	atevent_t tr_event;
};

#define	TRANS_TIMEOUT		0	/* waiting for a reply */
#define	TRANS_REQUEST		1	/* waiting to send a request */
#define	TRANS_RELEASE		2	/* waiting to send a release */
#define	TRANS_DONE			3	/* done - waiting for poll to complete */
#define	TRANS_FAILED		4	/* done - waiting for poll to report failure */
#define TRANS_ABORTING		5	/* waiting on atp_trans_abort list for thread to wakeup */

/*
 *	reply control block (local context at repling end)
 */

struct atp_rcb {
	struct atp_rcb_q	rc_list;		/* rcb list */
	struct atp_rcb_q        rc_tlist;
	struct atp_state	*rc_queue;		/* state data structure */
	gbuf_t			*rc_xmt;		/* replys being sent */
	gbuf_t			*rc_ioctl;		/* waiting ioctl */
	char			rc_snd[8];		/* replys actually to be sent */
	int                     rc_pktcnt;              /* no of pkts in this trans */
	short			rc_state;		/* current state */
	unsigned char		rc_xo;			/* execute once transaction */
	at_node			rc_local_node;
	at_net			rc_local_net;
	short			rc_rep_waiting;		/* in the reply wait list */
	int			rc_timestamp;		/* reply timer */
	unsigned char		rc_bitmap;		/* replied bitmask */
	unsigned char		rc_not_sent_bitmap;	/* replied bitmask */
	unsigned short		rc_tid;			/* transaction id */
	struct atp_socket	rc_socket;		/* the remote socket id */
};

#define RCB_UNQUEUED		0 	/* newly allocated, not q'd */
#define RCB_RESPONDING		2	/* waiting all of response from process*/
#define RCB_RESPONSE_FULL	3	/* got all of response */
#define RCB_RELEASED		4	/* got our release */
#define RCB_PENDING		5	/* a no wait rcb is full */
#define RCB_NOTIFIED		6
#define RCB_SENDING		7	/* we're currently xmitting this trans */

/*
 *	socket state (per module data structure)
 */

struct atp_state {
	gref_t		*atp_gref;	/* must be the first entry */
	int		atp_pid; 	/* process id, must be the second entry */
	gbuf_t 		*atp_msgq;	/* data msg, must be the third entry */
	unsigned char	dflag; 		/* structure flag, must be the fourth entry */
	unsigned char	filler;
	short	atp_socket_no;
	short	atp_flags;	        /* general flags */
	struct atp_trans_qhead	atp_trans_wait;		/* pending transaction list */
	struct atp_state	*atp_trans_waiting;	/* list of atps waiting for a
							   free transaction */
	unsigned int		atp_retry;		/* retry count */
	unsigned int		atp_timeout;		/* retry timeout */
	struct atp_state	*atp_rcb_waiting;
	struct atp_rcb_qhead	atp_rcb;		/* active rcbs */
	struct atp_rcb_qhead	atp_attached;		/* rcb's waiting to be read */
	atlock_t atp_lock;
	atevent_t atp_event;
	atlock_t atp_delay_lock;
	atevent_t atp_delay_event;
};


/*
 *     atp_state flag definitions
 */
#define ATP_CLOSING  0x08        /* atp stream in process of closing */


/*
 *	tcb/rcb/state allocation queues
 */

/*
 * Size defines; must be outside following #ifdef to permit
 *  debugging code to reference independent of ATP_DECLARE
 */
#define	NATP_RCB	512	/* the number of ATP RCBs at once */
#define NATP_STATE	192	/* the number of ATP sockets open at once */
				/* note: I made NATP_STATE == NSOCKETS */

#ifdef ATP_DECLARE
struct atp_trans *atp_trans_free_list = NULL;	/* free transactions */
struct atp_rcb *atp_rcb_free_list = NULL;		/* free rcbs */
struct atp_state *atp_free_list = NULL;         	/* free atp states */
struct atp_trans_qhead	atp_trans_abort;		/* aborted trans list */
struct atp_rcb* atp_rcb_data = NULL;
struct atp_state* atp_state_data=NULL;


#else
extern struct atp_trans *atp_trans_free_list;		/* free transactions */
extern struct atp_rcb *atp_rcb_free_list;			/* free rcbs */
extern struct atp_state *atp_free_list;				/* free atp states */
extern struct atp_rcb* atp_rcb_data;
extern struct atp_state* atp_state_data;
extern struct atp_trans_qhead atp_trans_abort;		/* aborting trans list */

extern void atp_req_timeout();
extern void atp_rcb_timer();
extern void atp_x_done();
extern struct atp_rcb *atp_rcb_alloc();
extern struct atp_trans *atp_trans_alloc();
#endif /* ATP_DECLARE */

/* prototypes */
void atp_send_req(gref_t *, gbuf_t *);
void atp_drop_req(gref_t *, gbuf_t *);
void atp_send_rsp(gref_t *, gbuf_t *, int);
void atp_wput(gref_t *, gbuf_t *);
void atp_rput(gref_t *, gbuf_t *);
void atp_retry_req(void *);
void atp_stop(gbuf_t *, int);
void atp_cancel_req(gref_t *, unsigned short);
int atp_open(gref_t *, int);
int atp_bind(gref_t *, unsigned int, unsigned char *);
int atp_close(gref_t *, int);
gbuf_t *atp_build_release(struct atp_trans *);
void atp_req_timeout(struct atp_trans *);
void atp_free(struct atp_trans *);
void atp_x_done(struct atp_trans *);
void atp_send(struct atp_trans *);
void atp_rsp_ind(struct atp_trans *, gbuf_t *);
void atp_trans_free(struct atp_trans *);
void atp_reply(struct atp_rcb *);
void atp_rcb_free(struct atp_rcb *);
void atp_send_replies(struct atp_state *, struct atp_rcb *);
void atp_dequeue_atp(struct atp_state *);
int atp_iocack(struct atp_state *, gbuf_t *);
void atp_req_ind(struct atp_state *, gbuf_t *);
int atp_iocnak(struct atp_state *, gbuf_t *, int);
void atp_trp_timer(void *, int);
void atp_timout(void (*func)(), struct atp_trans *, int);
void atp_untimout(void (*func)(), struct atp_trans *);
int atp_tid(struct atp_state *);

#endif /* KERNEL_PRIVATE */
#endif /* __APPLE_API_OBSOLETE */
#endif /* _NETAT_ATP_H_ */
Commit	Line	Data
1c79356b A	1	/*
	2	* Copyright (c) 2000 Apple Computer, Inc. All rights reserved.
	3	*
	4	* @APPLE_LICENSE_HEADER_START@
	5	*
e5568f75 A	6	* The contents of this file constitute Original Code as defined in and
	7	* are subject to the Apple Public Source License Version 1.1 (the
	8	* "License"). You may not use this file except in compliance with the
	9	* License. Please obtain a copy of the License at
	10	* http://www.apple.com/publicsource and read it before using this file.
1c79356b	11	*
e5568f75 A	12	* This Original Code and all software distributed under the License are
e5568f75 A	13	* distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, EITHER
1c79356b A	14	* EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
1c79356b A	15	* INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
e5568f75 A	16	* FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT. Please see the
	17	* License for the specific language governing rights and limitations
	18	* under the License.
1c79356b A	19	*
	20	* @APPLE_LICENSE_HEADER_END@
	21	*/
	22	/*
	23	*
	24	* ORIGINS: 82
	25	*
	26	* (C) COPYRIGHT Apple Computer, Inc. 1992-1996
	27	* All Rights Reserved
	28	*
	29	*/
	30
	31	/* Definitions for ATP protocol and streams module, per
	32	* AppleTalk Transaction Protocol documentation from
	33	* `Inside AppleTalk', July 14, 1986.
	34	*/
	35
	36	/*
	37	* Copyright (c) 1988, 1989 Apple Computer, Inc.
	38	*
	39	* The information contained herein is subject to change without
	40	* notice and should not be construed as a commitment by Apple
	41	* Computer, Inc. Apple Computer, Inc. assumes no responsibility
	42	* for any errors that may appear.
	43	*
	44	* Confidential and Proprietary to Apple Computer, Inc.
	45	*/
	46
	47	#ifndef _NETAT_ATP_H_
	48	#define _NETAT_ATP_H_
9bccf70c	49	#include <sys/appleapiopts.h>
1c79356b	50
91447636 A	51	#ifdef __APPLE_API_OBSOLETE
91447636 A	52
1c79356b A	53	/* ATP function codes */
	54
	55	#define ATP_CMD_TREQ 0x01 /* TRequest packet */
	56	#define ATP_CMD_TRESP 0x02 /* TResponse packet */
	57	#define ATP_CMD_TREL 0x03 /* TRelease packet */
	58
	59	/* Miscellaneous definitions */
	60
	61	#define ATP_DEF_RETRIES 8 /* Default for maximum retry count */
	62	#define ATP_DEF_INTERVAL 2 /* Default for retry interval in seconds */
	63
	64	#define ATP_TRESP_MAX 8 /* Maximum number of Tresp pkts */
	65
	66	#define ATP_HDR_SIZE 8 /* Size of the ATP header */
	67	#define ATP_DATA_SIZE 578 /* Maximum size of the ATP data area */
	68
	69	/* Consts for asynch support */
	70	#define ATP_ASYNCH_REQ 1
	71	#define ATP_ASYNCH_RESP 2
	72
	73	/* Timer values for XO release timers */
	74	#define ATP_XO_DEF_REL_TIME 0
	75	#define ATP_XO_30SEC 0
	76	#define ATP_XO_1MIN 1
	77	#define ATP_XO_2MIN 2
	78	#define ATP_XO_4MIN 3
	79	#define ATP_XO_8MIN 4
	80
	81	typedef struct {
	82	unsigned cmd : 2,
	83	xo : 1,
	84	eom : 1,
	85	sts : 1,
	86	xo_relt : 3;
	87	u_char bitmap;
	88	ua_short tid;
	89	ua_long user_bytes;
	90	u_char data[ATP_DATA_SIZE];
	91	} at_atp_t;
	92
	93	#define ATP_ATP_HDR(c) ((at_atp_t )(&((at_ddp_t )(c))->data[0]))
	94
	95	#define TOTAL_ATP_HDR_SIZE (ATP_HDR_SIZE+DDP_X_HDR_SIZE)
	96	#define ATP_CLEAR_CONTROL(c) ((char )(c) = 0)
	97
	98	/* ATP ioctl interface */
	99
	100	/* Structure for the atp_set_default call */
	101
	102	#define ATP_INFINITE_RETRIES 0xffffffff /* means retry forever
	103	* in the def_retries field
	104	*/
	105
	106	struct atp_set_default {
	107	u_int def_retries; /* number of retries for a request */
	108	u_int def_rate; /* retry rate (in seconds/100) NB: the
	109	* system may not be able to resolve
	110	* delays of 100th of a second but will
	111	* instead make a 'best effort'
	112	*/
	113	struct atpBDS def_bdsp; / BDS structure associated with this req */
	114	u_int def_BDSlen; /* size of BDS structure */
	115	};
	116
117
118	/* Return header from requests */
119
120	struct atp_result {
121	u_short count; /* the number of packets */
122	u_short hdr; /* offset to header in buffer */
123	u_short offset[8]; /* offset to the Nth packet in the buffer */
124	u_short len[8]; /* length of the Nth packet */
125	};
126
127	struct atpBDS {
128	ua_short bdsBuffSz;
129	ua_long bdsBuffAddr;
130	ua_short bdsDataSz;
131	unsigned char bdsUserData[4];
132	};
133
134
135	typedef struct {
136	u_short at_atpreq_type;
137	at_inet_t at_atpreq_to;
138	u_char at_atpreq_treq_user_bytes[4];
139	u_char *at_atpreq_treq_data;
140	u_short at_atpreq_treq_length;
141	u_char at_atpreq_treq_bitmap;
142	u_char at_atpreq_xo;
143	u_char at_atpreq_xo_relt;
144	u_short at_atpreq_retry_timeout;
145	u_short at_atpreq_maximum_retries;
146	u_char at_atpreq_tresp_user_bytes[ATP_TRESP_MAX][4];
147	u_char *at_atpreq_tresp_data[ATP_TRESP_MAX];
148	u_short at_atpreq_tresp_lengths[ATP_TRESP_MAX];
149	u_long at_atpreq_debug[4];
150	u_short at_atpreq_tid;
151	u_char at_atpreq_tresp_bitmap;
152	u_char at_atpreq_tresp_eom_seqno;
153	u_char at_atpreq_got_trel;
154	} at_atpreq;
155
156
157	/* The ATP module ioctl commands */
158
159	#define AT_ATP_CANCEL_REQUEST (('\|'<<8)\|1)
160	#define AT_ATP_ISSUE_REQUEST (('\|'<<8)\|2) /* ALO */
161	#define AT_ATP_ISSUE_REQUEST_DEF (('\|'<<8)\|3) /* XO */
162	#define AT_ATP_ISSUE_REQUEST_DEF_NOTE (('\|'<<8)\|4) /* XO & nowait -- not needed*/
163	#define AT_ATP_ISSUE_REQUEST_NOTE (('\|'<<8)\|5) /* ALO & nowait */
164	#define AT_ATP_GET_POLL (('\|'<<8)\|6)
165	#define AT_ATP_RELEASE_RESPONSE (('\|'<<8)\|7)
166	#define AT_ATP_REQUEST_COMPLETE (('\|'<<8)\|8)
167	#define AT_ATP_SEND_FULL_RESPONSE (('\|'<<8)\|9) /* not used */
168	#define AT_ATP_BIND_REQ (('\|'<<8)\|10)
169	#define AT_ATP_GET_CHANID (('\|'<<8)\|11)
170	#define AT_ATP_PEEK (('\|'<<8)\|12)
171	#define AT_ATP_ISSUE_REQUEST_TICKLE (('\|'<<8)\|13) /* ALO & nowait */
172
173	/* These macros don't really depend here, but since they're used only by the
174	* old ATP and old PAP, they're put here. Unisoft PAP includes this file.
175	*/
176	#define R16(x) UAS_VALUE(x)
177	#define W16(x,v) UAS_ASSIGN(x, v)
178	#define C16(x,v) UAS_UAS(x, v)
179
180	/*
181	* these are the dispatch codes for
182	* the new atp_control system call
183	*/
184	#define ATP_SENDREQUEST 0
185	#define ATP_GETRESPONSE 1
186	#define ATP_SENDRESPONSE 2
187	#define ATP_GETREQUEST 3
188
91447636	189	#ifdef KERNEL_PRIVATE
1c79356b A	190
	191
	192	/*
	193	* Stuff for accessing protocol headers
	194	*/
	195	#define AT_DDP_HDR(m) ((at_ddp_t *)(gbuf_rptr(m)))
	196	#define AT_ATP_HDR(m) ((at_atp_t )(&((at_ddp_t )(gbuf_rptr(m)))->data[0]))
	197
	198	/*
	199	* Masks for accessing/manipulating the bitmap field in atp headers
	200	*/
	201
	202	#ifdef ATP_DECLARE
	203	unsigned char atp_mask [] = {
	204	0x01, 0x02, 0x04, 0x08,
	205	0x10, 0x20, 0x40, 0x80,
	206	};
	207
	208	unsigned char atp_lomask [] = {
	209	0x00, 0x01, 0x03, 0x07,
	210	0x0f, 0x1f, 0x3f, 0x7f,
	211	0xff
	212	};
	213	#else
	214	extern unsigned char atp_mask [];
	215	extern unsigned char atp_lomask [];
	216	#endif /* ATP_DECLARE */
	217
	218	/*
	219	* doubly linked queue types and primitives
	220	*/
	221
	222	#define ATP_Q_ENTER(hdr, object, entry) { \
	223	if ((hdr).head) { \
	224	(hdr).head->entry.prev = (object); \
	225	(object)->entry.next = (hdr).head; \
	226	} else { \
	227	(hdr).tail = (object); \
	228	(object)->entry.next = NULL; \
	229	} \
	230	(object)->entry.prev = NULL; \
	231	(hdr).head = (object); \
	232	}
	233
	234	#define ATP_Q_APPEND(hdr, object, entry) { \
	235	if ((hdr).head) { \
	236	(hdr).tail->entry.next = (object); \
	237	(object)->entry.prev = (hdr).tail; \
	238	} else { \
	239	(hdr).head = (object); \
	240	(object)->entry.prev = NULL; \
	241	} \
	242	(object)->entry.next = NULL; \
	243	(hdr).tail = (object); \
	244	}
	245
	246	#define ATP_Q_REMOVE(hdr, object, entry) { \
	247	if ((object)->entry.prev) { \
	248	(object)->entry.prev->entry.next = (object)->entry.next;\
	249	} else { \
	250	(hdr).head = (object)->entry.next; \
	251	} \
	252	if ((object)->entry.next) { \
	253	(object)->entry.next->entry.prev = (object)->entry.prev;\
254	} else { \
255	(hdr).tail = (object)->entry.prev; \
256	} \
257	}
258
259	struct atp_rcb_qhead {
260	struct atp_rcb *head;
261	struct atp_rcb *tail;
262	};
263
264	struct atp_rcb_q {
265	struct atp_rcb *prev;
266	struct atp_rcb *next;
267	};
268
269	struct atp_trans_qhead {
270	struct atp_trans *head;
271	struct atp_trans *tail;
272	};
273
274	struct atp_trans_q {
275	struct atp_trans *prev;
276	struct atp_trans *next;
277	};
278
279	/*
280	* Locally saved remote node address
281	*/
282
283	struct atp_socket {
284	u_short net;
285	at_node node;
286	at_socket socket;
287	};
288
289	/*
290	* transaction control block (local context at requester end)
291	*/
292
293	struct atp_trans {
294	struct atp_trans_q tr_list; /* trans list */
295	struct atp_state tr_queue; / state data structure */
296	gbuf_t tr_xmt; / message being sent */
297	gbuf_t tr_rcv[8]; / message being rcvd */
298	unsigned int tr_retry; /* # retries left */
299	unsigned int tr_timeout; /* timer interval */
300	char tr_state; /* current state */
301	char tr_rsp_wait; /* waiting for transaction response */
302	char filler[2];
303	unsigned char tr_xo; /* execute once transaction */
304	unsigned char tr_bitmap; /* requested bitmask */
305	unsigned short tr_tid; /* transaction id */
306	struct atp_socket tr_socket; /* the remote socket id */
307	struct atp_trans_q tr_snd_wait; /* list of transactions waiting
308	for space to send a msg */
309	at_socket tr_local_socket;
310	at_node tr_local_node;
311	at_net tr_local_net;
312	gbuf_t tr_bdsp; / bds structure pointer */
313	unsigned int tr_tmo_delta;
314	void (*tr_tmo_func)();
315	struct atp_trans *tr_tmo_next;
316	struct atp_trans *tr_tmo_prev;
317	atlock_t tr_lock;
318	atevent_t tr_event;
319	};
320
321	#define TRANS_TIMEOUT 0 /* waiting for a reply */
322	#define TRANS_REQUEST 1 /* waiting to send a request */
323	#define TRANS_RELEASE 2 /* waiting to send a release */
0b4e3aa0	324	#define TRANS_DONE 3 /* done - waiting for poll to complete */
1c79356b	325	#define TRANS_FAILED 4 /* done - waiting for poll to report failure */
0b4e3aa0	326	#define TRANS_ABORTING 5 /* waiting on atp_trans_abort list for thread to wakeup */
1c79356b A	327
	328	/*
	329	* reply control block (local context at repling end)
	330	*/
	331
	332	struct atp_rcb {
	333	struct atp_rcb_q rc_list; /* rcb list */
	334	struct atp_rcb_q rc_tlist;
	335	struct atp_state rc_queue; / state data structure */
	336	gbuf_t rc_xmt; / replys being sent */
	337	gbuf_t rc_ioctl; / waiting ioctl */
	338	char rc_snd[8]; /* replys actually to be sent */
	339	int rc_pktcnt; /* no of pkts in this trans */
	340	short rc_state; /* current state */
	341	unsigned char rc_xo; /* execute once transaction */
	342	at_node rc_local_node;
	343	at_net rc_local_net;
	344	short rc_rep_waiting; /* in the reply wait list */
	345	int rc_timestamp; /* reply timer */
	346	unsigned char rc_bitmap; /* replied bitmask */
	347	unsigned char rc_not_sent_bitmap; /* replied bitmask */
	348	unsigned short rc_tid; /* transaction id */
	349	struct atp_socket rc_socket; /* the remote socket id */
	350	};
	351
	352	#define RCB_UNQUEUED 0 /* newly allocated, not q'd */
	353	#define RCB_RESPONDING 2 /* waiting all of response from process*/
	354	#define RCB_RESPONSE_FULL 3 /* got all of response */
	355	#define RCB_RELEASED 4 /* got our release */
	356	#define RCB_PENDING 5 /* a no wait rcb is full */
	357	#define RCB_NOTIFIED 6
	358	#define RCB_SENDING 7 /* we're currently xmitting this trans */
	359
	360	/*
	361	* socket state (per module data structure)
	362	*/
	363
	364	struct atp_state {
	365	gref_t atp_gref; / must be the first entry */
	366	int atp_pid; /* process id, must be the second entry */
	367	gbuf_t atp_msgq; / data msg, must be the third entry */
	368	unsigned char dflag; /* structure flag, must be the fourth entry */
	369	unsigned char filler;
	370	short atp_socket_no;
	371	short atp_flags; /* general flags */
	372	struct atp_trans_qhead atp_trans_wait; /* pending transaction list */
	373	struct atp_state atp_trans_waiting; / list of atps waiting for a
	374	free transaction */
	375	unsigned int atp_retry; /* retry count */
	376	unsigned int atp_timeout; /* retry timeout */
	377	struct atp_state *atp_rcb_waiting;
	378	struct atp_rcb_qhead atp_rcb; /* active rcbs */
	379	struct atp_rcb_qhead atp_attached; /* rcb's waiting to be read */
	380	atlock_t atp_lock;
	381	atevent_t atp_event;
	382	atlock_t atp_delay_lock;
	383	atevent_t atp_delay_event;
	384	};
	385
	386
	387	/*
	388	* atp_state flag definitions
	389	*/
	390	#define ATP_CLOSING 0x08 /* atp stream in process of closing */
391
392
393	/*
394	* tcb/rcb/state allocation queues
395	*/
396
397	/*
398	* Size defines; must be outside following #ifdef to permit
399	* debugging code to reference independent of ATP_DECLARE
400	*/
401	#define NATP_RCB 512 /* the number of ATP RCBs at once */
402	#define NATP_STATE 192 /* the number of ATP sockets open at once */
403	/* note: I made NATP_STATE == NSOCKETS */
404
405	#ifdef ATP_DECLARE
406	struct atp_trans atp_trans_free_list = NULL; / free transactions */
0b4e3aa0	407	struct atp_rcb atp_rcb_free_list = NULL; / free rcbs */
9bccf70c	408	struct atp_state atp_free_list = NULL; / free atp states */
0b4e3aa0	409	struct atp_trans_qhead atp_trans_abort; /* aborted trans list */
9bccf70c A	410	struct atp_rcb* atp_rcb_data = NULL;
9bccf70c A	411	struct atp_state* atp_state_data=NULL;
0b4e3aa0 A	412
0b4e3aa0 A	413
1c79356b A	414	#else
1c79356b A	415	extern struct atp_trans atp_trans_free_list; / free transactions */
0b4e3aa0 A	416	extern struct atp_rcb atp_rcb_free_list; / free rcbs */
0b4e3aa0 A	417	extern struct atp_state atp_free_list; / free atp states */
9bccf70c A	418	extern struct atp_rcb* atp_rcb_data;
9bccf70c A	419	extern struct atp_state* atp_state_data;
0b4e3aa0	420	extern struct atp_trans_qhead atp_trans_abort; /* aborting trans list */
1c79356b A	421
	422	extern void atp_req_timeout();
	423	extern void atp_rcb_timer();
	424	extern void atp_x_done();
	425	extern struct atp_rcb *atp_rcb_alloc();
	426	extern struct atp_trans *atp_trans_alloc();
	427	#endif /* ATP_DECLARE */
	428
	429	/* prototypes */
	430	void atp_send_req(gref_t , gbuf_t );
	431	void atp_drop_req(gref_t , gbuf_t );
	432	void atp_send_rsp(gref_t , gbuf_t , int);
	433	void atp_wput(gref_t , gbuf_t );
	434	void atp_rput(gref_t , gbuf_t );
55e303ae	435	void atp_retry_req(void *);
1c79356b A	436	void atp_stop(gbuf_t *, int);
	437	void atp_cancel_req(gref_t *, unsigned short);
	438	int atp_open(gref_t *, int);
	439	int atp_bind(gref_t , unsigned int, unsigned char );
	440	int atp_close(gref_t *, int);
	441	gbuf_t atp_build_release(struct atp_trans );
	442	void atp_req_timeout(struct atp_trans *);
	443	void atp_free(struct atp_trans *);
	444	void atp_x_done(struct atp_trans *);
	445	void atp_send(struct atp_trans *);
	446	void atp_rsp_ind(struct atp_trans , gbuf_t );
	447	void atp_trans_free(struct atp_trans *);
	448	void atp_reply(struct atp_rcb *);
	449	void atp_rcb_free(struct atp_rcb *);
	450	void atp_send_replies(struct atp_state , struct atp_rcb );
	451	void atp_dequeue_atp(struct atp_state *);
	452	int atp_iocack(struct atp_state , gbuf_t );
	453	void atp_req_ind(struct atp_state , gbuf_t );
	454	int atp_iocnak(struct atp_state , gbuf_t , int);
	455	void atp_trp_timer(void *, int);
	456	void atp_timout(void (func)(), struct atp_trans , int);
	457	void atp_untimout(void (func)(), struct atp_trans );
	458	int atp_tid(struct atp_state *);
	459
91447636 A	460	#endif /* KERNEL_PRIVATE */
91447636 A	461	#endif /* __APPLE_API_OBSOLETE */
1c79356b	462	#endif /* _NETAT_ATP_H_ */