capture.c File Reference

#include <ntdll.h>
#include <debug.h>

Include dependency graph for capture.c:

Go to the source code of this file.

Macros
#define	NDEBUG

Functions
VOID NTAPI	CsrProbeForRead (IN PVOID Address, IN ULONG Length, IN ULONG Alignment)
VOID NTAPI	CsrProbeForWrite (IN PVOID Address, IN ULONG Length, IN ULONG Alignment)
PCSR_CAPTURE_BUFFER NTAPI	CsrAllocateCaptureBuffer (IN ULONG ArgumentCount, IN ULONG BufferSize)
ULONG NTAPI	CsrAllocateMessagePointer (IN OUT PCSR_CAPTURE_BUFFER CaptureBuffer, IN ULONG MessageLength, OUT PVOID *CapturedData)
VOID NTAPI	CsrCaptureMessageBuffer (IN OUT PCSR_CAPTURE_BUFFER CaptureBuffer, IN PVOID MessageBuffer OPTIONAL, IN ULONG MessageLength, OUT PVOID *CapturedData)
VOID NTAPI	CsrFreeCaptureBuffer (IN PCSR_CAPTURE_BUFFER CaptureBuffer)
VOID NTAPI	CsrCaptureMessageString (IN OUT PCSR_CAPTURE_BUFFER CaptureBuffer, IN PCSTR String OPTIONAL, IN ULONG StringLength, IN ULONG MaximumLength, OUT PSTRING CapturedString)
static VOID	CsrCaptureMessageUnicodeStringInPlace (IN OUT PCSR_CAPTURE_BUFFER CaptureBuffer, IN PUNICODE_STRING String)
NTSTATUS NTAPI	CsrCaptureMessageMultiUnicodeStringsInPlace (OUT PCSR_CAPTURE_BUFFER *CaptureBuffer, IN ULONG StringsCount, IN PUNICODE_STRING *MessageStrings)
PLARGE_INTEGER NTAPI	CsrCaptureTimeout (IN ULONG Milliseconds, OUT PLARGE_INTEGER Timeout)

Variables
HANDLE	CsrPortHeap

Macro Definition Documentation

NDEBUG

#define NDEBUG

Definition at line 14 of file capture.c.

Function Documentation

CsrAllocateCaptureBuffer()

PCSR_CAPTURE_BUFFER NTAPI CsrAllocateCaptureBuffer	(	IN ULONG	ArgumentCount,
		IN ULONG	BufferSize
	)

Definition at line 90 of file capture.c.

{
    PCSR_CAPTURE_BUFFER CaptureBuffer;

    /* Validate size */
    if (BufferSize >= MAXLONG) return NULL;

    /* Add the size of the header and for each offset to the pointers */
    BufferSize += FIELD_OFFSET(CSR_CAPTURE_BUFFER, PointerOffsetsArray) +
                    (ArgumentCount * sizeof(ULONG_PTR));

    /* Align it to a 4-byte boundary */
    BufferSize = (BufferSize + 3) & ~3;

    /* Add the size of the alignment padding for each argument */
    BufferSize += ArgumentCount * 3;

    /* Allocate memory from the port heap */
    CaptureBuffer = RtlAllocateHeap(CsrPortHeap, HEAP_ZERO_MEMORY, BufferSize);
    if (CaptureBuffer == NULL) return NULL;

    /* Initialize the header */
    CaptureBuffer->Size = BufferSize;
    CaptureBuffer->PointerCount = 0;

    /* Initialize all the offsets */
    RtlZeroMemory(CaptureBuffer->PointerOffsetsArray,
                  ArgumentCount * sizeof(ULONG_PTR));

    /* Point to the start of the free buffer */
    CaptureBuffer->BufferEnd = (PVOID)((ULONG_PTR)CaptureBuffer->PointerOffsetsArray +
                                       ArgumentCount * sizeof(ULONG_PTR));

    /* Return the address of the buffer */
    return CaptureBuffer;
}

