rw.c File Reference

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

Include dependency graph for rw.c:

Go to the source code of this file.

Macros
#define	NDEBUG

Functions
	DEBUG_CHANNEL (kernel32file)
BOOL WINAPI	WriteFile (IN HANDLE hFile, IN LPCVOID lpBuffer, IN DWORD nNumberOfBytesToWrite OPTIONAL, OUT LPDWORD lpNumberOfBytesWritten, IN LPOVERLAPPED lpOverlapped OPTIONAL)
BOOL WINAPI	ReadFile (IN HANDLE hFile, IN LPVOID lpBuffer, IN DWORD nNumberOfBytesToRead, OUT LPDWORD lpNumberOfBytesRead OPTIONAL, IN LPOVERLAPPED lpOverlapped OPTIONAL)
VOID WINAPI	ApcRoutine (PVOID ApcContext, PIO_STATUS_BLOCK IoStatusBlock, ULONG Reserved)
BOOL WINAPI	WriteFileEx (IN HANDLE hFile, IN LPCVOID lpBuffer, IN DWORD nNumberOfBytesToWrite OPTIONAL, IN LPOVERLAPPED lpOverlapped, IN LPOVERLAPPED_COMPLETION_ROUTINE lpCompletionRoutine)
BOOL WINAPI	ReadFileEx (IN HANDLE hFile, IN LPVOID lpBuffer, IN DWORD nNumberOfBytesToRead OPTIONAL, IN LPOVERLAPPED lpOverlapped, IN LPOVERLAPPED_COMPLETION_ROUTINE lpCompletionRoutine)
BOOL WINAPI	ReadFileScatter (HANDLE hFile, FILE_SEGMENT_ELEMENT aSegmentArray[], DWORD nNumberOfBytesToRead, LPDWORD lpReserved, LPOVERLAPPED lpOverlapped)
BOOL WINAPI	WriteFileGather (HANDLE hFile, FILE_SEGMENT_ELEMENT aSegmentArray[], DWORD nNumberOfBytesToWrite, LPDWORD lpReserved, LPOVERLAPPED lpOverlapped)

Macro Definition Documentation

NDEBUG

#define NDEBUG

Definition at line 14 of file rw.c.

Function Documentation

ApcRoutine()

VOID WINAPI ApcRoutine	(	PVOID	ApcContext,
		PIO_STATUS_BLOCK	IoStatusBlock,
		ULONG	Reserved
	)

Definition at line 243 of file rw.c.

{
    DWORD dwErrorCode;
    LPOVERLAPPED_COMPLETION_ROUTINE lpCompletionRoutine =
        (LPOVERLAPPED_COMPLETION_ROUTINE)ApcContext;
 
    dwErrorCode = RtlNtStatusToDosError(IoStatusBlock->Status);
    lpCompletionRoutine(dwErrorCode,
                        IoStatusBlock->Information,
                        (LPOVERLAPPED)IoStatusBlock);
}

DEBUG_CHANNEL()

DEBUG_CHANNEL

(

kernel32file

)

ReadFile()

BOOL WINAPI ReadFile	(	IN HANDLE	hFile,
		IN LPVOID	lpBuffer,
		IN DWORD	nNumberOfBytesToRead,
		OUT LPDWORD lpNumberOfBytesRead	OPTIONAL,
		IN LPOVERLAPPED lpOverlapped	OPTIONAL
	)

Definition at line 123 of file rw.c.

