basis/windows/winsock/winsock.factor

   1 ! Copyright (C) 2006 Mackenzie Straight, Doug Coleman.
   2 ! See http://factorcode.org/license.txt for BSD license.
   3 USING: accessors alien alien.c-types alien.data alien.strings
   4 alien.syntax arrays byte-arrays classes.struct grouping init
   5 io.encodings.utf16n kernel literals math math.bitwise
   6 math.parser sequences system vocabs.parser windows.com.syntax
   7 windows.errors windows.kernel32 windows.types ;
   8 FROM: alien.c-types => short ;
   9 IN: windows.winsock
  10
  11 <<
  12 ! Some differences between Win32 and Win64
  13 cpu x86.64? "windows.winsock.64" "windows.winsock.32" ? use-vocab
  14 >>
  15
  16 TYPEDEF: int* SOCKET
  17
  18 : <wsadata> ( -- byte-array )
  19     0x190 <byte-array> ;
  20
  21 CONSTANT: SOCK_STREAM    1
  22 CONSTANT: SOCK_DGRAM     2
  23 CONSTANT: SOCK_RAW       3
  24 CONSTANT: SOCK_RDM       4
  25 CONSTANT: SOCK_SEQPACKET 5
  26
  27 CONSTANT: SO_DEBUG       0x1
  28 CONSTANT: SO_ACCEPTCONN  0x2
  29 CONSTANT: SO_REUSEADDR   0x4
  30 CONSTANT: SO_KEEPALIVE   0x8
  31 CONSTANT: SO_DONTROUTE   0x10
  32 CONSTANT: SO_BROADCAST   0x20
  33 CONSTANT: SO_USELOOPBACK 0x40
  34 CONSTANT: SO_LINGER      0x80
  35 CONSTANT: SO_OOBINLINE   0x100
  36 : SO_DONTLINGER ( -- n ) SO_LINGER bitnot ; inline
  37
  38 CONSTANT: SO_SNDBUF     0x1001
  39 CONSTANT: SO_RCVBUF     0x1002
  40 CONSTANT: SO_SNDLOWAT   0x1003
  41 CONSTANT: SO_RCVLOWAT   0x1004
  42 CONSTANT: SO_SNDTIMEO   0x1005
  43 CONSTANT: SO_RCVTIMEO   0x1006
  44 CONSTANT: SO_ERROR      0x1007
  45 CONSTANT: SO_TYPE       0x1008
  46
  47 CONSTANT: TCP_NODELAY   0x1
  48
  49 CONSTANT: AF_UNSPEC      0
  50 CONSTANT: AF_UNIX        1
  51 CONSTANT: AF_INET        2
  52 CONSTANT: AF_IMPLINK     3
  53 CONSTANT: AF_PUP         4
  54 CONSTANT: AF_CHAOS       5
  55 CONSTANT: AF_NS          6
  56 CONSTANT: AF_ISO         7
  57 ALIAS: AF_OSI    AF_ISO
  58 CONSTANT: AF_ECMA        8
  59 CONSTANT: AF_DATAKIT     9
  60 CONSTANT: AF_CCITT      10
  61 CONSTANT: AF_SNA        11
  62 CONSTANT: AF_DECnet     12
  63 CONSTANT: AF_DLI        13
  64 CONSTANT: AF_LAT        14
  65 CONSTANT: AF_HYLINK     15
  66 CONSTANT: AF_APPLETALK  16
  67 CONSTANT: AF_NETBIOS    17
  68 CONSTANT: AF_MAX        18
  69 CONSTANT: AF_INET6      23
  70 CONSTANT: AF_IRDA       26
  71 CONSTANT: AF_BTM        32
  72
  73 CONSTANT: PF_UNSPEC      0
  74 CONSTANT: PF_LOCAL       1
  75 CONSTANT: PF_INET        2
  76 CONSTANT: PF_INET6      23
  77
  78 CONSTANT: AI_PASSIVE     1
  79 CONSTANT: AI_CANONNAME   2
  80 CONSTANT: AI_NUMERICHOST 4
  81
  82 CONSTANT: AI_MASK flags{ AI_PASSIVE AI_CANONNAME AI_NUMERICHOST }
  83
  84 CONSTANT: NI_NUMERICHOST 1
  85 CONSTANT: NI_NUMERICSERV 2
  86
  87 CONSTANT: IPPROTO_TCP    6
  88 CONSTANT: IPPROTO_UDP   17
  89 CONSTANT: IPPROTO_RM   113
  90
  91 CONSTANT: WSA_FLAG_OVERLAPPED 1
  92 ALIAS: WSA_WAIT_EVENT_0 WAIT_OBJECT_0
  93 ALIAS: WSA_MAXIMUM_WAIT_EVENTS MAXIMUM_WAIT_OBJECTS
  94 CONSTANT: WSA_INVALID_EVENT f
  95 CONSTANT: WSA_WAIT_FAILED -1
  96 ALIAS: WSA_WAIT_IO_COMPLETION WAIT_IO_COMPLETION
  97 ALIAS: WSA_WAIT_TIMEOUT WAIT_TIMEOUT
  98 ALIAS: WSA_INFINITE INFINITE
  99 ALIAS: WSA_IO_PENDING ERROR_IO_PENDING
 100
 101 CONSTANT: INADDR_ANY 0
 102
 103 : INVALID_SOCKET ( -- n ) -1 <alien> ; inline
 104
 105 : SOCKET_ERROR ( -- n ) -1 <alien> ; inline
 106
 107 CONSTANT: SD_RECV 0
 108 CONSTANT: SD_SEND 1
 109 CONSTANT: SD_BOTH 2
 110
 111 CONSTANT: SOL_SOCKET 0xffff
 112
 113 C-TYPE: sockaddr
 114
 115 STRUCT: sockaddr-in
 116     { family short }
 117     { port ushort }
 118     { addr uint }
 119     { pad char[8] } ;
 120
 121 STRUCT: sockaddr-in6
 122     { family uchar }
 123     { port ushort }
 124     { flowinfo uint }
 125     { addr uchar[16] }
 126     { scopeid uint } ;
 127
 128 STRUCT: hostent
 129     { name c-string }
 130     { aliases void* }
 131     { addrtype short }
 132     { length short }
 133     { addr-list void* } ;
 134
 135 STRUCT: protoent
 136     { name c-string }
 137     { aliases void* }
 138     { proto short } ;
 139
 140 STRUCT: addrinfo
 141     { flags int }
 142     { family int }
 143     { socktype int }
 144     { protocol int }
 145     { addrlen size_t }
 146     { canonname c-string }
 147     { addr sockaddr* }
 148     { next addrinfo* } ;
 149
 150 STRUCT: timeval
 151     { sec long }
 152     { usec long } ;
 153
 154 GENERIC: sockaddr>ip ( sockaddr -- string )
 155
 156 M: sockaddr-in sockaddr>ip ( sockaddr -- string )
 157     addr>> uint <ref> [ number>string ] { } map-as "." join ;
 158
 159 M: sockaddr-in6 sockaddr>ip ( uchar-array -- string )
 160     addr>> [ >hex ] { } map-as 2 group [ concat ] map ":" join ;
 161
 162 C-TYPE: fd_set
 163
 164 LIBRARY: winsock
 165
 166 FUNCTION: int setsockopt ( SOCKET s, int level, int optname, c-string optval, int optlen ) ;
 167
 168 FUNCTION: ushort htons ( ushort n ) ;
 169 FUNCTION: ushort ntohs ( ushort n ) ;
 170 FUNCTION: int bind ( void* socket, sockaddr-in* sockaddr, int len ) ;
 171 FUNCTION: int listen ( void* socket, int backlog ) ;
 172 FUNCTION: c-string inet_ntoa ( int in-addr ) ;
 173 FUNCTION: int getaddrinfo ( c-string nodename,
 174                             c-string servername,
 175                             addrinfo* hints,
 176                             addrinfo** res ) ;
 177
 178 FUNCTION: void freeaddrinfo ( addrinfo* ai ) ;
 179
 180
 181 FUNCTION: hostent* gethostbyname ( c-string name ) ;
 182 FUNCTION: int gethostname ( c-string name, int len ) ;
 183 FUNCTION: void* socket ( int domain, int type, int protocol ) ;
 184 FUNCTION: int connect ( void* socket, sockaddr-in* sockaddr, int addrlen ) ;
 185 FUNCTION: int select ( int nfds, fd_set* readfds, fd_set* writefds, fd_set* exceptfds, timeval* timeout ) ;
 186 FUNCTION: int closesocket ( SOCKET s ) ;
 187 FUNCTION: int shutdown ( SOCKET s, int how ) ;
 188 FUNCTION: int send ( SOCKET s, c-string buf, int len, int flags ) ;
 189 FUNCTION: int recv ( SOCKET s, c-string buf, int len, int flags ) ;
 190
 191 FUNCTION: int getsockname ( SOCKET s, sockaddr-in* address, int* addrlen ) ;
 192 FUNCTION: int getpeername ( SOCKET s, sockaddr-in* address, int* addrlen ) ;
 193
 194 FUNCTION: protoent* getprotobyname ( c-string name ) ;
 195
 196 FUNCTION: servent* getservbyname ( c-string name, c-string prot ) ;
 197 FUNCTION: servent* getservbyport ( int port, c-string prot ) ;
 198
 199 TYPEDEF: uint SERVICETYPE
 200 TYPEDEF: OVERLAPPED WSAOVERLAPPED
 201 TYPEDEF: WSAOVERLAPPED* LPWSAOVERLAPPED
 202 TYPEDEF: uint GROUP
 203 TYPEDEF: void* LPCONDITIONPROC
 204 TYPEDEF: HANDLE WSAEVENT
 205 TYPEDEF: LPHANDLE LPWSAEVENT
 206 TYPEDEF: sockaddr* LPSOCKADDR
 207
 208 STRUCT: FLOWSPEC
 209     { TokenRate          uint        }
 210     { TokenBucketSize    uint        }
 211     { PeakBandwidth      uint        }
 212     { Latency            uint        }
 213     { DelayVariation     uint        }
 214     { ServiceType        SERVICETYPE }
 215     { MaxSduSize         uint        }
 216     { MinimumPolicedSize uint        } ;
 217 TYPEDEF: FLOWSPEC* PFLOWSPEC
 218 TYPEDEF: FLOWSPEC* LPFLOWSPEC
 219
 220 STRUCT: WSABUF
 221     { len ulong }
 222     { buf void* } ;
 223 TYPEDEF: WSABUF* LPWSABUF
 224
 225 STRUCT: QOS
 226     { SendingFlowspec FLOWSPEC }
 227     { ReceivingFlowspec FLOWSPEC }
 228     { ProviderSpecific WSABUF } ;
 229 TYPEDEF: QOS* LPQOS
 230
 231 CONSTANT: MAX_PROTOCOL_CHAIN 7
 232
 233 STRUCT: WSAPROTOCOLCHAIN
 234     { ChainLen int }
 235     { ChainEntries { DWORD 7 } } ;
 236     ! { ChainEntries { DWORD MAX_PROTOCOL_CHAIN } } ;
 237 TYPEDEF: WSAPROTOCOLCHAIN* LPWSAPROTOCOLCHAIN
 238
 239 CONSTANT: WSAPROTOCOL_LEN 255
 240
 241 STRUCT: WSAPROTOCOL_INFOW
 242     { dwServiceFlags1 DWORD }
 243     { dwServiceFlags2 DWORD }
 244     { dwServiceFlags3 DWORD }
 245     { dwServiceFlags4 DWORD }
 246     { dwProviderFlags DWORD }
 247     { ProviderId GUID }
 248     { dwCatalogEntryId DWORD }
 249     { ProtocolChain WSAPROTOCOLCHAIN }
 250     { iVersion int }
 251     { iAddressFamily int }
 252     { iMaxSockAddr int }
 253     { iMinSockAddr int }
 254     { iSocketType int }
 255     { iProtocol int }
 256     { iProtocolMaxOffset int }
 257     { iNetworkByteOrder int }
 258     { iSecurityScheme int }
 259     { dwMessageSize DWORD }
 260     { dwProviderReserved DWORD }
 261     { szProtocol { WCHAR 256 } } ;
 262     ! { szProtocol[WSAPROTOCOL_LEN+1] { WCHAR 256 } } ;
 263 TYPEDEF: WSAPROTOCOL_INFOW* PWSAPROTOCOL_INFOW
 264 TYPEDEF: WSAPROTOCOL_INFOW* LPWSAPROTOCOL_INFOW
 265 TYPEDEF: WSAPROTOCOL_INFOW WSAPROTOCOL_INFO
 266 TYPEDEF: WSAPROTOCOL_INFOW* PWSAPROTOCOL_INFO
 267 TYPEDEF: WSAPROTOCOL_INFOW* LPWSAPROTOCOL_INFO
 268
 269
 270 STRUCT: WSANAMESPACE_INFOW
 271     { NSProviderId   GUID    }
 272     { dwNameSpace    DWORD   }
 273     { fActive        BOOL    }
 274     { dwVersion      DWORD   }
 275     { lpszIdentifier LPWSTR  } ;
 276 TYPEDEF: WSANAMESPACE_INFOW* PWSANAMESPACE_INFOW
 277 TYPEDEF: WSANAMESPACE_INFOW* LPWSANAMESPACE_INFOW
 278 TYPEDEF: WSANAMESPACE_INFOW WSANAMESPACE_INFO
 279 TYPEDEF: WSANAMESPACE_INFO* PWSANAMESPACE_INFO
 280 TYPEDEF: WSANAMESPACE_INFO* LPWSANAMESPACE_INFO
 281
 282 CONSTANT: FD_MAX_EVENTS 10
 283
 284 STRUCT: WSANETWORKEVENTS
 285     { lNetworkEvents long }
 286     { iErrorCode { int FD_MAX_EVENTS } } ;
 287 TYPEDEF: WSANETWORKEVENTS* PWSANETWORKEVENTS
 288 TYPEDEF: WSANETWORKEVENTS* LPWSANETWORKEVENTS
 289
 290 ! STRUCT: WSAOVERLAPPED
 291     ! { Internal DWORD }
 292     ! { InternalHigh DWORD }
 293     ! { Offset DWORD }
 294     ! { OffsetHigh DWORD }
 295     ! { hEvent WSAEVENT }
 296     ! { bytesTransferred DWORD } ;
 297 ! TYPEDEF: WSAOVERLAPPED* LPWSAOVERLAPPED
 298
 299 FUNCTION: SOCKET WSAAccept ( SOCKET s,
 300                              sockaddr* addr,
 301                              LPINT addrlen,
 302                              LPCONDITIONPROC lpfnCondition,
 303                              DWORD dwCallbackData ) ;
 304
 305 ! FUNCTION: INT WSAAddressToString ( LPSOCKADDR lpsaAddress, DWORD dwAddressLength, LPWSAPROTOCOL_INFO lpProtocolInfo, LPTSTR lpszAddressString, LPDWORD lpdwAddressStringLength ) ;
 306
 307 FUNCTION: int WSACleanup ( ) ;
 308 FUNCTION: BOOL WSACloseEvent ( WSAEVENT hEvent ) ;
 309
 310 FUNCTION: int WSAConnect ( SOCKET s,
 311                            sockaddr* name,
 312                            int namelen,
 313                            LPWSABUF lpCallerData,
 314                            LPWSABUF lpCalleeData,
 315                            LPQOS lpSQOS,
 316                            LPQOS lpGQOS ) ;
 317 FUNCTION: WSAEVENT WSACreateEvent ( ) ;
 318 ! FUNCTION: INT WSAEnumNameSpaceProviders ( LPDWORD lpdwBufferLength, LPWSANAMESPACE_INFO lpnspBuffer ) ;
 319 FUNCTION: int WSAEnumNetworkEvents ( SOCKET s,
 320                                      WSAEVENT hEventObject,
 321                                      LPWSANETWORKEVENTS lpNetworkEvents ) ;
 322 ! FUNCTION: int WSAEnumProtocols ( LPINT lpiProtocols, LPWSAPROTOCOL_INFO lpProtocolBuffer, LPDWORD lpwdBufferLength ) ;
 323
 324 FUNCTION: int WSAEventSelect ( SOCKET s,
 325                                WSAEVENT hEventObject,
 326                                long lNetworkEvents ) ;
 327 FUNCTION: int WSAGetLastError ( ) ;
 328 FUNCTION: BOOL WSAGetOverlappedResult ( SOCKET s,
 329                                         LPWSAOVERLAPPED lpOverlapped,
 330                                         LPDWORD lpcbTransfer,
 331                                         BOOL fWait,
 332                                         LPDWORD lpdwFlags ) ;
 333
 334 FUNCTION: int WSAIoctl ( SOCKET s,
 335                          DWORD dwIoControlCode,
 336                          LPVOID lpvInBuffer,
 337                          DWORD cbInBuffer,
 338                          LPVOID lpvOutBuffer,
 339                          DWORD cbOutBuffer,
 340                          LPDWORD lpcbBytesReturned,
 341                          void* lpOverlapped,
 342                          void* lpCompletionRoutine ) ;
 343
 344 TYPEDEF: void* LPWSAOVERLAPPED_COMPLETION_ROUTINE
 345 FUNCTION: int WSARecv ( SOCKET s,
 346                         LPWSABUF lpBuffers,
 347                         DWORD dwBufferCount,
 348                         LPDWORD lpNumberOfBytesRecvd,
 349                         LPDWORD lpFlags,
 350                         LPWSAOVERLAPPED lpOverlapped,
 351                     LPWSAOVERLAPPED_COMPLETION_ROUTINE lpCompletionRoutine ) ;
 352
 353 FUNCTION: int WSARecvFrom ( SOCKET s,
 354                     LPWSABUF lpBuffers,
 355                     DWORD dwBufferCount,
 356                     LPDWORD lpNumberOfBytesRecvd,
 357                     LPDWORD lpFlags,
 358                     sockaddr* lpFrom,
 359                     LPINT lpFromlen,
 360                     LPWSAOVERLAPPED lpOverlapped,
 361                     LPWSAOVERLAPPED_COMPLETION_ROUTINE lpCompletionRoutine ) ;
 362
 363 FUNCTION: BOOL WSAResetEvent ( WSAEVENT hEvent ) ;
 364 FUNCTION: int WSASend ( SOCKET s,
 365                         LPWSABUF lpBuffers,
 366                         DWORD dwBufferCount,
 367                         LPDWORD lpNumberOfBytesSent,
 368                         LPDWORD lpFlags,
 369                         LPWSAOVERLAPPED lpOverlapped,
 370                  LPWSAOVERLAPPED_COMPLETION_ROUTINE lpCompletionRoutine ) ;
 371
 372 FUNCTION: int WSASendTo ( SOCKET s,
 373                           LPWSABUF lpBuffers,
 374                           DWORD dwBufferCount,
 375                           LPDWORD lpNumberOfBytesSent,
 376                           DWORD dwFlags,
 377                           sockaddr* lpTo,
 378                           int iToLen,
 379                           LPWSAOVERLAPPED lpOverlapped,
 380   LPWSAOVERLAPPED_COMPLETION_ROUTINE lpCompletionRoutine ) ;
 381
 382
 383 FUNCTION: int WSAStartup ( short version, void* out-data ) ;
 384
 385
 386
 387 FUNCTION: SOCKET WSASocketW ( int af,
 388                              int type,
 389                              int protocol,
 390                              LPWSAPROTOCOL_INFOW lpProtocolInfo,
 391                              GROUP g,
 392                              DWORD flags ) ;
 393 ALIAS: WSASocket WSASocketW
 394
 395 FUNCTION: DWORD WSAWaitForMultipleEvents ( DWORD cEvents,
 396                                            WSAEVENT* lphEvents,
 397                                            BOOL fWaitAll,
 398                                            DWORD dwTimeout,
 399                                            BOOL fAlertable ) ;
 400
 401
 402 LIBRARY: mswsock
 403
 404 FUNCTION: int AcceptEx ( void* listen, void* accept, void* out-buf, int recv-len, int addr-len, int remote-len, void* out-len, void* overlapped ) ;
 405
 406 FUNCTION: void GetAcceptExSockaddrs (
 407   PVOID lpOutputBuffer,
 408   DWORD dwReceiveDataLength,
 409   DWORD dwLocalAddressLength,
 410   DWORD dwRemoteAddressLength,
 411   LPSOCKADDR* LocalSockaddr,
 412   LPINT LocalSockaddrLength,
 413   LPSOCKADDR* RemoteSockaddr,
 414   LPINT RemoteSockaddrLength
 415 ) ;
 416
 417 CONSTANT: SIO_GET_EXTENSION_FUNCTION_POINTER -939524090
 418
 419 CONSTANT: WSAID_CONNECTEX GUID: {25a207b9-ddf3-4660-8ee9-76e58c74063e}
 420
 421 ERROR: winsock-exception n string ;
 422
 423 : winsock-expected-error? ( n -- ? )
 424     ${ ERROR_IO_PENDING ERROR_SUCCESS WSA_IO_PENDING } member? ;
 425
 426 : (maybe-winsock-exception) ( n -- winsock-exception/f )
 427     ! #! WSAStartup returns the error code 'n' directly
 428     dup winsock-expected-error?
 429     [ drop f ] [ [ ] [ n>win32-error-string ] bi \ winsock-exception boa ] if ;
 430
 431 : maybe-winsock-exception ( -- winsock-exception/f )
 432     WSAGetLastError (maybe-winsock-exception) ;
 433
 434 : winsock-error ( -- )
 435     maybe-winsock-exception [ throw ] when* ;
 436
 437 : (throw-winsock-error) ( n -- * )
 438     [ ] [ n>win32-error-string ] bi winsock-exception ;
 439
 440 : throw-winsock-error ( -- * )
 441     WSAGetLastError (throw-winsock-error) ;
 442
 443 : winsock-error=0/f ( n/f -- )
 444     { 0 f } member? [ throw-winsock-error ] when ;
 445
 446 : winsock-error!=0/f ( n/f -- )
 447     { 0 f } member? [ throw-winsock-error ] unless ;
 448
 449 ! WSAStartup and WSACleanup return the error code directly
 450 : winsock-return-check ( n/f -- )
 451     dup { 0 f } member? [
 452         drop
 453     ] [
 454         [ ] [ n>win32-error-string ] bi winsock-exception
 455     ] if ;
 456
 457 : socket-error* ( n -- )
 458     SOCKET_ERROR = [
 459         WSAGetLastError
 460         dup WSA_IO_PENDING = [
 461             drop
 462         ] [
 463             (maybe-winsock-exception) throw
 464         ] if
 465     ] when ;
 466
 467 : socket-error ( n -- )
 468     SOCKET_ERROR = [ winsock-error ] when ;
 469
 470 : init-winsock ( -- )
 471     0x0202 <wsadata> WSAStartup winsock-return-check ;
 472
 473 : shutdown-winsock ( -- ) WSACleanup winsock-return-check ;
 474
 475 [ init-winsock ] "windows.winsock" add-startup-hook
 476 [ shutdown-winsock ] "windows.winsock" add-shutdown-hook