Referenced by BaseCheckVDM(), CreateConsoleScreenBuffer(), CsrCaptureMessageMultiUnicodeStringsInPlace(), CsrClientConnectToServer(), DefineDosDeviceW(), GetConsoleFontInfo(), GetConsoleProcessList(), GetNextVDMCommand(), GetVDMCurrentDirectories(), IntAddConsoleAlias(), IntAllocConsole(), IntAttachConsole(), IntExpungeConsoleCommandHistory(), IntGetConsoleAlias(), IntGetConsoleAliases(), IntGetConsoleAliasesLength(), IntGetConsoleAliasExes(), IntGetConsoleCommandHistory(), IntGetConsoleCommandHistoryLength(), IntGetConsoleInput(), IntGetConsoleTitle(), IntReadConsole(), IntReadConsoleOutput(), IntReadConsoleOutputCode(), IntSetConsoleNumberOfCommands(), IntSetConsoleTitle(), IntWriteConsole(), IntWriteConsoleInput(), IntWriteConsoleOutput(), IntWriteConsoleOutputCode(), RegisterConsoleVDM(), and SetVDMCurrentDirectories().

CsrAllocateMessagePointer()

ULONG NTAPI CsrAllocateMessagePointer	(	IN OUT PCSR_CAPTURE_BUFFER	CaptureBuffer,
		IN ULONG	MessageLength,
		OUT PVOID *	CapturedData
	)

Definition at line 133 of file capture.c.

{
    if (MessageLength == 0)
    {
        *CapturedData = NULL;
        CapturedData = NULL;
    }
    else
    {
        /* Set the capture data at our current available buffer */
        *CapturedData = CaptureBuffer->BufferEnd;

        /* Validate the size */
        if (MessageLength >= MAXLONG) return 0;

        /* Align it to a 4-byte boundary */
        MessageLength = (MessageLength + 3) & ~3;

        /* Move our available buffer beyond this space */
        CaptureBuffer->BufferEnd = (PVOID)((ULONG_PTR)CaptureBuffer->BufferEnd + MessageLength);
    }

    /* Write down this pointer in the array and increase the count */
    CaptureBuffer->PointerOffsetsArray[CaptureBuffer->PointerCount++] = (ULONG_PTR)CapturedData;

    /* Return the aligned length */
    return MessageLength;
}

Referenced by CsrCaptureMessageBuffer(), CsrCaptureMessageString(), GetConsoleFontInfo(), GetConsoleProcessList(), GetNextVDMCommand(), GetVDMCurrentDirectories(), IntGetConsoleAlias(), IntGetConsoleAliases(), IntGetConsoleAliasExes(), IntGetConsoleCommandHistory(), IntGetConsoleInput(), IntGetConsoleTitle(), IntReadConsole(), IntReadConsoleOutput(), IntReadConsoleOutputCode(), and IntWriteConsoleOutput().

CsrCaptureMessageBuffer()

VOID NTAPI CsrCaptureMessageBuffer	(	IN OUT PCSR_CAPTURE_BUFFER	CaptureBuffer,
		IN PVOID MessageBuffer	OPTIONAL,
		IN ULONG	MessageLength,
		OUT PVOID *	CapturedData
	)

Definition at line 169 of file capture.c.

{
    /* Simply allocate a message pointer in the buffer */
    CsrAllocateMessagePointer(CaptureBuffer, MessageLength, CapturedData);

    /* Check if there was any data */
    if (!MessageBuffer || !MessageLength) return;

    /* Copy the data into the buffer */
    RtlMoveMemory(*CapturedData, MessageBuffer, MessageLength);
}

Referenced by BaseCheckVDM(), CreateConsoleScreenBuffer(), CsrClientConnectToServer(), DefineDosDeviceW(), IntAddConsoleAlias(), IntAllocConsole(), IntAttachConsole(), IntExpungeConsoleCommandHistory(), IntGetConsoleAlias(), IntGetConsoleAliases(), IntGetConsoleAliasesLength(), IntGetConsoleCommandHistory(), IntGetConsoleCommandHistoryLength(), IntSetConsoleNumberOfCommands(), IntSetConsoleTitle(), IntWriteConsole(), IntWriteConsoleInput(), IntWriteConsoleOutputCode(), RegisterConsoleVDM(), and SetVDMCurrentDirectories().