{
    NTSTATUS Status;
 
    TRACE("ReadFile(hFile %p)\n", hFile);
 
    if (lpNumberOfBytesRead != NULL) *lpNumberOfBytesRead = 0;
 
    hFile = TranslateStdHandle(hFile);
 
    if (IsConsoleHandle(hFile))
    {
        if (ReadConsoleA(hFile,
                         lpBuffer,
                         nNumberOfBytesToRead,
                         lpNumberOfBytesRead,
                         NULL))
        {
            DWORD dwMode;
            GetConsoleMode(hFile, &dwMode);
            if ((dwMode & ENABLE_PROCESSED_INPUT) && *(PCHAR)lpBuffer == 0x1a)
            {
                /* EOF character entered; simulate end-of-file */
                *lpNumberOfBytesRead = 0;
            }
            return TRUE;
        }
        return FALSE;
    }
 
    if (lpOverlapped != NULL)
    {
        LARGE_INTEGER Offset;
        PVOID ApcContext;
 
        Offset.u.LowPart = lpOverlapped->Offset;
        Offset.u.HighPart = lpOverlapped->OffsetHigh;
        lpOverlapped->Internal = STATUS_PENDING;
        ApcContext = (((ULONG_PTR)lpOverlapped->hEvent & 0x1) ? NULL : lpOverlapped);
 
        Status = NtReadFile(hFile,
                            lpOverlapped->hEvent,
                            NULL,
                            ApcContext,
                            (PIO_STATUS_BLOCK)lpOverlapped,
                            lpBuffer,
                            nNumberOfBytesToRead,
                            &Offset,
                            NULL);
 
        /* return FALSE in case of failure and pending operations! */
        if (!NT_SUCCESS(Status) || Status == STATUS_PENDING)
        {
            if (Status == STATUS_END_OF_FILE && lpNumberOfBytesRead != NULL)
                *lpNumberOfBytesRead = 0;
 
            BaseSetLastNTError(Status);
            return FALSE;
        }
 
        if (lpNumberOfBytesRead != NULL)
            *lpNumberOfBytesRead = lpOverlapped->InternalHigh;
    }
    else
    {
        IO_STATUS_BLOCK Iosb;
 
        Status = NtReadFile(hFile,
                            NULL,
                            NULL,
                            NULL,
                            &Iosb,
                            lpBuffer,
                            nNumberOfBytesToRead,
                            NULL,
                            NULL);
 
        /* Wait in case operation is pending */
        if (Status == STATUS_PENDING)
        {
            Status = NtWaitForSingleObject(hFile, FALSE, NULL);
            if (NT_SUCCESS(Status)) Status = Iosb.Status;
        }
 
        if (Status == STATUS_END_OF_FILE)
        {
            /*
             * lpNumberOfBytesRead must not be NULL here, in fact Win doesn't
             * check that case either and crashes (only after the operation
             * completed).
             */
            *lpNumberOfBytesRead = 0;
            return TRUE;
        }
 
        if (NT_SUCCESS(Status))
        {
            /*
             * lpNumberOfBytesRead must not be NULL here, in fact Win doesn't
             * check that case either and crashes (only after the operation
             * completed).
             */
            *lpNumberOfBytesRead = Iosb.Information;
        }
        else
        {
            BaseSetLastNTError(Status);
            return FALSE;
        }
    }
 
    TRACE("ReadFile() succeeded\n");
    return TRUE;
}

ReadFileEx()

BOOL WINAPI ReadFileEx	(	IN HANDLE	hFile,
		IN LPVOID	lpBuffer,
		IN DWORD nNumberOfBytesToRead	OPTIONAL,
		IN LPOVERLAPPED	lpOverlapped,
		IN LPOVERLAPPED_COMPLETION_ROUTINE	lpCompletionRoutine
	)

Definition at line 299 of file rw.c.

{
    LARGE_INTEGER Offset;
    NTSTATUS Status;
 
    Offset.u.LowPart = lpOverlapped->Offset;
    Offset.u.HighPart = lpOverlapped->OffsetHigh;
    lpOverlapped->Internal = STATUS_PENDING;
 
    Status = NtReadFile(hFile,
                        NULL,
                        ApcRoutine,
                        lpCompletionRoutine,
                        (PIO_STATUS_BLOCK)lpOverlapped,
                        lpBuffer,
                        nNumberOfBytesToRead,
                        &Offset,
                        NULL);
 
    if (!NT_SUCCESS(Status))
    {
        BaseSetLastNTError(Status);
        return FALSE;
    }
 
    return TRUE;
}

