int
WSPAPI
WSPRecv(SOCKET Handle,
LPWSABUF lpBuffers,
DWORD dwBufferCount,
LPDWORD lpNumberOfBytesRead,
LPDWORD ReceiveFlags,
LPWSAOVERLAPPED lpOverlapped,
LPWSAOVERLAPPED_COMPLETION_ROUTINE lpCompletionRoutine,
LPWSATHREADID lpThreadId,
LPINT lpErrno)
{
PIO_STATUS_BLOCK IOSB;
IO_STATUS_BLOCK DummyIOSB;
AFD_RECV_INFO RecvInfo;
NTSTATUS Status;
PVOID APCContext;
PVOID APCFunction;
HANDLE Event = NULL;
HANDLE SockEvent;
PSOCKET_INFORMATION Socket;
AFD_DbgPrint(MID_TRACE,("Called (%x)\n", Handle));
/* Get the Socket Structure associate to this Socket*/
Socket = GetSocketStructure(Handle);
if (!Socket)
{
*lpErrno = WSAENOTSOCK;
return SOCKET_ERROR;
}
Status = NtCreateEvent( &SockEvent, EVENT_ALL_ACCESS,
NULL, 1, FALSE );
if( !NT_SUCCESS(Status) )
return -1;
/* Set up the Receive Structure */
RecvInfo.BufferArray = (PAFD_WSABUF)lpBuffers;
RecvInfo.BufferCount = dwBufferCount;
RecvInfo.TdiFlags = 0;
RecvInfo.AfdFlags = Socket->SharedData.NonBlocking ? AFD_IMMEDIATE : 0;
/* Set the TDI Flags */
if (*ReceiveFlags == 0)
{
RecvInfo.TdiFlags |= TDI_RECEIVE_NORMAL;
}
else
{
if (*ReceiveFlags & MSG_OOB)
{
RecvInfo.TdiFlags |= TDI_RECEIVE_EXPEDITED;
}
if (*ReceiveFlags & MSG_PEEK)
{
RecvInfo.TdiFlags |= TDI_RECEIVE_PEEK;
}
if (*ReceiveFlags & MSG_PARTIAL)
{
RecvInfo.TdiFlags |= TDI_RECEIVE_PARTIAL;
}
}
/* Verifiy if we should use APC */
if (lpOverlapped == NULL)
{
/* Not using Overlapped structure, so use normal blocking on event */
APCContext = NULL;
APCFunction = NULL;
Event = SockEvent;
IOSB = &DummyIOSB;
}
else
{
if (lpCompletionRoutine == NULL)
{
/* Using Overlapped Structure, but no Completition Routine, so no need for APC */
APCContext = lpOverlapped;
APCFunction = NULL;
Event = lpOverlapped->hEvent;
}
else
{
/* Using Overlapped Structure and a Completition Routine, so use an APC */
APCFunction = NULL; // should be a private io completition function inside us
APCContext = lpCompletionRoutine;
RecvInfo.AfdFlags |= AFD_SKIP_FIO;
}
IOSB = (PIO_STATUS_BLOCK)&lpOverlapped->Internal;
RecvInfo.AfdFlags |= AFD_OVERLAPPED;
}
IOSB->Status = STATUS_PENDING;
/* Send IOCTL */
Status = NtDeviceIoControlFile((HANDLE)Handle,
Event,
APCFunction,
APCContext,
IOSB,
IOCTL_AFD_RECV,
&RecvInfo,
sizeof(RecvInfo),
NULL,
0);
/* Wait for completition of not overlapped */
if (Status == STATUS_PENDING && lpOverlapped == NULL)
{
/* It's up to the protocol to time out recv. We must wait
* until the protocol decides it's had enough.
*/
WaitForSingleObject(SockEvent, INFINITE);
Status = IOSB->Status;
}
NtClose( SockEvent );
AFD_DbgPrint(MID_TRACE,("Status %x Information %d\n", Status, IOSB->Information));
/* Return the Flags */
*ReceiveFlags = 0;
switch (Status)
{
case STATUS_RECEIVE_EXPEDITED:
*ReceiveFlags = MSG_OOB;
break;
case STATUS_RECEIVE_PARTIAL_EXPEDITED:
*ReceiveFlags = MSG_PARTIAL | MSG_OOB;
break;
case STATUS_RECEIVE_PARTIAL:
*ReceiveFlags = MSG_PARTIAL;
break;
}
/* Re-enable Async Event */
if (*ReceiveFlags & MSG_OOB)
{
SockReenableAsyncSelectEvent(Socket, FD_OOB);
}
else
{
SockReenableAsyncSelectEvent(Socket, FD_READ);
}
return MsafdReturnWithErrno ( Status, lpErrno, IOSB->Information, lpNumberOfBytesRead );
}
int
WSPAPI
WSPSendTo(SOCKET Handle,
LPWSABUF lpBuffers,
DWORD dwBufferCount,
LPDWORD lpNumberOfBytesSent,
DWORD iFlags,
const struct sockaddr *SocketAddress,
int SocketAddressLength,
LPWSAOVERLAPPED lpOverlapped,
LPWSAOVERLAPPED_COMPLETION_ROUTINE lpCompletionRoutine,
LPWSATHREADID lpThreadId,
LPINT lpErrno)
{
PIO_STATUS_BLOCK IOSB;
IO_STATUS_BLOCK DummyIOSB;
AFD_SEND_INFO_UDP SendInfo;
NTSTATUS Status;
PVOID APCContext;
PVOID APCFunction;
HANDLE Event = NULL;
PTRANSPORT_ADDRESS RemoteAddress;
PSOCKADDR BindAddress = NULL;
INT BindAddressLength;
HANDLE SockEvent;
PSOCKET_INFORMATION Socket;
/* Get the Socket Structure associate to this Socket */
Socket = GetSocketStructure(Handle);
if (!Socket)
{
*lpErrno = WSAENOTSOCK;
return SOCKET_ERROR;
}
if (!(Socket->SharedData.ServiceFlags1 & XP1_CONNECTIONLESS))
{
/* Use WSPSend for connection-oriented sockets */
return WSPSend(Handle,
lpBuffers,
dwBufferCount,
lpNumberOfBytesSent,
iFlags,
lpOverlapped,
lpCompletionRoutine,
lpThreadId,
lpErrno);
}
/* Bind us First */
if (Socket->SharedData.State == SocketOpen)
{
/* Get the Wildcard Address */
BindAddressLength = Socket->HelperData->MaxWSAddressLength;
BindAddress = HeapAlloc(GlobalHeap, 0, BindAddressLength);
if (!BindAddress)
{
MsafdReturnWithErrno(STATUS_INSUFFICIENT_RESOURCES, lpErrno, 0, NULL);
return INVALID_SOCKET;
}
Socket->HelperData->WSHGetWildcardSockaddr(Socket->HelperContext,
BindAddress,
&BindAddressLength);
/* Bind it */
if (WSPBind(Handle, BindAddress, BindAddressLength, lpErrno) == SOCKET_ERROR)
return SOCKET_ERROR;
}
RemoteAddress = HeapAlloc(GlobalHeap, 0, 0x6 + SocketAddressLength);
if (!RemoteAddress)
{
if (BindAddress != NULL)
{
HeapFree(GlobalHeap, 0, BindAddress);
}
return MsafdReturnWithErrno(STATUS_INSUFFICIENT_RESOURCES, lpErrno, 0, NULL);
}
Status = NtCreateEvent(&SockEvent,
EVENT_ALL_ACCESS,
NULL, 1, FALSE);
if (!NT_SUCCESS(Status))
{
HeapFree(GlobalHeap, 0, RemoteAddress);
if (BindAddress != NULL)
{
HeapFree(GlobalHeap, 0, BindAddress);
}
return SOCKET_ERROR;
}
/* Set up Address in TDI Format */
RemoteAddress->TAAddressCount = 1;
RemoteAddress->Address[0].AddressLength = SocketAddressLength - sizeof(SocketAddress->sa_family);
RtlCopyMemory(&RemoteAddress->Address[0].AddressType, SocketAddress, SocketAddressLength);
/* Set up Structure */
SendInfo.BufferArray = (PAFD_WSABUF)lpBuffers;
SendInfo.AfdFlags = Socket->SharedData.NonBlocking ? AFD_IMMEDIATE : 0;
SendInfo.BufferCount = dwBufferCount;
SendInfo.TdiConnection.RemoteAddress = RemoteAddress;
SendInfo.TdiConnection.RemoteAddressLength = Socket->HelperData->MaxTDIAddressLength;
/* Verifiy if we should use APC */
if (lpOverlapped == NULL)
{
/* Not using Overlapped structure, so use normal blocking on event */
APCContext = NULL;
APCFunction = NULL;
Event = SockEvent;
IOSB = &DummyIOSB;
}
else
{
if (lpCompletionRoutine == NULL)
{
/* Using Overlapped Structure, but no Completition Routine, so no need for APC */
APCContext = lpOverlapped;
APCFunction = NULL;
Event = lpOverlapped->hEvent;
}
else
{
/* Using Overlapped Structure and a Completition Routine, so use an APC */
/* Should be a private io completition function inside us */
APCFunction = NULL;
APCContext = lpCompletionRoutine;
SendInfo.AfdFlags |= AFD_SKIP_FIO;
}
IOSB = (PIO_STATUS_BLOCK)&lpOverlapped->Internal;
SendInfo.AfdFlags |= AFD_OVERLAPPED;
}
/* Send IOCTL */
Status = NtDeviceIoControlFile((HANDLE)Handle,
Event,
APCFunction,
APCContext,
IOSB,
IOCTL_AFD_SEND_DATAGRAM,
&SendInfo,
sizeof(SendInfo),
NULL,
0);
/* Wait for completition of not overlapped */
if (Status == STATUS_PENDING && lpOverlapped == NULL)
{
/* BUGBUG, shouldn't wait infintely for send... */
WaitForSingleObject(SockEvent, INFINITE);
Status = IOSB->Status;
}
NtClose(SockEvent);
HeapFree(GlobalHeap, 0, RemoteAddress);
if (BindAddress != NULL)
{
HeapFree(GlobalHeap, 0, BindAddress);
}
SockReenableAsyncSelectEvent(Socket, FD_WRITE);
return MsafdReturnWithErrno(Status, lpErrno, IOSB->Information, lpNumberOfBytesSent);
}
int
WSPAPI
WSPSend(SOCKET Handle,
LPWSABUF lpBuffers,
DWORD dwBufferCount,
LPDWORD lpNumberOfBytesSent,
DWORD iFlags,
LPWSAOVERLAPPED lpOverlapped,
LPWSAOVERLAPPED_COMPLETION_ROUTINE lpCompletionRoutine,
LPWSATHREADID lpThreadId,
LPINT lpErrno)
{
PIO_STATUS_BLOCK IOSB;
IO_STATUS_BLOCK DummyIOSB;
AFD_SEND_INFO SendInfo;
NTSTATUS Status;
PVOID APCContext;
PVOID APCFunction;
HANDLE Event = NULL;
HANDLE SockEvent;
PSOCKET_INFORMATION Socket;
/* Get the Socket Structure associate to this Socket*/
Socket = GetSocketStructure(Handle);
if (!Socket)
{
*lpErrno = WSAENOTSOCK;
return SOCKET_ERROR;
}
Status = NtCreateEvent( &SockEvent, EVENT_ALL_ACCESS,
NULL, 1, FALSE );
if( !NT_SUCCESS(Status) )
return -1;
AFD_DbgPrint(MID_TRACE,("Called\n"));
/* Set up the Send Structure */
SendInfo.BufferArray = (PAFD_WSABUF)lpBuffers;
SendInfo.BufferCount = dwBufferCount;
SendInfo.TdiFlags = 0;
SendInfo.AfdFlags = Socket->SharedData.NonBlocking ? AFD_IMMEDIATE : 0;
/* Set the TDI Flags */
if (iFlags)
{
if (iFlags & MSG_OOB)
{
SendInfo.TdiFlags |= TDI_SEND_EXPEDITED;
}
if (iFlags & MSG_PARTIAL)
{
SendInfo.TdiFlags |= TDI_SEND_PARTIAL;
}
}
/* Verifiy if we should use APC */
if (lpOverlapped == NULL)
{
/* Not using Overlapped structure, so use normal blocking on event */
APCContext = NULL;
APCFunction = NULL;
Event = SockEvent;
IOSB = &DummyIOSB;
}
else
{
if (lpCompletionRoutine == NULL)
{
/* Using Overlapped Structure, but no Completition Routine, so no need for APC */
APCContext = lpOverlapped;
APCFunction = NULL;
Event = lpOverlapped->hEvent;
}
else
{
/* Using Overlapped Structure and a Completition Routine, so use an APC */
APCFunction = NULL; // should be a private io completition function inside us
APCContext = lpCompletionRoutine;
SendInfo.AfdFlags |= AFD_SKIP_FIO;
}
IOSB = (PIO_STATUS_BLOCK)&lpOverlapped->Internal;
SendInfo.AfdFlags |= AFD_OVERLAPPED;
}
IOSB->Status = STATUS_PENDING;
/* Send IOCTL */
Status = NtDeviceIoControlFile((HANDLE)Handle,
Event,
APCFunction,
APCContext,
IOSB,
IOCTL_AFD_SEND,
&SendInfo,
sizeof(SendInfo),
NULL,
0);
/* Wait for completition of not overlapped */
if (Status == STATUS_PENDING && lpOverlapped == NULL)
{
WaitForSingleObject(SockEvent, INFINITE); // BUGBUG, shouldn wait infintely for send...
Status = IOSB->Status;
}
NtClose( SockEvent );
if (Status == STATUS_PENDING)
{
AFD_DbgPrint(MID_TRACE,("Leaving (Pending)\n"));
return MsafdReturnWithErrno(Status, lpErrno, IOSB->Information, lpNumberOfBytesSent);
}
/* Re-enable Async Event */
SockReenableAsyncSelectEvent(Socket, FD_WRITE);
AFD_DbgPrint(MID_TRACE,("Leaving (Success, %d)\n", IOSB->Information));
return MsafdReturnWithErrno( Status, lpErrno, IOSB->Information, lpNumberOfBytesSent );
}
int
WSPAPI
WSPSendTo (
SOCKET Handle,
LPWSABUF lpBuffers,
DWORD dwBufferCount,
LPDWORD lpNumberOfBytesSent,
DWORD iFlags,
const struct sockaddr *SocketAddress,
int SocketAddressLength,
LPWSAOVERLAPPED lpOverlapped,
LPWSAOVERLAPPED_COMPLETION_ROUTINE lpCompletionRoutine,
LPWSATHREADID lpThreadId,
LPINT lpErrno
)
/*++
Routine Description:
This routine is normally used on a connectionless socket specified by s
to send a datagram contained in one or more buffers to a specific peer
socket identified by the lpTo parameter. On a connection-oriented socket,
the lpTo and iToLen parameters are ignored; in this case the WSPSendTo()
is equivalent to WSPSend().
For overlapped sockets (created using WSPSocket() with flag
WSA_FLAG_OVERLAPPED) this will occur using overlapped I/O, unless both
lpOverlapped and lpCompletionRoutine are NULL in which case the socket is
treated as a non-overlapped socket. A completion indication will occur
(invocation of the completion routine or setting of an event object) when
the supplied buffer(s) have been consumed by the transport. If the
operation does not complete immediately, the final completion status is
retrieved via the completion routine or WSPGetOverlappedResult().
For non-overlapped sockets, the parameters lpOverlapped,
lpCompletionRoutine, and lpThreadId are ignored and WSPSend() adopts the
regular synchronous semantics. Data is copied from the supplied buffer(s)
into the transport's buffer. If the socket is non-blocking and stream-
oriented, and there is not sufficient space in the transport's buffer,
WSPSend() will return with only part of the supplied buffers having been
consumed. Given the same buffer situation and a blocking socket, WSPSend()
will block until all of the supplied buffer contents have been consumed.
The array of WSABUF structures pointed to by the lpBuffers parameter is
transient. If this operation completes in an overlapped manner, it is the
service provider's responsibility to capture these WSABUF structures
before returning from this call. This enables applications to build stack-
based WSABUF arrays.
For message-oriented sockets, care must be taken not to exceed the maximum
message size of the underlying provider, which can be obtained by getting
the value of socket option SO_MAX_MSG_SIZE. If the data is too long to
pass atomically through the underlying protocol the error WSAEMSGSIZE is
returned, and no data is transmitted.
Note that the successful completion of a WSPSendTo() does not indicate that
the data was successfully delivered.
dwFlags may be used to influence the behavior of the function invocation
beyond the options specified for the associated socket. That is, the
semantics of this routine are determined by the socket options and the
dwFlags parameter. The latter is constructed by or-ing any of the
following values:
MSG_DONTROUTE - Specifies that the data should not be subject
to routing. A WinSock service provider may choose to ignore this
flag.
MSG_OOB - Send out-of-band data (stream style socket such as
SOCK_STREAM only).
MSG_PARTIAL - Specifies that lpBuffers only contains a partial
message. Note that the error code WSAEOPNOTSUPP will be returned
which do not support partial message transmissions.
If an overlapped operation completes immediately, WSPSendTo() returns a
value of zero and the lpNumberOfBytesSent parameter is updated with the
number of bytes sent. If the overlapped operation is successfully
initiated and will complete later, WSPSendTo() returns SOCKET_ERROR and
indicates error code WSA_IO_PENDING. In this case, lpNumberOfBytesSent is
not updated. When the overlapped operation completes the amount of data
transferred is indicated either via the cbTransferred parameter in the
completion routine (if specified), or via the lpcbTransfer parameter in
WSPGetOverlappedResult().
Providers must allow this routine to be called from within the completion
routine of a previous WSPRecv(), WSPRecvFrom(), WSPSend() or WSPSendTo()
function. However, for a given socket, I/O completion routines may not be
nested. This permits time-sensitive data transmissions to occur entirely
within a preemptive context.
The lpOverlapped parameter must be valid for the duration of the
overlapped operation. If multiple I/O operations are simultaneously
outstanding, each must reference a separate overlapped structure. The
WSAOVERLAPPED structure has the following form:
typedef struct _WSAOVERLAPPED {
DWORD Internal; // reserved
DWORD InternalHigh; // reserved
DWORD Offset; // reserved
DWORD OffsetHigh; // reserved
WSAEVENT hEvent;
} WSAOVERLAPPED, FAR * LPWSAOVERLAPPED;
If the lpCompletionRoutine parameter is NULL, the service provider signals
the hEvent field of lpOverlapped when the overlapped operation completes
if it contains a valid event object handle. The WinSock SPI client can use
WSPGetOverlappedResult() to wait or poll on the event object.
If lpCompletionRoutine is not NULL, the hEvent field is ignored and can be
used by the WinSock SPI client to pass context information to the
completion routine. It is the service provider's responsibility to arrange
for invocation of the client-specified completion routine when the
overlapped operation completes. Since the completion routine must be
executed in the context of the same thread that initiated the overlapped
operation, it cannot be invoked directly from the service provider. The
WinSock DLL offers an asynchronous procedure call (APC) mechanism to
facilitate invocation of completion routines.
A service provider arranges for a function to be executed in the proper
thread by calling WPUQueueApc(). Note that this routine must be invoked
while in the context of the same process (but not necessarily the same
thread) that was used to initiate the overlapped operation. It is the
service provider's responsibility to arrange for this process context to
be active prior to calling WPUQueueApc().
WPUQueueApc() takes as input parameters a pointer to a WSATHREADID
structure (supplied to the provider via the lpThreadId input parameter),
a pointer to an APC function to be invoked, and a 32 bit context value
that is subsequently passed to the APC function. Because only a single
32-bit context value is available, the APC function cannot itself be the
client-specified completion routine. The service provider must instead
supply a pointer to its own APC function which uses the supplied context
value to access the needed result information for the overlapped operation,
and then invokes the client-specified completion routine.
The prototype for the client-supplied completion routine is as follows:
void
CALLBACK
CompletionRoutine(
IN DWORD dwError,
IN DWORD cbTransferred,
IN LPWSAOVERLAPPED lpOverlapped,
IN DWORD dwFlags
);
CompletionRoutine is a placeholder for a client supplied function
name.
dwError specifies the completion status for the overlapped
operation as indicated by lpOverlapped.
cbTransferred specifies the number of bytes sent.
No flag values are currently defined and the dwFlags value will
be zero.
This routine does not return a value.
The completion routines may be called in any order, not necessarily in
the same order the overlapped operations are completed. However, the
service provider guarantees to the client that posted buffers are sent
in the same order they are supplied.
Arguments:
s - A descriptor identifying a socket.
lpBuffers - A pointer to an array of WSABUF structures. Each WSABUF
structure contains a pointer to a buffer and the length of the
buffer. This array must remain valid for the duration of the
send operation.
dwBufferCount - The number of WSABUF structures in the lpBuffers
array.
lpNumberOfBytesSent - A pointer to the number of bytes sent by this
call.
dwFlags - Specifies the way in which the call is made.
lpTo - An optional pointer to the address of the target socket.
iTolen - The size of the address in lpTo.
lpOverlapped - A pointer to a WSAOVERLAPPED structure.
lpCompletionRoutine - A pointer to the completion routine called
when the send operation has been completed.
lpThreadId - A pointer to a thread ID structure to be used by the
provider in a subsequent call to WPUQueueApc(). The provider
should store the referenced WSATHREADID structure (not the
pointer to same) until after the WPUQueueApc() function returns.
lpErrno - A pointer to the error code.
Return Value:
If no error occurs and the send operation has completed immediately,
WSPSendTo() returns 0. Note that in this case the completion routine, if
specified, will have already been queued. Otherwise, a value of
SOCKET_ERROR is returned, and a specific error code is available in
lpErrno. The error code WSA_IO_PENDING indicates that the overlapped
operation has been successfully initiated and that completion will be
indicated at a later time. Any other error code indicates that no
overlapped operation was initiated and no completion indication will occur.
--*/
{
NTSTATUS status;
PWINSOCK_TLS_DATA tlsData;
PSOCKET_INFORMATION socket;
IO_STATUS_BLOCK localIoStatusBlock;
PIO_STATUS_BLOCK ioStatusBlock;
AFD_SEND_DATAGRAM_INFO sendInfo;
PTRANSPORT_ADDRESS tdiAddress;
ULONG tdiAddressLength;
int err;
UCHAR tdiAddressBuffer[MAX_FAST_TDI_ADDRESS];
HANDLE event;
PIO_APC_ROUTINE apcRoutine;
PVOID apcContext;
WS_ENTER( "WSPSendTo", (PVOID)Handle, (PVOID)lpBuffers, (PVOID)dwBufferCount, (PVOID)iFlags );
WS_ASSERT( lpErrno != NULL );
err = SockEnterApi( &tlsData );
if( err != NO_ERROR ) {
WS_EXIT( "WSPSendTo", SOCKET_ERROR, TRUE );
*lpErrno = err;
return SOCKET_ERROR;
}
//
// Set up locals so that we know how to clean up on exit.
//
tdiAddress = (PTRANSPORT_ADDRESS)tdiAddressBuffer;
//
// Find a pointer to the socket structure corresponding to the
// passed-in handle.
//
socket = SockFindAndReferenceSocket( Handle, TRUE );
if ( socket == NULL ) {
err = WSAENOTSOCK;
goto exit;
}
//
// If this is not a datagram socket, just call send() to process the
// call. The address and address length parameters are not checked.
//
if ( !IS_DGRAM_SOCK(socket)
|| ( (socket->State==SocketStateConnected)
&& ( SocketAddress == NULL || SocketAddressLength == 0 ))
) {
INT ret;
SockDereferenceSocket( socket );
ret = WSPSend(
Handle,
lpBuffers,
dwBufferCount,
lpNumberOfBytesSent,
iFlags,
lpOverlapped,
lpCompletionRoutine,
lpThreadId,
lpErrno
);
WS_EXIT( "WSPSendTo", ret, (BOOLEAN)(ret == SOCKET_ERROR) );
return ret;
}
IF_DEBUG(SEND) {
WS_PRINT(( "WSASendTo() on socket %lx to addr", Handle ));
WsPrintSockaddr( (PSOCKADDR)SocketAddress, &SocketAddressLength );
}
//
// If the socket is not connected, then the Address and AddressLength
// fields must be specified.
//
if ( socket->State != SocketStateConnected ) {
if ( SocketAddress == NULL ) {
err = WSAENOTCONN;
goto exit;
}
}
// Note: we simply truncate sockaddr's > MaxSockaddrLength down below
if ( SocketAddressLength < socket->HelperDll->MinSockaddrLength ) {
err = WSAEFAULT;
goto exit;
}
//
// The legal flags are MSG_OOB, MSG_DONTROUTE, and MSG_PARTIAL.
// MSG_OOB is not legal on datagram sockets.
//
WS_ASSERT( IS_DGRAM_SOCK( socket ) );
if ( ( (iFlags & ~(MSG_DONTROUTE)) != 0 ) ) {
err = WSAEOPNOTSUPP;
goto exit;
}
//
// If data send has been shut down, fail.
//
if ( socket->SendShutdown ) {
err = WSAESHUTDOWN;
goto exit;
}
__try {
//
// Make sure that the address family passed in here is the same as
// was passed in on the socket( ) call.
//
if ( (short)socket->AddressFamily != SocketAddress->sa_family ) {
err = WSAEAFNOSUPPORT;
goto exit;
}
//
// If this socket has not been set to allow broadcasts, check if this
// is an attempt to send to a broadcast address.
//
if ( !socket->Broadcast ) {
SOCKADDR_INFO sockaddrInfo;
err = socket->HelperDll->WSHGetSockaddrType(
(PSOCKADDR)SocketAddress,
SocketAddressLength,
&sockaddrInfo
);
if ( err != NO_ERROR) {
goto exit;
}
//
// If this is an attempt to send to a broadcast address, reject
// the attempt.
//
if ( sockaddrInfo.AddressInfo == SockaddrAddressInfoBroadcast ) {
err = WSAEACCES;
goto exit;
}
}
//
// If this socket is not yet bound to an address, bind it to an
// address. We only do this if the helper DLL for the socket supports
// a get wildcard address routine--if it doesn't, the app must bind
// to an address manually.
//
if ( socket->State == SocketStateOpen) {
if (socket->HelperDll->WSHGetWildcardSockaddr != NULL ) {
PSOCKADDR sockaddr;
INT sockaddrLength = socket->HelperDll->MaxSockaddrLength;
int result;
sockaddr = ALLOCATE_HEAP( sockaddrLength );
if ( sockaddr == NULL ) {
err = WSAENOBUFS;
goto exit;
}
err = socket->HelperDll->WSHGetWildcardSockaddr(
socket->HelperDllContext,
sockaddr,
&sockaddrLength
);
if ( err != NO_ERROR ) {
FREE_HEAP( sockaddr );
goto exit;
}
//
// Acquire the lock that protect this sockets. We hold this lock
// throughout this routine to synchronize against other callers
// performing operations on the socket we're sending data on.
//
SockAcquireSocketLockExclusive( socket );
//
// Recheck socket state under the lock
//
if (socket->State == SocketStateOpen) {
result = WSPBind(
Handle,
sockaddr,
sockaddrLength,
&err
);
}
else
result = ERROR_SUCCESS;
SockReleaseSocketLock( socket );
FREE_HEAP( sockaddr );
if( result == SOCKET_ERROR ) {
goto exit;
}
} else {
//
// The socket is not bound and the helper DLL does not support
// a wildcard socket address. Fail, the app must bind manually.
//
err = WSAEINVAL;
goto exit;
}
}
//
// Allocate enough space to hold the TDI address structure we'll pass
// to AFD. Note that is the address is small enough, we just use
// an automatic in order to improve performance.
//
tdiAddressLength = socket->HelperDll->MaxTdiAddressLength;
if ( tdiAddressLength > MAX_FAST_TDI_ADDRESS ) {
tdiAddress = ALLOCATE_HEAP( tdiAddressLength );
if ( tdiAddress == NULL ) {
err = WSAENOBUFS;
goto exit;
}
} else {
WS_ASSERT( (PUCHAR)tdiAddress == tdiAddressBuffer );
}
//
// Convert the address from the sockaddr structure to the appropriate
// TDI structure.
//
// Note: We'll truncate any part of the specifed sock addr beyond
// that which the helper considers valid
//
err = SockBuildTdiAddress(
tdiAddress,
(PSOCKADDR)SocketAddress,
(SocketAddressLength > socket->HelperDll->MaxSockaddrLength ?
socket->HelperDll->MaxSockaddrLength :
SocketAddressLength)
);
if (err!=NO_ERROR) {
goto exit;
}
//
// Set up the AFD_SEND_DATAGRAM_INFO structure.
//
sendInfo.BufferArray = lpBuffers;
sendInfo.BufferCount = dwBufferCount;
sendInfo.AfdFlags = 0;
//
// Set up the TDI_REQUEST structure to send the datagram.
//
sendInfo.TdiConnInfo.RemoteAddressLength = tdiAddressLength;
sendInfo.TdiConnInfo.RemoteAddress = tdiAddress;
//
// Determine the appropriate APC routine & context, event handle,
// and IO status block to use for the request.
//
if( lpOverlapped == NULL ) {
//
// This a synchronous request, use per-thread event object.
//
apcRoutine = NULL;
apcContext = NULL;
event = tlsData->EventHandle;
ioStatusBlock = &localIoStatusBlock;
} else {
if( lpCompletionRoutine == NULL ) {
//
// No APC, use event object from OVERLAPPED structure.
//
event = lpOverlapped->hEvent;
apcRoutine = NULL;
apcContext = ( (ULONG_PTR)event & 1 ) ? NULL : lpOverlapped;
} else {
//
// APC, ignore event object.
//
event = NULL;
apcRoutine = SockIoCompletion;
apcContext = lpCompletionRoutine;
//
// Tell AFD to skip fast IO on this request.
//
sendInfo.AfdFlags |= AFD_NO_FAST_IO;
}
//
// Use part of the OVERLAPPED structure as our IO_STATUS_BLOCK.
//
ioStatusBlock = (PIO_STATUS_BLOCK)&lpOverlapped->Internal;
//
// Tell AFD this is an overlapped operation.
//
sendInfo.AfdFlags |= AFD_OVERLAPPED;
}
ioStatusBlock->Status = STATUS_PENDING;
}
__except (SOCK_EXCEPTION_FILTER()) {
err = WSAEFAULT;
goto exit;
}
//
// Send the data over the socket.
//
status = NtDeviceIoControlFile(
socket->HContext.Handle,
event,
apcRoutine,
apcContext,
ioStatusBlock,
IOCTL_AFD_SEND_DATAGRAM,
&sendInfo,
sizeof(sendInfo),
NULL,
0
);
if ( apcRoutine != NULL && !NT_ERROR(status) ) {
tlsData->PendingAPCCount++;
InterlockedIncrement( &SockProcessPendingAPCCount );
}
//
// If this request has no overlapped structure, then wait for
// the operation to complete.
//
if ( status == STATUS_PENDING &&
lpOverlapped == NULL ) {
BOOL success;
success = SockWaitForSingleObject(
event,
Handle,
SOCK_CONDITIONALLY_CALL_BLOCKING_HOOK,
SOCK_SEND_TIMEOUT
);
//
// If the wait completed successfully, look in the IO status
// block to determine the real status code of the request. If
// the wait timed out, then cancel the IO and set up for an
// error return.
//
if ( success ) {
status = ioStatusBlock->Status;
} else {
SockCancelIo( Handle );
status = STATUS_IO_TIMEOUT;
}
}
switch (status) {
case STATUS_SUCCESS:
break;
case STATUS_PENDING:
err = WSA_IO_PENDING;
goto exit;
default:
if (!NT_SUCCESS(status) ) {
//
// Map the NTSTATUS to a WinSock error code.
//
err = SockNtStatusToSocketError( status );
goto exit;
}
}
//
// The request completed immediately, so return the number of
// bytes sent to the user.
// It is possible that application deallocated lpOverlapped
// in another thread if completion port was used to receive
// completion indication. We do not want to confuse the
// application by returning failure, just pretend that we didn't
// know about synchronous completion
//
__try {
*lpNumberOfBytesSent = (DWORD)ioStatusBlock->Information;
}
__except (EXCEPTION_EXECUTE_HANDLER) {
if (lpOverlapped) {
err = WSA_IO_PENDING;
}
else {
err = WSAEFAULT;
}
goto exit;
}
exit:
IF_DEBUG(SEND) {
if ( err != NO_ERROR ) {
WS_PRINT(( "WSPSendTo on socket %lx (%lx) failed: %ld.\n",
Handle, socket, err ));
} else {
WS_PRINT(( "WSPSendTo on socket %lx (%lx) succeeded, "
"bytes = %ld\n",
Handle, socket, ioStatusBlock->Information ));
}
}
if ( socket != NULL ) {
if ( SockAsyncSelectCalled && err == WSAEWOULDBLOCK ) {
SockAcquireSocketLockExclusive( socket );
SockReenableAsyncSelectEvent( socket, FD_WRITE );
SockReleaseSocketLock( socket );
}
SockDereferenceSocket( socket );
}
if ( tdiAddress != NULL &&
tdiAddress != (PTRANSPORT_ADDRESS)tdiAddressBuffer ) {
FREE_HEAP( tdiAddress );
}
if ( err != NO_ERROR ) {
WS_EXIT( "WSPSendTo", SOCKET_ERROR, TRUE );
*lpErrno = err;
return SOCKET_ERROR;
}
WS_EXIT( "WSPSendTo", 0, FALSE );
return 0;
} // WSPSendTo
int
WSPAPI
WSPSend (
SOCKET Handle,
LPWSABUF lpBuffers,
DWORD dwBufferCount,
LPDWORD lpNumberOfBytesSent,
DWORD iFlags,
LPWSAOVERLAPPED lpOverlapped,
LPWSAOVERLAPPED_COMPLETION_ROUTINE lpCompletionRoutine,
LPWSATHREADID lpThreadId,
LPINT lpErrno
)
/*++
Routine Description:
This routine is used to write outgoing data from one or more buffers on a
connection-oriented socket specified by s. It may also be used, however,
on connectionless sockets which have a stipulated default peer address
established via the WSPConnect() function.
For overlapped sockets (created using WSPSocket() with flag
WSA_FLAG_OVERLAPPED) this will occur using overlapped I/O, unless both
lpOverlapped and lpCompletionRoutine are NULL in which case the socket is
treated as a non-overlapped socket. A completion indication will occur
(invocation of the completion routine or setting of an event object) when
the supplied buffer(s) have been consumed by the transport. If the
operation does not complete immediately, the final completion status is
retrieved via the completion routine or WSPGetOverlappedResult().
For non-overlapped sockets, the parameters lpOverlapped,
lpCompletionRoutine, and lpThreadId are ignored and WSPSend() adopts the
regular synchronous semantics. Data is copied from the supplied buffer(s)
into the transport's buffer. If the socket is non-blocking and stream-
oriented, and there is not sufficient space in the transport's buffer,
WSPSend() will return with only part of the supplied buffers having been
consumed. Given the same buffer situation and a blocking socket, WSPSend()
will block until all of the supplied buffer contents have been consumed.
The array of WSABUF structures pointed to by the lpBuffers parameter is
transient. If this operation completes in an overlapped manner, it is the
service provider's responsibility to capture these WSABUF structures
before returning from this call. This enables applications to build stack-
based WSABUF arrays.
For message-oriented sockets, care must be taken not to exceed the maximum
message size of the underlying provider, which can be obtained by getting
the value of socket option SO_MAX_MSG_SIZE. If the data is too long to
pass atomically through the underlying protocol the error WSAEMSGSIZE is
returned, and no data is transmitted.
Note that the successful completion of a WSPSend() does not indicate that
the data was successfully delivered.
dwFlags may be used to influence the behavior of the function invocation
beyond the options specified for the associated socket. That is, the
semantics of this routine are determined by the socket options and the
dwFlags parameter. The latter is constructed by or-ing any of the
following values:
MSG_DONTROUTE - Specifies that the data should not be subject
to routing. A WinSock service provider may choose to ignore this
flag.
MSG_OOB - Send out-of-band data (stream style socket such as
SOCK_STREAM only).
MSG_PARTIAL - Specifies that lpBuffers only contains a partial
message. Note that the error code WSAEOPNOTSUPP will be returned
which do not support partial message transmissions.
If an overlapped operation completes immediately, WSPSend() returns a
value of zero and the lpNumberOfBytesSent parameter is updated with the
number of bytes sent. If the overlapped operation is successfully
initiated and will complete later, WSPSend() returns SOCKET_ERROR and
indicates error code WSA_IO_PENDING. In this case, lpNumberOfBytesSent is
not updated. When the overlapped operation completes the amount of data
transferred is indicated either via the cbTransferred parameter in the
completion routine (if specified), or via the lpcbTransfer parameter in
WSPGetOverlappedResult().
Providers must allow this routine to be called from within the completion
routine of a previous WSPRecv(), WSPRecvFrom(), WSPSend() or WSPSendTo()
function. However, for a given socket, I/O completion routines may not be
nested. This permits time-sensitive data transmissions to occur entirely
within a preemptive context.
The lpOverlapped parameter must be valid for the duration of the
overlapped operation. If multiple I/O operations are simultaneously
outstanding, each must reference a separate overlapped structure. The
WSAOVERLAPPED structure has the following form:
typedef struct _WSAOVERLAPPED {
DWORD Internal; // reserved
DWORD InternalHigh; // reserved
DWORD Offset; // reserved
DWORD OffsetHigh; // reserved
WSAEVENT hEvent;
} WSAOVERLAPPED, FAR * LPWSAOVERLAPPED;
If the lpCompletionRoutine parameter is NULL, the service provider signals
the hEvent field of lpOverlapped when the overlapped operation completes
if it contains a valid event object handle. The WinSock SPI client can use
WSPGetOverlappedResult() to wait or poll on the event object.
If lpCompletionRoutine is not NULL, the hEvent field is ignored and can be
used by the WinSock SPI client to pass context information to the
completion routine. It is the service provider's responsibility to arrange
for invocation of the client-specified completion routine when the
overlapped operation completes. Since the completion routine must be
executed in the context of the same thread that initiated the overlapped
operation, it cannot be invoked directly from the service provider. The
WinSock DLL offers an asynchronous procedure call (APC) mechanism to
facilitate invocation of completion routines.
A service provider arranges for a function to be executed in the proper
thread by calling WPUQueueApc(). Note that this routine must be invoked
while in the context of the same process (but not necessarily the same
thread) that was used to initiate the overlapped operation. It is the
service provider's responsibility to arrange for this process context to
be active prior to calling WPUQueueApc().
WPUQueueApc() takes as input parameters a pointer to a WSATHREADID
structure (supplied to the provider via the lpThreadId input parameter),
a pointer to an APC function to be invoked, and a 32 bit context value
that is subsequently passed to the APC function. Because only a single
32-bit context value is available, the APC function cannot itself be the
client-specified completion routine. The service provider must instead
supply a pointer to its own APC function which uses the supplied context
value to access the needed result information for the overlapped operation,
and then invokes the client-specified completion routine.
The prototype for the client-supplied completion routine is as follows:
void
CALLBACK
CompletionRoutine(
IN DWORD dwError,
IN DWORD cbTransferred,
IN LPWSAOVERLAPPED lpOverlapped,
IN DWORD dwFlags
);
CompletionRoutine is a placeholder for a client supplied function
name.
dwError specifies the completion status for the overlapped
operation as indicated by lpOverlapped.
cbTransferred specifies the number of bytes sent.
No flag values are currently defined and the dwFlags value will
be zero.
This routine does not return a value.
The completion routines may be called in any order, not necessarily in
the same order the overlapped operations are completed. However, the
service provider guarantees to the client that posted buffers are sent
in the same order they are supplied.
Arguments:
s - A descriptor identifying a connected socket.
lpBuffers - A pointer to an array of WSABUF structures. Each WSABUF
structure contains a pointer to a buffer and the length of the
buffer. This array must remain valid for the duration of the
send operation.
dwBufferCount - The number of WSABUF structures in the lpBuffers array.
lpNumberOfBytesSent - A pointer to the number of bytes sent by this
call.
dwFlags - Specifies the way in which the call is made.
lpOverlapped - A pointer to a WSAOVERLAPPED structure.
lpCompletionRoutine - A pointer to the completion routine called when
the send operation has been completed.
lpThreadId - A pointer to a thread ID structure to be used by the
provider in a subsequent call to WPUQueueApc(). The provider should
store the referenced WSATHREADID structure (not the pointer to same)
until after the WPUQueueApc() function returns.
lpErrno - A pointer to the error code.
Return Value:
If no error occurs and the send operation has completed immediately,
WSPSend() returns 0. Note that in this case the completion routine, if
specified, will have already been queued. Otherwise, a value of
SOCKET_ERROR is returned, and a specific error code is available in
lpErrno. The error code WSA_IO_PENDING indicates that the overlapped
operation has been successfully initiated and that completion will be
indicated at a later time. Any other error code indicates that no
overlapped operation was initiated and no completion indication will
occur.
--*/
{
NTSTATUS status;
PWINSOCK_TLS_DATA tlsData;
IO_STATUS_BLOCK localIoStatusBlock;
PIO_STATUS_BLOCK ioStatusBlock;
int err;
AFD_SEND_INFO sendInfo;
HANDLE event;
PIO_APC_ROUTINE apcRoutine;
PVOID apcContext;
PSOCKET_INFORMATION socket = NULL;
WS_ENTER( "WSPSend", (PVOID)Handle, (PVOID)lpBuffers, (PVOID)dwBufferCount, (PVOID)iFlags );
WS_ASSERT( lpErrno != NULL );
err = SockEnterApi( &tlsData );
if( err != NO_ERROR ) {
WS_EXIT( "WSPSend", SOCKET_ERROR, TRUE );
*lpErrno = err;
return SOCKET_ERROR;
}
#ifdef _AFD_SAN_SWITCH_
if (SockSanEnabled) {
socket = SockFindAndReferenceSocket( Handle, TRUE );
if ( socket == NULL ) {
err = WSAENOTSOCK;
goto exit;
}
if (socket->SanSocket!=NULL) {
err = SockSanSend (
socket,
lpBuffers,
dwBufferCount,
lpNumberOfBytesSent,
iFlags,
lpOverlapped,
lpCompletionRoutine,
lpThreadId->ThreadHandle);
goto exit;
}
}
#endif //_AFD_SAN_SWITCH_
//
// Set up AFD_SEND_INFO.TdiFlags;
//
sendInfo.BufferArray = lpBuffers;
sendInfo.BufferCount = dwBufferCount;
sendInfo.AfdFlags = 0;
sendInfo.TdiFlags = 0;
if ( iFlags != 0 ) {
//
// The legal flags are MSG_OOB, MSG_DONTROUTE and MSG_PARTIAL.
// MSG_OOB is not legal on datagram sockets.
//
if ( ( (iFlags & ~(MSG_OOB | MSG_DONTROUTE | MSG_PARTIAL)) != 0 ) ) {
err = WSAEOPNOTSUPP;
goto exit;
}
if ( (iFlags & MSG_OOB) != 0 ) {
sendInfo.TdiFlags |= TDI_SEND_EXPEDITED;
}
if ( (iFlags & MSG_PARTIAL) != 0 ) {
sendInfo.TdiFlags |= TDI_SEND_PARTIAL;
}
}
__try {
//
// Determine the appropriate APC routine & context, event handle,
// and IO status block to use for the request.
//
if( lpOverlapped == NULL ) {
//
// This a synchronous request, use per-thread event object.
//
apcRoutine = NULL;
apcContext = NULL;
event = tlsData->EventHandle;
ioStatusBlock = &localIoStatusBlock;
} else {
if( lpCompletionRoutine == NULL ) {
//
// No APC, use event object from OVERLAPPED structure.
//
event = lpOverlapped->hEvent;
apcRoutine = NULL;
apcContext = ( (ULONG_PTR)event & 1 ) ? NULL : lpOverlapped;
} else {
//
// APC, ignore event object.
//
event = NULL;
apcRoutine = SockIoCompletion;
apcContext = lpCompletionRoutine;
//
// Tell AFD to skip fast IO on this request.
//
sendInfo.AfdFlags |= AFD_NO_FAST_IO;
}
//
// Use part of the OVERLAPPED structure as our IO_STATUS_BLOCK.
//
ioStatusBlock = (PIO_STATUS_BLOCK)&lpOverlapped->Internal;
//
// Tell AFD this is an overlapped operation.
//
sendInfo.AfdFlags |= AFD_OVERLAPPED;
}
ioStatusBlock->Status = STATUS_PENDING;
}
__except (SOCK_EXCEPTION_FILTER()) {
err = WSAEFAULT;
goto exit;
}
//
// Send the data over the socket.
//
status = NtDeviceIoControlFile(
(HANDLE)Handle,
event,
apcRoutine,
apcContext,
ioStatusBlock,
IOCTL_AFD_SEND,
&sendInfo,
sizeof(sendInfo),
NULL,
0
);
if ( apcRoutine != NULL && !NT_ERROR(status) ) {
tlsData->PendingAPCCount++;
InterlockedIncrement( &SockProcessPendingAPCCount );
}
//
// If this request has no overlapped structure, then wait for
// the operation to complete.
//
if ( status == STATUS_PENDING &&
lpOverlapped == NULL ) {
BOOL success;
success = SockWaitForSingleObject(
event,
Handle,
SOCK_CONDITIONALLY_CALL_BLOCKING_HOOK,
SOCK_SEND_TIMEOUT
);
//
// If the wait completed successfully, look in the IO status
// block to determine the real status code of the request. If
// the wait timed out, then cancel the IO and set up for an
// error return.
//
if ( success ) {
status = ioStatusBlock->Status;
} else {
SockCancelIo( Handle );
status = STATUS_IO_TIMEOUT;
}
}
switch (status) {
case STATUS_SUCCESS:
break;
case STATUS_PENDING:
err = WSA_IO_PENDING;
goto exit;
default:
if (!NT_SUCCESS(status) ) {
//
// Map the NTSTATUS to a WinSock error code.
//
err = SockNtStatusToSocketError( status );
goto exit;
}
}
//
// The request completed immediately, so return the number of
// bytes sent to the user.
// It is possible that application deallocated lpOverlapped
// in another thread if completion port was used to receive
// completion indication. We do not want to confuse the
// application by returning failure, just pretend that we didn't
// know about synchronous completion
//
__try {
*lpNumberOfBytesSent = (DWORD)ioStatusBlock->Information;
}
__except (EXCEPTION_EXECUTE_HANDLER) {
if (lpOverlapped) {
err = WSA_IO_PENDING;
}
else {
err = WSAEFAULT;
}
goto exit;
}
exit:
IF_DEBUG(SEND) {
if ( err != NO_ERROR ) {
WS_PRINT(( "WSPSend on socket %lx failed: %ld.\n",
Handle, err ));
} else {
#ifdef _AFD_SAN_SWITCH_
WS_PRINT(( "WSPSend on socket %lx succeeded, "
"bytes = %ld\n", Handle, *lpNumberOfBytesSent ));
#else
WS_PRINT(( "WSPSend on socket %lx succeeded, "
"bytes = %ld\n", Handle, ioStatusBlock->Information ));
#endif //_AFD_SAN_SWITCH_
}
}
//
// If there is an async thread in this process, get a pointer to the
// socket information structure and reenable the appropriate event.
// We don't do this if there is no async thread as a performance
// optimization. Also, if we're not going to return WSAEWOULDBLOCK
// we don't need to reenable FD_WRITE events.
//
if ( SockAsyncSelectCalled && err == WSAEWOULDBLOCK ) {
#ifdef _AFD_SAN_SWITCH_
if (socket==NULL) {
socket = SockFindAndReferenceSocket( Handle, TRUE );
}
#else //_AFD_SAN_SWITCH_
socket = SockFindAndReferenceSocket( Handle, TRUE );
#endif //_AFD_SAN_SWITCH_
//
// If the socket was found reenable the right event. If it was
// not found, then presumably the socket handle was invalid.
//
if ( socket != NULL ) {
SockAcquireSocketLockExclusive( socket );
SockReenableAsyncSelectEvent( socket, FD_WRITE );
SockReleaseSocketLock( socket );
SockDereferenceSocket( socket );
} else {
if ( socket == NULL ) {
WS_PRINT(( "WSPSend: SockFindAndReferenceSocket failed.\n" ));
}
}
}
#ifdef _AFD_SAN_SWITCH_
else {
if (socket!=NULL) {
SockDereferenceSocket( socket );
}
}
#endif //_AFD_SAN_SWITCH_
if ( err != NO_ERROR ) {
WS_EXIT( "WSPSend", SOCKET_ERROR, TRUE );
*lpErrno = err;
return SOCKET_ERROR;
}
WS_EXIT( "WSPSend", 0, FALSE );
return 0;
} // WSPSend
SOCKET
WSPAPI
WSPAccept(
IN SOCKET Handle,
OUT struct sockaddr *SocketAddress,
OUT int *SocketAddressLength,
IN LPCONDITIONPROC lpfnCondition,
IN DWORD dwCallbackData,
OUT LPINT lpErrno
)
/*++
Routine Description:
This routine extracts the first connection on the queue of pending
connections on s, and checks it against the condition function, provided
the condition function is specified (i.e., not NULL). The condition
function must be executed in the same thread as this routine is. If the
condition function returns CF_ACCEPT, this routine creates a new socket
and performs any socket grouping as indicated by the result parameter g
in the condition function . Newly created sockets have the same
properties as s including network events registered with WSPAsyncSelect()
or with WSPEventSelect(), but not including the listening socket's group
ID, if any.
If the condition function returns CF_REJECT, this routine rejects the
connection request. If the client's accept/reject decision cannot be made
immediately, the condition function will return CF_DEFER to indicate that
no decision has been made, and no action about this connection request is
to be taken by the service provider. When the client is ready to take
action on the connection request, it will invoke WSPAccept() again and
return either CF_ACCEPT or CF_REJECT as a return value from the condition
function.
For sockets which are in the (default) blocking mode, if no pending
connections are present on the queue, WSPAccept() blocks the caller until
a connection is present. For sockets in a non-blocking mode, if this
function is called when no pending connections are present on the queue,
WSPAccept() returns the error code WSAEWOULDBLOCK as described below. The
accepted socket may not be used to accept more connections. The original
socket remains open.
The argument addr is a result parameter that is filled in with the address
of the connecting entity, as known to the service provider. The exact
format of the addr parameter is determined by the address family in which
the communication is occurring. The addrlen is a value-result parameter;
it will initially contain the amount of space pointed to by addr. On
return, it must contain the actual length (in bytes) of the address
returned by the service provider. This call is used with connection-
oriented socket types such as SOCK_STREAM. If addr and/or addrlen are
equal to NULL, then no information about the remote address of the
accepted socket is returned. Otherwise, these two parameters shall be
filled in regardless of whether the condition function is specified or
what it returns.
The prototype of the condition function is as follows:
int
CALLBACK
ConditionFunc(
IN LPWSABUF lpCallerId,
IN LPWSABUF lpCallerData,
IN OUT LPQOS lpSQOS,
IN OUT LPQOS lpGQOS,
IN LPWSABUF lpCalleeId,
IN LPWSABUF lpCalleeData,
OUT GROUP FAR * g,
IN DWORD dwCallbackData
);
The lpCallerId and lpCallerData are value parameters which must
contain the address of the connecting entity and any user data
that was sent along with the connection request, respectively.
If no caller ID or caller data is available, the corresponding
parameter will be NULL.
lpSQOS references the flow specs for socket s specified by the
caller, one for each direction, followed by any additional
provider-specific parameters. The sending or receiving flow spec
values will be ignored as appropriate for any unidirectional
sockets. A NULL value for lpSQOS indicates no caller supplied
QOS. QOS information may be returned if a QOS negotiation is to
occur.
lpGQOS references the flow specs for the socket group the caller
is to create, one for each direction, followed by any additional
provider-specific parameters. A NULL value for lpGQOS indicates
no caller-supplied group QOS. QOS information may be returned if
a QOS negotiation is to occur.
The lpCalleeId is a value parameter which contains the local
address of the connected entity. The lpCalleeData is a result
parameter used by the condition function to supply user data back
to the connecting entity. The storage for this data must be
provided by the service provider. lpCalleeData->len initially
contains the length of the buffer allocated by the service
provider and pointed to by lpCalleeData->buf. A value of zero
means passing user data back to the caller is not supported. The
condition function will copy up to lpCalleeData->len bytes of
data into lpCalleeData->buf , and then update lpCalleeData->len
to indicate the actual number of bytes transferred. If no user
data is to be passed back to the caller, the condition function
will set lpCalleeData->len to zero. The format of all address and
user data is specific to the address family to which the socket
belongs.
The result parameter g is assigned within the condition function
to indicate the following actions:
if &g is an existing socket group ID, add s to this
group, provided all the requirements set by this group
are met; or
if &g = SG_UNCONSTRAINED_GROUP, create an unconstrained
socket group and have s as the first member; or
if &g = SG_CONSTRAINED_GROUP, create a constrained
socket group and have s as the first member; or
if &g = zero, no group operation is performed.
Any set of sockets grouped together must be implemented by a
single service provider. For unconstrained groups, any set of
sockets may be grouped together. A constrained socket group may
consist only of connection-oriented sockets, and requires that
connections on all grouped sockets be to the same address on the
same host. For newly created socket groups, the new group ID
must be available for the WinSock SPI client to retrieve by
calling WSPGetSockOpt() with option SO_GROUP_ID. A socket group
and its associated ID remain valid until the last socket
belonging to this socket group is closed. Socket group IDs are
unique across all processes for a given service provider.
dwCallbackData is supplied to the condition function exactly as
supplied by the caller of WSPAccept().
Arguments:
s - A descriptor identifying a socket which is listening for connections
after a WSPListen().
addr - An optional pointer to a buffer which receives the address of the
connecting entity, as known to the service provider. The exact
format of the addr argument is determined by the address family
established when the socket was created.
addrlen - An optional pointer to an integer which contains the length of
the address addr.
lpfnCondition - The procedure instance address of an optional, WinSock 2
client- supplied condition function which will make an accept/reject
decision based on the caller information passed in as parameters,
and optionally create and/or join a socket group by assigning an
appropriate value to the result parameter, g, of this routine.
dwCallbackData - Callback data to be passed back to the WinSock 2 client
as a condition function parameter. This parameter is not interpreted
by the service provider.
lpErrno - A pointer to the error code.
Return Value:
If no error occurs, WSPAccept() returns a value of type SOCKET which is
a descriptor for the accepted socket. Otherwise, a value of
INVALID_SOCKET is returned, and a specific error code is available
in lpErrno.
--*/
{
NTSTATUS status;
PSOCKET_INFORMATION socketInfo;
IO_STATUS_BLOCK ioStatusBlock;
PAFD_LISTEN_RESPONSE_INFO afdListenResponse;
ULONG afdListenResponseLength;
AFD_ACCEPT_INFO afdAcceptInfo;
int err;
SOCKET newSocketHandle;
PSOCKET_INFORMATION newSocket;
INT socketAddressLength;
WSAPROTOCOL_INFOW protocolInfo;
GROUP newGroup;
BYTE afdLocalListenResponse[MAX_FAST_LISTEN_RESPONSE];
WS_ENTER( "WSPAccept", (PVOID)Handle, SocketAddress, (PVOID)SocketAddressLength, lpfnCondition );
WS_ASSERT( lpErrno != NULL );
IF_DEBUG(ACCEPT) {
WS_PRINT(( "WSPAccept() on socket %lx addr %ld addrlen *%lx == %ld\n",
Handle, SocketAddress, SocketAddressLength,
SocketAddressLength ? *SocketAddressLength : 0 ));
}
err = SockEnterApi( TRUE, TRUE, FALSE );
if( err != NO_ERROR ) {
WS_EXIT( "WSPAccept", INVALID_SOCKET, TRUE );
*lpErrno = err;
return INVALID_SOCKET;
}
//
// Set up local variables so that we know how to clean up on exit.
//
socketInfo = NULL;
afdListenResponse = NULL;
newSocket = NULL;
newSocketHandle = INVALID_SOCKET;
newGroup = 0;
//
// Find a pointer to the socket structure corresponding to the
// passed-in handle.
//
socketInfo = SockFindAndReferenceSocket( Handle, TRUE );
if ( socketInfo == NULL ) {
err = WSAENOTSOCK;
goto exit;
}
//
// Acquire the lock that protects sockets. We hold this lock
// throughout this routine to synchronize against other callers
// performing operations on the socket we're doing the accept on.
//
SockAcquireSocketLockExclusive( socketInfo );
//
// If this is a datagram socket, fail the request.
//
if ( IS_DGRAM_SOCK(socketInfo->SocketType) ) {
err = WSAEOPNOTSUPP;
goto exit;
}
//
// If the socket is not listening for connection attempts, fail this
// request.
//
if ( socketInfo->State != SocketStateListening ) {
err = WSAEINVAL;
goto exit;
}
//
// Make sure that the length of the address buffer is large enough
// to hold a sockaddr structure for the address family of this
// socket.
//
if ( ARGUMENT_PRESENT( SocketAddressLength ) &&
socketInfo->HelperDll->MinSockaddrLength > *SocketAddressLength ) {
err = WSAEFAULT;
goto exit;
}
//
// Allocate space to hold the listen response structure. This
// buffer must be large enough to hold a TRANSPORT_STRUCTURE for the
// address family of this socket.
//
afdListenResponseLength = sizeof(AFD_LISTEN_RESPONSE_INFO) -
sizeof(TRANSPORT_ADDRESS) +
socketInfo->HelperDll->MaxTdiAddressLength;
if ( afdListenResponseLength <= sizeof(afdLocalListenResponse) ) {
afdListenResponse = (PAFD_LISTEN_RESPONSE_INFO)afdLocalListenResponse;
} else {
afdListenResponse = ALLOCATE_HEAP( afdListenResponseLength );
if ( afdListenResponse == NULL ) {
err = WSAENOBUFS;
goto exit;
}
}
//
// If the socket is non-blocking, determine whether data exists on
// the socket. If not, fail the request.
//
if ( socketInfo->NonBlocking ) {
struct fd_set readfds;
struct timeval timeout;
int returnCode;
FD_ZERO( &readfds );
FD_SET( socketInfo->Handle, &readfds );
timeout.tv_sec = 0;
timeout.tv_usec = 0;
returnCode = WSPSelect(
1,
&readfds,
NULL,
NULL,
&timeout,
lpErrno
);
if ( returnCode == SOCKET_ERROR ) {
err = *lpErrno;
goto exit;
}
if ( !FD_ISSET( socketInfo->Handle, &readfds ) ) {
WS_ASSERT( returnCode == 0 );
err = WSAEWOULDBLOCK;
goto exit;
}
WS_ASSERT( returnCode == 1 );
}
//
// Wait for a connection attempt to arrive.
//
status = NtDeviceIoControlFile(
(HANDLE)socketInfo->Handle,
SockThreadEvent,
NULL, // APC Routine
NULL, // APC Context
&ioStatusBlock,
IOCTL_AFD_WAIT_FOR_LISTEN,
NULL,
0,
afdListenResponse,
afdListenResponseLength
);
if ( status == STATUS_PENDING ) {
SockReleaseSocketLock( socketInfo );
SockWaitForSingleObject(
SockThreadEvent,
socketInfo->Handle,
SOCK_CONDITIONALLY_CALL_BLOCKING_HOOK,
SOCK_NO_TIMEOUT
);
SockAcquireSocketLockExclusive( socketInfo );
status = ioStatusBlock.Status;
}
if ( !NT_SUCCESS(status) ) {
err = SockNtStatusToSocketError( status );
goto exit;
}
//
// If a condition function was specified, then give the user the
// opportunity to accept/reject the incoming connection.
//
if( lpfnCondition != NULL ) {
WSABUF callerId;
WSABUF callerData;
WSABUF calleeId;
WSABUF calleeData;
INT result;
BYTE fastAddressBuffer[sizeof(SOCKADDR_IN)];
PBYTE addressBuffer;
ULONG addressBufferLength;
INT remoteAddressLength;
BOOLEAN isValidGroup;
PCHAR connectDataBuffer;
INT connectDataBufferLength;
//
// Allocate space for the remote address.
//
addressBufferLength = socketInfo->HelperDll->MaxSockaddrLength;
if( addressBufferLength <= sizeof(fastAddressBuffer) ) {
addressBuffer = fastAddressBuffer;
} else {
addressBuffer = ALLOCATE_HEAP( addressBufferLength );
if( addressBuffer == NULL ) {
err = WSAENOBUFS;
goto exit;
}
}
connectDataBufferLength = 0;
connectDataBuffer = NULL;
if( ( socketInfo->ServiceFlags1 & XP1_CONNECT_DATA ) != 0 ) {
AFD_UNACCEPTED_CONNECT_DATA_INFO connectInfo;
//
// Determine the size of the incoming connect data.
//
connectInfo.Sequence = afdListenResponse->Sequence;
connectInfo.LengthOnly = TRUE;
status = NtDeviceIoControlFile(
(HANDLE)socketInfo->Handle,
SockThreadEvent,
NULL,
NULL,
&ioStatusBlock,
IOCTL_AFD_GET_UNACCEPTED_CONNECT_DATA,
&connectInfo,
sizeof(connectInfo),
&connectInfo,
sizeof(connectInfo)
);
if( status == STATUS_PENDING ) {
SockWaitForSingleObject(
SockThreadEvent,
socketInfo->Handle,
SOCK_NEVER_CALL_BLOCKING_HOOK,
SOCK_NO_TIMEOUT
);
status = ioStatusBlock.Status;
}
if( !NT_SUCCESS(status) ) {
err = SockNtStatusToSocketError( status );
goto exit;
}
//
// If there is data on the connection, get it.
//
connectDataBufferLength = ioStatusBlock.Information;
if( connectDataBufferLength > 0 ) {
connectDataBuffer = ALLOCATE_HEAP( connectDataBufferLength );
if( connectDataBuffer == NULL ) {
err = WSAENOBUFS;
goto exit;
}
//
// Retrieve the data.
//
connectInfo.Sequence = afdListenResponse->Sequence;
connectInfo.LengthOnly = FALSE;
status = NtDeviceIoControlFile(
(HANDLE)socketInfo->Handle,
SockThreadEvent,
NULL,
NULL,
&ioStatusBlock,
IOCTL_AFD_GET_UNACCEPTED_CONNECT_DATA,
&connectInfo,
sizeof(connectInfo),
connectDataBuffer,
connectDataBufferLength
);
if( status == STATUS_PENDING ) {
SockWaitForSingleObject(
SockThreadEvent,
socketInfo->Handle,
SOCK_NEVER_CALL_BLOCKING_HOOK,
SOCK_NO_TIMEOUT
);
status = ioStatusBlock.Status;
}
if( !NT_SUCCESS(status) ) {
err = SockNtStatusToSocketError( status );
FREE_HEAP( connectDataBuffer );
goto exit;
}
}
}
//
// Build the addresses.
//
calleeId.buf = (CHAR *)socketInfo->LocalAddress;
calleeId.len = (ULONG)socketInfo->LocalAddressLength;
SockBuildSockaddr(
(PSOCKADDR)addressBuffer,
&remoteAddressLength,
&afdListenResponse->RemoteAddress
);
callerId.buf = (CHAR *)addressBuffer;
callerId.len = (ULONG)remoteAddressLength;
//
// Build the caller/callee data.
//
// Unfortunately, since we're "faking" this deferred accept
// stuff (meaning that AFD has already fully accepted the
// connection before the DLL ever sees it) there's no way
// to support "callee data" in the condition function.
//
callerData.buf = connectDataBuffer;
callerData.len = connectDataBufferLength;
calleeData.buf = NULL;
calleeData.len = 0;
result = (lpfnCondition)(
&callerId, // lpCallerId
callerData.buf == NULL // lpCallerData
? NULL
: &callerData,
NULL, // lpSQOS
NULL, // lpGQOS
&calleeId, // lpCalleeId
calleeData.buf == NULL // lpCalleeData
? NULL
: &calleeData,
&newGroup, // g
dwCallbackData // dwCallbackData
);
//
// Before we free the buffers, validate the group ID returned
// by the condition function.
//
isValidGroup = TRUE;
if( result == CF_ACCEPT &&
newGroup != 0 &&
newGroup != SG_UNCONSTRAINED_GROUP &&
newGroup != SG_CONSTRAINED_GROUP ) {
isValidGroup = SockIsAddressConsistentWithConstrainedGroup(
socketInfo,
newGroup,
(PSOCKADDR)addressBuffer,
remoteAddressLength
);
}
if( addressBuffer != fastAddressBuffer ) {
FREE_HEAP( addressBuffer );
}
if( connectDataBuffer != NULL ) {
FREE_HEAP( connectDataBuffer );
}
if( result == CF_ACCEPT ) {
if( !isValidGroup ) {
err = WSAEINVAL;
goto exit;
}
} else {
//
// If the condition function returned any value other than
// CF_ACCEPT, then we'll need to tell AFD to deal with this,
// and we may also need to retry the wait for listen.
//
AFD_DEFER_ACCEPT_INFO deferAcceptInfo;
if( result != CF_DEFER && result != CF_REJECT ) {
err = WSAEINVAL;
goto exit;
}
deferAcceptInfo.Sequence = afdListenResponse->Sequence;
deferAcceptInfo.Reject = ( result == CF_REJECT );
status = NtDeviceIoControlFile(
(HANDLE)socketInfo->Handle,
SockThreadEvent,
NULL, // APC Routine
NULL, // APC Context
&ioStatusBlock,
IOCTL_AFD_DEFER_ACCEPT,
&deferAcceptInfo,
sizeof(deferAcceptInfo),
NULL,
0
);
//
// IOCTL_AFD_DEFER_ACCEPT should never pend.
//
WS_ASSERT( status != STATUS_PENDING );
if ( !NT_SUCCESS(status) ) {
err = SockNtStatusToSocketError( status );
goto exit;
}
//
// The condition function returned either CF_REJECT or
// CF_DEFER, so fail the WSPAccept() call with the
// appropriate error code.
//
if( result == CF_REJECT ) {
err = WSAECONNREFUSED;
} else {
WS_ASSERT( result == CF_DEFER );
err = WSATRY_AGAIN;
}
goto exit;
}
}
//
// Create a new socket to use for the connection.
//
RtlZeroMemory( &protocolInfo, sizeof(protocolInfo) );
protocolInfo.iAddressFamily = socketInfo->AddressFamily;
protocolInfo.iSocketType = socketInfo->SocketType;
protocolInfo.iProtocol = socketInfo->Protocol;
protocolInfo.dwCatalogEntryId = socketInfo->CatalogEntryId;
protocolInfo.dwServiceFlags1 = socketInfo->ServiceFlags1;
protocolInfo.dwProviderFlags = socketInfo->ProviderFlags;
newSocketHandle = WSPSocket(
socketInfo->AddressFamily,
socketInfo->SocketType,
socketInfo->Protocol,
&protocolInfo,
newGroup,
socketInfo->CreationFlags,
&err
);
if ( newSocketHandle == INVALID_SOCKET ) {
WS_ASSERT( err != NO_ERROR );
goto exit;
}
//
// Find a pointer to the new socket and reference the socket.
//
newSocket = SockFindAndReferenceSocket( newSocketHandle, FALSE );
if( newSocket == NULL ) {
//
// Cannot find the newly created socket. This usually means the
// app has closed a random socket handle that just happens to
// be the one we just created.
//
err = WSAENOTSOCK;
goto exit;
}
//
// Set up to accept the connection attempt.
//
afdAcceptInfo.Sequence = afdListenResponse->Sequence;
afdAcceptInfo.AcceptHandle = (HANDLE)newSocketHandle;
//
// Do the actual accept. This associates the new socket we just
// opened with the connection object that describes the VC that
// was just initiated.
//
status = NtDeviceIoControlFile(
(HANDLE)socketInfo->Handle,
SockThreadEvent,
NULL, // APC Routine
NULL, // APC Context
&ioStatusBlock,
IOCTL_AFD_ACCEPT,
&afdAcceptInfo,
sizeof(afdAcceptInfo),
NULL,
0
);
if ( status == STATUS_PENDING ) {
SockReleaseSocketLock( socketInfo );
SockWaitForSingleObject(
SockThreadEvent,
socketInfo->Handle,
SOCK_CONDITIONALLY_CALL_BLOCKING_HOOK,
SOCK_NO_TIMEOUT
);
SockAcquireSocketLockExclusive( socketInfo );
status = ioStatusBlock.Status;
}
if ( !NT_SUCCESS(status) ) {
err = SockNtStatusToSocketError( status );
goto exit;
}
//
// Notify the helper DLL that the socket has been accepted.
//
err = SockNotifyHelperDll( newSocket, WSH_NOTIFY_ACCEPT );
if ( err != NO_ERROR ) {
goto exit;
}
//
// Remember the address of the remote client in the new socket,
// and copy the local address of the newly created socket into
// the new socket.
//
SockBuildSockaddr(
newSocket->RemoteAddress,
&socketAddressLength,
&afdListenResponse->RemoteAddress
);
RtlCopyMemory(
newSocket->LocalAddress,
socketInfo->LocalAddress,
socketInfo->LocalAddressLength
);
newSocket->LocalAddressLength = socketInfo->LocalAddressLength;
//
// Copy the remote address into the caller's address buffer, and
// indicate the size of the remote address.
//
if ( ARGUMENT_PRESENT( SocketAddress ) &&
ARGUMENT_PRESENT( SocketAddressLength ) ) {
SockBuildSockaddr(
SocketAddress,
SocketAddressLength,
&afdListenResponse->RemoteAddress
);
}
//
// Do the core operations in accepting the socket.
//
err = SockCoreAccept( socketInfo, newSocket );
if ( err != NO_ERROR ) {
goto exit;
}
exit:
IF_DEBUG(ACCEPT) {
if ( err != NO_ERROR ) {
WS_PRINT(( " accept on socket %lx (%lx) failed: %ld\n",
Handle, socketInfo, err ));
} else {
WS_PRINT(( " accept on socket %lx (%lx) returned socket "
"%lx (%lx), remote", Handle,
socketInfo, newSocketHandle, newSocket ));
WsPrintSockaddr( newSocket->RemoteAddress, &newSocket->RemoteAddressLength );
}
}
if ( socketInfo != NULL ) {
if ( SockAsyncThreadInitialized ) {
SockReenableAsyncSelectEvent( socketInfo, FD_ACCEPT );
}
SockReleaseSocketLock( socketInfo );
SockDereferenceSocket( socketInfo );
}
if ( newSocket != NULL ) {
SockDereferenceSocket( newSocket );
}
if ( afdListenResponse != (PAFD_LISTEN_RESPONSE_INFO)afdLocalListenResponse &&
afdListenResponse != NULL ) {
FREE_HEAP( afdListenResponse );
}
if ( err != NO_ERROR ) {
if ( newSocketHandle != INVALID_SOCKET ) {
int errTmp;
WSPCloseSocket( newSocketHandle, &errTmp );
}
*lpErrno = err;
return INVALID_SOCKET;
}
WS_EXIT( "accept", newSocketHandle, FALSE );
return newSocketHandle;
} // WSPAccept