CsrCaptureMessageMultiUnicodeStringsInPlace()

NTSTATUS NTAPI CsrCaptureMessageMultiUnicodeStringsInPlace	(	OUT PCSR_CAPTURE_BUFFER *	CaptureBuffer,
		IN ULONG	StringsCount,
		IN PUNICODE_STRING *	MessageStrings
	)

Definition at line 271 of file capture.c.

{
    ULONG Count;

    if (!CaptureBuffer) return STATUS_INVALID_PARAMETER;

    /* Allocate a new capture buffer if we don't have one already */
    if (!*CaptureBuffer)
    {
        /* Compute the required size for the capture buffer */
        ULONG Size = 0;

        Count = 0;
        while (Count < StringsCount)
        {
            if (MessageStrings[Count])
                Size += MessageStrings[Count]->MaximumLength;

            ++Count;
        }

        /* Allocate the capture buffer */
        *CaptureBuffer = CsrAllocateCaptureBuffer(StringsCount, Size);
        if (!*CaptureBuffer) return STATUS_NO_MEMORY;
    }

    /* Now capture each UNICODE string */
    Count = 0;
    while (Count < StringsCount)
    {
        if (MessageStrings[Count])
            CsrCaptureMessageUnicodeStringInPlace(*CaptureBuffer, MessageStrings[Count]);

        ++Count;
    }

    return STATUS_SUCCESS;
}

CsrCaptureMessageString()

VOID NTAPI CsrCaptureMessageString	(	IN OUT PCSR_CAPTURE_BUFFER	CaptureBuffer,
		IN PCSTR String	OPTIONAL,
		IN ULONG	StringLength,
		IN ULONG	MaximumLength,
		OUT PSTRING	CapturedString
	)

Definition at line 200 of file capture.c.

{
    ASSERT(CapturedString != NULL);

    /*
     * If we don't have a string, initialize an empty one,
     * otherwise capture the given string.
     */
    if (!String)
    {
        CapturedString->Length = 0;
        CapturedString->MaximumLength = (USHORT)MaximumLength;

        /* Allocate a pointer for it */
        CsrAllocateMessagePointer(CaptureBuffer,
                                  MaximumLength,
                                  (PVOID*)&CapturedString->Buffer);
    }
    else
    {
        /* Cut-off the string length if needed */
        if (StringLength > MaximumLength)
            StringLength = MaximumLength;

        CapturedString->Length = (USHORT)StringLength;

        /* Allocate a buffer and get its size */
        CapturedString->MaximumLength =
            (USHORT)CsrAllocateMessagePointer(CaptureBuffer,
                                              MaximumLength,
                                              (PVOID*)&CapturedString->Buffer);

        /* If the string has data, copy it into the buffer */
        if (StringLength)
            RtlMoveMemory(CapturedString->Buffer, String, StringLength);
    }

    /* Null-terminate the string if we don't take up the whole space */
    if (CapturedString->Length < CapturedString->MaximumLength)
        CapturedString->Buffer[CapturedString->Length] = '\0';
}

Referenced by CsrCaptureMessageUnicodeStringInPlace().

CsrCaptureMessageUnicodeStringInPlace()

static VOID CsrCaptureMessageUnicodeStringInPlace ( IN OUT PCSR_CAPTURE_BUFFER  CaptureBuffer, IN PUNICODE_STRING  String  )

static

Definition at line 247 of file capture.c.

{
    ASSERT(String != NULL);

    /* This is a way to capture the UNICODE string, since (Maximum)Length are also in bytes */
    CsrCaptureMessageString(CaptureBuffer,
                            (PCSTR)String->Buffer,
                            String->Length,
                            String->MaximumLength,
                            (PSTRING)String);

    /* Null-terminate the string */
    if (String->MaximumLength >= String->Length + sizeof(WCHAR))
    {
        String->Buffer[String->Length / sizeof(WCHAR)] = L'\0';
    }
}