Referenced by pipeserver(), ReadPipeCompletion(), serverThreadMain5(), test_async_file_errors(), test_readfileex_pending(), and WdmAudCommitWaveBufferByLegacy().

ReadFileScatter()

BOOL WINAPI ReadFileScatter	(	HANDLE	hFile,
		FILE_SEGMENT_ELEMENT	aSegmentArray[],
		DWORD	nNumberOfBytesToRead,
		LPDWORD	lpReserved,
		LPOVERLAPPED	lpOverlapped
	)

Definition at line 337 of file rw.c.

{
    PIO_STATUS_BLOCK pIOStatus;
    LARGE_INTEGER Offset;
    NTSTATUS Status;
 
    DPRINT("(%p %p %u %p)\n", hFile, aSegmentArray, nNumberOfBytesToRead, lpOverlapped);
 
    Offset.LowPart  = lpOverlapped->Offset;
    Offset.HighPart = lpOverlapped->OffsetHigh;
    pIOStatus = (PIO_STATUS_BLOCK) lpOverlapped;
    pIOStatus->Status = STATUS_PENDING;
    pIOStatus->Information = 0;
 
    Status = NtReadFileScatter(hFile,
                               NULL,
                               NULL,
                               NULL,
                               pIOStatus,
                               aSegmentArray,
                               nNumberOfBytesToRead,
                               &Offset,
                               NULL);
 
    if (!NT_SUCCESS(Status))
    {
        SetLastError(RtlNtStatusToDosError(Status));
        return FALSE;
    }
 
    return TRUE;
}

Referenced by test_WriteFileGather().

WriteFile()

BOOL WINAPI WriteFile	(	IN HANDLE	hFile,
		IN LPCVOID	lpBuffer,
		IN DWORD nNumberOfBytesToWrite	OPTIONAL,
		OUT LPDWORD	lpNumberOfBytesWritten,
		IN LPOVERLAPPED lpOverlapped	OPTIONAL
	)

Definition at line 24 of file rw.c.

{
    NTSTATUS Status;
 
    TRACE("WriteFile(hFile %p)\n", hFile);
 
    if (lpNumberOfBytesWritten != NULL) *lpNumberOfBytesWritten = 0;
 
    hFile = TranslateStdHandle(hFile);
 
    if (IsConsoleHandle(hFile))
    {
        return WriteConsoleA(hFile,
                             lpBuffer,
                             nNumberOfBytesToWrite,
                             lpNumberOfBytesWritten,
                             lpOverlapped);
    }
 
    if (lpOverlapped != NULL)
    {
        LARGE_INTEGER Offset;
        PVOID ApcContext;
 
        Offset.u.LowPart = lpOverlapped->Offset;
        Offset.u.HighPart = lpOverlapped->OffsetHigh;
        lpOverlapped->Internal = STATUS_PENDING;
        ApcContext = (((ULONG_PTR)lpOverlapped->hEvent & 0x1) ? NULL : lpOverlapped);
 
        Status = NtWriteFile(hFile,
                             lpOverlapped->hEvent,
                             NULL,
                             ApcContext,
                             (PIO_STATUS_BLOCK)lpOverlapped,
                             (PVOID)lpBuffer,
                             nNumberOfBytesToWrite,
                             &Offset,
                             NULL);
 
        /* return FALSE in case of failure and pending operations! */
        if (!NT_SUCCESS(Status) || Status == STATUS_PENDING)
        {
            BaseSetLastNTError(Status);
            return FALSE;
        }
 
        if (lpNumberOfBytesWritten != NULL)
            *lpNumberOfBytesWritten = lpOverlapped->InternalHigh;
    }
    else
    {
        IO_STATUS_BLOCK Iosb;
 
        Status = NtWriteFile(hFile,
                             NULL,
                             NULL,
                             NULL,
                             &Iosb,
                             (PVOID)lpBuffer,
                             nNumberOfBytesToWrite,
                             NULL,
                             NULL);
 
        /* Wait in case operation is pending */
        if (Status == STATUS_PENDING)
        {
            Status = NtWaitForSingleObject(hFile, FALSE, NULL);
            if (NT_SUCCESS(Status)) Status = Iosb.Status;
        }
 
        if (NT_SUCCESS(Status))
        {
            /*
             * lpNumberOfBytesWritten must not be NULL here, in fact Win doesn't
             * check that case either and crashes (only after the operation
             * completed).
             */
            *lpNumberOfBytesWritten = Iosb.Information;
        }
        else
        {
            BaseSetLastNTError(Status);
            return FALSE;
        }
    }
 
    TRACE("WriteFile() succeeded\n");
    return TRUE;
}

