iocompl.c File Reference

#include <k32.h>
#include <debug.h>

Include dependency graph for iocompl.c:

Go to the source code of this file.

Macros
#define	NDEBUG
#define	FILE_SKIP_COMPLETION_PORT_ON_SUCCESS   0x1
#define	FILE_SKIP_SET_EVENT_ON_HANDLE   0x2

Functions
BOOL WINAPI	SetFileCompletionNotificationModes (IN HANDLE FileHandle, IN UCHAR Flags)
HANDLE WINAPI	CreateIoCompletionPort (IN HANDLE FileHandle, IN HANDLE ExistingCompletionPort, IN ULONG_PTR CompletionKey, IN DWORD NumberOfConcurrentThreads)
BOOL WINAPI	GetQueuedCompletionStatus (IN HANDLE CompletionHandle, IN LPDWORD lpNumberOfBytesTransferred, OUT PULONG_PTR lpCompletionKey, OUT LPOVERLAPPED *lpOverlapped, IN DWORD dwMilliseconds)
BOOL WINAPI	PostQueuedCompletionStatus (IN HANDLE CompletionHandle, IN DWORD dwNumberOfBytesTransferred, IN ULONG_PTR dwCompletionKey, IN LPOVERLAPPED lpOverlapped)
BOOL WINAPI	GetOverlappedResult (IN HANDLE hFile, IN LPOVERLAPPED lpOverlapped, OUT LPDWORD lpNumberOfBytesTransferred, IN BOOL bWait)
BOOL WINAPI	BindIoCompletionCallback (IN HANDLE FileHandle, IN LPOVERLAPPED_COMPLETION_ROUTINE Function, IN ULONG Flags)

Macro Definition Documentation

FILE_SKIP_COMPLETION_PORT_ON_SUCCESS

#define FILE_SKIP_COMPLETION_PORT_ON_SUCCESS   0x1

Definition at line 22 of file iocompl.c.

FILE_SKIP_SET_EVENT_ON_HANDLE

#define FILE_SKIP_SET_EVENT_ON_HANDLE   0x2

Definition at line 23 of file iocompl.c.

NDEBUG

#define NDEBUG

Definition at line 13 of file iocompl.c.

Function Documentation

BindIoCompletionCallback()

BOOL WINAPI BindIoCompletionCallback	(	IN HANDLE	FileHandle,
		IN LPOVERLAPPED_COMPLETION_ROUTINE	Function,
		IN ULONG	Flags
	)

Definition at line 277 of file iocompl.c.

{
    NTSTATUS Status;
 
    /* Call RTL */
    Status = RtlSetIoCompletionCallback(FileHandle,
                                        (PIO_APC_ROUTINE)Function,
                                        Flags);
    if (!NT_SUCCESS(Status))
    {
        /* Set error and fail */
        BaseSetLastNTError(Status);
        return FALSE;
    }
 
    /* Return success */
    return TRUE;
}

CreateIoCompletionPort()

HANDLE WINAPI CreateIoCompletionPort	(	IN HANDLE	FileHandle,
		IN HANDLE	ExistingCompletionPort,
		IN ULONG_PTR	CompletionKey,
		IN DWORD	NumberOfConcurrentThreads
	)

Definition at line 65 of file iocompl.c.

