* mtcpnet.c - MacTCP interface
*/
+#if !TARGET_API_MAC_CARBON
+
#include <MacTypes.h>
#include <Devices.h>
#include <Endian.h>
#include <assert.h>
+#define DEFINE_PLUG_METHOD_MACROS
#include "putty.h"
#include "network.h"
#include "mac.h"
typedef STACK_UPP_TYPE(AddrToStrProcPtr) AddrToStrUPP;
enum { uppAddrToStrProcInfo = kCStackBased
| RESULT_SIZE(SIZE_CODE(sizeof(OSErr)))
- | STACK_ROUTINE_PARAMETER(1, SIZE_CODE(sizeof(unsigned long)))
- | STACK_ROUTINE_PARAMETER(2, SIZE_CODE(sizeof(char *)))
+ | STACK_ROUTINE_PARAMETER(1, SIZE_CODE(sizeof(UInt32)))
+ | STACK_ROUTINE_PARAMETER(2, SIZE_CODE(sizeof(unsigned long)))
+ | STACK_ROUTINE_PARAMETER(3, SIZE_CODE(sizeof(char *)))
};
#define InvokeAddrToStrUPP(selector, addr, addrStr, userUPP) \
CALL_THREE_PARAMETER_UPP((userUPP), uppAddrToStrProcInfo, (selector),\
/* End of AddressXlation.h bits */
+/* TCP connection states, mysteriously missing from <MacTCP.h> */
+#define TCPS_CLOSED 0
+#define TCPS_LISTEN 2
+#define TCPS_SYN_RECEIVED 4
+#define TCPS_SYN_SENT 6
+#define TCPS_ESTABLISHED 8
+#define TCPS_FIN_WAIT_1 10
+#define TCPS_FIN_WAIT_2 12
+#define TCPS_CLOSE_WAIT 14
+#define TCPS_CLOSING 16
+#define TCPS_LAST_ACK 18
+#define TCPS_TIME_WAIT 20
+
struct Socket_tag {
struct socket_function_table *fn;
/* the above variable absolutely *must* be the first in this structure */
+ StreamPtr s;
+ OSErr err;
+ Plug plug;
+ void *private_ptr;
+ bufchain output_data;
+ int connected;
+ int writable;
+ int frozen; /* this causes readability notifications to be ignored */
+ int frozen_readable; /* this means we missed at least one readability
+ * notification while we were frozen */
+ int localhost_only; /* for listening sockets */
+ char oobdata[1];
+ int sending_oob;
+ int oobpending; /* is there OOB data available to read? */
+ int oobinline;
+ int pending_error; /* in case send() returns error */
+ int listener;
+ struct Socket_tag *next;
+ struct Socket_tag **prev;
};
/*
Handle dnr_handle;
int initialised;
short refnum;
+ ProcessSerialNumber self;
+ Actual_Socket socklist;
} mactcp;
static pascal void mactcp_lookupdone(struct hostInfo *hi, char *cookie);
+static pascal void mactcp_asr(StreamPtr, unsigned short, Ptr, unsigned short,
+ struct ICMPReport *);
+static Plug mactcp_plug(Socket, Plug);
+static void mactcp_flush(Socket);
+static void mactcp_close(Socket);
+static int mactcp_write(Socket, char const *, int);
+static int mactcp_write_oob(Socket, char const*, int);
+static void mactcp_set_private_ptr(Socket, void *);
+static void *mactcp_get_private_ptr(Socket);
+static const char *mactcp_socket_error(Socket);
+static void mactcp_set_frozen(Socket, int);
+
+static void mactcp_recv(Actual_Socket s, size_t len);
/*
* Initialise MacTCP.
/*
* IM:Devices describes a convoluted way of finding a spare unit
* number to open a driver on before calling OpenDriver. Happily,
- * I think the MacTCP INIT ensures that .IPP is already open (and
- * hence has a valid unit number already) so we don't need to go
- * through all that.
+ * the MacTCP INIT ensures that .IPP is already open (and hence
+ * has a valid unit number already) so we don't need to go through
+ * all that. (MacTCP Programmer's Guide p6)
*/
err = OpenDriver("\p.IPP", &mactcp.refnum);
if (err != noErr) return err;
return noErr;
}
-void mactcp_shutdown(void)
+void mactcp_cleanup(void)
{
+ Actual_Socket s, next;
+
+ /*
+ * Eventually, PuTTY should close down each session as it exits,
+ * so there should be no sockets left when we get here. Still,
+ * better safe than sorry.
+ *
+ * XXX What about in-flight aync I/O (when we support that)?
+ */
+ for (s = mactcp.socklist; s != NULL; s = next) {
+ next = s->next; /* s is about to vanish */
+ mactcp_close(&s->fn);
+ }
+ /*
+ * When we get async DNS, we have to wait for any outstanding
+ * requests to complete here before exiting.
+ */
CloseResolver();
mactcp.initialised = FALSE;
}
static ResultUPP mactcp_lookupdone_upp;
-SockAddr sk_namelookup(char *host, char **canonicalname)
+SockAddr mactcp_namelookup(char const *host, char **canonicalname)
{
- SockAddr ret = smalloc(sizeof(struct SockAddr_tag));
+ SockAddr ret = snew(struct SockAddr_tag);
OSErr err;
volatile int done = FALSE;
char *realhost;
+ int realhostlen;
/* Clear the structure. */
memset(ret, 0, sizeof(struct SockAddr_tag));
if (mactcp_lookupdone_upp == NULL)
mactcp_lookupdone_upp = NewResultUPP(&mactcp_lookupdone);
- err = StrToAddr(host, &ret->hostinfo, mactcp_lookupdone_upp,
+ /* Casting away const -- hope StrToAddr is sensible */
+ err = StrToAddr((char *)host, &ret->hostinfo, mactcp_lookupdone_upp,
(char *)&done);
/*
* PuTTY expects DNS lookups to be synchronous (see bug
continue;
ret->resolved = TRUE;
- if (ret->hostinfo.rtnCode == noErr)
+ if (ret->hostinfo.rtnCode == noErr) {
realhost = ret->hostinfo.cname;
- else
+ /* MacTCP puts trailing dots on canonical names. */
+ realhostlen = strlen(realhost);
+ if (realhost[realhostlen - 1] == '.')
+ realhost[realhostlen - 1] = '\0';
+ } else
realhost = "";
- *canonicalname = smalloc(1+strlen(realhost));
+ *canonicalname = snewn(1 + strlen(realhost), char);
strcpy(*canonicalname, realhost);
return ret;
}
*donep = TRUE;
}
-SockAddr sk_nonamelookup(char *host)
+SockAddr mactcp_nonamelookup(char const *host)
{
- SockAddr ret = smalloc(sizeof(struct SockAddr_tag));
+ SockAddr ret = snew(struct SockAddr_tag);
ret->resolved = FALSE;
ret->hostinfo.rtnCode = noErr;
return ret;
}
-void sk_getaddr(SockAddr addr, char *buf, int buflen)
+void mactcp_getaddr(SockAddr addr, char *buf, int buflen)
{
char mybuf[16];
OSErr err;
- /* XXX only return first address */
- err = AddrToStr(addr->hostinfo.addr[0], mybuf);
- buf[0] = '\0';
- if (err != noErr)
- strncat(buf, mybuf, buflen - 1);
+ if (addr->resolved) {
+ /* XXX only return first address */
+ err = AddrToStr(addr->hostinfo.addr[0], mybuf);
+ buf[0] = '\0';
+ if (err != noErr)
+ strncat(buf, mybuf, buflen - 1);
+ } else {
+ buf[0] = '\0';
+ strncat(buf, addr->hostname, buflen - 1);
+ }
}
/* I think "local" here really means "loopback" */
-int sk_hostname_is_local(char *name)
+int mactcp_hostname_is_local(char *name)
{
return !strcmp(name, "localhost");
}
-int sk_address_is_local(SockAddr addr)
+int mactcp_address_is_local(SockAddr addr)
{
int i;
return FALSE;
}
-int sk_addrtype(SockAddr addr)
+int mactcp_addrtype(SockAddr addr)
{
if (addr->resolved)
return ADDRTYPE_NAME;
}
-void sk_addrcopy(SockAddr addr, char *buf)
+void mactcp_addrcopy(SockAddr addr, char *buf)
{
/* XXX only return first address */
memcpy(buf, &addr->hostinfo.addr[0], 4);
}
-void sk_addr_free(SockAddr addr)
+void mactcp_addr_free(SockAddr addr)
{
sfree(addr);
}
-Socket sk_new(SockAddr addr, int port, int privport, int oobinline,
+static Plug mactcp_plug(Socket sock, Plug p)
+{
+ Actual_Socket s = (Actual_Socket) sock;
+ Plug ret = s->plug;
+
+ if (p)
+ s->plug = p;
+ return ret;
+}
+
+static void mactcp_flush(Socket s)
+{
+
+ fatalbox("mactcp_flush");
+}
+
+Socket mactcp_register(void *sock, Plug plug)
+{
+
+ fatalbox("mactcp_register");
+}
+
+static TCPNotifyUPP mactcp_asr_upp;
+
+Socket mactcp_new(SockAddr addr, int port, int privport, int oobinline,
int nodelay, Plug plug)
{
+ static struct socket_function_table fn_table = {
+ mactcp_plug,
+ mactcp_close,
+ mactcp_write,
+ mactcp_write_oob,
+ mactcp_flush,
+ mactcp_set_private_ptr,
+ mactcp_get_private_ptr,
+ mactcp_set_frozen,
+ mactcp_socket_error
+ };
+ TCPiopb pb;
+ UDPiopb upb;
+ Actual_Socket ret;
+ ip_addr dstaddr;
+ size_t buflen;
+
+ /*
+ * Create Socket structure.
+ */
+ ret = snew(struct Socket_tag);
+ ret->s = 0;
+ ret->fn = &fn_table;
+ ret->err = noErr;
+ ret->plug = plug;
+ bufchain_init(&ret->output_data);
+ ret->connected = 0; /* to start with */
+ ret->writable = 0; /* to start with */
+ ret->sending_oob = 0;
+ ret->frozen = 0;
+ ret->frozen_readable = 0;
+ ret->localhost_only = 0; /* unused, but best init anyway */
+ ret->pending_error = 0;
+ ret->oobinline = oobinline;
+ ret->oobpending = FALSE;
+ ret->listener = 0;
+
+ dstaddr = addr->hostinfo.addr[0]; /* XXX should try all of them */
+ /*
+ * Create a TCP stream.
+ *
+ * MacTCP requires us to provide it with some buffer memory. Page
+ * 31 of the Programmer's Guide says it should be a minimum of
+ * 4*MTU+1024. Page 36 says a minimum of 4096 bytes. Assume
+ * they're both correct.
+ */
+ assert(addr->resolved);
+ upb.ioCRefNum = mactcp.refnum;
+ upb.csCode = UDPMaxMTUSize;
+ upb.csParam.mtu.remoteHost = dstaddr;
+ upb.csParam.mtu.userDataPtr = NULL;
+ ret->err = PBControlSync((ParmBlkPtr)&upb);
+ if (ret->err != noErr) return (Socket)ret;
+
+ buflen = upb.csParam.mtu.mtuSize * 4 + 1024;
+ if (buflen < 4096) buflen = 4096;
+ if (mactcp_asr_upp == NULL)
+ mactcp_asr_upp = NewTCPNotifyUPP(&mactcp_asr);
+ GetCurrentProcess(&mactcp.self);
+ pb.ioCRefNum = mactcp.refnum;
+ pb.csCode = TCPCreate;
+ pb.csParam.create.rcvBuff = snewn(buflen, char);
+ pb.csParam.create.rcvBuffLen = buflen;
+ pb.csParam.create.notifyProc = mactcp_asr_upp;
+ pb.csParam.create.userDataPtr = (Ptr)ret;
+ ret->err = PBControlSync((ParmBlkPtr)&pb);
+ if (ret->err != noErr) return (Socket)ret;
+ ret->s = pb.tcpStream;
+
+ /*
+ * Open the connection.
+ */
+ pb.ioCRefNum = mactcp.refnum;
+ pb.csCode = TCPActiveOpen;
+ pb.tcpStream = ret->s;
+ pb.csParam.open.validityFlags = 0;
+ pb.csParam.open.remoteHost = dstaddr;
+ pb.csParam.open.remotePort = port;
+ pb.csParam.open.localPort = privport ? 1023 : 0;
+ pb.csParam.open.dontFrag = FALSE;
+ pb.csParam.open.timeToLive = 0;
+ pb.csParam.open.security = 0;
+ pb.csParam.open.optionCnt = 0;
+ pb.csParam.open.userDataPtr = (Ptr)ret;
+ while (1) {
+ ret->err = PBControlSync((ParmBlkPtr)&pb);
+ if (!privport || ret->err != duplicateSocket)
+ break;
+ pb.csParam.open.localPort--;
+ if (pb.csParam.open.localPort == 0)
+ break;
+ }
+
+ if (ret->err != noErr) return (Socket)ret;
+
+ ret->connected = TRUE;
+ ret->writable = TRUE;
+
+ /* Add this to the list of all sockets */
+ ret->next = mactcp.socklist;
+ ret->prev = &mactcp.socklist;
+ if (ret->next != NULL)
+ ret->next->prev = &ret->next;
+ mactcp.socklist = ret;
+
+ sk_addr_free(addr); /* don't need this anymore */
+
+ return (Socket)ret;
+}
+
+Socket mactcp_newlistener(char *srcaddr, int port, Plug plug,
+ int local_host_only)
+{
+
+ fatalbox("mactcp_newlistener");
+}
+
+static void mactcp_close(Socket sock)
+{
+ Actual_Socket s = (Actual_Socket)sock;
+ TCPiopb pb;
+
+ /*
+ * TCPClose is equivalent to shutdown(fd, SHUT_WR), and hence
+ * leaves the Rx side open, while TCPAbort seems rather vicious,
+ * throwing away Tx data that haven't been ACKed yet. We do both
+ * in succession.
+ */
+ pb.ioCRefNum = mactcp.refnum;
+ pb.csCode = TCPClose;
+ pb.tcpStream = s->s;
+ pb.csParam.close.validityFlags = 0;
+ pb.csParam.close.userDataPtr = (Ptr)s;
+ s->err = PBControlSync((ParmBlkPtr)&pb);
+ /* Not much we can do about an error anyway. */
+
+ pb.ioCRefNum = mactcp.refnum;
+ pb.csCode = TCPAbort;
+ pb.tcpStream = s->s;
+ pb.csParam.abort.userDataPtr = (Ptr)s;
+ s->err = PBControlSync((ParmBlkPtr)&pb);
+ /* Even less we can do about an error here. */
+
+ pb.ioCRefNum = mactcp.refnum;
+ pb.csCode = TCPRelease;
+ pb.tcpStream = s->s;
+ pb.csParam.create.userDataPtr = (Ptr)s;
+ s->err = PBControlSync((ParmBlkPtr)&pb);
+ if (s->err == noErr)
+ sfree(pb.csParam.create.rcvBuff);
+
+ /* Unhitch from list of sockets */
+ *s->prev = s->next;
+ if (s->next != NULL)
+ s->next->prev = s->prev;
+
+ sfree(s);
+}
+
+static int mactcp_write(Socket sock, char const *buf, int len)
+{
+ Actual_Socket s = (Actual_Socket) sock;
+ wdsEntry wds[2];
+ TCPiopb pb;
+
+ /*
+ * Casting away const from buf should be safe -- MacTCP won't
+ * write to it.
+ */
+ wds[0].length = len;
+ wds[0].ptr = (char *)buf;
+ wds[1].length = 0;
+
+ pb.ioCRefNum = mactcp.refnum;
+ pb.csCode = TCPSend;
+ pb.tcpStream = s->s;
+ pb.csParam.send.validityFlags = 0;
+ pb.csParam.send.pushFlag = TRUE; /* XXX we want it to return. */
+ pb.csParam.send.urgentFlag = 0;
+ pb.csParam.send.wdsPtr = (Ptr)wds;
+ pb.csParam.send.userDataPtr = (Ptr)s;
+ s->err = PBControlSync((ParmBlkPtr)&pb);
+ return 0;
+}
+
+static int mactcp_write_oob(Socket sock, char const *buf, int len)
+{
+
+ fatalbox("mactcp_write_oob");
+}
+
+static pascal void mactcp_asr(StreamPtr str, unsigned short event, Ptr cookie,
+ unsigned short termin_reason,
+ struct ICMPReport *icmp)
+{
+
+ WakeUpProcess(&mactcp.self);
+}
+
+/*
+ * Called from our event loop if there's work to do.
+ */
+void mactcp_poll(void)
+{
+ Actual_Socket s, next;
+ TCPiopb pb;
+
+ for (s = mactcp.socklist; s != NULL; s = next) {
+ next = s->next;
+ do {
+ pb.ioCRefNum = mactcp.refnum;
+ pb.csCode = TCPStatus;
+ pb.tcpStream = s->s;
+ pb.csParam.status.userDataPtr = (Ptr)s;
+ s->err = PBControlSync((ParmBlkPtr)&pb);
+ if (s->err != noErr)
+ goto next_socket;
+ if (pb.csParam.status.amtUnreadData == 0)
+ break;
+ mactcp_recv(s, pb.csParam.status.amtUnreadData);
+ } while (TRUE);
+ switch (pb.csParam.status.connectionState) {
+ case TCPS_CLOSE_WAIT:
+ /* Remote end has sent us a FIN */
+ plug_closing(s->plug, NULL, 0, 0);
+ }
+ next_socket:
+ ;
+ }
+}
+
+static void mactcp_recv(Actual_Socket s, size_t len)
+{
+ rdsEntry rds[2];
+ TCPiopb pb;
+
+ if (s->frozen) return;
+
+ while (len > 0) {
+ pb.ioCRefNum = mactcp.refnum;
+ pb.csCode = TCPNoCopyRcv;
+ pb.tcpStream = s->s;
+ pb.csParam.receive.commandTimeoutValue = 0;
+ pb.csParam.receive.rdsPtr = (Ptr)rds;
+ pb.csParam.receive.rdsLength = lenof(rds) - 1;
+ pb.csParam.receive.userDataPtr = (Ptr)s;
+ s->err = PBControlSync((ParmBlkPtr)&pb);
+ if (s->err != noErr)
+ return;
+ plug_receive(s->plug, 0, rds[0].ptr, rds[0].length);
+ len -= rds[0].length;
+ pb.csCode = TCPRcvBfrReturn;
+ s->err = PBControlSync((ParmBlkPtr)&pb);
+ if (s->err != noErr)
+ return;
+ }
+}
+
+/*
+ * Each socket abstraction contains a `void *' private field in
+ * which the client can keep state.
+ */
+static void mactcp_set_private_ptr(Socket sock, void *ptr)
+{
+ Actual_Socket s = (Actual_Socket) sock;
+ s->private_ptr = ptr;
+}
- fatalbox("sk_new");
+static void *mactcp_get_private_ptr(Socket sock)
+{
+ Actual_Socket s = (Actual_Socket) sock;
+ return s->private_ptr;
}
/*
- * Special error values are returned from sk_namelookup and sk_new
- * if there's a problem. These functions extract an error message,
- * or return NULL if there's no problem.
+ * Special error values are returned from mactcp_namelookup and
+ * mactcp_new if there's a problem. These functions extract an error
+ * message, or return NULL if there's no problem.
*/
-char *sk_addr_error(SockAddr addr)
+char *mactcp_addr_error(SockAddr addr)
{
static char buf[64];
}
}
+static const char *mactcp_socket_error(Socket sock)
+{
+ static char buf[64];
+ Actual_Socket s = (Actual_Socket) sock;
+
+ switch (s->err) {
+ case noErr:
+ return NULL;
+ case insufficientResources:
+ return "Insufficient resources to open TCP stream";
+ case duplicateSocket:
+ return "Duplicate socket";
+ case openFailed:
+ return "Connection failed while opening";
+ default:
+ sprintf(buf, "Unknown MacTCP error %d", s->err);
+ return buf;
+ }
+}
+
+static void mactcp_set_frozen(Socket sock, int is_frozen)
+{
+ Actual_Socket s = (Actual_Socket) sock;
+
+ if (s->frozen == is_frozen)
+ return;
+ s->frozen = is_frozen;
+}
/*
* Bits below here would usually be in dnr.c, shipped with the MacTCP
pb.fileParam.ioDirID = dirid;
fd = -1;
- while (PBHGetFInfo(&pb, FALSE) == noErr) {
+ while (PBHGetFInfoSync(&pb) == noErr) {
if (pb.fileParam.ioFlFndrInfo.fdType == 'cdev' &&
pb.fileParam.ioFlFndrInfo.fdCreator == 'ztcp') {
fd = HOpenResFile(vrefnum, dirid, filename, fsRdPerm);
return noErr;
}
+#endif
+
/*
* Local Variables:
* c-file-style: "simon"
projects / u / mdw / putty / blobdiff