Referenced by __report_error(), _hwrite(), _overlapped_write_async(), _overlapped_write_sync(), _putch(), _RunRemoteTest(), _tiffWriteProc(), _write(), _wsopen_s(), append_file(), ata_bblk(), BackupBootSector(), BestFit_CreateFile(), BestFit_Write(), build_exe(), cabinet_write(), child_process(), ClipboardWriteMemory(), CloseEnhMetaFile(), CloseMetaFile(), BtrfsRecv::cmd_setxattr(), BtrfsRecv::cmd_write(), CmosWriteFile(), ConErrPrintf(), ConOutPuts(), ConWrite(), copy(), CopyEnhMetaFileA(), CopyEnhMetaFileW(), CopyMetaFileW(), create_and_write_file(), create_assembly(), create_avi_file(), create_bitmap(), create_bitmap_file(), create_cache_entry(), create_cache_file(), create_cdf_file(), create_chm(), create_fake_dll(), create_file(), create_file_data(), create_ico_file(), create_inf_file(), create_manifest_file(), create_source_file(), create_source_fileA(), create_source_fileW(), create_temp_binary(), create_temp_file(), create_test_dll(), create_test_dll_sections(), create_test_file(), create_testfontfile(), create_textstream(), create_tmp_ini_file(), create_xml_file(), CreateEnhMetaFileW(), CreateMetaFileW(), createTestFile(), CreateTestFile(), CRYPT_CacheURL(), CRYPT_FileOutputFunc(), CRYPT_SavePKCSToFile(), custom_action_server(), custom_client_thread(), custom_stop_server(), DllRegisterServer(), doChild(), DoEntry(), DoExport(), DoFileSave(), DoSaveFile(), DosWriteFile(), DoTypeFile(), DoWriteFile(), dump_memory64_info(), dump_memory_info(), dump_system_info(), DumpMemoryRaw(), DumpMemoryTxt(), EMFDRV_WriteRecord(), EnumThreadProc(), CShellCommandValue::Execute(), exercizeServer(), export_field(), export_forcecodepage(), export_record(), export_stream(), export_summaryinformation(), ExtCabCallback(), extract2(), extract_one(), extract_resource(), ExtractFilesFromZip(), CZipExtract::ExtractSingle(), ExtractTTFFile(), fci_write(), fdi_write(), FileLockBytesImpl_WriteAt(), FNWRITE(), FormatOutput(), FTP_RetrieveFileData(), FTPFILE_ReadFile(), Generate(), GetAndSendInputThread(), getpass(), ICreateTypeLib2_fnSaveAllChanges(), IDirectXFileImpl_CreateEnumObject(), IDirectXFileImpl_RegisterTemplates(), ImageAddCertificate(), IMAGEHLP_RecalculateChecksum(), IMAGEHLP_SetSecurityDirOffset(), ImageRemoveCertificate(), inf_open_file_content(), initFileFromData(), InitLogging(), InstallDevice(), InstanceThread(), IStream_fnWrite(), ITERATE_PublishIcon(), load_resource(), load_v6_module(), local_server_thread(), LocalmonWritePort(), LocalWritePrinter(), LogToFile(), mailslot_test(), MailSlotWriter(), main(), make_tmp_file(), makeFile(), makestringfile(), MFDRV_CloseMetaFile(), MFDRV_WriteRecord(), MSI_ProcessMessageVerbatim(), myprintf(), named_pipe_client_func(), CNewMenu::NewItemByNonCommand(), OLECONVERT_GetOLE20FromOLE10(), open_file_test(), output_header(), output_string(), output_writeconsole(), OutputResult(), TANSIParser::ParseBuffer(), PersistFile_Save(), PipeSend(), print_string(), printit(), PROFILE_WriteLine(), PROFILE_WriteMarker(), pSetupDebugPrint(), read_http_stream(), read_pipe_test(), RecycleBin5_Create(), BtrfsContextMenu::reflink_copy(), reflink_copy2(), RemoveFile(), replace(), Rs232Thread(), Rs232WriteByteWin32(), WriterThread::Run(), run_cmd(), run_script(), save_base64(), save_blackbox(), save_der(), save_persistent_cookie(), save_pfx(), save_profile(), save_prop(), SaveServicesToFile(), SaveTextFileFromEdit(), sc_cb_write(), ScConnectControlPipe(), ScmControlService(), ScmSendStartCommand(), ScrnshotDownloadCallback(), ScServiceDispatcher(), send_msg(), send_subvol(), CJournaledTestList::SerializeIntoJournal(), serverThreadMain1(), serverThreadMain2(), serverThreadMain3(), serverThreadMain4(), SetupLogErrorA(), stream_out(), taskkill_vprintfW(), tcp_send(), TerminateShell(), test_AtlAxCreateControl(), test_ax_win(), test_bind_image_ex(), test_cache_read(), test_calchash(), test_catalog_properties(), test_CloseHandle(), test_completion(), test_Console(), test_CopyFile2(), test_CopyFileA(), test_create_catalog_file(), test_create_db_imp(), test_create_exe_imp(), test_create_file_imp(), test_create_ne_imp(), test_CreateFile(), test_CreateNamedPipe(), test_CreatePipe(), test_CryptCATAdminAddRemoveCatalog(), test_dib_bits_access(), test_DisconnectNamedPipe(), test_domdoc(), test_ExitProcess(), test_file_access(), test_file_completion_information(), test_file_contents(), test_file_protocol(), test_FileSecurity(), test_filesourcefilter(), test_FindFirstChangeNotification(), test_FlushFileBuffers(), test_get_digest_stream(), test_get_inf_class(), test_get_osfhandle(), test_GetFileInformationByHandleEx(), test_http_cache(), test_image_load(), test_ImpersonateNamedPipeClient(), test_import_resolution(), test_int_widths(), test_iocp_callback(), test_iocp_fileio(), test_ITextDocument_Open(), test_LoadIconWithScaleDown(), test_LoadImage_working_directory_run(), test_LoadImageFile(), test_LocalizedNames(), test_LockFile(), test_LoopbackRead(), test_LZCopy(), test_LZRead(), test_mhtml_protocol_binding(), test_monochrome_icon(), test_MoveFileA(), test_NtMapViewOfSection(), test_null_device(), test_offset_in_overlapped_structure(), test_OleLoadPicturePath(), test_openbackup(), test_OpenFileById(), test_overlapped(), test_profile_delete_on_close(), test_profile_existing(), test_profile_refresh(), test_profile_sections(), test_profile_sections_names(), test_profile_string(), test_query_recyclebin(), Test_RawSize(), test_read_write(), test_ReadFile(), test_readfileex_pending(), test_readonlyfile(), test_readonlyfile_cab(), test_ReplaceFileA(), test_ResolveDelayLoadedAPI(), test_saxreader(), test_saxreader_encoding(), test_section_access(), Test_SectionContents(), test_SetFileValidData(), test_sip(), test_sip_create_indirect_data(), test_SIPRetrieveSubjectGUID(), test_textstream(), test_TransformWithLoadingLocalFile(), Test_Truncate(), test_WaitRx(), test_waittxempty(), test_wintrust_digest(), test_write_watch(), textstream_writecrlf(), textstream_writestr(), BtrfsSend::Thread(), CDownloadManager::ThreadFunc(), transfer_file_http(), translateinfstringex_test(), UDFPhWriteSynchronous(), unpack_avi_file(), CJournaledTestList::UpdateJournal(), VfdCreateImageFile(), VfdFormatMedia(), VfdOpenImage(), VfdSaveImage(), win32_write_file_func(), WINETEST_PRINTF_ATTR(), WMSFT_write_segment(), Write(), CPipe::Write(), write_buffer_to_file(), write_file(), write_inifile(), write_manifest(), write_raw_file(), write_resource_file(), write_tmp_file(), write_to_file(), write_typelib(), write_wav(), writeat(), WriteClipboardFile(), WriteDisk(), WriteEncodedText(), CJournaledTestList::WriteInitialJournalFile(), WriteJobShadowFile(), WritePrinter(), WriteRdpFile(), WriteSdbFile(), TNetwork::WriteString(), WriteToLog(), WriteToPipeThread(), WriteVolumeSector(), wWinMain(), and XCOPY_wprintf().