Referenced by CsrCaptureMessageMultiUnicodeStringsInPlace().

CsrCaptureTimeout()

PLARGE_INTEGER NTAPI CsrCaptureTimeout	(	IN ULONG	Milliseconds,
		OUT PLARGE_INTEGER	Timeout
	)

Definition at line 317 of file capture.c.

{
    /* Validate the time */
    if (Milliseconds == -1) return NULL;

    /* Convert to relative ticks */
    Timeout->QuadPart = Milliseconds * -10000LL;
    return Timeout;
}

CsrFreeCaptureBuffer()

VOID NTAPI CsrFreeCaptureBuffer

(

IN PCSR_CAPTURE_BUFFER

CaptureBuffer

)

Definition at line 189 of file capture.c.

{
    /* Free it from the heap */
    RtlFreeHeap(CsrPortHeap, 0, CaptureBuffer);
}

Referenced by BaseCheckVDM(), CreateConsoleScreenBuffer(), CreateProcessInternalW(), CsrClientConnectToServer(), DefineDosDeviceW(), GetConsoleFontInfo(), GetConsoleProcessList(), GetNextVDMCommand(), GetVDMCurrentDirectories(), IntAddConsoleAlias(), IntAllocConsole(), IntAttachConsole(), IntExpungeConsoleCommandHistory(), IntGetConsoleAlias(), IntGetConsoleAliases(), IntGetConsoleAliasesLength(), IntGetConsoleAliasExes(), IntGetConsoleCommandHistory(), IntGetConsoleCommandHistoryLength(), IntGetConsoleInput(), IntGetConsoleTitle(), IntReadConsole(), IntReadConsoleOutput(), IntReadConsoleOutputCode(), IntSetConsoleNumberOfCommands(), IntSetConsoleTitle(), IntWriteConsole(), IntWriteConsoleInput(), IntWriteConsoleOutput(), IntWriteConsoleOutputCode(), RegisterConsoleVDM(), and SetVDMCurrentDirectories().

CsrProbeForRead()

VOID NTAPI CsrProbeForRead	(	IN PVOID	Address,
		IN ULONG	Length,
		IN ULONG	Alignment
	)

Definition at line 28 of file capture.c.

{
    volatile UCHAR *Pointer;
    UCHAR Data;

    /* Validate length */
    if (Length == 0) return;

    /* Validate alignment */
    if ((ULONG_PTR)Address & (Alignment - 1))
    {
        /* Raise exception if it doesn't match */
        RtlRaiseStatus(STATUS_DATATYPE_MISALIGNMENT);
    }

    /* Probe first byte */
    Pointer = Address;
    Data = *Pointer;

    /* Probe last byte */
    Pointer = (PUCHAR)Address + Length - 1;
    Data = *Pointer;
    (void)Data;
}

CsrProbeForWrite()

VOID NTAPI CsrProbeForWrite	(	IN PVOID	Address,
		IN ULONG	Length,
		IN ULONG	Alignment
	)

Definition at line 60 of file capture.c.

{
    volatile UCHAR *Pointer;

    /* Validate length */
    if (Length == 0) return;

    /* Validate alignment */
    if ((ULONG_PTR)Address & (Alignment - 1))
    {
        /* Raise exception if it doesn't match */
        RtlRaiseStatus(STATUS_DATATYPE_MISALIGNMENT);
    }

    /* Probe first byte */
    Pointer = Address;
    *Pointer = *Pointer;

    /* Probe last byte */
    Pointer = (PUCHAR)Address + Length - 1;
    *Pointer = *Pointer;
}

Variable Documentation

CsrPortHeap

HANDLE CsrPortHeap

Definition at line 23 of file connect.c.

Referenced by CsrAllocateCaptureBuffer(), CsrClientConnectToServer(), CsrFreeCaptureBuffer(), and CsrpConnectToServer().