bsd/netat/atp.h

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