WriteFileEx()

BOOL WINAPI WriteFileEx	(	IN HANDLE	hFile,
		IN LPCVOID	lpBuffer,
		IN DWORD nNumberOfBytesToWrite	OPTIONAL,
		IN LPOVERLAPPED	lpOverlapped,
		IN LPOVERLAPPED_COMPLETION_ROUTINE	lpCompletionRoutine
	)

Definition at line 262 of file rw.c.

{
    LARGE_INTEGER Offset;
    NTSTATUS Status;
 
    Offset.u.LowPart = lpOverlapped->Offset;
    Offset.u.HighPart = lpOverlapped->OffsetHigh;
    lpOverlapped->Internal = STATUS_PENDING;
 
    Status = NtWriteFile(hFile,
                         NULL,
                         ApcRoutine,
                         lpCompletionRoutine,
                         (PIO_STATUS_BLOCK)lpOverlapped,
                         (PVOID)lpBuffer,
                         nNumberOfBytesToWrite,
                         &Offset,
                         NULL);
 
    if (!NT_SUCCESS(Status))
    {
        BaseSetLastNTError(Status);
        return FALSE;
    }
 
    return TRUE;
}

Referenced by ReadPipeCompletion(), serverThreadMain5(), test_readfileex_pending(), WdmAudCommitWaveBufferByLegacy(), WriteFileEx_Committer(), and WriteFileEx_Remixer().