{
    NTSTATUS Status;
    HANDLE NewPort;
    FILE_COMPLETION_INFORMATION CompletionInformation;
    IO_STATUS_BLOCK IoStatusBlock;
 
    /* Check if this is a new port */
    NewPort = ExistingCompletionPort;
    if (!ExistingCompletionPort)
    {
        /* Create it */
        Status = NtCreateIoCompletion(&NewPort,
                                      IO_COMPLETION_ALL_ACCESS,
                                      NULL,
                                      NumberOfConcurrentThreads);
        if (!NT_SUCCESS(Status))
        {
            /* Convert error and fail */
            BaseSetLastNTError(Status);
            return FALSE;
        }
    }
 
    /* Check if no actual file is being associated with the completion port */
    if (FileHandle == INVALID_HANDLE_VALUE)
    {
        /* Was there a port already associated? */
        if (ExistingCompletionPort)
        {
            /* You are not allowed using an old port and dropping the handle */
            NewPort = NULL;
            BaseSetLastNTError(STATUS_INVALID_PARAMETER);
        }
    }
    else
    {
        /* We have a file handle, so associated it with this completion port */
        CompletionInformation.Port = NewPort;
        CompletionInformation.Key = (PVOID)CompletionKey;
        Status = NtSetInformationFile(FileHandle,
                                      &IoStatusBlock,
                                      &CompletionInformation,
                                      sizeof(FILE_COMPLETION_INFORMATION),
                                      FileCompletionInformation);
        if (!NT_SUCCESS(Status))
        {
            /* Convert the error code and close the newly created port, if any */
            BaseSetLastNTError(Status);
            if (!ExistingCompletionPort) NtClose(NewPort);
            return FALSE;
        }
    }
 
    /* Return the newly created port, if any */
    return NewPort;
}

Referenced by serverThreadMain4(), test_completion(), test_file_completion_information(), and test_WriteFileGather().

GetOverlappedResult()

BOOL WINAPI GetOverlappedResult	(	IN HANDLE	hFile,
		IN LPOVERLAPPED	lpOverlapped,
		OUT LPDWORD	lpNumberOfBytesTransferred,
		IN BOOL	bWait
	)

Definition at line 221 of file iocompl.c.

{
    DWORD WaitStatus;
    HANDLE hObject;
 
    /* Check for pending operation */
    if (lpOverlapped->Internal == STATUS_PENDING)
    {
        /* Check if the caller is okay with waiting */
        if (!bWait)
        {
            /* Set timeout */
            WaitStatus = WAIT_TIMEOUT;
        }
        else
        {
            /* Wait for the result */
            hObject = lpOverlapped->hEvent ? lpOverlapped->hEvent : hFile;
            WaitStatus = WaitForSingleObject(hObject, INFINITE);
        }
 
        /* Check for timeout */
        if (WaitStatus == WAIT_TIMEOUT)
        {
            /* We have to override the last error with INCOMPLETE instead */
            SetLastError(ERROR_IO_INCOMPLETE);
            return FALSE;
        }
 
        /* Fail if we had an error -- the last error is already set */
        if (WaitStatus) return FALSE;
    }
 
    /* Return bytes transferred */
    *lpNumberOfBytesTransferred = lpOverlapped->InternalHigh;
 
    /* Check for failure during I/O */
    if (!NT_SUCCESS(lpOverlapped->Internal))
    {
        /* Set the error and fail */
        BaseSetLastNTError(lpOverlapped->Internal);
        return FALSE;
    }
 
    /* All done */
    return TRUE;
}

Referenced by _overlapped_read_sync(), _overlapped_write_sync(), _test_overlapped_failure(), _test_overlapped_result(), Control(), FileAsyncReader_SyncRead(), FileAsyncReader_WaitForNext(), GetDeviceData(), KmtFltGetMessageResult(), CKsInterfaceHandler::KsCompleteIo(), KsSynchronousDeviceControl(), local_server_thread(), LogToFile(), overlapped_server(), PerformIO(), PipeSend(), PipeThreadProc(), CPipe::Read(), ScmControlService(), ScmSendStartCommand(), ScmWaitForServiceConnect(), serverThreadMain3(), SyncOverlappedDeviceIoControl(), tcp_recv(), tcp_send(), test_AbortWaitCts(), test_async_file_errors(), test_events(), test_file_completion_information(), test_null_device(), test_overlapped(), test_overlapped_error(), test_read_device(), test_read_write(), test_readdirectorychanges(), test_WaitBreak(), test_WaitCommEvent(), test_WaitCts(), test_WaitDcd(), test_WaitDsr(), test_WaitRing(), test_WaitRx(), test_waittxempty(), test_write_watch(), testNotifyAddrChange(), and WSPGetOverlappedResult().

GetQueuedCompletionStatus()

