2 * Copyright (c) 2003 Ben Harris
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
14 * The above copyright notice and this permission notice shall be
15 * included in all copies or substantial portions of the Software.
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
27 * mtcpnet.c - MacTCP interface
35 #include <MixedMode.h>
36 #include <Resources.h>
40 #define DEFINE_PLUG_METHOD_MACROS
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.
52 static OSErr OpenResolver(char *);
53 static OSErr CloseResolver(void);
66 #define NUM_ALT_ADDRS 4
68 typedef struct hostInfo {
71 unsigned long addr[NUM_ALT_ADDRS];
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 *)))
80 #define NewResultUPP(userRoutine) \
81 (ResultUPP)NewRoutineDescriptor((ProcPtr)(userRoutine), \
83 GetCurrentArchitecture())
84 #define DisposeResultUPP(userUPP) DisposeRoutineDescriptor(userUPP)
86 static OSErr StrToAddr(char *, struct hostInfo *, ResultUPP *, char *);
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*)))
95 #define InvokeOpenResolverUPP(selector, fileName, userUPP) \
96 CALL_TWO_PARAMETER_UPP((userUPP), uppOpenResolverProcInfo, \
97 (selector), (fileName))
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)))
105 #define InvokeCloseResolverUPP(selector, userUPP) \
106 CALL_ONE_PARAMETER_UPP((userUPP), uppCloseResolverProcInfo, (selector))
108 typedef CALLBACK_API_C(OSErr, StrToAddrProcPtr)(UInt32, char *,
109 struct hostInfo *, ResultUPP,
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 *)))
120 #define InvokeStrToAddrUPP(selector, hostName, hostInfoPtr, ResultProc, \
121 userDataPtr, userUPP) \
122 CALL_FIVE_PARAMETER_UPP((userUPP), uppStrToAddrProcInfo, (selector),\
123 (hostName), (hostInfoPtr), (ResultProc), \
125 #define StrToAddr(hostName, hostInfoPtr, ResultProc, userDataPtr) \
126 InvokeStrToAddrUPP(STRTOADDR, hostName, hostInfoPtr, ResultProc, \
127 userDataPtr, (StrToAddrUPP)*mactcp.dnr_handle)
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 *)))
136 #define InvokeAddrToStrUPP(selector, addr, addrStr, userUPP) \
137 CALL_THREE_PARAMETER_UPP((userUPP), uppAddrToStrProcInfo, (selector),\
139 #define AddrToStr(addr, addrStr) \
140 InvokeAddrToStrUPP(ADDRTOSTR, addr, addrStr, \
141 (AddrToStrUPP)*mactcp.dnr_handle)
143 /* End of AddressXlation.h bits */
146 struct socket_function_table *fn;
147 /* the above variable absolutely *must* be the first in this structure */
152 bufchain output_data;
155 int frozen; /* this causes readability notifications to be ignored */
156 int frozen_readable; /* this means we missed at least one readability
157 * notification while we were frozen */
158 int localhost_only; /* for listening sockets */
161 int oobpending; /* is there OOB data available to read? */
163 int pending_error; /* in case send() returns error */
165 struct Socket_tag *next;
166 struct Socket_tag **prev;
170 * We used to typedef struct Socket_tag *Socket.
172 * Since we have made the networking abstraction slightly more
173 * abstract, Socket no longer means a tcp socket (it could mean
174 * an ssl socket). So now we must use Actual_Socket when we know
175 * we are talking about a tcp socket.
177 typedef struct Socket_tag *Actual_Socket;
179 struct SockAddr_tag {
181 struct hostInfo hostinfo;
185 /* Global variables */
190 ProcessSerialNumber self;
191 Actual_Socket socklist;
194 static pascal void mactcp_lookupdone(struct hostInfo *hi, char *cookie);
195 static pascal void mactcp_asr(StreamPtr, unsigned short, Ptr, unsigned short,
196 struct ICMPReport *);
197 static Plug mactcp_plug(Socket, Plug);
198 static void mactcp_flush(Socket);
199 static void mactcp_close(Socket);
200 static int mactcp_write(Socket, char const *, int);
201 static int mactcp_write_oob(Socket, char const*, int);
202 static void mactcp_set_private_ptr(Socket, void *);
203 static void *mactcp_get_private_ptr(Socket);
204 static char *mactcp_socket_error(Socket);
205 static void mactcp_set_frozen(Socket, int);
207 static void mactcp_recv(Actual_Socket s, size_t len);
211 * This should be called once before any TCP connection is opened.
214 OSErr mactcp_init(void)
219 * IM:Devices describes a convoluted way of finding a spare unit
220 * number to open a driver on before calling OpenDriver. Happily,
221 * the MacTCP INIT ensures that .IPP is already open (and hence
222 * has a valid unit number already) so we don't need to go through
223 * all that. (MacTCP Programmer's Guide p6)
225 err = OpenDriver("\p.IPP", &mactcp.refnum);
226 if (err != noErr) return err;
227 err = OpenResolver(NULL);
228 if (err != noErr) return err;
230 mactcp.initialised = TRUE;
234 void mactcp_shutdown(void)
236 Actual_Socket s, next;
239 * Eventually, PuTTY should close down each session as it exits,
240 * so there should be no sockets left when we get here. Still,
241 * better safe than sorry.
243 * XXX What about in-flight aync I/O (when we support that)?
245 for (s = mactcp.socklist; s != NULL; s = next) {
246 next = s->next; /* s is about to vanish */
247 mactcp_close(&s->fn);
251 * When we get async DNS, we have to wait for any outstanding
252 * requests to complete here before exiting.
255 mactcp.initialised = FALSE;
258 static ResultUPP mactcp_lookupdone_upp;
260 SockAddr sk_namelookup(char *host, char **canonicalname)
262 SockAddr ret = smalloc(sizeof(struct SockAddr_tag));
264 volatile int done = FALSE;
267 /* Clear the structure. */
268 memset(ret, 0, sizeof(struct SockAddr_tag));
269 if (mactcp_lookupdone_upp == NULL)
270 mactcp_lookupdone_upp = NewResultUPP(&mactcp_lookupdone);
271 err = StrToAddr(host, &ret->hostinfo, mactcp_lookupdone_upp,
274 * PuTTY expects DNS lookups to be synchronous (see bug
275 * "async-dns"), so we pretend they are.
277 if (err == cacheFault)
280 ret->resolved = TRUE;
282 if (ret->hostinfo.rtnCode == noErr)
283 realhost = ret->hostinfo.cname;
286 *canonicalname = smalloc(1+strlen(realhost));
287 strcpy(*canonicalname, realhost);
291 static pascal void mactcp_lookupdone(struct hostInfo *hi, char *cookie)
293 volatile int *donep = (int *)cookie;
298 SockAddr sk_nonamelookup(char *host)
300 SockAddr ret = smalloc(sizeof(struct SockAddr_tag));
302 ret->resolved = FALSE;
303 ret->hostinfo.rtnCode = noErr;
304 ret->hostname[0] = '\0';
305 strncat(ret->hostname, host, lenof(ret->hostname) - 1);
309 void sk_getaddr(SockAddr addr, char *buf, int buflen)
314 if (addr->resolved) {
315 /* XXX only return first address */
316 err = AddrToStr(addr->hostinfo.addr[0], mybuf);
319 strncat(buf, mybuf, buflen - 1);
322 strncat(buf, addr->hostname, buflen - 1);
326 /* I think "local" here really means "loopback" */
328 int sk_hostname_is_local(char *name)
331 return !strcmp(name, "localhost");
334 int sk_address_is_local(SockAddr addr)
339 for (i = 0; i < NUM_ALT_ADDRS; i++)
340 if (addr->hostinfo.addr[i] & 0xff000000 == 0x7f000000)
345 int sk_addrtype(SockAddr addr)
349 return ADDRTYPE_IPV4;
350 return ADDRTYPE_NAME;
353 void sk_addrcopy(SockAddr addr, char *buf)
356 /* XXX only return first address */
357 memcpy(buf, &addr->hostinfo.addr[0], 4);
360 void sk_addr_free(SockAddr addr)
366 static Plug mactcp_plug(Socket sock, Plug p)
368 Actual_Socket s = (Actual_Socket) sock;
376 static void mactcp_flush(Socket s)
379 fatalbox("sk_tcp_flush");
382 Socket sk_register(void *sock, Plug plug)
385 fatalbox("sk_register");
388 static TCPNotifyUPP mactcp_asr_upp;
390 Socket sk_new(SockAddr addr, int port, int privport, int oobinline,
391 int nodelay, Plug plug)
393 static struct socket_function_table fn_table = {
399 mactcp_set_private_ptr,
400 mactcp_get_private_ptr,
411 * Create Socket structure.
413 ret = smalloc(sizeof(struct Socket_tag));
418 bufchain_init(&ret->output_data);
419 ret->connected = 0; /* to start with */
420 ret->writable = 0; /* to start with */
421 ret->sending_oob = 0;
423 ret->frozen_readable = 0;
424 ret->localhost_only = 0; /* unused, but best init anyway */
425 ret->pending_error = 0;
426 ret->oobinline = oobinline;
427 ret->oobpending = FALSE;
430 dstaddr = addr->hostinfo.addr[0]; /* XXX should try all of them */
432 * Create a TCP stream.
434 * MacTCP requires us to provide it with some buffer memory. Page
435 * 31 of the Programmer's Guide says it should be a minimum of
436 * 4*MTU+1024. Page 36 says a minimum of 4096 bytes. Assume
437 * they're both correct.
439 assert(addr->resolved);
440 upb.ioCRefNum = mactcp.refnum;
441 upb.csCode = UDPMaxMTUSize;
442 upb.csParam.mtu.remoteHost = dstaddr;
443 upb.csParam.mtu.userDataPtr = NULL;
444 ret->err = PBControlSync((ParmBlkPtr)&upb);
445 if (ret->err != noErr) return (Socket)ret;
447 buflen = upb.csParam.mtu.mtuSize * 4 + 1024;
448 if (buflen < 4096) buflen = 4096;
449 if (mactcp_asr_upp == NULL)
450 mactcp_asr_upp = NewTCPNotifyUPP(&mactcp_asr);
451 GetCurrentProcess(&mactcp.self);
452 pb.ioCRefNum = mactcp.refnum;
453 pb.csCode = TCPCreate;
454 pb.csParam.create.rcvBuff = smalloc(buflen);
455 pb.csParam.create.rcvBuffLen = buflen;
456 pb.csParam.create.notifyProc = mactcp_asr_upp;
457 pb.csParam.create.userDataPtr = (Ptr)ret;
458 ret->err = PBControlSync((ParmBlkPtr)&pb);
459 if (ret->err != noErr) return (Socket)ret;
460 ret->s = pb.tcpStream;
463 * Open the connection.
465 pb.ioCRefNum = mactcp.refnum;
466 pb.csCode = TCPActiveOpen;
467 pb.tcpStream = ret->s;
468 pb.csParam.open.validityFlags = 0;
469 pb.csParam.open.remoteHost = dstaddr;
470 pb.csParam.open.remotePort = port;
471 pb.csParam.open.localPort = privport ? 1023 : 0;
472 pb.csParam.open.dontFrag = FALSE;
473 pb.csParam.open.timeToLive = 0;
474 pb.csParam.open.security = 0;
475 pb.csParam.open.optionCnt = 0;
476 pb.csParam.open.userDataPtr = (Ptr)ret;
478 ret->err = PBControlSync((ParmBlkPtr)&pb);
479 if (!privport || ret->err != duplicateSocket)
481 pb.csParam.open.localPort--;
482 if (pb.csParam.open.localPort == 0)
486 if (ret->err != noErr) return (Socket)ret;
488 ret->connected = TRUE;
489 ret->writable = TRUE;
491 /* Add this to the list of all sockets */
492 ret->next = mactcp.socklist;
493 ret->prev = &mactcp.socklist;
494 ret->next->prev = &ret->next;
495 mactcp.socklist = ret;
500 Socket sk_newlistener(char *srcaddr, int port, Plug plug, int local_host_only)
503 fatalbox("sk_newlistener");
506 static void mactcp_close(Socket sock)
508 Actual_Socket s = (Actual_Socket)sock;
512 * TCPClose is equivalent to shutdown(fd, SHUT_WR), and hence
513 * leaves the Rx side open, while TCPAbort seems rather vicious,
514 * throwing away Tx data that haven't been ACKed yet. We do both
517 pb.ioCRefNum = mactcp.refnum;
518 pb.csCode = TCPClose;
520 pb.csParam.close.validityFlags = 0;
521 pb.csParam.close.userDataPtr = (Ptr)s;
522 s->err = PBControlSync((ParmBlkPtr)&pb);
523 /* Not much we can do about an error anyway. */
525 pb.ioCRefNum = mactcp.refnum;
526 pb.csCode = TCPAbort;
528 pb.csParam.abort.userDataPtr = (Ptr)s;
529 s->err = PBControlSync((ParmBlkPtr)&pb);
530 /* Even less we can do about an error here. */
532 pb.ioCRefNum = mactcp.refnum;
533 pb.csCode = TCPRelease;
535 pb.csParam.create.userDataPtr = (Ptr)s;
536 s->err = PBControlSync((ParmBlkPtr)&pb);
538 sfree(pb.csParam.create.rcvBuff);
540 /* Unhitch from list of sockets */
543 s->next->prev = s->prev;
548 static int mactcp_write(Socket sock, char const *buf, int len)
550 Actual_Socket s = (Actual_Socket) sock;
555 * Casting away const from buf should be safe -- MacTCP won't
559 wds[0].ptr = (char *)buf;
562 pb.ioCRefNum = mactcp.refnum;
565 pb.csParam.send.validityFlags = 0;
566 pb.csParam.send.pushFlag = TRUE; /* XXX we want it to return. */
567 pb.csParam.send.urgentFlag = 0;
568 pb.csParam.send.wdsPtr = (Ptr)wds;
569 pb.csParam.send.userDataPtr = (Ptr)s;
570 s->err = PBControlSync((ParmBlkPtr)&pb);
574 static int mactcp_write_oob(Socket sock, char const *buf, int len)
577 fatalbox("mactcp_write_oob");
580 static pascal void mactcp_asr(StreamPtr str, unsigned short event, Ptr cookie,
581 unsigned short termin_reason,
582 struct ICMPReport *icmp)
585 WakeUpProcess(&mactcp.self);
589 * Called from our event loop if there's work to do.
591 void mactcp_poll(void)
596 for (s = mactcp.socklist; s != NULL; s = s->next) {
597 /* XXX above can't handle sockets being deleted. */
599 pb.ioCRefNum = mactcp.refnum;
600 pb.csCode = TCPStatus;
602 pb.csParam.status.userDataPtr = (Ptr)s;
603 s->err = PBControlSync((ParmBlkPtr)&pb);
606 if (pb.csParam.status.amtUnreadData == 0)
608 mactcp_recv(s, pb.csParam.status.amtUnreadData);
609 /* Should check connectionState in case remote has closed */
616 static void mactcp_recv(Actual_Socket s, size_t len)
621 if (s->frozen) return;
624 pb.ioCRefNum = mactcp.refnum;
625 pb.csCode = TCPNoCopyRcv;
627 pb.csParam.receive.commandTimeoutValue = 0;
628 pb.csParam.receive.rdsPtr = (Ptr)rds;
629 pb.csParam.receive.rdsLength = lenof(rds) - 1;
630 pb.csParam.receive.userDataPtr = (Ptr)s;
631 s->err = PBControlSync((ParmBlkPtr)&pb);
634 plug_receive(s->plug, 0, rds[0].ptr, rds[0].length);
635 len -= rds[0].length;
636 pb.csCode = TCPRcvBfrReturn;
637 s->err = PBControlSync((ParmBlkPtr)&pb);
644 * Each socket abstraction contains a `void *' private field in
645 * which the client can keep state.
647 static void mactcp_set_private_ptr(Socket sock, void *ptr)
649 Actual_Socket s = (Actual_Socket) sock;
650 s->private_ptr = ptr;
653 static void *mactcp_get_private_ptr(Socket sock)
655 Actual_Socket s = (Actual_Socket) sock;
656 return s->private_ptr;
660 * Special error values are returned from sk_namelookup and sk_new
661 * if there's a problem. These functions extract an error message,
662 * or return NULL if there's no problem.
664 char *sk_addr_error(SockAddr addr)
668 switch (addr->hostinfo.rtnCode) {
672 return "Name syntax error";
674 return "No name server found";
676 return "Domain name does not exist";
678 return "No answer from domain name server";
680 return "Domain name server returned an error";
682 return "Out of memory";
684 sprintf(buf, "Unknown DNR error %d", addr->hostinfo.rtnCode);
689 static char *mactcp_socket_error(Socket sock)
692 Actual_Socket s = (Actual_Socket) sock;
697 case insufficientResources:
698 return "Insufficient resources to open TCP stream";
699 case duplicateSocket:
700 return "Duplicate socket";
702 return "Connection failed while opening";
704 sprintf(buf, "Unknown MacTCP error %d", s->err);
709 static void mactcp_set_frozen(Socket sock, int is_frozen)
711 Actual_Socket s = (Actual_Socket) sock;
713 if (s->frozen == is_frozen)
715 s->frozen = is_frozen;
719 * Bits below here would usually be in dnr.c, shipped with the MacTCP
720 * SDK, but its convenient not to require that, and since we assume
721 * System 7 we can actually simplify things a lot.
724 static OSErr OpenResolver(char *hosts_file)
734 if (mactcp.dnr_handle != NULL)
737 err = FindFolder(kOnSystemDisk, kControlPanelFolderType, FALSE, &vrefnum,
739 if (err != noErr) return err;
742 * Might be better to use PBCatSearch here, but it's not always
745 pb.fileParam.ioCompletion = NULL;
746 pb.fileParam.ioNamePtr = filename;
747 pb.fileParam.ioVRefNum = vrefnum;
748 pb.fileParam.ioFDirIndex = 1;
749 pb.fileParam.ioDirID = dirid;
752 while (PBHGetFInfoSync(&pb) == noErr) {
753 if (pb.fileParam.ioFlFndrInfo.fdType == 'cdev' &&
754 pb.fileParam.ioFlFndrInfo.fdCreator == 'ztcp') {
755 fd = HOpenResFile(vrefnum, dirid, filename, fsRdPerm);
756 if (fd == -1) continue;
757 dnr_handle = Get1IndResource('dnrp', 1);
758 if (dnr_handle != NULL)
763 pb.fileParam.ioDirID = dirid;
764 pb.fileParam.ioFDirIndex++;
769 DetachResource(dnr_handle);
775 err = InvokeOpenResolverUPP(OPENRESOLVER, hosts_file,
776 (OpenResolverUPP)*dnr_handle);
779 DisposeHandle(dnr_handle);
783 mactcp.dnr_handle = dnr_handle;
787 OSErr CloseResolver(void)
789 Handle dnr_handle = mactcp.dnr_handle;
792 if (mactcp.dnr_handle == NULL)
795 err = InvokeCloseResolverUPP(CLOSERESOLVER,
796 (CloseResolverUPP)*mactcp.dnr_handle);
800 mactcp.dnr_handle = NULL;
802 DisposeHandle(dnr_handle);
806 /* MacTCP doesn't have a services database. */
807 int net_service_lookup(char *service)
816 * c-file-style: "simon"