mac/mtcpnet.c

   1 /*
   2  * Copyright (c) 2003 Ben Harris
   3  * All rights reserved.
   4  *
   5  * Permission is hereby granted, free of charge, to any person
   6  * obtaining a copy of this software and associated documentation
   7  * files (the "Software"), to deal in the Software without
   8  * restriction, including without limitation the rights to use,
   9  * copy, modify, merge, publish, distribute, sublicense, and/or
  10  * sell copies of the Software, and to permit persons to whom the
  11  * Software is furnished to do so, subject to the following
  12  * conditions:
  13  *
  14  * The above copyright notice and this permission notice shall be
  15  * included in all copies or substantial portions of the Software.
  16  *
  17  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  18  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  19  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  20  * NONINFRINGEMENT.  IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR
  21  * ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
  22  * CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
  23  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  24  * SOFTWARE.
  25  */
  26 /*
  27  * mtcpnet.c - MacTCP interface
  28  */
  29
  30 #include <MacTypes.h>
  31 #include <Devices.h>
  32 #include <Endian.h>
  33 #include <Folders.h>
  34 #include <MacTCP.h>
  35 #include <MixedMode.h>
  36 #include <Resources.h>
  37
  38 #include <assert.h>
  39
  40 #define DEFINE_PLUG_METHOD_MACROS
  41 #include "putty.h"
  42 #include "network.h"
  43 #include "mac.h"
  44
  45 /*
  46  * The following structures are documented as being in
  47  * <AddressXlation.h>, but that isn't shipped with Universal
  48  * Interfaces, and it's easier to define them here than to require
  49  * people to download yet another SDK.
  50  */
  51
  52 static OSErr OpenResolver(char *);
  53 static OSErr CloseResolver(void);
  54
  55 enum {
  56     OPENRESOLVER = 1,
  57     CLOSERESOLVER,
  58     STRTOADDR,
  59     ADDRTOSTR,
  60     ENUMCACHE,
  61     ADDRTONAME,
  62     HXINFO,
  63     MXINFO
  64 };
  65
  66 #define NUM_ALT_ADDRS 4
  67
  68 typedef struct hostInfo {
  69     int rtnCode;
  70     char cname[255];
  71     unsigned long addr[NUM_ALT_ADDRS];
  72 };
  73
  74 typedef CALLBACK_API(void, ResultProcPtr)(struct hostInfo *, char *);
  75 typedef STACK_UPP_TYPE(ResultProcPtr) ResultUPP;
  76 enum { uppResultProcInfo = kPascalStackBased
  77        | STACK_ROUTINE_PARAMETER(1, SIZE_CODE(sizeof(struct hostInfo*)))
  78        | STACK_ROUTINE_PARAMETER(2, SIZE_CODE(sizeof(char *)))
  79 };
  80 #define NewResultUPP(userRoutine)                                       \
  81     (ResultUPP)NewRoutineDescriptor((ProcPtr)(userRoutine),             \
  82                                     uppResultProcInfo,                  \
  83                                     GetCurrentArchitecture())
  84 #define DisposeResultUPP(userUPP) DisposeRoutineDescriptor(userUPP)
  85
  86 static OSErr StrToAddr(char *, struct hostInfo *, ResultUPP *, char *);
  87
  88 typedef CALLBACK_API_C(OSErr, OpenResolverProcPtr)(UInt32, char *);
  89 typedef STACK_UPP_TYPE(OpenResolverProcPtr) OpenResolverUPP;
  90 enum { uppOpenResolverProcInfo = kCStackBased
  91        | RESULT_SIZE(SIZE_CODE(sizeof(OSErr)))
  92        | STACK_ROUTINE_PARAMETER(1, SIZE_CODE(sizeof(UInt32)))
  93        | STACK_ROUTINE_PARAMETER(2, SIZE_CODE(sizeof(char*)))
  94 };
  95 #define InvokeOpenResolverUPP(selector, fileName, userUPP)              \
  96     CALL_TWO_PARAMETER_UPP((userUPP), uppOpenResolverProcInfo,          \
  97                            (selector), (fileName))
  98
  99 typedef CALLBACK_API_C(OSErr, CloseResolverProcPtr)(UInt32);
 100 typedef STACK_UPP_TYPE(CloseResolverProcPtr) CloseResolverUPP;
 101 enum { uppCloseResolverProcInfo = kCStackBased
 102        | RESULT_SIZE(SIZE_CODE(sizeof(OSErr)))
 103        | STACK_ROUTINE_PARAMETER(1, SIZE_CODE(sizeof(UInt32)))
 104 };
 105 #define InvokeCloseResolverUPP(selector, userUPP)                       \
 106     CALL_ONE_PARAMETER_UPP((userUPP), uppCloseResolverProcInfo, (selector))
 107
 108 typedef CALLBACK_API_C(OSErr, StrToAddrProcPtr)(UInt32, char *,
 109                                                 struct hostInfo *, ResultUPP,
 110                                                 char *);
 111 typedef STACK_UPP_TYPE(StrToAddrProcPtr) StrToAddrUPP;
 112 enum { uppStrToAddrProcInfo = kCStackBased
 113        | RESULT_SIZE(SIZE_CODE(sizeof(OSErr)))
 114        | STACK_ROUTINE_PARAMETER(1, SIZE_CODE(sizeof(UInt32)))
 115        | STACK_ROUTINE_PARAMETER(2, SIZE_CODE(sizeof(char *)))
 116        | STACK_ROUTINE_PARAMETER(3, SIZE_CODE(sizeof(struct hostInfo *)))
 117        | STACK_ROUTINE_PARAMETER(4, SIZE_CODE(sizeof(ResultUPP)))
 118        | STACK_ROUTINE_PARAMETER(5, SIZE_CODE(sizeof(char *)))
 119 };
 120 #define InvokeStrToAddrUPP(selector, hostName, hostInfoPtr, ResultProc, \
 121                            userDataPtr, userUPP)                        \
 122     CALL_FIVE_PARAMETER_UPP((userUPP), uppStrToAddrProcInfo, (selector),\
 123                             (hostName), (hostInfoPtr), (ResultProc),    \
 124                             (userDataPtr))
 125 #define StrToAddr(hostName, hostInfoPtr, ResultProc, userDataPtr)       \
 126     InvokeStrToAddrUPP(STRTOADDR, hostName, hostInfoPtr, ResultProc,    \
 127                        userDataPtr, (StrToAddrUPP)*mactcp.dnr_handle)
 128
 129 typedef CALLBACK_API_C(OSErr, AddrToStrProcPtr)(UInt32, unsigned long, char *);
 130 typedef STACK_UPP_TYPE(AddrToStrProcPtr) AddrToStrUPP;
 131 enum { uppAddrToStrProcInfo = kCStackBased
 132        | RESULT_SIZE(SIZE_CODE(sizeof(OSErr)))
 133        | STACK_ROUTINE_PARAMETER(1, SIZE_CODE(sizeof(unsigned long)))
 134        | STACK_ROUTINE_PARAMETER(2, SIZE_CODE(sizeof(char *)))
 135 };
 136 #define InvokeAddrToStrUPP(selector, addr, addrStr, userUPP)            \
 137     CALL_THREE_PARAMETER_UPP((userUPP), uppAddrToStrProcInfo, (selector),\
 138                              (addr), (addrStr))
 139 #define AddrToStr(addr, addrStr)                                        \
 140     InvokeAddrToStrUPP(ADDRTOSTR, addr, addrStr,                        \
 141                        (AddrToStrUPP)*mactcp.dnr_handle)
 142
 143 /* End of AddressXlation.h bits */
 144
 145 /* TCP connection states, mysteriously missing from <MacTCP.h> */
 146 #define TCPS_CLOSED             0
 147 #define TCPS_LISTEN             2
 148 #define TCPS_SYN_RECEIVED       4
 149 #define TCPS_SYN_SENT           6
 150 #define TCPS_ESTABLISHED        8
 151 #define TCPS_FIN_WAIT_1         10
 152 #define TCPS_FIN_WAIT_2         12
 153 #define TCPS_CLOSE_WAIT         14
 154 #define TCPS_CLOSING            16
 155 #define TCPS_LAST_ACK           18
 156 #define TCPS_TIME_WAIT          20
 157
 158 struct Socket_tag {
 159     struct socket_function_table *fn;
 160     /* the above variable absolutely *must* be the first in this structure */
 161     StreamPtr s;
 162     OSErr err;
 163     Plug plug;
 164     void *private_ptr;
 165     bufchain output_data;
 166     int connected;
 167     int writable;
 168     int frozen; /* this causes readability notifications to be ignored */
 169     int frozen_readable; /* this means we missed at least one readability
 170                           * notification while we were frozen */
 171     int localhost_only;                /* for listening sockets */
 172     char oobdata[1];
 173     int sending_oob;
 174     int oobpending;                    /* is there OOB data available to read? */
 175     int oobinline;
 176     int pending_error;                 /* in case send() returns error */
 177     int listener;
 178     struct Socket_tag *next;
 179     struct Socket_tag **prev;
 180 };
 181
 182 /*
 183  * We used to typedef struct Socket_tag *Socket.
 184  *
 185  * Since we have made the networking abstraction slightly more
 186  * abstract, Socket no longer means a tcp socket (it could mean
 187  * an ssl socket).  So now we must use Actual_Socket when we know
 188  * we are talking about a tcp socket.
 189  */
 190 typedef struct Socket_tag *Actual_Socket;
 191
 192 struct SockAddr_tag {
 193     int resolved;
 194     struct hostInfo hostinfo;
 195     char hostname[512];
 196 };
 197
 198 /* Global variables */
 199 static struct {
 200     Handle dnr_handle;
 201     int initialised;
 202     short refnum;
 203     ProcessSerialNumber self;
 204     Actual_Socket socklist;
 205 } mactcp;
 206
 207 static pascal void mactcp_lookupdone(struct hostInfo *hi, char *cookie);
 208 static pascal void mactcp_asr(StreamPtr, unsigned short, Ptr, unsigned short,
 209                               struct ICMPReport *);
 210 static Plug mactcp_plug(Socket, Plug);
 211 static void mactcp_flush(Socket);
 212 static void mactcp_close(Socket);
 213 static int mactcp_write(Socket, char const *, int);
 214 static int mactcp_write_oob(Socket, char const*, int);
 215 static void mactcp_set_private_ptr(Socket, void *);
 216 static void *mactcp_get_private_ptr(Socket);
 217 static char *mactcp_socket_error(Socket);
 218 static void mactcp_set_frozen(Socket, int);
 219
 220 static void mactcp_recv(Actual_Socket s, size_t len);
 221
 222 /*
 223  * Initialise MacTCP.
 224  * This should be called once before any TCP connection is opened.
 225  */
 226
 227 OSErr mactcp_init(void)
 228 {
 229     OSErr err;
 230
 231     /*
 232      * IM:Devices describes a convoluted way of finding a spare unit
 233      * number to open a driver on before calling OpenDriver.  Happily,
 234      * the MacTCP INIT ensures that .IPP is already open (and hence
 235      * has a valid unit number already) so we don't need to go through
 236      * all that.  (MacTCP Programmer's Guide p6)
 237      */
 238     err = OpenDriver("\p.IPP", &mactcp.refnum);
 239     if (err != noErr) return err;
 240     err = OpenResolver(NULL);
 241     if (err != noErr) return err;
 242
 243     mactcp.initialised = TRUE;
 244     return noErr;
 245 }
 246
 247 void mactcp_cleanup(void)
 248 {
 249     Actual_Socket s, next;
 250
 251     /*
 252      * Eventually, PuTTY should close down each session as it exits,
 253      * so there should be no sockets left when we get here.  Still,
 254      * better safe than sorry.
 255      *
 256      * XXX What about in-flight aync I/O (when we support that)?
 257      */
 258     for (s = mactcp.socklist; s != NULL; s = next) {
 259         next = s->next; /* s is about to vanish */
 260         mactcp_close(&s->fn);
 261     }
 262
 263     /*
 264      * When we get async DNS, we have to wait for any outstanding
 265      * requests to complete here before exiting.
 266      */
 267     CloseResolver();
 268     mactcp.initialised = FALSE;
 269 }
 270
 271 static ResultUPP mactcp_lookupdone_upp;
 272
 273 SockAddr mactcp_namelookup(char *host, char **canonicalname)
 274 {
 275     SockAddr ret = smalloc(sizeof(struct SockAddr_tag));
 276     OSErr err;
 277     volatile int done = FALSE;
 278     char *realhost;
 279
 280     /* Clear the structure. */
 281     memset(ret, 0, sizeof(struct SockAddr_tag));
 282     if (mactcp_lookupdone_upp == NULL)
 283         mactcp_lookupdone_upp = NewResultUPP(&mactcp_lookupdone);
 284     err = StrToAddr(host, &ret->hostinfo, mactcp_lookupdone_upp,
 285                     (char *)&done);
 286     /*
 287      * PuTTY expects DNS lookups to be synchronous (see bug
 288      * "async-dns"), so we pretend they are.
 289      */
 290     if (err == cacheFault)
 291         while (!done)
 292             continue;
 293     ret->resolved = TRUE;
 294
 295     if (ret->hostinfo.rtnCode == noErr)
 296         realhost = ret->hostinfo.cname;
 297     else
 298         realhost = "";
 299     *canonicalname = smalloc(1+strlen(realhost));
 300     strcpy(*canonicalname, realhost);
 301     return ret;
 302 }
 303
 304 static pascal void mactcp_lookupdone(struct hostInfo *hi, char *cookie)
 305 {
 306     volatile int *donep = (int *)cookie;
 307
 308     *donep = TRUE;
 309 }
 310
 311 SockAddr mactcp_nonamelookup(char *host)
 312 {
 313     SockAddr ret = smalloc(sizeof(struct SockAddr_tag));
 314
 315     ret->resolved = FALSE;
 316     ret->hostinfo.rtnCode = noErr;
 317     ret->hostname[0] = '\0';
 318     strncat(ret->hostname, host, lenof(ret->hostname) - 1);
 319     return ret;
 320 }
 321
 322 void mactcp_getaddr(SockAddr addr, char *buf, int buflen)
 323 {
 324     char mybuf[16];
 325     OSErr err;
 326
 327     if (addr->resolved) {
 328         /* XXX only return first address */
 329         err = AddrToStr(addr->hostinfo.addr[0], mybuf);
 330         buf[0] = '\0';
 331         if (err != noErr)
 332             strncat(buf, mybuf, buflen - 1);
 333     } else {
 334         buf[0] = '\0';
 335         strncat(buf, addr->hostname, buflen - 1);
 336     }
 337 }
 338
 339 /* I think "local" here really means "loopback" */
 340
 341 int mactcp_hostname_is_local(char *name)
 342 {
 343
 344     return !strcmp(name, "localhost");
 345 }
 346
 347 int mactcp_address_is_local(SockAddr addr)
 348 {
 349     int i;
 350
 351     if (addr->resolved)
 352         for (i = 0; i < NUM_ALT_ADDRS; i++)
 353             if (addr->hostinfo.addr[i] & 0xff000000 == 0x7f000000)
 354                 return TRUE;
 355     return FALSE;
 356 }
 357
 358 int mactcp_addrtype(SockAddr addr)
 359 {
 360
 361     if (addr->resolved)
 362         return ADDRTYPE_IPV4;
 363     return ADDRTYPE_NAME;
 364 }
 365
 366 void mactcp_addrcopy(SockAddr addr, char *buf)
 367 {
 368
 369     /* XXX only return first address */
 370     memcpy(buf, &addr->hostinfo.addr[0], 4);
 371 }
 372
 373 void mactcp_addr_free(SockAddr addr)
 374 {
 375
 376     sfree(addr);
 377 }
 378
 379 static Plug mactcp_plug(Socket sock, Plug p)
 380 {
 381     Actual_Socket s = (Actual_Socket) sock;
 382     Plug ret = s->plug;
 383
 384     if (p)
 385         s->plug = p;
 386     return ret;
 387 }
 388
 389 static void mactcp_flush(Socket s)
 390 {
 391
 392     fatalbox("mactcp_flush");
 393 }
 394
 395 Socket mactcp_register(void *sock, Plug plug)
 396 {
 397
 398     fatalbox("mactcp_register");
 399 }
 400
 401 static TCPNotifyUPP mactcp_asr_upp;
 402
 403 Socket mactcp_new(SockAddr addr, int port, int privport, int oobinline,
 404               int nodelay, Plug plug)
 405 {
 406     static struct socket_function_table fn_table = {
 407         mactcp_plug,
 408         mactcp_close,
 409         mactcp_write,
 410         mactcp_write_oob,
 411         mactcp_flush,
 412         mactcp_set_private_ptr,
 413         mactcp_get_private_ptr,
 414         mactcp_set_frozen,
 415         mactcp_socket_error
 416     };
 417     TCPiopb pb;
 418     UDPiopb upb;
 419     Actual_Socket ret;
 420     ip_addr dstaddr;
 421     size_t buflen;
 422
 423     /*
 424      * Create Socket structure.
 425      */
 426     ret = smalloc(sizeof(struct Socket_tag));
 427     ret->s = 0;
 428     ret->fn = &fn_table;
 429     ret->err = noErr;
 430     ret->plug = plug;
 431     bufchain_init(&ret->output_data);
 432     ret->connected = 0;                /* to start with */
 433     ret->writable = 0;                 /* to start with */
 434     ret->sending_oob = 0;
 435     ret->frozen = 0;
 436     ret->frozen_readable = 0;
 437     ret->localhost_only = 0;           /* unused, but best init anyway */
 438     ret->pending_error = 0;
 439     ret->oobinline = oobinline;
 440     ret->oobpending = FALSE;
 441     ret->listener = 0;
 442
 443     dstaddr = addr->hostinfo.addr[0]; /* XXX should try all of them */
 444     /*
 445      * Create a TCP stream.
 446      *
 447      * MacTCP requires us to provide it with some buffer memory.  Page
 448      * 31 of the Programmer's Guide says it should be a minimum of
 449      * 4*MTU+1024.  Page 36 says a minimum of 4096 bytes.  Assume
 450      * they're both correct.
 451      */
 452     assert(addr->resolved);
 453     upb.ioCRefNum = mactcp.refnum;
 454     upb.csCode = UDPMaxMTUSize;
 455     upb.csParam.mtu.remoteHost = dstaddr;
 456     upb.csParam.mtu.userDataPtr = NULL;
 457     ret->err = PBControlSync((ParmBlkPtr)&upb);
 458     if (ret->err != noErr) return (Socket)ret;
 459
 460     buflen = upb.csParam.mtu.mtuSize * 4 + 1024;
 461     if (buflen < 4096) buflen = 4096;
 462     if (mactcp_asr_upp == NULL)
 463         mactcp_asr_upp = NewTCPNotifyUPP(&mactcp_asr);
 464     GetCurrentProcess(&mactcp.self);
 465     pb.ioCRefNum = mactcp.refnum;
 466     pb.csCode = TCPCreate;
 467     pb.csParam.create.rcvBuff = smalloc(buflen);
 468     pb.csParam.create.rcvBuffLen = buflen;
 469     pb.csParam.create.notifyProc = mactcp_asr_upp;
 470     pb.csParam.create.userDataPtr = (Ptr)ret;
 471     ret->err = PBControlSync((ParmBlkPtr)&pb);
 472     if (ret->err != noErr) return (Socket)ret;
 473     ret->s = pb.tcpStream;
 474
 475     /*
 476      * Open the connection.
 477      */
 478     pb.ioCRefNum = mactcp.refnum;
 479     pb.csCode = TCPActiveOpen;
 480     pb.tcpStream = ret->s;
 481     pb.csParam.open.validityFlags = 0;
 482     pb.csParam.open.remoteHost = dstaddr;
 483     pb.csParam.open.remotePort = port;
 484     pb.csParam.open.localPort = privport ? 1023 : 0;
 485     pb.csParam.open.dontFrag = FALSE;
 486     pb.csParam.open.timeToLive = 0;
 487     pb.csParam.open.security = 0;
 488     pb.csParam.open.optionCnt = 0;
 489     pb.csParam.open.userDataPtr = (Ptr)ret;
 490     while (1) {
 491         ret->err = PBControlSync((ParmBlkPtr)&pb);
 492         if (!privport || ret->err != duplicateSocket)
 493             break;
 494         pb.csParam.open.localPort--;
 495         if (pb.csParam.open.localPort == 0)
 496             break;
 497     }
 498
 499     if (ret->err != noErr) return (Socket)ret;
 500
 501     ret->connected = TRUE;
 502     ret->writable = TRUE;
 503
 504     /* Add this to the list of all sockets */
 505     ret->next = mactcp.socklist;
 506     ret->prev = &mactcp.socklist;
 507     if (ret->next != NULL)
 508         ret->next->prev = &ret->next;
 509     mactcp.socklist = ret;
 510
 511     return (Socket)ret;
 512 }
 513
 514 Socket mactcp_newlistener(char *srcaddr, int port, Plug plug,
 515                           int local_host_only)
 516 {
 517
 518     fatalbox("mactcp_newlistener");
 519 }
 520
 521 static void mactcp_close(Socket sock)
 522 {
 523     Actual_Socket s = (Actual_Socket)sock;
 524     TCPiopb pb;
 525
 526     /*
 527      * TCPClose is equivalent to shutdown(fd, SHUT_WR), and hence
 528      * leaves the Rx side open, while TCPAbort seems rather vicious,
 529      * throwing away Tx data that haven't been ACKed yet.  We do both
 530      * in succession.
 531      */
 532     pb.ioCRefNum = mactcp.refnum;
 533     pb.csCode = TCPClose;
 534     pb.tcpStream = s->s;
 535     pb.csParam.close.validityFlags = 0;
 536     pb.csParam.close.userDataPtr = (Ptr)s;
 537     s->err = PBControlSync((ParmBlkPtr)&pb);
 538     /* Not much we can do about an error anyway. */
 539
 540     pb.ioCRefNum = mactcp.refnum;
 541     pb.csCode = TCPAbort;
 542     pb.tcpStream = s->s;
 543     pb.csParam.abort.userDataPtr = (Ptr)s;
 544     s->err = PBControlSync((ParmBlkPtr)&pb);
 545     /* Even less we can do about an error here. */
 546
 547     pb.ioCRefNum = mactcp.refnum;
 548     pb.csCode = TCPRelease;
 549     pb.tcpStream = s->s;
 550     pb.csParam.create.userDataPtr = (Ptr)s;
 551     s->err = PBControlSync((ParmBlkPtr)&pb);
 552     if (s->err == noErr)
 553         sfree(pb.csParam.create.rcvBuff);
 554
 555     /* Unhitch from list of sockets */
 556     *s->prev = s->next;
 557     if (s->next != NULL)
 558         s->next->prev = s->prev;
 559
 560     sfree(s);
 561 }
 562
 563 static int mactcp_write(Socket sock, char const *buf, int len)
 564 {
 565     Actual_Socket s = (Actual_Socket) sock;
 566     wdsEntry wds[2];
 567     TCPiopb pb;
 568
 569     /*
 570      * Casting away const from buf should be safe -- MacTCP won't
 571      * write to it.
 572      */
 573     wds[0].length = len;
 574     wds[0].ptr = (char *)buf;
 575     wds[1].length = 0;
 576
 577     pb.ioCRefNum = mactcp.refnum;
 578     pb.csCode = TCPSend;
 579     pb.tcpStream = s->s;
 580     pb.csParam.send.validityFlags = 0;
 581     pb.csParam.send.pushFlag = TRUE; /* XXX we want it to return. */
 582     pb.csParam.send.urgentFlag = 0;
 583     pb.csParam.send.wdsPtr = (Ptr)wds;
 584     pb.csParam.send.userDataPtr = (Ptr)s;
 585     s->err = PBControlSync((ParmBlkPtr)&pb);
 586     return 0;
 587 }
 588
 589 static int mactcp_write_oob(Socket sock, char const *buf, int len)
 590 {
 591
 592     fatalbox("mactcp_write_oob");
 593 }
 594
 595 static pascal void mactcp_asr(StreamPtr str, unsigned short event, Ptr cookie,
 596                               unsigned short termin_reason,
 597                               struct ICMPReport *icmp)
 598 {
 599
 600     WakeUpProcess(&mactcp.self);
 601 }
 602
 603 /*
 604  * Called from our event loop if there's work to do.
 605  */
 606 void mactcp_poll(void)
 607 {
 608     Actual_Socket s, next;
 609     TCPiopb pb;
 610
 611     for (s = mactcp.socklist; s != NULL; s = next) {
 612         next = s->next;
 613         do {
 614             pb.ioCRefNum = mactcp.refnum;
 615             pb.csCode = TCPStatus;
 616             pb.tcpStream = s->s;
 617             pb.csParam.status.userDataPtr = (Ptr)s;
 618             s->err = PBControlSync((ParmBlkPtr)&pb);
 619             if (s->err != noErr)
 620                 goto next_socket;
 621             if (pb.csParam.status.amtUnreadData == 0)
 622                 break;
 623             mactcp_recv(s, pb.csParam.status.amtUnreadData);
 624         } while (TRUE);
 625         switch (pb.csParam.status.connectionState) {
 626           case TCPS_CLOSE_WAIT:
 627             /* Remote end has sent us a FIN */
 628             plug_closing(s->plug, NULL, 0, 0);
 629         }
 630       next_socket:
 631         ;
 632     }
 633 }
 634
 635 static void mactcp_recv(Actual_Socket s, size_t len)
 636 {
 637     rdsEntry rds[2];
 638     TCPiopb pb;
 639
 640     if (s->frozen) return;
 641
 642     while (len > 0) {
 643         pb.ioCRefNum = mactcp.refnum;
 644         pb.csCode = TCPNoCopyRcv;
 645         pb.tcpStream = s->s;
 646         pb.csParam.receive.commandTimeoutValue = 0;
 647         pb.csParam.receive.rdsPtr = (Ptr)rds;
 648         pb.csParam.receive.rdsLength = lenof(rds) - 1;
 649         pb.csParam.receive.userDataPtr = (Ptr)s;
 650         s->err = PBControlSync((ParmBlkPtr)&pb);
 651         if (s->err != noErr)
 652             return;
 653         plug_receive(s->plug, 0, rds[0].ptr, rds[0].length);
 654         len -= rds[0].length;
 655         pb.csCode = TCPRcvBfrReturn;
 656         s->err = PBControlSync((ParmBlkPtr)&pb);
 657         if (s->err != noErr)
 658             return;
 659     }
 660 }
 661
 662 /*
 663  * Each socket abstraction contains a `void *' private field in
 664  * which the client can keep state.
 665  */
 666 static void mactcp_set_private_ptr(Socket sock, void *ptr)
 667 {
 668     Actual_Socket s = (Actual_Socket) sock;
 669     s->private_ptr = ptr;
 670 }
 671
 672 static void *mactcp_get_private_ptr(Socket sock)
 673 {
 674     Actual_Socket s = (Actual_Socket) sock;
 675     return s->private_ptr;
 676 }
 677
 678 /*
 679  * Special error values are returned from mactcp_namelookup and
 680  * mactcp_new if there's a problem. These functions extract an error
 681  * message, or return NULL if there's no problem.
 682  */
 683 char *mactcp_addr_error(SockAddr addr)
 684 {
 685     static char buf[64];
 686
 687     switch (addr->hostinfo.rtnCode) {
 688       case noErr:
 689         return NULL;
 690       case nameSyntaxErr:
 691         return "Name syntax error";
 692       case noNameServer:
 693         return "No name server found";
 694       case authNameErr:
 695         return "Domain name does not exist";
 696       case noAnsErr:
 697         return "No answer from domain name server";
 698       case dnrErr:
 699         return "Domain name server returned an error";
 700       case outOfMemory:
 701         return "Out of memory";
 702       default:
 703         sprintf(buf, "Unknown DNR error %d", addr->hostinfo.rtnCode);
 704         return buf;
 705     }
 706 }
 707
 708 static char *mactcp_socket_error(Socket sock)
 709 {
 710     static char buf[64];
 711     Actual_Socket s = (Actual_Socket) sock;
 712
 713     switch (s->err) {
 714       case noErr:
 715         return NULL;
 716       case insufficientResources:
 717         return "Insufficient resources to open TCP stream";
 718       case duplicateSocket:
 719         return "Duplicate socket";
 720       case openFailed:
 721         return "Connection failed while opening";
 722       default:
 723         sprintf(buf, "Unknown MacTCP error %d", s->err);
 724         return buf;
 725     }
 726 }
 727
 728 static void mactcp_set_frozen(Socket sock, int is_frozen)
 729 {
 730     Actual_Socket s = (Actual_Socket) sock;
 731
 732     if (s->frozen == is_frozen)
 733         return;
 734     s->frozen = is_frozen;
 735 }
 736
 737 /*
 738  * Bits below here would usually be in dnr.c, shipped with the MacTCP
 739  * SDK, but its convenient not to require that, and since we assume
 740  * System 7 we can actually simplify things a lot.
 741  */
 742
 743 static OSErr OpenResolver(char *hosts_file)
 744 {
 745     short vrefnum;
 746     long dirid;
 747     HParamBlockRec pb;
 748     Str255 filename;
 749     OSErr err;
 750     int fd;
 751     Handle dnr_handle;
 752
 753     if (mactcp.dnr_handle != NULL)
 754         return noErr;
 755
 756     err = FindFolder(kOnSystemDisk, kControlPanelFolderType, FALSE, &vrefnum,
 757                      &dirid);
 758     if (err != noErr) return err;
 759
 760     /*
 761      * Might be better to use PBCatSearch here, but it's not always
 762      * available.
 763      */
 764     pb.fileParam.ioCompletion = NULL;
 765     pb.fileParam.ioNamePtr = filename;
 766     pb.fileParam.ioVRefNum = vrefnum;
 767     pb.fileParam.ioFDirIndex = 1;
 768     pb.fileParam.ioDirID = dirid;
 769     fd = -1;
 770
 771     while (PBHGetFInfoSync(&pb) == noErr) {
 772         if (pb.fileParam.ioFlFndrInfo.fdType == 'cdev' &&
 773             pb.fileParam.ioFlFndrInfo.fdCreator == 'ztcp') {
 774             fd = HOpenResFile(vrefnum, dirid, filename, fsRdPerm);
 775             if (fd == -1) continue;
 776             dnr_handle = Get1IndResource('dnrp', 1);
 777             if (dnr_handle != NULL)
 778                 break;
 779             CloseResFile(fd);
 780             fd = -1;
 781         }
 782         pb.fileParam.ioDirID = dirid;
 783         pb.fileParam.ioFDirIndex++;
 784     }
 785     if (fd == -1)
 786         return fnfErr;
 787
 788     DetachResource(dnr_handle);
 789     CloseResFile(fd);
 790
 791     MoveHHi(dnr_handle);
 792     HLock(dnr_handle);
 793
 794     err = InvokeOpenResolverUPP(OPENRESOLVER, hosts_file,
 795                                 (OpenResolverUPP)*dnr_handle);
 796     if (err != noErr) {
 797         HUnlock(dnr_handle);
 798         DisposeHandle(dnr_handle);
 799         return err;
 800     }
 801
 802     mactcp.dnr_handle = dnr_handle;
 803     return noErr;
 804 }
 805
 806 OSErr CloseResolver(void)
 807 {
 808     Handle dnr_handle = mactcp.dnr_handle;
 809     OSErr err;
 810
 811     if (mactcp.dnr_handle == NULL)
 812         return notOpenErr;
 813
 814     err = InvokeCloseResolverUPP(CLOSERESOLVER,
 815                                  (CloseResolverUPP)*mactcp.dnr_handle);
 816     if (err != noErr)
 817         return err;
 818
 819     mactcp.dnr_handle = NULL;
 820     HUnlock(dnr_handle);
 821     DisposeHandle(dnr_handle);
 822     return noErr;
 823 }
 824
 825 /* MacTCP doesn't have a services database. */
 826 int net_service_lookup(char *service)
 827 {
 828
 829     return 0;
 830 }
 831
 832
 833 /*
 834  * Local Variables:
 835  * c-file-style: "simon"
 836  * End:
 837  */