BOOL WINAPI GetQueuedCompletionStatus	(	IN HANDLE	CompletionHandle,
		IN LPDWORD	lpNumberOfBytesTransferred,
		OUT PULONG_PTR	lpCompletionKey,
		OUT LPOVERLAPPED *	lpOverlapped,
		IN DWORD	dwMilliseconds
	)

Definition at line 131 of file iocompl.c.

{
    NTSTATUS Status;
    IO_STATUS_BLOCK IoStatus;
    ULONG_PTR CompletionKey;
    LARGE_INTEGER Time;
    PLARGE_INTEGER TimePtr;
 
    /* Convert the timeout and then call the native API */
    TimePtr = BaseFormatTimeOut(&Time, dwMilliseconds);
    Status = NtRemoveIoCompletion(CompletionHandle,
                                  (PVOID*)&CompletionKey,
                                  (PVOID*)lpOverlapped,
                                  &IoStatus,
                                  TimePtr);
    if (!(NT_SUCCESS(Status)) || (Status == STATUS_TIMEOUT))
    {
        /* Clear out the overlapped output */
        *lpOverlapped = NULL;
 
        /* Check what kind of error we got */
        if (Status == STATUS_TIMEOUT)
        {
            /* Timeout error is set directly since there's no conversion */
            SetLastError(WAIT_TIMEOUT);
        }
        else
        {
            /* Any other error gets converted */
            BaseSetLastNTError(Status);
        }
 
        /* This is a failure case */
        return FALSE;
    }
 
    /* Write back the output parameters */
    *lpCompletionKey = CompletionKey;
    *lpNumberOfBytesTransferred = IoStatus.Information;
 
    /* Check for error */
    if (!NT_SUCCESS(IoStatus.Status))
    {
        /* Convert and fail */
        BaseSetLastNTError(IoStatus.Status);
        return FALSE;
    }
 
    /* Return success */
    return TRUE;
}

Referenced by _test_completion(), serverThreadMain4(), test_completion(), test_file_completion_information(), and test_WriteFileGather().

PostQueuedCompletionStatus()

BOOL WINAPI PostQueuedCompletionStatus	(	IN HANDLE	CompletionHandle,
		IN DWORD	dwNumberOfBytesTransferred,
		IN ULONG_PTR	dwCompletionKey,
		IN LPOVERLAPPED	lpOverlapped
	)

Definition at line 192 of file iocompl.c.

{
    NTSTATUS Status;
 
    /* Call the native API */
    Status = NtSetIoCompletion(CompletionHandle,
                               (PVOID)dwCompletionKey,
                               (PVOID)lpOverlapped,
                               STATUS_SUCCESS,
                               dwNumberOfBytesTransferred);
    if (!NT_SUCCESS(Status))
    {
        /* Convert the error and fail */
        BaseSetLastNTError(Status);
        return FALSE;
    }
 
    /* Success path */
    return TRUE;
}

Referenced by async_notifier_proc(), and WSPIoctl().

SetFileCompletionNotificationModes()

BOOL WINAPI SetFileCompletionNotificationModes	(	IN HANDLE	FileHandle,
		IN UCHAR	Flags
	)

Definition at line 31 of file iocompl.c.

{
    NTSTATUS Status;
    FILE_IO_COMPLETION_NOTIFICATION_INFORMATION FileInformation;
    IO_STATUS_BLOCK IoStatusBlock;
 
    if (Flags & ~(FILE_SKIP_COMPLETION_PORT_ON_SUCCESS | FILE_SKIP_SET_EVENT_ON_HANDLE))
    {
        SetLastError(ERROR_INVALID_PARAMETER);
        return FALSE;
    }
 
    FileInformation.Flags = Flags;
 
    Status = NtSetInformationFile(FileHandle,
                                  &IoStatusBlock,
                                  &FileInformation,
                                  sizeof(FileInformation),
                                  FileIoCompletionNotificationInformation);
    if (!NT_SUCCESS(Status))
    {
        BaseSetLastNTError(Status);
        return FALSE;
    }
 
    return TRUE;
}