WriteFileGather()

BOOL WINAPI WriteFileGather	(	HANDLE	hFile,
		FILE_SEGMENT_ELEMENT	aSegmentArray[],
		DWORD	nNumberOfBytesToWrite,
		LPDWORD	lpReserved,
		LPOVERLAPPED	lpOverlapped
	)

Definition at line 379 of file rw.c.

{
    PIO_STATUS_BLOCK IOStatus;
    LARGE_INTEGER Offset;
    NTSTATUS Status;
 
    DPRINT("%p %p %u %p\n", hFile, aSegmentArray, nNumberOfBytesToWrite, lpOverlapped);
 
    Offset.LowPart = lpOverlapped->Offset;
    Offset.HighPart = lpOverlapped->OffsetHigh;
    IOStatus = (PIO_STATUS_BLOCK) lpOverlapped;
    IOStatus->Status = STATUS_PENDING;
    IOStatus->Information = 0;
 
    Status = NtWriteFileGather(hFile,
                               NULL,
                               NULL,
                               NULL,
                               IOStatus,
                               aSegmentArray,
                               nNumberOfBytesToWrite,
                               &Offset,
                               NULL);
 
    if (!NT_SUCCESS(Status))
    {
        SetLastError(RtlNtStatusToDosError(Status));
        return FALSE;
    }
 
    return TRUE;
}

Referenced by test_WriteFileGather().