#include <ntifs.h>
#include <stdio.h>
#include <ntoskrnl/include/internal/hdl.h>
#include <sacmsg.h>

Include dependency graph for sacdrv.h:

This graph shows which files directly or indirectly include this file:

Classes
struct	_SAC_MEMORY_ENTRY

struct	_SAC_MEMORY_LIST

struct	_SAC_MESSAGE_ENTRY

struct	_SAC_CHANNEL_ID

struct	_SAC_CHANNEL_LOCK

struct	_SAC_CELL_DATA

struct	_SAC_VTUTF8_SCREEN

struct	_SAC_STATIC_ESCAPE_STRING

struct	_SAC_CHANNEL

struct	_SAC_CHANNEL_ATTRIBUTES

struct	_SAC_MACHINE_INFO

struct	_SAC_DEVICE_EXTENSION

Macros
#define	SacAllocatePool(Length, Tag) MyAllocatePool(Length, Tag, __FILE__, __LINE__)

#define	SacFreePool(Pointer) MyFreePool((PVOID*)(&Pointer))

#define	SAC_DBG_ENTRY_EXIT 0x01

#define	SAC_DBG_UTIL 0x02

#define	SAC_DBG_INIT 0x04

#define	SAC_DBG_MM 0x1000

#define	SAC_DBG_MACHINE 0x2000

#define	SAC_DBG(x, ...)

#define	CHECK_PARAMETER_WITH_STATUS(Condition, Status)

#define	CHECK_PARAMETER(x) CHECK_PARAMETER_WITH_STATUS(x, STATUS_INVALID_PARAMETER)

#define	CHECK_PARAMETER1(x) CHECK_PARAMETER_WITH_STATUS(x, STATUS_INVALID_PARAMETER_1)

#define	CHECK_PARAMETER2(x) CHECK_PARAMETER_WITH_STATUS(x, STATUS_INVALID_PARAMETER_2)

#define	CHECK_PARAMETER3(x) CHECK_PARAMETER_WITH_STATUS(x, STATUS_INVALID_PARAMETER_3)

#define	CHECK_PARAMETER4(x) CHECK_PARAMETER_WITH_STATUS(x, STATUS_INVALID_PARAMETER_4)

#define	CHECK_ALLOCATION(x) CHECK_PARAMETER_WITH_STATUS(x, STATUS_NO_MEMORY)

#define	ChannelInitializeEvent(Channel, Attributes, x)

#define	ChannelUninitializeEvent(Channel, x, f)

#define	ChannelSetEvent(Channel, x)

#define	ChannelClearEvent(Channel, x)

#define	GENERIC_TAG '?pcR'

#define	ALLOC_BLOCK_TAG 'ApcR'

#define	INITIAL_BLOCK_TAG 'IpcR'

#define	SECURITY_BLOCK_TAG 'SpcR'

#define	FREE_POOL_TAG 'FpcR'

#define	GLOBAL_BLOCK_TAG 'GpcR'

#define	CHANNEL_BLOCK_TAG 'CpcR'

#define	LOCAL_MEMORY_SIGNATURE 'SSEL'

#define	GLOBAL_MEMORY_SIGNATURE 'DAEH'

#define	SAC_MEMORY_LIST_SIZE (1 * 1024 * 1024)

#define	SAC_OBUFFER_SIZE (2 * 1024)

#define	SAC_CHANNEL_NAME_SIZE 64

#define	SAC_CHANNEL_DESCRIPTION_SIZE 256

#define	SAC_MAX_CHANNELS 10

#define	SAC_SERIAL_PORT_BUFFER_SIZE 1024

#define	SAC_MAX_MESSAGES 200

#define	SAC_VTUTF8_COL_WIDTH 80

#define	SAC_VTUTF8_COL_HEIGHT 25

#define	SAC_VTUTF8_ROW_HEIGHT 24

#define	MAX_UTF8_ENCODE_BLOCK_LENGTH (Utf8ConversionBufferSize / 3 - 1)

#define	SAC_VTUTF8_OBUFFER_SIZE 0x2D00

#define	SAC_VTUTF8_IBUFFER_SIZE 0x2000

#define	SAC_RAW_OBUFFER_SIZE 0x2000

#define	SAC_RAW_IBUFFER_SIZE 0x2000

#define	SAC_CHANNEL_FLAG_INTERNAL 0x1

#define	SAC_CHANNEL_FLAG_CLOSE_EVENT 0x2

#define	SAC_CHANNEL_FLAG_HAS_NEW_DATA_EVENT 0x4

#define	SAC_CHANNEL_FLAG_LOCK_EVENT 0x8

#define	SAC_CHANNEL_FLAG_REDRAW_EVENT 0x10

#define	SAC_CHANNEL_FLAG_APPLICATION 0x20

#define	SAC_CELL_FLAG_BLINK 1

#define	SAC_CELL_FLAG_BOLD 2

#define	SAC_CELL_FLAG_INVERTED 4

#define	ChannelLockCreates() SacAcquireLock(&ChannelCreateLock);

#define	ChannelUnlockCreates() SacReleaseLock(&ChannelCreateLock);

#define	ChannelLockOBuffer(x) SacAcquireLock(&x->ChannelOBufferLock);

#define	ChannelUnlockOBuffer(x) SacReleaseLock(&x->ChannelOBufferLock);

#define	ChannelLockIBuffer(x) SacAcquireLock(&x->ChannelIBufferLock);

#define	ChannelUnlockIBuffer(x) SacReleaseLock(&x->ChannelIBufferLock);

#define	ChannelLockAttributes(x) SacAcquireLock(&x->ChannelAttributeLock);

#define	ChannelUnlockAttributes(x) SacReleaseLock(&x->ChannelAttributeLock);

#define	ChannelSlotLock(x) SacAcquireLock(&ChannelSlotLock[x]);

#define	ChannelSlotUnlock(x) SacReleaseLock(&ChannelSlotLock[x]);

#define	VT_ANSI_ESCAPE L'\x1B'

#define	VT_ANSI_COMMAND L'['

#define	VT_ANSI_CURSOR_UP_CHAR L'A'

#define	VT_ANSI_CURSOR_UP L"[A"

#define	VT_ANSI_CURSOR_DOWN_CHAR L'B'

#define	VT_ANSI_CURSOR_DOWN L"[B"

#define	VT_ANSI_CURSOR_RIGHT_CHAR L'C'

#define	VT_ANSI_CURSOR_RIGHT L"[C"

#define	VT_ANSI_CURSOR_LEFT_CHAR L'D'

#define	VT_ANSI_CURSOR_LEFT L"[D"

#define	VT_ANSI_ERASE_LINE_CHAR L'K'

#define	VT_ANSI_ERASE_END_LINE L"[K"

#define	VT_ANSI_ERASE_START_LINE L"[1K"

#define	VT_ANSI_ERASE_ENTIRE_LINE L"[2K"

#define	VT_ANSI_ERASE_SCREEN_CHAR L'J'

#define	VT_ANSI_ERASE_DOWN_SCREEN L"[J"

#define	VT_ANSI_ERASE_UP_SCREEN L"[1J"

#define	VT_ANSI_ERASE_ENTIRE_SCREEN L"[2J"

#define	VT_ANSI_BACKTAB_CHAR L'Z'

#define	VT_220_BACKTAB L"[0Z"

#define	VT_ANSI_SET_ATTRIBUTE_CHAR L'm'

#define	VT_ANSI_SEPARATOR_CHAR L';'

#define	VT_ANSI_HVP_CURSOR_CHAR L'f'

#define	VT_ANSI_CUP_CURSOR_CHAR L'H'

#define	VT_ANSI_SCROLL_CHAR L'r'

Typedefs
typedef struct _SAC_MEMORY_ENTRY	SAC_MEMORY_ENTRY

typedef struct _SAC_MEMORY_ENTRY *	PSAC_MEMORY_ENTRY

typedef struct _SAC_MEMORY_LIST	SAC_MEMORY_LIST

typedef struct _SAC_MEMORY_LIST *	PSAC_MEMORY_LIST

typedef struct _SAC_MESSAGE_ENTRY	SAC_MESSAGE_ENTRY

typedef struct _SAC_MESSAGE_ENTRY *	PSAC_MESSAGE_ENTRY

typedef enum _SAC_ANSI_COMMANDS	SAC_ANSI_COMMANDS

typedef enum _SAC_ANSI_DISPATCH	SAC_ANSI_DISPATCH

typedef enum _SAC_POST_COMMANDS	SAC_POST_COMMANDS

typedef enum _SAC_CHANNEL_TYPE	SAC_CHANNEL_TYPE

typedef enum _SAC_CHANNEL_STATUS	SAC_CHANNEL_STATUS

typedef enum _SAC_CHANNEL_STATUS *	PSAC_CHANNEL_STATUS

typedef struct _SAC_CHANNEL_ID	SAC_CHANNEL_ID

typedef struct _SAC_CHANNEL_ID *	PSAC_CHANNEL_ID

typedef struct _SAC_CHANNEL_LOCK	SAC_CHANNEL_LOCK

typedef struct _SAC_CHANNEL_LOCK *	PSAC_CHANNEL_LOCK

typedef struct _SAC_CELL_DATA	SAC_CELL_DATA

typedef struct _SAC_CELL_DATA *	PSAC_CELL_DATA

typedef struct _SAC_VTUTF8_SCREEN	SAC_VTUTF8_SCREEN

typedef struct _SAC_VTUTF8_SCREEN *	PSAC_VTUTF8_SCREEN

typedef struct _SAC_STATIC_ESCAPE_STRING	SAC_STATIC_ESCAPE_STRING

typedef struct _SAC_STATIC_ESCAPE_STRING *	PSAC_STATIC_ESCAPE_STRING

typedef NTSTATUS(NTAPI *	PSAC_CHANNEL_CREATE) (IN struct _SAC_CHANNEL *Channel)

typedef NTSTATUS(NTAPI *	PSAC_CHANNEL_DESTROY) (IN struct _SAC_CHANNEL *Channel)

typedef NTSTATUS(NTAPI *	PSAC_CHANNEL_OREAD) (IN struct _SAC_CHANNEL *Channel, IN PCHAR Buffer, IN ULONG BufferSize, OUT PULONG ByteCount)

typedef NTSTATUS(NTAPI *	PSAC_CHANNEL_OECHO) (IN struct _SAC_CHANNEL *Channel, IN PCHAR String, IN ULONG Length)

typedef NTSTATUS(NTAPI *	PSAC_CHANNEL_OFLUSH) (IN struct _SAC_CHANNEL *Channel)

typedef NTSTATUS(NTAPI *	PSAC_CHANNEL_OWRITE) (IN struct _SAC_CHANNEL *Channel, IN PCHAR String, IN ULONG Length)

typedef NTSTATUS(NTAPI *	PSAC_CHANNEL_IREAD) (IN struct _SAC_CHANNEL *Channel, IN PCHAR Buffer, IN ULONG BufferSize, IN PULONG ReturnBufferSize)

typedef NTSTATUS(NTAPI *	PSAC_CHANNEL_IBUFFER_FULL) (IN struct _SAC_CHANNEL *Channel, OUT PBOOLEAN BufferStatus)

typedef ULONG(NTAPI *	PSAC_CHANNEL_IBUFFER_LENGTH) (IN struct _SAC_CHANNEL *Channel)

typedef WCHAR(NTAPI *	PSAC_CHANNEL_IREAD_LAST) (IN struct _SAC_CHANNEL *Channel)

typedef NTSTATUS(NTAPI *	PSAC_CHANNEL_IWRITE) (IN struct _SAC_CHANNEL *Channel, IN PCHAR Buffer, IN ULONG BufferSize)

typedef struct _SAC_CHANNEL	SAC_CHANNEL

typedef struct _SAC_CHANNEL *	PSAC_CHANNEL

typedef struct _SAC_CHANNEL_ATTRIBUTES	SAC_CHANNEL_ATTRIBUTES

typedef struct _SAC_CHANNEL_ATTRIBUTES *	PSAC_CHANNEL_ATTRIBUTES

typedef struct _SAC_MACHINE_INFO	SAC_MACHINE_INFO

typedef struct _SAC_MACHINE_INFO *	PSAC_MACHINE_INFO

typedef struct _SAC_DEVICE_EXTENSION	SAC_DEVICE_EXTENSION

typedef struct _SAC_DEVICE_EXTENSION *	PSAC_DEVICE_EXTENSION

typedef enum _VT_ANSI_ATTRIBUTES	VT_ANSI_ATTRIBUTES

Enumerations
enum	_SAC_ANSI_COMMANDS { SacCursorUp , SacCursorDown , SacCursorRight , SacCursorLeft , SacFontNormal , SacFontBlink , SacFontBlinkOff , SacFontBold , SacFontBoldOff , SacFontInverse , SacFontInverseOff , SacBackTab , SacEraseEndOfLine , SacEraseStartOfLine , SacEraseLine , SacEraseEndOfScreen , SacEraseStartOfScreen , SacEraseScreen , SacSetCursorPosition , SacSetScrollRegion , SacSetColors , SacSetBackgroundColor , SacSetFontColor , SacSetColorsAndAttributes }

enum	_SAC_ANSI_DISPATCH { SacAnsiClearScreen , SacAnsiClearEndOfScreen , SacAnsiClearEndOfLine , SacAnsiSetColors , SacAnsiSetPosition , SacAnsiClearAttributes , SacAnsiSetInverseAttribute , SacAnsiClearInverseAttribute , SacAnsiSetBlinkAttribute , SacAnsiClearBlinkAttribute , SacAnsiSetBoldAttribute , SacAnsiClearBoldAttribute }

enum	_SAC_POST_COMMANDS { Nothing , Shutdown , Close , Restart }

enum	_SAC_CHANNEL_TYPE { VtUtf8 , Cmd , Raw }

enum	_SAC_CHANNEL_STATUS { Inactive , Active }

enum	_VT_ANSI_ATTRIBUTES { Normal , Bold , Faint , Italic , Underline , SlowBlink , FastBlink , Inverse , Conceal , Strikethrough , PrimaryFont , AlternateFont1 , AlternateFont2 , AlternateFont3 , Alternatefont4 , AlternateFont5 , AlternateFont6 , AlternateFont7 , AlternateFont8 , AlternateFont9 , Fraktur , DoubleUnderline , BoldOff , ItalicOff , UnderlineOff , BlinkOff , Reserved , InverseOff , ConcealOff , StrikethroughOff , SetColorStart , SetColorBlack = SetColorStart , SetColorRed , SetColorGreen , SetColorYellow , SetColorBlue , SetcolorMAgent , SetColorCyan , SetColorWhite , SetColorMax = SetColorWhite , SetColor256 , SeTextColorDefault , SetBackColorStart , SetBackColorBlack = SetBackColorStart , SetBackColorRed , SetBackColorGreen , SetBackColorYellow , SetBackColorBlue , SetBackcolorMAgent , SetBackColorCyan , SetBackColorWhite , SetBackColorMax = SetBackColorWhite , SetBackColor256 , SetBackColorDefault , Reserved1 , Framed , Encircled , Overlined , FramedOff , OverlinedOff , Reserved2 , Reserved3 , Reserved4 , Reserved5 }

Functions
	C_ASSERT (sizeof(SAC_CELL_DATA)==6)

NTSTATUS NTAPI	Dispatch (IN PDEVICE_OBJECT DeviceObject, IN PIRP Irp)

NTSTATUS NTAPI	DispatchDeviceControl (IN PDEVICE_OBJECT DeviceObject, IN PIRP Irp)

NTSTATUS NTAPI	DispatchShutdownControl (IN PDEVICE_OBJECT DeviceObject, IN PIRP Irp)

VOID NTAPI	UnloadHandler (IN PDRIVER_OBJECT DriverObject)

VOID NTAPI	FreeGlobalData (VOID)

VOID NTAPI	FreeDeviceData (IN PDEVICE_OBJECT DeviceObject)

BOOLEAN NTAPI	InitializeDeviceData (IN PDEVICE_OBJECT DeviceObject)

BOOLEAN NTAPI	InitializeGlobalData (IN PUNICODE_STRING RegistryPath, IN PDRIVER_OBJECT DriverObject)

BOOLEAN NTAPI	InitializeMemoryManagement (VOID)

VOID NTAPI	FreeMemoryManagement (VOID)

VOID NTAPI	InitializeCmdEventInfo (VOID)

VOID NTAPI	InitializeMachineInformation (VOID)

NTSTATUS NTAPI	PreloadGlobalMessageTable (IN PVOID ImageBase)

NTSTATUS NTAPI	TearDownGlobalMessageTable (VOID)

NTSTATUS NTAPI	GetCommandConsoleLaunchingPermission (OUT PBOOLEAN Permission)

NTSTATUS NTAPI	ImposeSacCmdServiceStartTypePolicy (VOID)

NTSTATUS NTAPI	RegisterBlueScreenMachineInformation (VOID)

VOID NTAPI	FreeMachineInformation (VOID)

VOID NTAPI	TimerDpcRoutine (IN PKDPC Dpc, IN PVOID DeferredContext, IN PVOID SystemArgument1, IN PVOID SystemArgument2)

PVOID NTAPI	MyAllocatePool (IN SIZE_T PoolSize, IN ULONG Tag, IN PCHAR File, IN ULONG Line)

VOID NTAPI	MyFreePool (IN PVOID *Block)

NTSTATUS NTAPI	ConMgrInitialize (VOID)

VOID NTAPI	ConMgrWorkerProcessEvents (IN PSAC_DEVICE_EXTENSION DeviceExtension)

NTSTATUS NTAPI	ConMgrShutdown (VOID)

BOOLEAN NTAPI	ConMgrSimpleEventMessage (IN ULONG MessageIndex, IN BOOLEAN LockHeld)

BOOLEAN NTAPI	SacPutSimpleMessage (IN ULONG MessageIndex)

VOID NTAPI	SacPutString (IN PWCHAR String)

NTSTATUS NTAPI	ConMgrWriteData (IN PSAC_CHANNEL Channel, IN PVOID Buffer, IN ULONG BufferLength)

NTSTATUS NTAPI	ConMgrFlushData (IN PSAC_CHANNEL Channel)

BOOLEAN NTAPI	ConMgrIsWriteEnabled (IN PSAC_CHANNEL Channel)

NTSTATUS NTAPI	ConMgrHandleEvent (IN ULONG EventCode, IN PSAC_CHANNEL Channel, OUT PVOID Data)

NTSTATUS NTAPI	ChanMgrInitialize (VOID)

NTSTATUS NTAPI	ChanMgrShutdown (VOID)

NTSTATUS NTAPI	ChanMgrCreateChannel (OUT PSAC_CHANNEL *Channel, IN PSAC_CHANNEL_ATTRIBUTES Attributes)

NTSTATUS NTAPI	ChanMgrGetByHandle (IN SAC_CHANNEL_ID ChannelId, OUT PSAC_CHANNEL *TargetChannel)

NTSTATUS NTAPI	ChanMgrReleaseChannel (IN PSAC_CHANNEL Channel)

NTSTATUS NTAPI	ChanMgrGetNextActiveChannel (IN PSAC_CHANNEL CurrentChannel, IN PULONG TargetIndex, OUT PSAC_CHANNEL *TargetChannel)

NTSTATUS NTAPI	ChanMgrCloseChannel (IN PSAC_CHANNEL Channel)

NTSTATUS NTAPI	ChannelClose (IN PSAC_CHANNEL Channel)

BOOLEAN NTAPI	ChannelIsEqual (IN PSAC_CHANNEL Channel, IN PSAC_CHANNEL_ID ChannelId)

NTSTATUS NTAPI	ChannelOWrite (IN PSAC_CHANNEL Channel, IN PCHAR Buffer, IN ULONG BufferSize)

NTSTATUS NTAPI	ChannelOFlush (IN PSAC_CHANNEL Channel)

NTSTATUS NTAPI	ChannelSetRedrawEvent (IN PSAC_CHANNEL Channel)

NTSTATUS NTAPI	ChannelClearRedrawEvent (IN PSAC_CHANNEL Channel)

NTSTATUS NTAPI	ChannelHasRedrawEvent (IN PSAC_CHANNEL Channel, OUT PBOOLEAN Present)

BOOLEAN NTAPI	ChannelIsActive (IN PSAC_CHANNEL Channel)

NTSTATUS NTAPI	ChannelGetName (IN PSAC_CHANNEL Channel, OUT PWCHAR *Name)

NTSTATUS NTAPI	ChannelCreate (IN PSAC_CHANNEL Channel, IN PSAC_CHANNEL_ATTRIBUTES Attributes, IN SAC_CHANNEL_ID ChannelId)

NTSTATUS NTAPI	ChannelDestroy (IN PSAC_CHANNEL Channel)

NTSTATUS NTAPI	ChannelIWrite (IN PSAC_CHANNEL Channel, IN PCHAR Buffer, IN ULONG BufferSize)

WCHAR NTAPI	ChannelIReadLast (IN PSAC_CHANNEL Channel)

ULONG NTAPI	ChannelIBufferLength (IN PSAC_CHANNEL Channel)

NTSTATUS NTAPI	ChannelIRead (IN PSAC_CHANNEL Channel, IN PCHAR Buffer, IN ULONG BufferSize, IN OUT PULONG ResultBufferSize)

NTSTATUS NTAPI	RawChannelCreate (IN PSAC_CHANNEL Channel)

NTSTATUS NTAPI	RawChannelDestroy (IN PSAC_CHANNEL Channel)

NTSTATUS NTAPI	RawChannelORead (IN PSAC_CHANNEL Channel, IN PCHAR Buffer, IN ULONG BufferSize, OUT PULONG ByteCount)

NTSTATUS NTAPI	RawChannelOEcho (IN PSAC_CHANNEL Channel, IN PCHAR String, IN ULONG Length)

NTSTATUS NTAPI	RawChannelOFlush (IN PSAC_CHANNEL Channel)

NTSTATUS NTAPI	RawChannelOWrite (IN PSAC_CHANNEL Channel, IN PCHAR String, IN ULONG Length)

NTSTATUS NTAPI	RawChannelIRead (IN PSAC_CHANNEL Channel, IN PCHAR Buffer, IN ULONG BufferSize, IN PULONG ReturnBufferSize)

NTSTATUS NTAPI	RawChannelIBufferIsFull (IN PSAC_CHANNEL Channel, OUT PBOOLEAN BufferStatus)

ULONG NTAPI	RawChannelIBufferLength (IN PSAC_CHANNEL Channel)

WCHAR NTAPI	RawChannelIReadLast (IN PSAC_CHANNEL Channel)

NTSTATUS NTAPI	RawChannelIWrite (IN PSAC_CHANNEL Channel, IN PCHAR Buffer, IN ULONG BufferSize)

NTSTATUS NTAPI	VTUTF8ChannelCreate (IN PSAC_CHANNEL Channel)

NTSTATUS NTAPI	VTUTF8ChannelDestroy (IN PSAC_CHANNEL Channel)

NTSTATUS NTAPI	VTUTF8ChannelORead (IN PSAC_CHANNEL Channel, IN PCHAR Buffer, IN ULONG BufferSize, OUT PULONG ByteCount)

NTSTATUS NTAPI	VTUTF8ChannelOEcho (IN PSAC_CHANNEL Channel, IN PCHAR String, IN ULONG Length)

NTSTATUS NTAPI	VTUTF8ChannelOFlush (IN PSAC_CHANNEL Channel)

NTSTATUS NTAPI	VTUTF8ChannelOWrite (IN PSAC_CHANNEL Channel, IN PCHAR String, IN ULONG Length)

NTSTATUS NTAPI	VTUTF8ChannelIRead (IN PSAC_CHANNEL Channel, IN PCHAR Buffer, IN ULONG BufferSize, IN PULONG ReturnBufferSize)

NTSTATUS NTAPI	VTUTF8ChannelIBufferIsFull (IN PSAC_CHANNEL Channel, OUT PBOOLEAN BufferStatus)

ULONG NTAPI	VTUTF8ChannelIBufferLength (IN PSAC_CHANNEL Channel)

WCHAR NTAPI	VTUTF8ChannelIReadLast (IN PSAC_CHANNEL Channel)

NTSTATUS NTAPI	VTUTF8ChannelIWrite (IN PSAC_CHANNEL Channel, IN PCHAR Buffer, IN ULONG BufferSize)

BOOLEAN NTAPI	SacTranslateUtf8ToUnicode (IN CHAR Utf8Char, IN PCHAR Utf8Buffer, OUT PWCHAR Utf8Value)

ULONG NTAPI	GetMessageLineCount (IN ULONG MessageIndex)

NTSTATUS NTAPI	SerialBufferGetChar (OUT PCHAR Char)

NTSTATUS NTAPI	UTF8EncodeAndSend (IN PWCHAR String)

NTSTATUS NTAPI	TranslateMachineInformationXML (IN PWCHAR *Buffer, IN PWCHAR ExtraData)

PWCHAR NTAPI	GetMessage (IN ULONG MessageIndex)

BOOLEAN NTAPI	VerifyEventWaitable (IN HANDLE Handle, OUT PVOID WaitObject, OUT PVOID ActualWaitObject)

BOOLEAN NTAPI	SacTranslateUnicodeToUtf8 (IN PWCHAR SourceBuffer, IN ULONG SourceBufferLength, OUT PCHAR DestinationBuffer, IN ULONG DestinationBufferSize, OUT PULONG UTF8Count, OUT PULONG ProcessedCount)

VOID NTAPI	DoRebootCommand (IN BOOLEAN Reboot)

VOID NTAPI	DoFullInfoCommand (VOID)

VOID NTAPI	DoPagingCommand (VOID)

VOID NTAPI	DoSetTimeCommand (IN PCHAR InputTime)

VOID NTAPI	DoKillCommand (IN PCHAR KillString)

VOID NTAPI	DoLowerPriorityCommand (IN PCHAR PrioString)

VOID NTAPI	DoRaisePriorityCommand (IN PCHAR PrioString)

VOID NTAPI	DoLimitMemoryCommand (IN PCHAR LimitString)

VOID NTAPI	DoCrashCommand (VOID)

VOID NTAPI	DoMachineInformationCommand (VOID)

VOID NTAPI	DoChannelCommand (IN PCHAR ChannelString)

VOID NTAPI	DoCmdCommand (IN PCHAR InputString)

VOID NTAPI	DoLockCommand (VOID)

VOID NTAPI	DoHelpCommand (VOID)

VOID NTAPI	DoGetNetInfo (IN BOOLEAN DoPrint)

VOID NTAPI	DoSetIpAddressCommand (IN PCHAR IpString)

VOID NTAPI	DoTlistCommand (VOID)

FORCEINLINE VOID	SacInitializeLock (IN PSAC_CHANNEL_LOCK Lock)

FORCEINLINE VOID	SacAcquireLock (IN PSAC_CHANNEL_LOCK Lock)

FORCEINLINE VOID	SacReleaseLock (IN PSAC_CHANNEL_LOCK Lock)

FORCEINLINE VOID	SacAssertMutexLockHeld (VOID)

FORCEINLINE VOID	SacInitializeMutexLock (VOID)

FORCEINLINE VOID	SacAcquireMutexLock (VOID)

FORCEINLINE VOID	SacReleaseMutexLock (VOID)

FORCEINLINE ULONG	ChannelGetFlags (IN PSAC_CHANNEL Channel)

FORCEINLINE LONG	ChannelGetIndex (IN PSAC_CHANNEL Channel)

FORCEINLINE BOOLEAN	ChannelHasNewIBufferData (IN PSAC_CHANNEL Channel)

Macro Definition Documentation

◆ ALLOC_BLOCK_TAG

#define ALLOC_BLOCK_TAG 'ApcR'

Definition at line 138 of file sacdrv.h.

◆ CHANNEL_BLOCK_TAG

#define CHANNEL_BLOCK_TAG 'CpcR'

Definition at line 143 of file sacdrv.h.

◆ ChannelClearEvent

#define ChannelClearEvent	(	Channel,
		x
	)

Value:

{                                                   \
    ASSERT(Channel->x);                             \
    ASSERT(Channel->x##ObjectBody);                 \
    ASSERT(Channel->x##WaitObjectBody);             \
    if (Channel->x##WaitObjectBody)                 \
    {                                               \
        KeClearEvent(Channel->x##WaitObjectBody);   \
        Status = STATUS_SUCCESS;                    \
    }                                               \
    else                                            \
    {                                               \
        Status = STATUS_UNSUCCESSFUL;               \
    }                                               \
}

Definition at line 114 of file sacdrv.h.

◆ ChannelInitializeEvent

#define ChannelInitializeEvent	(	Channel,
		Attributes,
		x
	)

Value:

{                                                                       \
    PVOID Object, WaitObject;                                           \
    if (Attributes->x)                                                  \
    {                                                                   \
        if (!VerifyEventWaitable(Attributes->x, &Object, &WaitObject))  \
        {                                                               \
            Status = STATUS_INVALID_HANDLE;                             \
            goto FailChannel;                                           \
        }                                                               \
        Channel->x = Attributes->x;                                     \
        Channel->x##ObjectBody = Object;                                \
        Channel->x##WaitObjectBody = WaitObject;                        \
    }                                                                   \
}

Definition at line 70 of file sacdrv.h.

◆ ChannelLockAttributes

#define ChannelLockAttributes ( x ) SacAcquireLock(&x->ChannelAttributeLock);

Definition at line 1336 of file sacdrv.h.

◆ ChannelLockCreates

#define ChannelLockCreates ( ) SacAcquireLock(&ChannelCreateLock);

Definition at line 1330 of file sacdrv.h.

◆ ChannelLockIBuffer

#define ChannelLockIBuffer ( x ) SacAcquireLock(&x->ChannelIBufferLock);

Definition at line 1334 of file sacdrv.h.

◆ ChannelLockOBuffer

#define ChannelLockOBuffer ( x ) SacAcquireLock(&x->ChannelOBufferLock);

Definition at line 1332 of file sacdrv.h.

◆ ChannelSetEvent

#define ChannelSetEvent	(	Channel,
		x
	)

Value:

{                                                                       \
    ASSERT(Channel->x);                                                 \
    ASSERT(Channel->x##ObjectBody);                                     \
    ASSERT(Channel->x##WaitObjectBody);                                 \
    if (Channel->x##WaitObjectBody)                                     \
    {                                                                   \
        KeSetEvent(Channel->x##WaitObjectBody, EVENT_INCREMENT, FALSE); \
        Status = STATUS_SUCCESS;                                        \
    }                                                                   \
    else                                                                \
    {                                                                   \
        Status = STATUS_UNSUCCESSFUL;                                   \
    }                                                                   \
}

Definition at line 99 of file sacdrv.h.

◆ ChannelSlotLock

#define ChannelSlotLock ( x ) SacAcquireLock(&ChannelSlotLock[x]);

Definition at line 1338 of file sacdrv.h.

◆ ChannelSlotUnlock

#define ChannelSlotUnlock ( x ) SacReleaseLock(&ChannelSlotLock[x]);

Definition at line 1339 of file sacdrv.h.

◆ ChannelUninitializeEvent

#define ChannelUninitializeEvent	(	Channel,
		x,
		f
	)

Value:

{                                                       \
    ASSERT(ChannelGetFlags(Channel) & (f));             \
    ASSERT(Channel->x##ObjectBody);                     \
    ASSERT(Channel->x##WaitObjectBody);                 \
    if (Channel->x##ObjectBody)                         \
    {                                                   \
        ObDereferenceObject(Channel->x##ObjectBody);    \
        Channel->Flags &= ~(f);                         \
        Channel->x = NULL;                              \
        Channel->x##ObjectBody = NULL;                  \
        Channel->x##WaitObjectBody = NULL;              \
    }                                                   \
}

Definition at line 85 of file sacdrv.h.

◆ ChannelUnlockAttributes

#define ChannelUnlockAttributes ( x ) SacReleaseLock(&x->ChannelAttributeLock);

Definition at line 1337 of file sacdrv.h.

◆ ChannelUnlockCreates

#define ChannelUnlockCreates ( ) SacReleaseLock(&ChannelCreateLock);

Definition at line 1331 of file sacdrv.h.

◆ ChannelUnlockIBuffer

#define ChannelUnlockIBuffer ( x ) SacReleaseLock(&x->ChannelIBufferLock);

Definition at line 1335 of file sacdrv.h.

◆ ChannelUnlockOBuffer

#define ChannelUnlockOBuffer ( x ) SacReleaseLock(&x->ChannelOBufferLock);

Definition at line 1333 of file sacdrv.h.

◆ CHECK_ALLOCATION

#define CHECK_ALLOCATION ( x ) CHECK_PARAMETER_WITH_STATUS(x, STATUS_NO_MEMORY)

Definition at line 64 of file sacdrv.h.

◆ CHECK_PARAMETER

#define CHECK_PARAMETER ( x ) CHECK_PARAMETER_WITH_STATUS(x, STATUS_INVALID_PARAMETER)

Definition at line 54 of file sacdrv.h.

◆ CHECK_PARAMETER1

#define CHECK_PARAMETER1 ( x ) CHECK_PARAMETER_WITH_STATUS(x, STATUS_INVALID_PARAMETER_1)

Definition at line 56 of file sacdrv.h.

◆ CHECK_PARAMETER2

#define CHECK_PARAMETER2 ( x ) CHECK_PARAMETER_WITH_STATUS(x, STATUS_INVALID_PARAMETER_2)

Definition at line 58 of file sacdrv.h.

◆ CHECK_PARAMETER3

#define CHECK_PARAMETER3 ( x ) CHECK_PARAMETER_WITH_STATUS(x, STATUS_INVALID_PARAMETER_3)

Definition at line 60 of file sacdrv.h.

◆ CHECK_PARAMETER4

#define CHECK_PARAMETER4 ( x ) CHECK_PARAMETER_WITH_STATUS(x, STATUS_INVALID_PARAMETER_4)

Definition at line 62 of file sacdrv.h.

◆ CHECK_PARAMETER_WITH_STATUS

#define CHECK_PARAMETER_WITH_STATUS	(	Condition,
		Status
	)

Value:

{                                                       \
    if (!NT_VERIFY(Condition))                          \
    {                                                   \
        return Status;                                  \
    }                                                   \
}

Definition at line 47 of file sacdrv.h.

◆ FREE_POOL_TAG

#define FREE_POOL_TAG 'FpcR'

Definition at line 141 of file sacdrv.h.

◆ GENERIC_TAG

#define GENERIC_TAG '?pcR'

Definition at line 137 of file sacdrv.h.

◆ GLOBAL_BLOCK_TAG

#define GLOBAL_BLOCK_TAG 'GpcR'

Definition at line 142 of file sacdrv.h.

◆ GLOBAL_MEMORY_SIGNATURE

#define GLOBAL_MEMORY_SIGNATURE 'DAEH'

Definition at line 145 of file sacdrv.h.

◆ INITIAL_BLOCK_TAG

#define INITIAL_BLOCK_TAG 'IpcR'

Definition at line 139 of file sacdrv.h.

◆ LOCAL_MEMORY_SIGNATURE

#define LOCAL_MEMORY_SIGNATURE 'SSEL'

Definition at line 144 of file sacdrv.h.

◆ MAX_UTF8_ENCODE_BLOCK_LENGTH

#define MAX_UTF8_ENCODE_BLOCK_LENGTH (Utf8ConversionBufferSize / 3 - 1)

Definition at line 160 of file sacdrv.h.

◆ SAC_CELL_FLAG_BLINK

#define SAC_CELL_FLAG_BLINK 1

Definition at line 179 of file sacdrv.h.

◆ SAC_CELL_FLAG_BOLD

#define SAC_CELL_FLAG_BOLD 2

Definition at line 180 of file sacdrv.h.

◆ SAC_CELL_FLAG_INVERTED

#define SAC_CELL_FLAG_INVERTED 4

Definition at line 181 of file sacdrv.h.

◆ SAC_CHANNEL_DESCRIPTION_SIZE

#define SAC_CHANNEL_DESCRIPTION_SIZE 256

Definition at line 153 of file sacdrv.h.

◆ SAC_CHANNEL_FLAG_APPLICATION

#define SAC_CHANNEL_FLAG_APPLICATION 0x20

Definition at line 174 of file sacdrv.h.

◆ SAC_CHANNEL_FLAG_CLOSE_EVENT

#define SAC_CHANNEL_FLAG_CLOSE_EVENT 0x2

Definition at line 170 of file sacdrv.h.

◆ SAC_CHANNEL_FLAG_HAS_NEW_DATA_EVENT

#define SAC_CHANNEL_FLAG_HAS_NEW_DATA_EVENT 0x4

Definition at line 171 of file sacdrv.h.

◆ SAC_CHANNEL_FLAG_INTERNAL

#define SAC_CHANNEL_FLAG_INTERNAL 0x1

Definition at line 169 of file sacdrv.h.

◆ SAC_CHANNEL_FLAG_LOCK_EVENT

#define SAC_CHANNEL_FLAG_LOCK_EVENT 0x8

Definition at line 172 of file sacdrv.h.

◆ SAC_CHANNEL_FLAG_REDRAW_EVENT

#define SAC_CHANNEL_FLAG_REDRAW_EVENT 0x10

Definition at line 173 of file sacdrv.h.

◆ SAC_CHANNEL_NAME_SIZE

#define SAC_CHANNEL_NAME_SIZE 64

Definition at line 152 of file sacdrv.h.

◆ SAC_DBG

#define SAC_DBG	(	x,
		...
	)

Value:

    if (SACDebug & x)                       \
    {                                       \
        DbgPrint("SAC %s: ", __FUNCTION__); \
        DbgPrint(__VA_ARGS__);              \
    }

Definition at line 37 of file sacdrv.h.

◆ SAC_DBG_ENTRY_EXIT

#define SAC_DBG_ENTRY_EXIT 0x01

Definition at line 32 of file sacdrv.h.

◆ SAC_DBG_INIT

#define SAC_DBG_INIT 0x04

Definition at line 34 of file sacdrv.h.

◆ SAC_DBG_MACHINE

#define SAC_DBG_MACHINE 0x2000

Definition at line 36 of file sacdrv.h.

◆ SAC_DBG_MM

#define SAC_DBG_MM 0x1000

Definition at line 35 of file sacdrv.h.

◆ SAC_DBG_UTIL

#define SAC_DBG_UTIL 0x02

Definition at line 33 of file sacdrv.h.

◆ SAC_MAX_CHANNELS

#define SAC_MAX_CHANNELS 10

Definition at line 154 of file sacdrv.h.

◆ SAC_MAX_MESSAGES

#define SAC_MAX_MESSAGES 200

Definition at line 156 of file sacdrv.h.

◆ SAC_MEMORY_LIST_SIZE

#define SAC_MEMORY_LIST_SIZE (1 * 1024 * 1024)

Definition at line 150 of file sacdrv.h.

◆ SAC_OBUFFER_SIZE

#define SAC_OBUFFER_SIZE (2 * 1024)

Definition at line 151 of file sacdrv.h.

◆ SAC_RAW_IBUFFER_SIZE

#define SAC_RAW_IBUFFER_SIZE 0x2000

Definition at line 164 of file sacdrv.h.

◆ SAC_RAW_OBUFFER_SIZE

#define SAC_RAW_OBUFFER_SIZE 0x2000

Definition at line 163 of file sacdrv.h.

◆ SAC_SERIAL_PORT_BUFFER_SIZE

#define SAC_SERIAL_PORT_BUFFER_SIZE 1024

Definition at line 155 of file sacdrv.h.

◆ SAC_VTUTF8_COL_HEIGHT

#define SAC_VTUTF8_COL_HEIGHT 25

Definition at line 158 of file sacdrv.h.

◆ SAC_VTUTF8_COL_WIDTH

#define SAC_VTUTF8_COL_WIDTH 80

Definition at line 157 of file sacdrv.h.

◆ SAC_VTUTF8_IBUFFER_SIZE

#define SAC_VTUTF8_IBUFFER_SIZE 0x2000

Definition at line 162 of file sacdrv.h.

◆ SAC_VTUTF8_OBUFFER_SIZE

#define SAC_VTUTF8_OBUFFER_SIZE 0x2D00

Definition at line 161 of file sacdrv.h.

◆ SAC_VTUTF8_ROW_HEIGHT

#define SAC_VTUTF8_ROW_HEIGHT 24

Definition at line 159 of file sacdrv.h.

◆ SacAllocatePool

#define SacAllocatePool	(	Length,
		Tag
	)	MyAllocatePool(Length, Tag, __FILE__, __LINE__)

Definition at line 24 of file sacdrv.h.

◆ SacFreePool

#define SacFreePool ( Pointer ) MyFreePool((PVOID*)(&Pointer))

Definition at line 26 of file sacdrv.h.

◆ SECURITY_BLOCK_TAG

#define SECURITY_BLOCK_TAG 'SpcR'

Definition at line 140 of file sacdrv.h.

◆ VT_220_BACKTAB

#define VT_220_BACKTAB L"[0Z"

Definition at line 1510 of file sacdrv.h.

◆ VT_ANSI_BACKTAB_CHAR

#define VT_ANSI_BACKTAB_CHAR L'Z'

Definition at line 1509 of file sacdrv.h.

◆ VT_ANSI_COMMAND

#define VT_ANSI_COMMAND L'['

Definition at line 1485 of file sacdrv.h.

◆ VT_ANSI_CUP_CURSOR_CHAR

#define VT_ANSI_CUP_CURSOR_CHAR L'H'

Definition at line 1515 of file sacdrv.h.

◆ VT_ANSI_CURSOR_DOWN

#define VT_ANSI_CURSOR_DOWN L"[B"

Definition at line 1491 of file sacdrv.h.

◆ VT_ANSI_CURSOR_DOWN_CHAR

#define VT_ANSI_CURSOR_DOWN_CHAR L'B'

Definition at line 1490 of file sacdrv.h.

◆ VT_ANSI_CURSOR_LEFT

#define VT_ANSI_CURSOR_LEFT L"[D"

Definition at line 1497 of file sacdrv.h.

◆ VT_ANSI_CURSOR_LEFT_CHAR

#define VT_ANSI_CURSOR_LEFT_CHAR L'D'

Definition at line 1496 of file sacdrv.h.

◆ VT_ANSI_CURSOR_RIGHT

#define VT_ANSI_CURSOR_RIGHT L"[C"

Definition at line 1494 of file sacdrv.h.

◆ VT_ANSI_CURSOR_RIGHT_CHAR

#define VT_ANSI_CURSOR_RIGHT_CHAR L'C'

Definition at line 1493 of file sacdrv.h.

◆ VT_ANSI_CURSOR_UP

#define VT_ANSI_CURSOR_UP L"[A"

Definition at line 1488 of file sacdrv.h.

◆ VT_ANSI_CURSOR_UP_CHAR

#define VT_ANSI_CURSOR_UP_CHAR L'A'

Definition at line 1487 of file sacdrv.h.

◆ VT_ANSI_ERASE_DOWN_SCREEN

#define VT_ANSI_ERASE_DOWN_SCREEN L"[J"

Definition at line 1505 of file sacdrv.h.

◆ VT_ANSI_ERASE_END_LINE

#define VT_ANSI_ERASE_END_LINE L"[K"

Definition at line 1500 of file sacdrv.h.

◆ VT_ANSI_ERASE_ENTIRE_LINE

#define VT_ANSI_ERASE_ENTIRE_LINE L"[2K"

Definition at line 1502 of file sacdrv.h.

◆ VT_ANSI_ERASE_ENTIRE_SCREEN

#define VT_ANSI_ERASE_ENTIRE_SCREEN L"[2J"

Definition at line 1507 of file sacdrv.h.

◆ VT_ANSI_ERASE_LINE_CHAR

#define VT_ANSI_ERASE_LINE_CHAR L'K'

Definition at line 1499 of file sacdrv.h.

◆ VT_ANSI_ERASE_SCREEN_CHAR

#define VT_ANSI_ERASE_SCREEN_CHAR L'J'

Definition at line 1504 of file sacdrv.h.

◆ VT_ANSI_ERASE_START_LINE

#define VT_ANSI_ERASE_START_LINE L"[1K"

Definition at line 1501 of file sacdrv.h.

◆ VT_ANSI_ERASE_UP_SCREEN

#define VT_ANSI_ERASE_UP_SCREEN L"[1J"

Definition at line 1506 of file sacdrv.h.

◆ VT_ANSI_ESCAPE

#define VT_ANSI_ESCAPE L'\x1B'

Definition at line 1484 of file sacdrv.h.

◆ VT_ANSI_HVP_CURSOR_CHAR

#define VT_ANSI_HVP_CURSOR_CHAR L'f'

Definition at line 1514 of file sacdrv.h.

◆ VT_ANSI_SCROLL_CHAR

#define VT_ANSI_SCROLL_CHAR L'r'

Definition at line 1516 of file sacdrv.h.

◆ VT_ANSI_SEPARATOR_CHAR

#define VT_ANSI_SEPARATOR_CHAR L';'

Definition at line 1513 of file sacdrv.h.

◆ VT_ANSI_SET_ATTRIBUTE_CHAR

#define VT_ANSI_SET_ATTRIBUTE_CHAR L'm'

Definition at line 1512 of file sacdrv.h.

Typedef Documentation

◆ PSAC_CELL_DATA

typedef struct _SAC_CELL_DATA * PSAC_CELL_DATA

◆ PSAC_CHANNEL

typedef struct _SAC_CHANNEL * PSAC_CHANNEL

◆ PSAC_CHANNEL_ATTRIBUTES

typedef struct _SAC_CHANNEL_ATTRIBUTES * PSAC_CHANNEL_ATTRIBUTES

◆ PSAC_CHANNEL_CREATE

typedef NTSTATUS(NTAPI * PSAC_CHANNEL_CREATE) (IN struct _SAC_CHANNEL *Channel)

Definition at line 343 of file sacdrv.h.

◆ PSAC_CHANNEL_DESTROY

typedef NTSTATUS(NTAPI * PSAC_CHANNEL_DESTROY) (IN struct _SAC_CHANNEL *Channel)

Definition at line 349 of file sacdrv.h.

◆ PSAC_CHANNEL_IBUFFER_FULL

typedef NTSTATUS(NTAPI * PSAC_CHANNEL_IBUFFER_FULL) (IN struct _SAC_CHANNEL *Channel, OUT PBOOLEAN BufferStatus)

Definition at line 395 of file sacdrv.h.

◆ PSAC_CHANNEL_IBUFFER_LENGTH

typedef ULONG(NTAPI * PSAC_CHANNEL_IBUFFER_LENGTH) (IN struct _SAC_CHANNEL *Channel)

Definition at line 402 of file sacdrv.h.

◆ PSAC_CHANNEL_ID

typedef struct _SAC_CHANNEL_ID * PSAC_CHANNEL_ID

◆ PSAC_CHANNEL_IREAD

typedef NTSTATUS(NTAPI * PSAC_CHANNEL_IREAD) (IN struct _SAC_CHANNEL *Channel, IN PCHAR Buffer, IN ULONG BufferSize, IN PULONG ReturnBufferSize)

Definition at line 386 of file sacdrv.h.

◆ PSAC_CHANNEL_IREAD_LAST

typedef WCHAR(NTAPI * PSAC_CHANNEL_IREAD_LAST) (IN struct _SAC_CHANNEL *Channel)

Definition at line 408 of file sacdrv.h.

◆ PSAC_CHANNEL_IWRITE

typedef NTSTATUS(NTAPI * PSAC_CHANNEL_IWRITE) (IN struct _SAC_CHANNEL *Channel, IN PCHAR Buffer, IN ULONG BufferSize)

Definition at line 414 of file sacdrv.h.

◆ PSAC_CHANNEL_LOCK

typedef struct _SAC_CHANNEL_LOCK * PSAC_CHANNEL_LOCK

◆ PSAC_CHANNEL_OECHO

typedef NTSTATUS(NTAPI * PSAC_CHANNEL_OECHO) (IN struct _SAC_CHANNEL *Channel, IN PCHAR String, IN ULONG Length)

Definition at line 364 of file sacdrv.h.

◆ PSAC_CHANNEL_OFLUSH

typedef NTSTATUS(NTAPI * PSAC_CHANNEL_OFLUSH) (IN struct _SAC_CHANNEL *Channel)

Definition at line 372 of file sacdrv.h.

◆ PSAC_CHANNEL_OREAD

typedef NTSTATUS(NTAPI * PSAC_CHANNEL_OREAD) (IN struct _SAC_CHANNEL *Channel, IN PCHAR Buffer, IN ULONG BufferSize, OUT PULONG ByteCount)

Definition at line 355 of file sacdrv.h.

◆ PSAC_CHANNEL_OWRITE

typedef NTSTATUS(NTAPI * PSAC_CHANNEL_OWRITE) (IN struct _SAC_CHANNEL *Channel, IN PCHAR String, IN ULONG Length)

Definition at line 378 of file sacdrv.h.

◆ PSAC_CHANNEL_STATUS

typedef enum _SAC_CHANNEL_STATUS * PSAC_CHANNEL_STATUS

◆ PSAC_DEVICE_EXTENSION

typedef struct _SAC_DEVICE_EXTENSION * PSAC_DEVICE_EXTENSION

◆ PSAC_MACHINE_INFO

typedef struct _SAC_MACHINE_INFO * PSAC_MACHINE_INFO

◆ PSAC_MEMORY_ENTRY

typedef struct _SAC_MEMORY_ENTRY * PSAC_MEMORY_ENTRY

◆ PSAC_MEMORY_LIST

typedef struct _SAC_MEMORY_LIST * PSAC_MEMORY_LIST

◆ PSAC_MESSAGE_ENTRY

typedef struct _SAC_MESSAGE_ENTRY * PSAC_MESSAGE_ENTRY

◆ PSAC_STATIC_ESCAPE_STRING

typedef struct _SAC_STATIC_ESCAPE_STRING * PSAC_STATIC_ESCAPE_STRING

◆ PSAC_VTUTF8_SCREEN

typedef struct _SAC_VTUTF8_SCREEN * PSAC_VTUTF8_SCREEN

◆ SAC_ANSI_COMMANDS

typedef enum _SAC_ANSI_COMMANDS SAC_ANSI_COMMANDS

◆ SAC_ANSI_DISPATCH

typedef enum _SAC_ANSI_DISPATCH SAC_ANSI_DISPATCH

◆ SAC_CELL_DATA

typedef struct _SAC_CELL_DATA SAC_CELL_DATA

◆ SAC_CHANNEL

typedef struct _SAC_CHANNEL SAC_CHANNEL

◆ SAC_CHANNEL_ATTRIBUTES

typedef struct _SAC_CHANNEL_ATTRIBUTES SAC_CHANNEL_ATTRIBUTES

◆ SAC_CHANNEL_ID

typedef struct _SAC_CHANNEL_ID SAC_CHANNEL_ID

◆ SAC_CHANNEL_LOCK

typedef struct _SAC_CHANNEL_LOCK SAC_CHANNEL_LOCK

◆ SAC_CHANNEL_STATUS

typedef enum _SAC_CHANNEL_STATUS SAC_CHANNEL_STATUS

◆ SAC_CHANNEL_TYPE

typedef enum _SAC_CHANNEL_TYPE SAC_CHANNEL_TYPE

◆ SAC_DEVICE_EXTENSION

typedef struct _SAC_DEVICE_EXTENSION SAC_DEVICE_EXTENSION

◆ SAC_MACHINE_INFO

typedef struct _SAC_MACHINE_INFO SAC_MACHINE_INFO

◆ SAC_MEMORY_ENTRY

typedef struct _SAC_MEMORY_ENTRY SAC_MEMORY_ENTRY

◆ SAC_MEMORY_LIST

typedef struct _SAC_MEMORY_LIST SAC_MEMORY_LIST

◆ SAC_MESSAGE_ENTRY

typedef struct _SAC_MESSAGE_ENTRY SAC_MESSAGE_ENTRY

◆ SAC_POST_COMMANDS

typedef enum _SAC_POST_COMMANDS SAC_POST_COMMANDS

◆ SAC_STATIC_ESCAPE_STRING

typedef struct _SAC_STATIC_ESCAPE_STRING SAC_STATIC_ESCAPE_STRING

◆ SAC_VTUTF8_SCREEN

typedef struct _SAC_VTUTF8_SCREEN SAC_VTUTF8_SCREEN

◆ VT_ANSI_ATTRIBUTES

typedef enum _VT_ANSI_ATTRIBUTES VT_ANSI_ATTRIBUTES

Enumeration Type Documentation

◆ _SAC_ANSI_COMMANDS

enum _SAC_ANSI_COMMANDS

Enumerator
SacCursorUp
SacCursorDown
SacCursorRight
SacCursorLeft
SacFontNormal
SacFontBlink
SacFontBlinkOff
SacFontBold
SacFontBoldOff
SacFontInverse
SacFontInverseOff
SacBackTab
SacEraseEndOfLine
SacEraseStartOfLine
SacEraseLine
SacEraseEndOfScreen
SacEraseStartOfScreen
SacEraseScreen
SacSetCursorPosition
SacSetScrollRegion
SacSetColors
SacSetBackgroundColor
SacSetFontColor
SacSetColorsAndAttributes

Definition at line 214 of file sacdrv.h.

{
    SacCursorUp,
    SacCursorDown,
    SacCursorRight,
    SacCursorLeft,
    SacFontNormal,
    SacFontBlink,
    SacFontBlinkOff,
    SacFontBold,
    SacFontBoldOff,
    SacFontInverse,
    SacFontInverseOff,
    SacBackTab,
    SacEraseEndOfLine,
    SacEraseStartOfLine,
    SacEraseLine,
    SacEraseEndOfScreen,
    SacEraseStartOfScreen,
    SacEraseScreen,
    SacSetCursorPosition,
    SacSetScrollRegion,
    SacSetColors,
    SacSetBackgroundColor,
    SacSetFontColor,
    SacSetColorsAndAttributes
} SAC_ANSI_COMMANDS;

◆ _SAC_ANSI_DISPATCH

enum _SAC_ANSI_DISPATCH

Enumerator
SacAnsiClearScreen
SacAnsiClearEndOfScreen
SacAnsiClearEndOfLine
SacAnsiSetColors
SacAnsiSetPosition
SacAnsiClearAttributes
SacAnsiSetInverseAttribute
SacAnsiClearInverseAttribute
SacAnsiSetBlinkAttribute
SacAnsiClearBlinkAttribute
SacAnsiSetBoldAttribute
SacAnsiClearBoldAttribute

Definition at line 245 of file sacdrv.h.

{
    SacAnsiClearScreen,
    SacAnsiClearEndOfScreen,
    SacAnsiClearEndOfLine,
    SacAnsiSetColors,
    SacAnsiSetPosition,
    SacAnsiClearAttributes,
    SacAnsiSetInverseAttribute,
    SacAnsiClearInverseAttribute,
    SacAnsiSetBlinkAttribute,
    SacAnsiClearBlinkAttribute,
    SacAnsiSetBoldAttribute,
    SacAnsiClearBoldAttribute
} SAC_ANSI_DISPATCH;

◆ _SAC_CHANNEL_STATUS

enum _SAC_CHANNEL_STATUS

Enumerator
Inactive
Active

Definition at line 285 of file sacdrv.h.

{
    Inactive,
    Active
} SAC_CHANNEL_STATUS, *PSAC_CHANNEL_STATUS;

◆ _SAC_CHANNEL_TYPE

enum _SAC_CHANNEL_TYPE

Enumerator
VtUtf8
Cmd
Raw

Definition at line 275 of file sacdrv.h.

{
    VtUtf8,
    Cmd,
    Raw
} SAC_CHANNEL_TYPE;

◆ _SAC_POST_COMMANDS

enum _SAC_POST_COMMANDS

Enumerator
Nothing
Shutdown
Close
Restart

Definition at line 264 of file sacdrv.h.

{
    Nothing,
    Shutdown,
    Close,
    Restart
} SAC_POST_COMMANDS;

◆ _VT_ANSI_ATTRIBUTES

enum _VT_ANSI_ATTRIBUTES

Enumerator
Normal
Bold
Faint
Italic
Underline
SlowBlink
FastBlink
Inverse
Conceal
Strikethrough
PrimaryFont
AlternateFont1
AlternateFont2
AlternateFont3
Alternatefont4
AlternateFont5
AlternateFont6
AlternateFont7
AlternateFont8
AlternateFont9
Fraktur
DoubleUnderline
BoldOff
ItalicOff
UnderlineOff
BlinkOff
Reserved
InverseOff
ConcealOff
StrikethroughOff
SetColorStart
SetColorBlack
SetColorRed
SetColorGreen
SetColorYellow
SetColorBlue
SetcolorMAgent
SetColorCyan
SetColorWhite
SetColorMax
SetColor256
SeTextColorDefault
SetBackColorStart
SetBackColorBlack
SetBackColorRed
SetBackColorGreen
SetBackColorYellow
SetBackColorBlue
SetBackcolorMAgent
SetBackColorCyan
SetBackColorWhite
SetBackColorMax
SetBackColor256
SetBackColorDefault
Reserved1
Framed
Encircled
Overlined
FramedOff
OverlinedOff
Reserved2
Reserved3
Reserved4
Reserved5

Definition at line 1373 of file sacdrv.h.

{
    //
    // Attribute modifiers (mostly supported)
    //
    Normal,
    Bold,
    Faint,
    Italic,
    Underline,
    SlowBlink,
    FastBlink,
    Inverse,
    Conceal,
    Strikethrough,
 
    //
    // Font selectors (not supported)
    //
    PrimaryFont,
    AlternateFont1,
    AlternateFont2,
    AlternateFont3,
    Alternatefont4,
    AlternateFont5,
    AlternateFont6,
    AlternateFont7,
    AlternateFont8,
    AlternateFont9,
 
    //
    // Additional attributes (not supported)
    //
    Fraktur,
    DoubleUnderline,
 
    //
    // Attribute Un-modifiers (mostly supported)
    //
    BoldOff,
    ItalicOff,
    UnderlineOff,
    BlinkOff,
    Reserved,
    InverseOff,
    ConcealOff,
    StrikethroughOff,
 
    //
    // Standard Text Color
    //
    SetColorStart,
    SetColorBlack = SetColorStart,
    SetColorRed,
    SetColorGreen,
    SetColorYellow,
    SetColorBlue,
    SetcolorMAgent,
    SetColorCyan,
    SetColorWhite,
    SetColorMax = SetColorWhite,
 
    //
    // Extended Text Color (not supported)
    //
    SetColor256,
    SeTextColorDefault,
 
    //
    // Standard Background Color
    //
    SetBackColorStart,
    SetBackColorBlack = SetBackColorStart,
    SetBackColorRed,
    SetBackColorGreen,
    SetBackColorYellow,
    SetBackColorBlue,
    SetBackcolorMAgent,
    SetBackColorCyan,
    SetBackColorWhite,
    SetBackColorMax = SetBackColorWhite,
 
    //
    // Extended Background Color (not supported)
    //
    SetBackColor256,
    SetBackColorDefault,
 
    //
    // Extra Attributes (not supported)
    //
    Reserved1,
    Framed,
    Encircled,
    Overlined,
    FramedOff,
    OverlinedOff,
    Reserved2,
    Reserved3,
    Reserved4,
    Reserved5
 
    //
    // Ideograms (not supported)
    //
} VT_ANSI_ATTRIBUTES;

Function Documentation

◆ C_ASSERT()

C_ASSERT ( sizeof(SAC_CELL_DATA) = =6 )

◆ ChanMgrCloseChannel()

NTSTATUS NTAPI ChanMgrCloseChannel ( IN PSAC_CHANNEL Channel )

Definition at line 593 of file chanmgr.c.

{
    NTSTATUS Status;
    CHECK_PARAMETER(Channel);
 
    /* Check if the channel is active */
    if (ChannelIsActive(Channel))
    {
        /* Yep, close it */
        Status = ChannelClose(Channel);
    }
    else
    {
        /* Nothing to do */
        Status = STATUS_ALREADY_DISCONNECTED;
    }
 
    /* Handle the channel close */
    ConMgrHandleEvent(TRUE, Channel, &Status);
    return Status;
}

Referenced by ChanMgrCloseChannelsWithFileObject(), and ConMgrWorkerProcessEvents().

◆ ChanMgrCreateChannel()

NTSTATUS NTAPI ChanMgrCreateChannel	(	OUT PSAC_CHANNEL *	Channel,
		IN PSAC_CHANNEL_ATTRIBUTES	Attributes
	)

Definition at line 345 of file chanmgr.c.

{
    NTSTATUS Status;
    PSAC_CHANNEL NewChannel;
    SAC_CHANNEL_ID ChanId;
    ULONG i;
    CHECK_PARAMETER(Channel);
    CHECK_PARAMETER2(Attributes);
 
    /* No other channel create attempts can happen */
    ChannelLockCreates();
 
    /* Is the channel manager initialized? */
    if (!ChannelCreateEnabled)
    {
        /* Nope, bail out */
        Status = STATUS_UNSUCCESSFUL;
        goto ReturnStatus;
    }
 
    /* Reap any zombie channels */
    Status = ChanMgrReapChannels();
    if (!NT_SUCCESS(Status))
    {
        /* Bail out on error */
        Status = STATUS_UNSUCCESSFUL;
        goto ReturnStatus;
    }
 
    /* Check if we already have a channel with this name */
    if (!ChanMgrIsUniqueName(Attributes->NameBuffer))
    {
        /* We do, fail */
        Status = STATUS_DUPLICATE_NAME;
        goto ReturnStatus;
    }
 
    /* Allocate this channel */
    NewChannel = SacAllocatePool(sizeof(SAC_CHANNEL), CHANNEL_BLOCK_TAG);
    CHECK_PARAMETER_WITH_STATUS(NewChannel, STATUS_NO_MEMORY); // bug
    RtlZeroMemory(NewChannel, sizeof(SAC_CHANNEL));
 
    /* Loop channel slots */
    for (i = 0; i < SAC_MAX_CHANNELS; i++)
    {
        /* Find a free spot for it */
        if (ChannelReaped[i])
        {
            /* Free slot found, attempt to use it */
            ASSERT(!CHANNEL_SLOT_IS_IN_USE(i));
            InterlockedCompareExchangePointer((PVOID*)&ChannelArray[i], NewChannel, NULL);
            if (ChannelArray[i] == NewChannel) break;
        }
    }
 
    /* Did we not find a single free slot? */
    if (i == SAC_MAX_CHANNELS)
    {
        /* Bail out */
        goto ReturnStatus;
    }
 
    /* Create an ID for this channel */
    RtlZeroMemory(&ChanId, sizeof(ChanId));
    Status = ExUuidCreate(&ChanId.ChannelGuid);
    if (!NT_SUCCESS(Status))
    {
        /* Bail out if we couldn't */
        SAC_DBG(SAC_DBG_INIT, "SAC Create Channel :: Failed to get GUID\n");
        goto ReturnStatus;
    }
 
    /* Now create the channel proper */
    Status = ChannelCreate(NewChannel, Attributes, ChanId);
    if (NT_SUCCESS(Status))
    {
        /* Set the channel index */
        _InterlockedExchange(&NewChannel->Index, i);
 
        /* Add the initial reference to the channel */
        ChannelReferenceToOneByIndexWithLock(i);
 
        /* Return it to the caller */
        *Channel = NewChannel;
 
        /* This slot is now occupied */
        ASSERT(ChannelReaped[i] == 1);
        _InterlockedExchange(&ChannelReaped[i], 0);
    }
    else
    {
        /* We couldn't create it, free the buffer */
        SacFreePool(NewChannel);
    }
 
ReturnStatus:
    /* Return whatever the operation status was */
    ChannelUnlockCreates();
    return Status;
}

Referenced by ConMgrInitialize().

◆ ChanMgrGetByHandle()

NTSTATUS NTAPI ChanMgrGetByHandle	(	IN SAC_CHANNEL_ID	ChannelId,
		OUT PSAC_CHANNEL *	TargetChannel
	)

Definition at line 202 of file chanmgr.c.

{
    NTSTATUS Status;
    ULONG i;
    PSAC_CHANNEL Channel;
    CHECK_PARAMETER2(TargetChannel);
 
    /* Assume failure */
    *TargetChannel = NULL;
    Status = STATUS_NOT_FOUND;
 
    /* Loop through all channels */
    for (i = 0; i < SAC_MAX_CHANNELS; i++)
    {
        /* Reference this one and check if it's valid */
        if (ChannelReferenceByIndexWithLock(i) > 0)
        {
            /* All good, grab it */
            Channel = ChannelFromIndex(i);
            ASSERT(Channel != NULL);
 
            /* Check if the channel ID matches */
            if (ChannelIsEqual(Channel, &ChannelId))
            {
                /* We found it, return it (with a reference held) */
                *TargetChannel = Channel;
                return STATUS_SUCCESS;
            }
 
            /* Not the one we want, dereference this one and keep going */
            ChannelDereferenceByIndexWithLock(i);
        }
    }
 
    /* No channels with this ID were found */
    return Status;
}

Referenced by ChanMgrGetByHandleAndFileObject(), ConMgrInitialize(), and ConMgrResetCurrentChannel().

◆ ChanMgrGetNextActiveChannel()

NTSTATUS NTAPI ChanMgrGetNextActiveChannel	(	IN PSAC_CHANNEL	CurrentChannel,
		IN PULONG	TargetIndex,
		OUT PSAC_CHANNEL *	TargetChannel
	)

Definition at line 521 of file chanmgr.c.

{
    NTSTATUS Status;
    ULONG i;
    LONG ChannelIndex, StartIndex;
    PSAC_CHANNEL FoundChannel;
    BOOLEAN ChannelFound;
    CHECK_PARAMETER1(CurrentChannel);
    CHECK_PARAMETER2(TargetIndex);
    CHECK_PARAMETER3(TargetChannel);
 
    /* Get the current channel index */
    Status = ChanMgrGetChannelIndex(CurrentChannel, &ChannelIndex);
    if (!NT_SUCCESS(Status)) return Status;
 
    /* Assume failure */
    ChannelFound = FALSE;
 
    /* Loop through all the possible active channels */
    StartIndex = (ChannelIndex + 1) % SAC_MAX_CHANNELS;
    for (i = StartIndex; i != StartIndex; i = (i + 1) % SAC_MAX_CHANNELS)
    {
        /* Get the channel and see if it exists*/
        Status = ChanMgrGetByIndex(i, &FoundChannel);
        if (Status != STATUS_NOT_FOUND)
        {
            /* Bail out if we failed for some reason */
            if (!NT_SUCCESS(Status)) return Status;
 
            /* It exists -- is it active? Or, does it have output data? */
            if ((ChannelIsActive(FoundChannel)) ||
                (!(ChannelIsActive(FoundChannel)) &&
                  (FoundChannel->ChannelHasNewOBufferData)))
            {
                /* It's active or has output data, return with it */
                ChannelFound = TRUE;
                break;
            }
 
            /* Drop the reference on this channel and try the next one */
            Status = ChanMgrReleaseChannel(FoundChannel);
            if (!NT_SUCCESS(Status)) return Status;
        }
    }
 
    /* Check if we successfully found a channel */
    if ((NT_SUCCESS(Status)) && (ChannelFound))
    {
        /* Return it and its indexed. Remember we still hold the reference */
        *TargetIndex = i;
        *TargetChannel = FoundChannel;
    }
 
    /* All done */
    return Status;
}

Referenced by ConMgrAdvanceCurrentChannel().

◆ ChanMgrInitialize()

NTSTATUS NTAPI ChanMgrInitialize ( VOID )

Definition at line 118 of file chanmgr.c.

{
    ULONG i;
 
    /* Initialize the channel lock */
    SacInitializeLock(&ChannelCreateLock);
    ChannelCreateEnabled = TRUE;
 
    /* Loop through the channel arrays */
    for (i = 0; i < SAC_MAX_CHANNELS; i++)
    {
        /* Clear and initialize their locks */
        ChannelArray[i] = NULL;
        SacInitializeLock(&ChannelSlotLock[i]);
 
        /* Clear their statuses and reference counts */
        _InterlockedExchange(&ChannelRefCount[i], 0);
        _InterlockedExchange(&ChannelReaped[i], 1);
    }
 
    /* All good */
    return STATUS_SUCCESS;
}

Referenced by InitializeGlobalData().

◆ ChanMgrReleaseChannel()

NTSTATUS NTAPI ChanMgrReleaseChannel ( IN PSAC_CHANNEL Channel )

Definition at line 243 of file chanmgr.c.

{
    LONG Index;
    ULONG RefCount;
    PSAC_CHANNEL ThisChannel;
    CHECK_PARAMETER(Channel);
 
    /* Get the index of the channel */
    Index = ChannelGetIndex(Channel);
 
    /* Drop a reference -- there should still be at least the keepalive left */
    ChannelSlotLock(Index);
    RefCount = ChannelDereferenceByIndex(Index);
    ASSERT(RefCount > 0);
 
    /* Do we only have the keep-alive left, and the channel is dead? */
    if ((RefCount == 1) && !(ChannelIsActive(Channel)))
    {
        /* Check if the ??? flag is set, or if there's no output data */
        ThisChannel = ChannelFromIndex(Index);
        if (!(ThisChannel->Flags & 1))
        {
            /* Nope, we can wipe the references and get rid of it */
            ChannelDereferenceToZeroByIndex(Index);
        }
        else if (!ThisChannel->ChannelHasNewOBufferData)
        {
            /* No data, we can wipe the references and get rid of it */
            ChannelDereferenceToZeroByIndex(Index);
        }
    }
 
    /* We're done, we can unlock the slot now */
    ChannelSlotUnlock(Index);
    return STATUS_SUCCESS;
}

Referenced by ChanMgrCloseChannelsWithFileObject(), ChanMgrGetByHandleAndFileObject(), ChanMgrGetChannelCount(), ChanMgrGetNextActiveChannel(), ChanMgrIsUniqueName(), ConMgrSetCurrentChannel(), ConMgrShutdown(), and ConMgrWorkerProcessEvents().

◆ ChanMgrShutdown()

NTSTATUS NTAPI ChanMgrShutdown ( VOID )

Definition at line 144 of file chanmgr.c.

{
    /* FIXME: TODO */
    return STATUS_NOT_IMPLEMENTED;
}

Referenced by FreeGlobalData().

◆ ChannelClearRedrawEvent()

NTSTATUS NTAPI ChannelClearRedrawEvent ( IN PSAC_CHANNEL Channel )

Definition at line 198 of file channel.c.

{
    NTSTATUS Status;
 
    /* Clear the event */
    ChannelClearEvent(Channel, RedrawEvent);
    return Status;
}

Referenced by ConMgrSetCurrentChannel().

◆ ChannelClose()

NTSTATUS NTAPI ChannelClose ( IN PSAC_CHANNEL Channel )

Definition at line 558 of file channel.c.

{
    NTSTATUS Status;
    CHECK_PARAMETER(Channel);
 
    /* Set the channel inactive */
    ChannelSetStatus(Channel, Inactive);
 
    /* Set the close event */
    if (Channel->Flags & SAC_CHANNEL_FLAG_CLOSE_EVENT)
    {
        ChannelSetEvent(Channel, CloseEvent);
    }
 
    /* Close all the handles */
    Status = ChannelDereferenceHandles(Channel);
    return Status;
}

Referenced by ChanMgrCloseChannel(), and ConMgrShutdown().

◆ ChannelCreate()

NTSTATUS NTAPI ChannelCreate	(	IN PSAC_CHANNEL	Channel,
		IN PSAC_CHANNEL_ATTRIBUTES	Attributes,
		IN SAC_CHANNEL_ID	ChannelId
	)

Definition at line 457 of file channel.c.

{
    NTSTATUS Status;
    CHECK_PARAMETER1(Channel);
    CHECK_PARAMETER2(Attributes);
 
    /* If a close event is being passed in, it must exist, and vice-versa */
    if (Attributes->Flag & SAC_CHANNEL_FLAG_CLOSE_EVENT)
    {
        CHECK_PARAMETER(Attributes->CloseEvent != NULL);
    }
    else
    {
        CHECK_PARAMETER(Attributes->CloseEvent == NULL);
    }
 
    /* If a new data event is being passed in, it must exist, and vice-versa */
    if (Attributes->Flag & SAC_CHANNEL_FLAG_HAS_NEW_DATA_EVENT)
    {
        CHECK_PARAMETER(Attributes->HasNewDataEvent != NULL);
    }
    else
    {
        CHECK_PARAMETER(Attributes->HasNewDataEvent == NULL);
    }
 
    /* If a lock event is being passed in, it must exist, and vice-versa */
    if (Attributes->Flag & SAC_CHANNEL_FLAG_LOCK_EVENT)
    {
        CHECK_PARAMETER(Attributes->LockEvent != NULL);
    }
    else
    {
        CHECK_PARAMETER(Attributes->LockEvent == NULL);
    }
 
    /* If a redraw event is being passed in, it must exist, and vice-versa */
    if (Attributes->Flag & SAC_CHANNEL_FLAG_REDRAW_EVENT)
    {
        CHECK_PARAMETER(Attributes->RedrawEvent != NULL);
    }
    else
    {
        CHECK_PARAMETER(Attributes->RedrawEvent == NULL);
    }
 
    /* Initialize the channel structure */
    RtlZeroMemory(Channel, sizeof(SAC_CHANNEL));
    Channel->ChannelId = ChannelId;
    Channel->ChannelType = Attributes->ChannelType;
    Channel->Flags = Attributes->Flag;
    if (Attributes->Flag & SAC_CHANNEL_FLAG_APPLICATION)
    {
        Channel->ApplicationType = Attributes->ChannelId;
    }
 
    /* Initialize all the locks and events */
    SacInitializeLock(&Channel->ChannelAttributeLock);
    SacInitializeLock(&Channel->ChannelOBufferLock);
    SacInitializeLock(&Channel->ChannelIBufferLock);
    ChannelInitializeEvent(Channel, Attributes, CloseEvent);
    ChannelInitializeEvent(Channel, Attributes, HasNewDataEvent);
    ChannelInitializeEvent(Channel, Attributes, LockEvent);
    ChannelInitializeEvent(Channel, Attributes, RedrawEvent);
 
    /* Set the name and description */
    ChannelSetName(Channel, Attributes->NameBuffer);
    ChannelSetDescription(Channel, Attributes->DescriptionBuffer);
 
    /* Initialize the function table for the type of channel this is */
    Status = ChannelInitializeVTable(Channel);
    if (!NT_SUCCESS(Status))
    {
        /* This is critical */
        SAC_DBG(SAC_DBG_INIT, "SAC Create Channel :: Failed to initialize vtable\n");
        goto FailChannel;
    }
 
    /* Now call the channel specific type constructor */
    Status = Channel->ChannelCreate(Channel);
    if (!NT_SUCCESS(Status))
    {
        /* This is critical */
        SAC_DBG(SAC_DBG_INIT, "SAC Create Channel :: Failed channel specific initialization\n");
        goto FailChannel;
    }
 
    /* Finally, mark the channel as active */
    ChannelSetStatus(Channel, Active);
    return STATUS_SUCCESS;
 
FailChannel:
    /* Destroy the channel and return the failure code */
    Channel->ChannelDestroy(Channel);
    return Status;
}

Referenced by ChanMgrCreateChannel().

◆ ChannelDestroy()

NTSTATUS NTAPI ChannelDestroy ( IN PSAC_CHANNEL Channel )

Definition at line 77 of file channel.c.

{
    CHECK_PARAMETER(Channel);
 
    /* Same thing as dereferencing all the handles */
    return ChannelDereferenceHandles(Channel);
}

Referenced by RawChannelDestroy(), and VTUTF8ChannelDestroy().

◆ ChannelGetFlags()

FORCEINLINE ULONG ChannelGetFlags ( IN PSAC_CHANNEL Channel )

Definition at line 1346 of file sacdrv.h.

{
    return Channel->Flags;
}

◆ ChannelGetIndex()

FORCEINLINE LONG ChannelGetIndex ( IN PSAC_CHANNEL Channel )

Definition at line 1353 of file sacdrv.h.

{
    /* Return the index of the channel */
    return Channel->Index;
}

Referenced by ChanMgrGetChannelIndex(), and ChanMgrReleaseChannel().

◆ ChannelGetName()

NTSTATUS NTAPI ChannelGetName	(	IN PSAC_CHANNEL	Channel,
		OUT PWCHAR *	Name
	)

Definition at line 297 of file channel.c.

{
    CHECK_PARAMETER1(Channel);
    CHECK_PARAMETER2(Name);
 
    /* Allocate space to hold the name */
    *Name = SacAllocatePool(sizeof(Channel->NameBuffer), GLOBAL_BLOCK_TAG);
    CHECK_ALLOCATION(*Name);
 
    /* Lock the attributes while we copy the name */
    ChannelLockAttributes(Channel);
 
    /* Copy the name and null-terminate it */
    ASSERT(((wcslen(Channel->NameBuffer) + 1) * sizeof(WCHAR)) <= ((SAC_CHANNEL_NAME_SIZE + 1) * sizeof(WCHAR)));
    wcsncpy(*Name, Channel->NameBuffer, RTL_NUMBER_OF(Channel->NameBuffer)); // bug
    (*Name)[SAC_CHANNEL_NAME_SIZE] = UNICODE_NULL;
 
    /* Release the lock and return */
    ChannelUnlockAttributes(Channel);
    return STATUS_SUCCESS;
}

Referenced by ChanMgrGetChannelByName().

◆ ChannelHasNewIBufferData()

FORCEINLINE BOOLEAN ChannelHasNewIBufferData ( IN PSAC_CHANNEL Channel )

Definition at line 1361 of file sacdrv.h.

{
    /* Return if there's any new data in the input buffer */
    return Channel->ChannelHasNewIBufferData;
}

Referenced by ChanMgrReapChannels(), RawChannelIRead(), and VTUTF8ChannelIRead().

◆ ChannelHasRedrawEvent()

NTSTATUS NTAPI ChannelHasRedrawEvent	(	IN PSAC_CHANNEL	Channel,
		OUT PBOOLEAN	Present
	)

Definition at line 209 of file channel.c.

{
    CHECK_PARAMETER1(Channel);
    CHECK_PARAMETER2(Present);
 
    /* Return if the flag is set */
    *Present = Channel->Flags & SAC_CHANNEL_FLAG_REDRAW_EVENT;
    return STATUS_SUCCESS;
}

Referenced by ConMgrDisplayCurrentChannel(), and ConMgrSetCurrentChannel().

◆ ChannelIBufferLength()

ULONG NTAPI ChannelIBufferLength ( IN PSAC_CHANNEL Channel )

Definition at line 163 of file channel.c.

{
    ULONG Length;
 
    /* Get the input buffer length while holding the lock */
    ChannelLockOBuffer(Channel);
    Length = Channel->ChannelInputBufferLength(Channel);
    ChannelUnlockOBuffer(Channel);
    return Length;
}

Referenced by ConMgrSerialPortConsumer().

◆ ChannelIRead()

NTSTATUS NTAPI ChannelIRead	(	IN PSAC_CHANNEL	Channel,
		IN PCHAR	Buffer,
		IN ULONG	BufferSize,
		IN OUT PULONG	ResultBufferSize
	)

Definition at line 131 of file channel.c.

{
    NTSTATUS Status;
 
    /* Read the input buffer while holding the lock */
    ChannelLockIBuffer(Channel);
    Status = Channel->ChannelInputRead(Channel,
                                       Buffer,
                                       BufferSize,
                                       ResultBufferSize);
    ChannelUnlockIBuffer(Channel);
    return Status;
}

Referenced by ConMgrSerialPortConsumer().

◆ ChannelIReadLast()

WCHAR NTAPI ChannelIReadLast ( IN PSAC_CHANNEL Channel )

Definition at line 150 of file channel.c.

{
    WCHAR LastChar;
 
    /* Read the last character while holding the lock */
    ChannelLockIBuffer(Channel);
    LastChar = Channel->ChannelInputReadLast(Channel);
    ChannelUnlockIBuffer(Channel);
    return LastChar;
}

Referenced by ConMgrSerialPortConsumer().

◆ ChannelIsActive()

BOOLEAN NTAPI ChannelIsActive ( IN PSAC_CHANNEL Channel )

Definition at line 250 of file channel.c.

{
    SAC_CHANNEL_STATUS ChannelStatus;
    BOOLEAN IsActive;
 
    /* Get the status */
    if (!NT_SUCCESS(ChannelGetStatus(Channel, &ChannelStatus)))
    {
        /* We couldn't even do that, assume it's inactive */
        IsActive = FALSE;
    }
    else
    {
        /* Check if the status shows activity */
        IsActive = (ChannelStatus == Active);
    }
 
    /* Return the state */
    return IsActive;
}

Referenced by ChanMgrCloseChannel(), ChanMgrGetChannelCount(), ChanMgrGetNextActiveChannel(), ChanMgrReleaseChannel(), and ChannelDereferenceToZeroByIndex().

◆ ChannelIsEqual()

BOOLEAN NTAPI ChannelIsEqual	(	IN PSAC_CHANNEL	Channel,
		IN PSAC_CHANNEL_ID	ChannelId
	)

Definition at line 25 of file channel.c.

{
    /* Check if the GUIDs match */
    return IsEqualGUIDAligned(&Channel->ChannelId.ChannelGuid,
                              &ChannelId->ChannelGuid);
}

Referenced by ChanMgrGetByHandle(), and ConMgrIsWriteEnabled().

◆ ChannelIWrite()

NTSTATUS NTAPI ChannelIWrite	(	IN PSAC_CHANNEL	Channel,
		IN PCHAR	Buffer,
		IN ULONG	BufferSize
	)

Definition at line 116 of file channel.c.

{
    NTSTATUS Status;
 
    /* Write into the input buffer while holding the lock */
    ChannelLockIBuffer(Channel);
    Status = Channel->ChannelInputWrite(Channel, Buffer, BufferSize);
    ChannelUnlockIBuffer(Channel);
    return Status;
}

Referenced by ConMgrSerialPortConsumer().

◆ ChannelOFlush()

NTSTATUS NTAPI ChannelOFlush ( IN PSAC_CHANNEL Channel )

Definition at line 103 of file channel.c.

{
    NTSTATUS Status;
 
    /* While holding the output lock, flush to the output buffer */
    ChannelLockOBuffer(Channel);
    Status = Channel->ChannelOutputFlush(Channel);
    ChannelUnlockOBuffer(Channel);
    return Status;
}

Referenced by ConMgrDisplayCurrentChannel().

◆ ChannelOWrite()

NTSTATUS NTAPI ChannelOWrite	(	IN PSAC_CHANNEL	Channel,
		IN PCHAR	Buffer,
		IN ULONG	BufferSize
	)

Definition at line 87 of file channel.c.

{
    NTSTATUS Status;
    CHECK_PARAMETER3(BufferSize < SAC_OBUFFER_SIZE);
 
    /* While holding the output lock, write to the output buffer */
    ChannelLockOBuffer(Channel);
    Status = Channel->ChannelOutputWrite(Channel, Buffer, BufferSize);
    ChannelUnlockOBuffer(Channel);
    return Status;
}

Referenced by SacPutString().

◆ ChannelSetRedrawEvent()

NTSTATUS NTAPI ChannelSetRedrawEvent ( IN PSAC_CHANNEL Channel )

Definition at line 176 of file channel.c.

{
    NTSTATUS Status;
 
    /* Set the event */
    ChannelSetEvent(Channel, RedrawEvent);
    return Status;
}

Referenced by ConMgrDisplayCurrentChannel().

◆ ConMgrFlushData()

NTSTATUS NTAPI ConMgrFlushData ( IN PSAC_CHANNEL Channel )

Definition at line 139 of file conmgr.c.

{
    /* Nothing to do */
    return STATUS_SUCCESS;
}

Referenced by RawChannelOEcho(), RawChannelOFlush(), VTUTF8ChannelAnsiDispatch(), VTUTF8ChannelOEcho(), and VTUTF8ChannelOFlush().

◆ ConMgrHandleEvent()

NTSTATUS NTAPI ConMgrHandleEvent	(	IN ULONG	EventCode,
		IN PSAC_CHANNEL	Channel,
		OUT PVOID	Data
	)

Definition at line 888 of file conmgr.c.

{
    ASSERT(FALSE);
    return STATUS_NOT_IMPLEMENTED;
}

Referenced by ChanMgrCloseChannel().

◆ ConMgrInitialize()

NTSTATUS NTAPI ConMgrInitialize ( VOID )

Definition at line 163 of file conmgr.c.

{
    PWCHAR pcwch;
    PSAC_CHANNEL FoundChannel;
    SAC_CHANNEL_ATTRIBUTES SacChannelAttributes;
    NTSTATUS Status;
 
    /* Initialize the connection manager lock */
    SacInitializeMutexLock();
    SacAcquireMutexLock();
 
    /* Setup the attributes for the raw SAC channel */
    RtlZeroMemory(&SacChannelAttributes, sizeof(SacChannelAttributes));
    SacChannelAttributes.ChannelType = VtUtf8;
 
    /* Get the right name for it */
    pcwch = GetMessage(SAC_CHANNEL_NAME);
    ASSERT(pcwch);
    wcsncpy(SacChannelAttributes.NameBuffer, pcwch, SAC_CHANNEL_NAME_SIZE);
    SacChannelAttributes.NameBuffer[SAC_CHANNEL_NAME_SIZE] = ANSI_NULL;
 
    /* Get the right description for it */
    pcwch = GetMessage(SAC_CHANNEL_DESCRIPTION);
    ASSERT(pcwch);
    wcsncpy(SacChannelAttributes.DescriptionBuffer, pcwch, SAC_CHANNEL_DESCRIPTION_SIZE);
    SacChannelAttributes.DescriptionBuffer[SAC_CHANNEL_DESCRIPTION_SIZE] = ANSI_NULL;
 
    /* Set all the right flags */
    SacChannelAttributes.Flag = SAC_CHANNEL_FLAG_APPLICATION | SAC_CHANNEL_FLAG_INTERNAL;
    SacChannelAttributes.CloseEvent = NULL;
    SacChannelAttributes.HasNewDataEvent = NULL;
    SacChannelAttributes.LockEvent = NULL;
    SacChannelAttributes.RedrawEvent = NULL;
    SacChannelAttributes.ChannelId = PRIMARY_SAC_CHANNEL_APPLICATION_GUID;
 
    /* Now create it */
    Status = ChanMgrCreateChannel(&SacChannel, &SacChannelAttributes);
    if (NT_SUCCESS(Status))
    {
        /* Try to get it back */
        Status = ChanMgrGetByHandle(SacChannel->ChannelId, &FoundChannel);
        if (NT_SUCCESS(Status))
        {
            /* Set it as the current and SAC channel */
            SacChannel = CurrentChannel = FoundChannel;
 
            /* Disable writes for now and clear the display */
            _InterlockedExchange(&FoundChannel->WriteEnabled, FALSE);
            Status = HeadlessDispatch(HeadlessCmdClearDisplay, NULL, 0, NULL, NULL);
            if (!NT_SUCCESS(Status))
            {
                SAC_DBG(SAC_DBG_INIT, "SAC ConMgrInitialize: Failed dispatch\n");
            }
 
            /* Display the initial prompt */
            SacPutSimpleMessage(SAC_NEWLINE);
            SacPutSimpleMessage(SAC_INIT_STATUS);
            SacPutSimpleMessage(SAC_NEWLINE);
            SacPutSimpleMessage(SAC_PROMPT);
 
            /* Display the current channel */
            ConMgrDisplayCurrentChannel();
        }
    }
 
    /* Release the channel lock */
    SacReleaseMutexLock();
    return STATUS_SUCCESS;
}

Referenced by InitializeDeviceData().

◆ ConMgrIsWriteEnabled()

BOOLEAN NTAPI ConMgrIsWriteEnabled ( IN PSAC_CHANNEL Channel )

Definition at line 155 of file conmgr.c.

{
    /* If the current channel is active, allow writes */
    return ChannelIsEqual(Channel, &CurrentChannel->ChannelId);
}

Referenced by ConMgrChannelClose(), RawChannelOWrite(), and VTUTF8ChannelOWrite().

◆ ConMgrShutdown()

NTSTATUS NTAPI ConMgrShutdown ( VOID )

Definition at line 372 of file conmgr.c.

{
    NTSTATUS Status;
 
    /* Check if we have a SAC channel */
    if (SacChannel)
    {
        /* Close it */
        Status = ChannelClose(SacChannel);
        if (!NT_SUCCESS(Status))
        {
            SAC_DBG(SAC_DBG_INIT, "SAC ConMgrShutdown: failed closing SAC channel.\n");
        }
 
        /* No longer have one */
        SacChannel = NULL;
    }
 
    /* Check if we have a current channel */
    if (CurrentChannel)
    {
        /* Release it */
        Status = ChanMgrReleaseChannel(CurrentChannel);
        if (!NT_SUCCESS(Status))
        {
            SAC_DBG(SAC_DBG_INIT, "SAC ConMgrShutdown: failed releasing current channel\n");
        }
 
        /* No longer have one */
        CurrentChannel = NULL;
    }
 
    /* All done */
    return STATUS_SUCCESS;
}

Referenced by FreeGlobalData().

◆ ConMgrSimpleEventMessage()

BOOLEAN NTAPI ConMgrSimpleEventMessage	(	IN ULONG	MessageIndex,
		IN BOOLEAN	LockHeld
	)

Definition at line 252 of file conmgr.c.

{
    PWCHAR MessageBuffer;
    BOOLEAN Result;
 
    /* Get the message to send out */
    MessageBuffer = GetMessage(MessageIndex);
    if (MessageBuffer)
    {
        /* Send it */
        ConMgrEventMessage(MessageBuffer, LockHeld);
        Result = TRUE;
    }
    else
    {
        /* It doesn't exist, fail */
        Result = FALSE;
    }
 
    /* Return if the message was sent or not */
    return Result;
}

Referenced by DoRebootCommand().

◆ ConMgrWorkerProcessEvents()

VOID NTAPI ConMgrWorkerProcessEvents ( IN PSAC_DEVICE_EXTENSION DeviceExtension )

Definition at line 835 of file conmgr.c.

{
    SAC_DBG(SAC_DBG_ENTRY_EXIT, "SAC WorkerProcessEvents: Entering.\n");
 
    /* Enter the main loop */
    while (TRUE)
    {
        /* Wait for something to do */
        KeWaitForSingleObject(&DeviceExtension->Event,
                              Executive,
                              KernelMode,
                              FALSE,
                              NULL);
 
        /* Consume data off the serial port */
        ConMgrSerialPortConsumer();
        switch (ExecutePostConsumerCommand)
        {
            case Restart:
                /* A reboot was sent, do it  */
                DoRebootCommand(FALSE);
                break;
 
            case Close:
                /* A close was sent, do it */
                ChanMgrCloseChannel(ExecutePostConsumerCommandData);
                ChanMgrReleaseChannel(ExecutePostConsumerCommandData);
                break;
 
            case Shutdown:
                /* A shutdown was sent, do it */
                DoRebootCommand(TRUE);
                break;
        }
 
        /* Clear the serial port consumer state */
        ExecutePostConsumerCommand = Nothing;
        ExecutePostConsumerCommandData = NULL;
    }
}

Referenced by WorkerProcessEvents().

◆ ConMgrWriteData()

NTSTATUS NTAPI ConMgrWriteData	(	IN PSAC_CHANNEL	Channel,
		IN PVOID	Buffer,
		IN ULONG	BufferLength
	)

Definition at line 111 of file conmgr.c.

{
    ULONG i;
    NTSTATUS Status;
    LARGE_INTEGER Interval;
 
    /* Loop up to 32 times */
    for (i = 0; i < 32; i++)
    {
        /* Attempt sending the data */
        Status = HeadlessDispatch(HeadlessCmdPutData, Buffer, BufferLength, NULL, NULL);
        if (Status != STATUS_UNSUCCESSFUL) break;
 
        /* Sending the data on the port failed, wait a second... */
        Interval.HighPart = -1;
        Interval.LowPart = -100000;
        KeDelayExecutionThread(KernelMode, FALSE, &Interval);
    }
 
    /* After 32 attempts it should really have worked... */
    ASSERT(NT_SUCCESS(Status));
    return Status;
}

Referenced by RawChannelOEcho(), RawChannelOFlush(), VTUTF8ChannelAnsiDispatch(), VTUTF8ChannelOEcho(), and VTUTF8ChannelOFlush().

◆ Dispatch()

NTSTATUS NTAPI Dispatch	(	IN PDEVICE_OBJECT	DeviceObject,
		IN PIRP	Irp
	)

Definition at line 53 of file dispatch.c.

{
    return STATUS_NOT_IMPLEMENTED;
}

◆ DispatchDeviceControl()

NTSTATUS NTAPI DispatchDeviceControl	(	IN PDEVICE_OBJECT	DeviceObject,
		IN PIRP	Irp
	)

Definition at line 21 of file dispatch.c.

{
    return STATUS_NOT_IMPLEMENTED;
}

Referenced by DriverEntry().

◆ DispatchShutdownControl()

NTSTATUS NTAPI DispatchShutdownControl	(	IN PDEVICE_OBJECT	DeviceObject,
		IN PIRP	Irp
	)

Definition at line 29 of file dispatch.c.

{
    return STATUS_NOT_IMPLEMENTED;
}

Referenced by DriverEntry().

◆ DoChannelCommand()

VOID NTAPI DoChannelCommand ( IN PCHAR ChannelString )

Definition at line 484 of file concmd.c.

{
    SAC_DBG(SAC_DBG_ENTRY_EXIT, "Entering\n");
}

Referenced by ConMgrProcessInputLine().

◆ DoCmdCommand()

VOID NTAPI DoCmdCommand ( IN PCHAR InputString )

Definition at line 491 of file concmd.c.

{
    SAC_DBG(SAC_DBG_ENTRY_EXIT, "Entering\n");
}

Referenced by ConMgrProcessInputLine().

◆ DoCrashCommand()

VOID NTAPI DoCrashCommand ( VOID )

Definition at line 466 of file concmd.c.

{
    SAC_DBG(SAC_DBG_ENTRY_EXIT, "SAC DoCrashCommand: Entering.\n");
 
    /* Crash the machine */
    KeBugCheckEx(MANUALLY_INITIATED_CRASH, 0, 0, 0, 0);
    __debugbreak();
}

Referenced by ConMgrProcessInputLine().

◆ DoFullInfoCommand()

VOID NTAPI DoFullInfoCommand ( VOID )

Definition at line 409 of file concmd.c.

{
    /* Flip the flag */
    GlobalDoThreads = !GlobalDoThreads;
 
    /* Print out the new state */
    SacPutSimpleMessage(GlobalDoThreads ? 8 : 7);
}

Referenced by ConMgrProcessInputLine().

◆ DoGetNetInfo()

VOID NTAPI DoGetNetInfo ( IN BOOLEAN DoPrint )

Definition at line 557 of file concmd.c.

{
    SAC_DBG(SAC_DBG_ENTRY_EXIT, "Entering\n");
}

◆ DoHelpCommand()

VOID NTAPI DoHelpCommand ( VOID )

Definition at line 529 of file concmd.c.

{
    ULONG Count = 0;
 
    /* Print out all the help messages */
    if (!PrintHelpMessage(112, &Count)) return;
    if (!PrintHelpMessage(12, &Count)) return;
    if (!PrintHelpMessage(13, &Count)) return;
    if (!PrintHelpMessage(14, &Count)) return;
    if (!PrintHelpMessage(15, &Count)) return;
    if (!PrintHelpMessage(16, &Count)) return;
    if (!PrintHelpMessage(31, &Count)) return;
    if (!PrintHelpMessage(18, &Count)) return;
    if (!PrintHelpMessage(19, &Count)) return;
    if (!PrintHelpMessage(32, &Count)) return;
    if (!PrintHelpMessage(20, &Count)) return;
    if (!PrintHelpMessage(21, &Count)) return;
    if (!PrintHelpMessage(22, &Count)) return;
    if (!PrintHelpMessage(23, &Count)) return;
    if (!PrintHelpMessage(24, &Count)) return;
    if (!PrintHelpMessage(25, &Count)) return;
    if (!PrintHelpMessage(27, &Count)) return;
    if (!PrintHelpMessage(28, &Count)) return;
    if (!PrintHelpMessage(29, &Count)) return;
}

Referenced by ConMgrProcessInputLine().

◆ DoKillCommand()

VOID NTAPI DoKillCommand ( IN PCHAR KillString )

Definition at line 438 of file concmd.c.

{
    SAC_DBG(SAC_DBG_ENTRY_EXIT, "Entering\n");
}

Referenced by ConMgrProcessInputLine().

◆ DoLimitMemoryCommand()

VOID NTAPI DoLimitMemoryCommand ( IN PCHAR LimitString )

Definition at line 459 of file concmd.c.

{
    SAC_DBG(SAC_DBG_ENTRY_EXIT, "Entering\n");
}

Referenced by ConMgrProcessInputLine().

◆ DoLockCommand()

VOID NTAPI DoLockCommand ( VOID )

Definition at line 498 of file concmd.c.

{
    SAC_DBG(SAC_DBG_ENTRY_EXIT, "Entering\n");
}

Referenced by ConMgrProcessInputLine().

◆ DoLowerPriorityCommand()

VOID NTAPI DoLowerPriorityCommand ( IN PCHAR PrioString )

Definition at line 445 of file concmd.c.

{
    SAC_DBG(SAC_DBG_ENTRY_EXIT, "Entering\n");
}

Referenced by ConMgrProcessInputLine().

◆ DoMachineInformationCommand()

VOID NTAPI DoMachineInformationCommand ( VOID )

Definition at line 477 of file concmd.c.

{
    SAC_DBG(SAC_DBG_ENTRY_EXIT, "Entering\n");
}

Referenced by ConMgrProcessInputLine().

◆ DoPagingCommand()

VOID NTAPI DoPagingCommand ( VOID )

Definition at line 420 of file concmd.c.

{
    /* Flip the flag */
    GlobalPagingNeeded = !GlobalPagingNeeded;
 
    /* Print out the new state */
    SacPutSimpleMessage(GlobalPagingNeeded ? 10 : 9);
}

Referenced by ConMgrProcessInputLine().

◆ DoRaisePriorityCommand()

VOID NTAPI DoRaisePriorityCommand ( IN PCHAR PrioString )

Definition at line 452 of file concmd.c.

{
    SAC_DBG(SAC_DBG_ENTRY_EXIT, "Entering\n");
}

Referenced by ConMgrProcessInputLine().

◆ DoRebootCommand()

VOID NTAPI DoRebootCommand ( IN BOOLEAN Reboot )

Definition at line 355 of file concmd.c.

{
    LARGE_INTEGER Timeout, TickCount;
    NTSTATUS Status;
    KEVENT Event;
    SAC_DBG(SAC_DBG_ENTRY_EXIT, "SAC DoRebootCommand: Entering.\n");
 
    /* Get the current time now, and setup a timeout in 1 second */
    KeQueryTickCount(&TickCount);
    Timeout.QuadPart = TickCount.QuadPart / (10000000 / KeQueryTimeIncrement());
 
    /* Check if the timeout is small enough */
    if (Timeout.QuadPart < 60 )
    {
        /* Show the prompt */
        ConMgrSimpleEventMessage(Reboot ?
                                 SAC_RESTART_PROMPT : SAC_SHUTDOWN_PROMPT,
                                 TRUE);
 
        /* Do the wait */
        KeInitializeEvent(&Event, SynchronizationEvent, 0);
        Timeout.QuadPart = -10000000 * (60 - Timeout.LowPart);
        KeWaitForSingleObject(&Event, Executive, KernelMode, FALSE, &Timeout);
    }
 
    /* Do a shutdown or a reboot, based on the request */
    Status = NtShutdownSystem(Reboot ? ShutdownReboot : ShutdownPowerOff);
 
    /* Check if anyone in the command channel already allocated this */
    if (!GlobalBuffer)
    {
        /* Allocate it */
        GlobalBuffer = SacAllocatePool(PAGE_SIZE, GLOBAL_BLOCK_TAG);
        if (!GlobalBuffer)
        {
            /* We need the global buffer, bail out without it*/
            SacPutSimpleMessage(SAC_OUT_OF_MEMORY_PROMPT);
            SAC_DBG(SAC_DBG_ENTRY_EXIT, "SAC DoRebootCommand: Exiting (1).\n");
            return;
        }
 
        /* Set the size of the buffer */
        GlobalBufferSize = PAGE_SIZE;
    }
 
    /* We came back from a reboot, this doesn't make sense, tell the user */
    SacPutSimpleMessage(Reboot ? SAC_RESTART_FAIL_PROMPT : SAC_SHUTDOWN_FAIL_PROMPT);
    swprintf(GlobalBuffer, GetMessage(SAC_FAIL_PROMPT), Status);
    SacPutString(GlobalBuffer);
    SAC_DBG(SAC_DBG_ENTRY_EXIT, "SAC DoRebootCommand: Exiting.\n");
}

Referenced by ConMgrWorkerProcessEvents().

◆ DoSetIpAddressCommand()

VOID NTAPI DoSetIpAddressCommand ( IN PCHAR IpString )

Definition at line 564 of file concmd.c.

{
    SAC_DBG(SAC_DBG_ENTRY_EXIT, "Entering\n");
}

Referenced by ConMgrProcessInputLine().

◆ DoSetTimeCommand()

VOID NTAPI DoSetTimeCommand ( IN PCHAR InputTime )

Definition at line 431 of file concmd.c.

{
    SAC_DBG(SAC_DBG_ENTRY_EXIT, "Entering\n");
}

Referenced by ConMgrProcessInputLine().

◆ DoTlistCommand()

VOID NTAPI DoTlistCommand ( VOID )

Definition at line 571 of file concmd.c.

{
    NTSTATUS Status;
    PVOID NewGlobalBuffer;
    ULONG Size;
    SAC_DBG(SAC_DBG_ENTRY_EXIT, "SAC DoTlistCommand: Entering.\n");
 
    /* Check if a global buffer already exists */
    if (!GlobalBuffer)
    {
        /* It doesn't, allocate one */
        GlobalBuffer = SacAllocatePool(4096, GLOBAL_BLOCK_TAG);
        if (GlobalBuffer)
        {
            /* Remember its current size */
            GlobalBufferSize = 4096;
        }
        else
        {
            /* Out of memory, bail out */
            SacPutSimpleMessage(11);
            SAC_DBG(SAC_DBG_ENTRY_EXIT, "SAC DoTlistCommand: Exiting.\n");
            return;
        }
    }
 
    /* Loop as long as the buffer is too small */
    while (TRUE)
    {
        /* Get the process list */
        Status = GetTListInfo(GlobalBuffer, GlobalBufferSize, &Size);
        if ((Status != STATUS_NO_MEMORY) &&
            (Status != STATUS_INFO_LENGTH_MISMATCH))
        {
            /* It fits! Bail out */
            break;
        }
 
        /* We need a new bigger buffer */
        NewGlobalBuffer = SacAllocatePool(GlobalBufferSize + 4096,
                                          GLOBAL_BLOCK_TAG);
        if (!NewGlobalBuffer)
        {
            /* Out of memory, bail out */
            SacPutSimpleMessage(11);
            SAC_DBG(SAC_DBG_ENTRY_EXIT, "SAC DoTlistCommand: Exiting.\n");
            return;
        }
 
        /* Free the old one, update state */
        SacFreePool(GlobalBuffer);
        GlobalBufferSize += 4096;
        GlobalBuffer = NewGlobalBuffer;
    }
 
    /* Did we get here because we have the whole list? */
    if (!NT_SUCCESS(Status))
    {
        /* Nope, print out a failure message */
        SacPutSimpleMessage(68);
        swprintf(GlobalBuffer, GetMessage(48), Status);
        SacPutString(GlobalBuffer);
    }
    else
    {
        /* Yep, print out the list */
        PrintTListInfo(GlobalBuffer);
    }
 
    SAC_DBG(SAC_DBG_ENTRY_EXIT, "SAC DoTlistCommand: Exiting.\n");
}

Referenced by ConMgrProcessInputLine().

◆ FreeDeviceData()

VOID NTAPI FreeDeviceData ( IN PDEVICE_OBJECT DeviceObject )

Definition at line 147 of file data.c.

{
    PSAC_DEVICE_EXTENSION DeviceExtension;
    NTSTATUS Status;
    KIRQL OldIrql;
    SAC_DBG(SAC_DBG_ENTRY_EXIT, "SAC FreeDeviceData: Entering.\n");
 
    /* Get the device extension and see how far we had gotten */
    DeviceExtension = (PSAC_DEVICE_EXTENSION)DeviceObject->DeviceExtension;
    if (!(GlobalDataInitialized) || !(DeviceExtension->Initialized))
    {
        goto Exit;
    }
 
    /* Attempt to rundown while holding the lock */
    KeAcquireSpinLock(&DeviceExtension->Lock, &OldIrql);
    while (DeviceExtension->RundownInProgress)
    {
        SAC_DBG(SAC_DBG_ENTRY_EXIT, "SAC FreeDeviceData: Waiting....\n");
 
        /* Initiate and wait for rundown */
        KeInitializeEvent(&DeviceExtension->RundownEvent, SynchronizationEvent, 0);
        KeReleaseSpinLock(&DeviceExtension->Lock, OldIrql);
        Status = KeWaitForSingleObject(&DeviceExtension->RundownEvent,
                                       Executive,
                                       KernelMode,
                                       FALSE,
                                       NULL);
        ASSERT(Status == STATUS_SUCCESS);
 
        /* Re-acquire the lock and check if rundown is done */
        KeAcquireSpinLock(&DeviceExtension->Lock, &OldIrql);
    }
 
    /* Now set the rundown flag while we cancel the timer */
    DeviceExtension->RundownInProgress = TRUE;
    KeReleaseSpinLock(&DeviceExtension->Lock, OldIrql);
 
    /* Cancel it */
    KeCancelTimer(&DeviceExtension->Timer);
 
    /* Reacquire the lock*/
    KeAcquireSpinLock(&DeviceExtension->Lock, &OldIrql);
    DeviceExtension->RundownInProgress = FALSE;
 
    /* Now do the last rundown attempt, we should be the only ones here */
    KeInitializeEvent(&DeviceExtension->RundownEvent, SynchronizationEvent, 0);
    KeReleaseSpinLock(&DeviceExtension->Lock, OldIrql);
    KeSetEvent(&DeviceExtension->Event, DeviceExtension->PriorityBoost, 0);
    Status = KeWaitForSingleObject(&DeviceExtension->RundownEvent,
                                   Executive,
                                   KernelMode,
                                   FALSE,
                                   NULL);
    ASSERT(Status == STATUS_SUCCESS);
 
    /* We no longer care about shutdown */
    IoUnregisterShutdownNotification(DeviceObject);
 
    /* We are now fully uninitialized */
    KeAcquireSpinLock(&DeviceExtension->Lock, &OldIrql);
    DeviceExtension->Initialized = FALSE;
    KeReleaseSpinLock(&DeviceExtension->Lock, OldIrql);
Exit:
    SAC_DBG(SAC_DBG_ENTRY_EXIT, "SAC FreeDeviceData: Exiting.\n");
}

Referenced by UnloadHandler().

◆ FreeGlobalData()

VOID NTAPI FreeGlobalData ( VOID )

Definition at line 100 of file data.c.

{
    UNICODE_STRING SymbolicLink;
    SAC_DBG(SAC_DBG_ENTRY_EXIT, "SAC FreeGlobalData: Entering.\n");
 
    /* Only free if we allocated */
    if (GlobalDataInitialized)
    {
        /* Close the SAC event if we had created one */
        if (SACEvent)
        {
            ZwClose(SACEventHandle);
            SACEvent = NULL;
        }
 
        /* Destroy the cached messages */
        TearDownGlobalMessageTable();
 
        /* Delete the Win32 symbolic link */
        RtlInitUnicodeString(&SymbolicLink, L"\\DosDevices\\SAC");
        IoDeleteSymbolicLink(&SymbolicLink);
 
        /* Tear down connections */
        ConMgrShutdown();
 
        /* Tear down channels */
        ChanMgrShutdown();
 
        /* Free the serial port buffer */
        if (SerialPortBuffer) SacFreePool(SerialPortBuffer);
 
        /* Free cached machine information */
        FreeMachineInformation();
 
        /* Cleanup the custom heap allocator */
        FreeMemoryManagement();
 
        /* We're back to a virgin state */
        GlobalDataInitialized = FALSE;
    }
 
    /* All done */
    SAC_DBG(SAC_DBG_ENTRY_EXIT, "SAC FreeGlobalData: Exiting.\n");
}

Referenced by DriverEntry(), and UnloadHandler().

◆ FreeMachineInformation()

VOID NTAPI FreeMachineInformation ( VOID )

Definition at line 1156 of file util.c.

{
    ASSERT(MachineInformation);
 
    /* Free every cached string of machine information */
    if (MachineInformation->MachineName) SacFreePool(MachineInformation);
    if (MachineInformation->MachineGuid) SacFreePool(MachineInformation->MachineGuid);
    if (MachineInformation->ProcessorArchitecture) SacFreePool(MachineInformation->ProcessorArchitecture);
    if (MachineInformation->MajorVersion) SacFreePool(MachineInformation->MajorVersion);
    if (MachineInformation->BuildNumber) SacFreePool(MachineInformation->BuildNumber);
    if (MachineInformation->ProductType) SacFreePool(MachineInformation->ProductType);
    if (MachineInformation->ServicePack) SacFreePool(MachineInformation->ServicePack);
}

Referenced by FreeGlobalData().

◆ FreeMemoryManagement()

VOID NTAPI FreeMemoryManagement ( VOID )

Definition at line 62 of file memory.c.

{
    PSAC_MEMORY_LIST Next;
    KIRQL OldIrql;
    SAC_DBG(SAC_DBG_ENTRY_EXIT, "Entering\n");
 
    /* Acquire the memory lock while freeing the list(s) */
    KeAcquireSpinLock(&MemoryLock, &OldIrql);
    while (GlobalMemoryList)
    {
        ASSERT(GlobalMemoryList->Signature == GLOBAL_MEMORY_SIGNATURE);
 
        /* While outside of the lock, save the next list and free this one */
        KeReleaseSpinLock(&MemoryLock, OldIrql);
        Next = GlobalMemoryList->Next;
        ExFreePoolWithTag(GlobalMemoryList, 0);
 
        /* Reacquire the lock and see if there was another list to free */
        KeAcquireSpinLock(&MemoryLock, &OldIrql);
        GlobalMemoryList = Next;
    }
 
    /* All done */
    KeReleaseSpinLock(&MemoryLock, OldIrql);
    SAC_DBG(SAC_DBG_ENTRY_EXIT, "Exiting\n");
}

Referenced by FreeGlobalData().

◆ GetCommandConsoleLaunchingPermission()

NTSTATUS NTAPI GetCommandConsoleLaunchingPermission ( OUT PBOOLEAN Permission )

Definition at line 981 of file util.c.

{
    NTSTATUS Status;
    PKEY_VALUE_PARTIAL_INFORMATION Dummy;
 
    /* Assume success and read the key */
    *Permission = TRUE;
    Status = GetRegistryValueBuffer(L"\\Registry\\Machine\\System\\CurrentControlSet\\Services\\sacdrv",
                                    L"DisableCmdSessions",
                                    &Dummy);
    if (Status == STATUS_OBJECT_NAME_NOT_FOUND)
    {
        /* The default is success */
        Status = STATUS_SUCCESS;
    }
    else
    {
        /* Only if the key is present and set, do we disable permission */
        if (NT_SUCCESS(Status)) *Permission = FALSE;
    }
 
    /* Return status */
    return Status;
}

Referenced by InitializeGlobalData().

◆ GetMessage()

PWCHAR NTAPI GetMessage ( IN ULONG MessageIndex )

Definition at line 139 of file util.c.

{
    PSAC_MESSAGE_ENTRY MessageEntry;
    ULONG i;
    PWCHAR MessageData = NULL;
 
    /* Loop all cached messages */
    for (i = 0; i < GlobalMessageTableCount; i++)
    {
        /* Check if this one matches the index */
        MessageEntry = &GlobalMessageTable[i];
        if (MessageEntry->Index == MessageIndex)
        {
            /* It does, return the buffer */
            MessageData = MessageEntry->Buffer;
            break;
        }
    }
 
    /* We should always find it */
    if (!MessageData) ASSERT(FALSE);
    return MessageData;
}

◆ GetMessageLineCount()

ULONG NTAPI GetMessageLineCount ( IN ULONG MessageIndex )

Definition at line 1233 of file util.c.

{
    ULONG LineCount = 0;
    PWCHAR Buffer;
 
    /* Get the message buffer */
    Buffer = GetMessage(MessageIndex);
    if (Buffer)
    {
        /* Scan it looking for new lines, and increment the count each time */
        while (*Buffer) if (*Buffer++ == L'\n') ++LineCount;
    }
 
    /* Return the line count */
    return LineCount;
}

Referenced by PrintHelpMessage().

◆ ImposeSacCmdServiceStartTypePolicy()

NTSTATUS NTAPI ImposeSacCmdServiceStartTypePolicy ( VOID )

Definition at line 1008 of file util.c.

{
    NTSTATUS Status;
    PKEY_VALUE_PARTIAL_INFORMATION Buffer = NULL;
    PULONG Data;
 
    /* Read the service start type*/
    Status = GetRegistryValueBuffer(L"\\Registry\\Machine\\System\\CurrentControlSet\\Services\\sacsvr",
                                    L"Start",
                                    &Buffer);
    if (!NT_SUCCESS(Status)) return Status;
 
    /* If there's no start type, fail, as this is unusual */
    if (!Buffer) return STATUS_UNSUCCESSFUL;
 
    /* Read the value */
    Status = CopyRegistryValueData((PVOID*)&Data, Buffer);
    SacFreePool(Buffer);
    if (!NT_SUCCESS(Status)) return Status;
 
    /* Check what the current start type is */
    switch (*Data)
    {
        /* It's boot, system, or disabled */
        case 1:
        case 2:
        case 4:
            /* Leave it as is */
            return Status;
 
        case 3:
 
            /* It's set to automatic, set it to system instead */
            *Data = 2;
            Status = SetRegistryValue(L"\\Registry\\Machine\\System\\CurrentControlSet\\Services\\sacsvr",
                                      L"Start",
                                      REG_DWORD,
                                      Data,
                                      sizeof(ULONG));
            if (!NT_SUCCESS(Status))
            {
                SAC_DBG(SAC_DBG_INIT, "SAC ImposeSacCmdServiceStartTypePolicy: Failed SetRegistryValue: %X\n", Status);
            }
            break;
 
        default:
            ASSERT(FALSE);
    }
 
    return Status;
}

Referenced by InitializeGlobalData().

◆ InitializeCmdEventInfo()

VOID NTAPI InitializeCmdEventInfo ( VOID )

Definition at line 1062 of file util.c.

{
    /* Check if we were already initialized */
    if (HaveUserModeServiceCmdEventInfo)
    {
        /* Full state expected */
        ASSERT(RequestSacCmdEventObjectBody);
        ASSERT(RequestSacCmdSuccessEventObjectBody);
        ASSERT(RequestSacCmdFailureEventObjectBody);
 
        /* Dereference each wait object in turn */
        if (RequestSacCmdEventObjectBody)
        {
            ObDereferenceObject(RequestSacCmdEventObjectBody);
        }
 
        if (RequestSacCmdSuccessEventObjectBody)
        {
            ObDereferenceObject(RequestSacCmdSuccessEventObjectBody);
        }
 
        if (RequestSacCmdFailureEventObjectBody)
        {
            ObDereferenceObject(RequestSacCmdFailureEventObjectBody);
        }
    }
 
    /* Claer everything */
    RequestSacCmdEventObjectBody = NULL;
    RequestSacCmdEventWaitObjectBody = NULL;
    RequestSacCmdSuccessEventObjectBody = NULL;
    RequestSacCmdSuccessEventWaitObjectBody = NULL;
    RequestSacCmdFailureEventObjectBody = NULL;
    RequestSacCmdFailureEventWaitObjectBody = NULL;
    ServiceProcessFileObject = NULL;
 
    /* Reset state */
    HaveUserModeServiceCmdEventInfo = FALSE;
}

Referenced by InitializeGlobalData().

◆ InitializeDeviceData()

BOOLEAN NTAPI InitializeDeviceData ( IN PDEVICE_OBJECT DeviceObject )

Definition at line 216 of file data.c.

{
    PSAC_DEVICE_EXTENSION DeviceExtension = DeviceObject->DeviceExtension;
    BOOLEAN EnableData;
    ULONG PriorityValue;
    NTSTATUS Status;
    LARGE_INTEGER DueTime;
    PWCHAR Message;
    PAGED_CODE();
    SAC_DBG(SAC_DBG_ENTRY_EXIT, "Entering.\n");
 
    /* If we already did this, bail out */
    if (DeviceExtension->Initialized) goto SuccessExit;
 
    /* Setup the DO flags */
    DeviceObject->Flags |= DO_DIRECT_IO;
    DeviceObject->StackSize = 16;
 
    /* Setup the device extension */
    DeviceExtension->DeviceObject = DeviceObject;
    DeviceExtension->PriorityBoost = IO_SERIAL_INCREMENT;
    DeviceExtension->PriorityFail = 0;
    DeviceExtension->RundownInProgress = 0;
 
    /* Initialize locks, events, timers, DPCs, etc... */
    KeInitializeTimer(&DeviceExtension->Timer);
    KeInitializeDpc(&DeviceExtension->Dpc, TimerDpcRoutine, DeviceExtension);
    KeInitializeSpinLock(&DeviceExtension->Lock);
    KeInitializeEvent(&DeviceExtension->Event, SynchronizationEvent, FALSE);
    InitializeListHead(&DeviceExtension->List);
 
    /* Attempt to enable HDL support */
    EnableData = TRUE;
    Status = HeadlessDispatch(HeadlessCmdEnableTerminal,
                              &EnableData,
                              sizeof(EnableData),
                              NULL,
                              NULL);
    if (!NT_SUCCESS(Status))
    {
        /* Bail out if we couldn't even get this far */
        SAC_DBG(SAC_DBG_ENTRY_EXIT, "Exiting (1) with status FALSE\n");
        return FALSE;
    }
 
    /* Remember which process we started in */
    DeviceExtension->Process = IoGetCurrentProcess();
 
    /* Protect the device against non-admins */
    Status = CreateDeviceSecurityDescriptor(&DeviceExtension->DeviceObject);
    if (!NT_SUCCESS(Status))
    {
        /* Write down why we failed */
        SAC_DBG(SAC_DBG_ENTRY_EXIT, "Exiting (2) with status FALSE\n");
 
        /* Disable the HDL terminal on failure */
        EnableData = FALSE;
        Status = HeadlessDispatch(HeadlessCmdEnableTerminal,
                                  &EnableData,
                                  sizeof(EnableData),
                                  NULL,
                                  NULL);
        if (!NT_SUCCESS(Status)) SAC_DBG(SAC_DBG_INIT, "Failed dispatch\n");
 
        /* Bail out */
        return FALSE;
    }
 
    /* Create the worker thread */
    Status = PsCreateSystemThread(&DeviceExtension->WorkerThreadHandle,
                                  THREAD_ALL_ACCESS,
                                  NULL,
                                  NULL,
                                  NULL,
                                  WorkerThreadStartUp,
                                  DeviceExtension);
    if (!NT_SUCCESS(Status))
    {
        /* Write down why we failed */
        SAC_DBG(SAC_DBG_ENTRY_EXIT, "Exiting (3) with status FALSE\n");
 
        /* Disable the HDL terminal on failure */
        EnableData = FALSE;
        Status = HeadlessDispatch(HeadlessCmdEnableTerminal,
                                  &EnableData,
                                  sizeof(EnableData),
                                  NULL,
                                  NULL);
        if (!NT_SUCCESS(Status)) SAC_DBG(SAC_DBG_INIT, "Failed dispatch\n");
 
        /* Bail out */
        return FALSE;
    }
 
    /* Set the priority of our thread to highest */
    PriorityValue = HIGH_PRIORITY;
    Status = NtSetInformationThread(DeviceExtension->WorkerThreadHandle,
                                    ThreadPriority,
                                    &PriorityValue,
                                    sizeof(PriorityValue));
    if (!NT_SUCCESS(Status))
    {
        /* For debugging, write down why we failed */
        SAC_DBG(SAC_DBG_ENTRY_EXIT, "Exiting (6) with status FALSE\n");
        DeviceExtension->PriorityFail = TRUE;
 
        /* Initialize rundown and wait for the thread to do it */
        KeInitializeEvent(&DeviceExtension->RundownEvent, SynchronizationEvent, FALSE);
        KeSetEvent(&DeviceExtension->Event, DeviceExtension->PriorityBoost, FALSE);
        Status = KeWaitForSingleObject(&DeviceExtension->RundownEvent,
                                       Executive,
                                       KernelMode,
                                       FALSE,
                                       NULL);
        ASSERT(Status == STATUS_SUCCESS);
 
        /* Disable the HDL terminal on failure */
        EnableData = FALSE;
        Status = HeadlessDispatch(HeadlessCmdEnableTerminal,
                                  &EnableData,
                                  sizeof(EnableData),
                                  NULL,
                                  NULL);
        if (!NT_SUCCESS(Status)) SAC_DBG(SAC_DBG_INIT, "Failed dispatch\n");
 
        /* Bail out */
        return FALSE;
    }
 
    /* The first "packet" is the machine information in XML... */
    Status = TranslateMachineInformationXML(&Message, NULL);
    if (NT_SUCCESS(Status))
    {
        /* Go ahead and send it */
        UTF8EncodeAndSend(L"<?xml version=\"1.0\"?>\r\n");
        UTF8EncodeAndSend(Message);
 
        /* Free the temporary buffer */
        SacFreePool(Message);
    }
 
    /* Finally, initialize the I/O Manager */
    Status = ConMgrInitialize();
    if (!NT_SUCCESS(Status)) return FALSE;
 
    /* Set the timer. Once this is done, the device is initialized */
    DueTime.QuadPart = -4000;
    KeSetTimerEx(&DeviceExtension->Timer, DueTime, 4, &DeviceExtension->Dpc);
    DeviceExtension->Initialized = TRUE;
 
SuccessExit:
    /* Success path -- everything worked */
    SAC_DBG(SAC_DBG_ENTRY_EXIT, "Exiting with status TRUE\n");
    return TRUE;
}

Referenced by DriverEntry().

◆ InitializeGlobalData()

BOOLEAN NTAPI InitializeGlobalData	(	IN PUNICODE_STRING	RegistryPath,
		IN PDRIVER_OBJECT	DriverObject
	)

Definition at line 374 of file data.c.

{
    NTSTATUS Status;
    UNICODE_STRING LinkName;
    UNICODE_STRING DeviceName;
    UNICODE_STRING EventName;
    PAGED_CODE();
    SAC_DBG(SAC_DBG_ENTRY_EXIT, "Entering.\n");
 
    /* If we already did this, bail out */
    if (GlobalDataInitialized) goto SuccessExit;
 
    /* Setup the symbolic link for Win32 support */
    RtlInitUnicodeString(&LinkName, L"\\DosDevices\\SAC");
    RtlInitUnicodeString(&DeviceName, L"\\Device\\SAC");
    Status = IoCreateSymbolicLink(&LinkName, &DeviceName);
    if (!NT_SUCCESS(Status)) return FALSE;
 
    /* Initialize the internal heap manager */
    if (!InitializeMemoryManagement())
    {
        IoDeleteSymbolicLink(&LinkName);
        SAC_DBG(SAC_DBG_ENTRY_EXIT, "Exiting with status FALSE\n");
        return FALSE;
    }
 
    /* Preload the messages in memory */
    Status = PreloadGlobalMessageTable(DriverObject->DriverStart);
    if (!NT_SUCCESS(Status))
    {
        IoDeleteSymbolicLink(&LinkName);
        SAC_DBG(SAC_DBG_INIT, "unable to pre-load message table: %X\n", Status);
        return FALSE;
    }
 
    /* Check if the administrator enabled this */
    Status = GetCommandConsoleLaunchingPermission(&CommandConsoleLaunchingEnabled);
    if (!NT_SUCCESS(Status))
    {
        /* Is it enabled? */
        if (CommandConsoleLaunchingEnabled)
        {
            /* Set the service start type to the correct value */
            Status = ImposeSacCmdServiceStartTypePolicy();
            if (!NT_SUCCESS(Status))
            {
                SAC_DBG(SAC_DBG_INIT, "failed ImposeSacCmdServiceStartTypePolicy: %X\n", Status);
            }
        }
 
        /* We're going to keep going with the default */
        SAC_DBG(SAC_DBG_INIT, "failed GetCommandConsoleLaunchingPermission: %X\n", Status);
    }
 
    /* Allocate the UTF-8 Conversion Buffer */
    Utf8ConversionBuffer = SacAllocatePool(Utf8ConversionBufferSize, GLOBAL_BLOCK_TAG);
    if (!Utf8ConversionBuffer)
    {
        /* Handle failure case */
        TearDownGlobalMessageTable();
        IoDeleteSymbolicLink(&LinkName);
        SAC_DBG(SAC_DBG_INIT, "unable to allocate memory for UTF8 translation\n");
        return FALSE;
    }
 
    /* Initialize the channel manager */
    Status = ChanMgrInitialize();
    if (!NT_SUCCESS(Status))
    {
        /* Handle failure case */
        SacFreePool(Utf8ConversionBuffer);
        TearDownGlobalMessageTable();
        IoDeleteSymbolicLink(&LinkName);
        SAC_DBG(SAC_DBG_INIT, "Failed to create SAC Channel\n");
        return FALSE;
    }
 
    /* Allocate the serial port buffer */
    SerialPortBuffer = SacAllocatePool(SAC_SERIAL_PORT_BUFFER_SIZE, GLOBAL_BLOCK_TAG);
    if (!SerialPortBuffer)
    {
        /* Handle failure case */
        SacFreePool(Utf8ConversionBuffer);
        TearDownGlobalMessageTable();
        IoDeleteSymbolicLink(&LinkName);
        SAC_DBG(SAC_DBG_INIT, "Failed to allocate Serial Port Buffer\n");
        return FALSE;
    }
 
    /* Zero it out */
    RtlZeroMemory(SerialPortBuffer, SAC_SERIAL_PORT_BUFFER_SIZE);
 
    /* Initialize command events. After this, driver data is good to go */
    KeInitializeMutex(&SACCMDEventInfoMutex, FALSE);
    InitializeCmdEventInfo();
    GlobalDataInitialized = TRUE;
    ProcessingType = 0;
    IoctlSubmitted = 0;
 
    /* Create the SAC event */
    RtlInitUnicodeString(&EventName, L"\\SACEvent");
    SACEvent = IoCreateSynchronizationEvent(&EventName, &SACEventHandle);
    if (!SACEvent)
    {
        /* Handle failure case */
        SacFreePool(Utf8ConversionBuffer);
        TearDownGlobalMessageTable();
        IoDeleteSymbolicLink(&LinkName);
        SAC_DBG(SAC_DBG_ENTRY_EXIT, "Exiting with event NULL\n");
        return FALSE;
    }
 
    /* Cache machine information */
    InitializeMachineInformation();
 
    /* Register it */
    Status = RegisterBlueScreenMachineInformation();
    if (!NT_SUCCESS(Status))
    {
        /* Handle failure case */
        SacFreePool(Utf8ConversionBuffer);
        TearDownGlobalMessageTable();
        IoDeleteSymbolicLink(&LinkName);
        SAC_DBG(SAC_DBG_INIT, "Failed to register blue screen machine info\n");
        return FALSE;
    }
 
SuccessExit:
    /* Success path -- everything worked */
    SAC_DBG(SAC_DBG_ENTRY_EXIT, "Exiting with status TRUE\n");
    return TRUE;
}

Referenced by DriverEntry().

◆ InitializeMachineInformation()

VOID NTAPI InitializeMachineInformation ( VOID )

Definition at line 692 of file util.c.

{
    NTSTATUS Status;
    PWCHAR GuidString, MajorVersion, ServicePack, BuildNumber, MessageBuffer;
    PWCHAR ProductType;
    ULONG SuiteTypeMessage;
    BOOLEAN SetupInProgress = FALSE;
    GUID SystemGuid;
    SIZE_T RealSize, Size, OutputSize;
    PKEY_VALUE_PARTIAL_INFORMATION PartialInfo;
    RTL_OSVERSIONINFOEXW VersionInformation;
    SAC_DBG(SAC_DBG_ENTRY_EXIT, "SAC Initialize Machine Information : Entering.\n");
 
    /* Don't do anything if we already queried this */
    if (MachineInformation)
    {
        SAC_DBG(SAC_DBG_MACHINE, "SAC Initialize Machine Information:: MachineInformationBuffer already initialized.\n");
        return;
    }
 
    /* Allocate the machine information */
    MachineInformation = SacAllocatePool(sizeof(*MachineInformation),
                                         GLOBAL_BLOCK_TAG);
    if (!MachineInformation)
    {
        goto Fail;
    }
 
    /* Zero it out for now */
    RtlZeroMemory(MachineInformation, sizeof(*MachineInformation));
 
    /* Query OS version */
    RtlZeroMemory(&VersionInformation, sizeof(VersionInformation));
    VersionInformation.dwOSVersionInfoSize = sizeof(VersionInformation);
    Status = RtlGetVersion((PRTL_OSVERSIONINFOW)&VersionInformation);
    if (!NT_SUCCESS(Status))
    {
        SAC_DBG(SAC_DBG_ENTRY_EXIT, "SAC InitializeMachineInformation: Exiting (2).\n");
        goto Fail;
    }
 
    /* Check if setup is in progress */
    Status = GetRegistryValueBuffer(L"\\Registry\\Machine\\System\\Setup",
                                    L"SystemSetupInProgress",
                                    &PartialInfo);
    if (NT_SUCCESS(Status))
    {
        /* The key is there, is the value set? */
        if (*(PULONG)PartialInfo->Data) SetupInProgress = TRUE;
        SacFreePool(PartialInfo);
        if (SetupInProgress)
        {
            /* Yes, so we'll use a special hostname to identify this */
            MessageBuffer = GetMessage(SAC_UNINITIALIZED_MSG);
            Size = wcslen(MessageBuffer);
            ASSERT(Size > 0);
            RealSize = Size * sizeof(WCHAR) + sizeof(UNICODE_NULL);
 
            /* Make room for it and copy it in there */
            MachineInformation->MachineName = SacAllocatePool(RealSize,
                                                              GLOBAL_BLOCK_TAG);
            if (MachineInformation->MachineName)
            {
                wcscpy(MachineInformation->MachineName, MessageBuffer);
            }
        }
    }
 
    /* If we are not in setup mode, or if we failed to check... */
    if (!SetupInProgress)
    {
        /* Query the computer name */
        Status = GetRegistryValueBuffer(L"\\Registry\\Machine\\System\\"
                                        L"CurrentControlSet\\Control\\"
                                        L"ComputerName\\ComputerName",
                                        L"ComputerName",
                                        &PartialInfo);
        if (!NT_SUCCESS(Status))
        {
            /* It's not critical, but we won't have it */
            SAC_DBG(SAC_DBG_ENTRY_EXIT, "SAC InitializeMachineInformation: Failed to get machine name.\n");
        }
        else
        {
            /* We have the name, copy it from the registry */
            Status = CopyRegistryValueData((PVOID*)&MachineInformation->
                                           MachineName,
                                           PartialInfo);
            SacFreePool(PartialInfo);
            if (!NT_SUCCESS(Status))
            {
                SAC_DBG(SAC_DBG_ENTRY_EXIT, "SAC InitializeMachineInformation: Exiting (20).\n");
                goto Fail;
            }
        }
    }
 
    /* Next step, try to get the machine GUID */
    RtlZeroMemory(&SystemGuid, sizeof(SystemGuid));
    OutputSize = sizeof(SystemGuid);
    Status = HeadlessDispatch(HeadlessCmdQueryGUID,
                              NULL,
                              0,
                              &SystemGuid,
                              &OutputSize);
    if (!NT_SUCCESS(Status))
    {
        SAC_DBG(SAC_DBG_ENTRY_EXIT, "SAC InitializeMachineInformation: Failed to get Machine GUID.\n");
    }
    else
    {
        /* We have it -- make room for it */
        GuidString = SacAllocatePool(0x50, GLOBAL_BLOCK_TAG);
        if (!GuidString)
        {
            SAC_DBG(SAC_DBG_ENTRY_EXIT, "SAC InitializeMachineInformation: Exiting (31).\n");
            goto Fail;
        }
 
        /* Build the string with the GUID in it, and save the ppointer to it */
        swprintf(GuidString,
                 L"%08lx-%04x-%04x-%02x%02x-%02x%02x%02x%02x%02x%02x",
                 SystemGuid.Data1,
                 SystemGuid.Data2,
                 SystemGuid.Data3,
                 SystemGuid.Data4[0],
                 SystemGuid.Data4[1],
                 SystemGuid.Data4[2],
                 SystemGuid.Data4[3],
                 SystemGuid.Data4[4],
                 SystemGuid.Data4[5],
                 SystemGuid.Data4[6],
                 SystemGuid.Data4[7]);
        MachineInformation->MachineGuid = GuidString;
    }
 
    /* Next, query the processor architecture */
    Status = GetRegistryValueBuffer(L"\\Registry\\Machine\\System\\"
                                    L"CurrentControlSet\\Control\\"
                                    L"Session Manager\\Environment",
                                    L"PROCESSOR_ARCHITECTURE",
                                    &PartialInfo);
    if (!NT_SUCCESS(Status))
    {
        /* It's not critical, but we won't have it */
        SAC_DBG(SAC_DBG_ENTRY_EXIT, "SAC InitializeMachineInformation: Exiting (30).\n");
    }
    else
    {
        /* We have it! Copy the value from the registry */
        Status = CopyRegistryValueData((PVOID*)&MachineInformation->
                                       ProcessorArchitecture,
                                       PartialInfo);
        SacFreePool(PartialInfo);
        if (!NT_SUCCESS(Status))
        {
            SAC_DBG(SAC_DBG_ENTRY_EXIT, "SAC InitializeMachineInformation: Exiting (30).\n");
            goto Fail;
        }
    }
 
    /* Now allocate a buffer for the OS version number */
    MajorVersion = SacAllocatePool(0x18, GLOBAL_BLOCK_TAG);
    if (!MajorVersion)
    {
        SAC_DBG(SAC_DBG_ENTRY_EXIT, "SAC InitializeMachineInformation: Exiting (50).\n");
        goto Fail;
    }
 
    /* Build the buffer and set a pointer to it */
    swprintf(MajorVersion,
             L"%d.%d",
             VersionInformation.dwMajorVersion,
             VersionInformation.dwMinorVersion);
    MachineInformation->MajorVersion = MajorVersion;
 
    /* Now allocate a buffer for the OS build number */
    BuildNumber = SacAllocatePool(0xC, GLOBAL_BLOCK_TAG);
    if (!BuildNumber)
    {
        SAC_DBG(SAC_DBG_ENTRY_EXIT, "SAC InitializeMachineInformation: Exiting (60).\n");
        goto Fail;
    }
 
    /* Build the buffer and set a pointer to it */
    swprintf(BuildNumber, L"%d", VersionInformation.dwBuildNumber);
    MachineInformation->BuildNumber = BuildNumber;
 
    /* Now check what kind of SKU this is */
    if (ExVerifySuite(DataCenter))
    {
        SuiteTypeMessage = SAC_DATACENTER_SUITE_MSG;
    }
    else if (ExVerifySuite(EmbeddedNT))
    {
        SuiteTypeMessage = SAC_EMBEDDED_SUITE_MSG;
    }
    else if (ExVerifySuite(Enterprise))
    {
        SuiteTypeMessage = SAC_ENTERPRISE_SUITE_MSG;
    }
    else
    {
        /* Unknown or perhaps a client SKU */
        SuiteTypeMessage = SAC_NO_SUITE_MSG;
    }
 
    /* Get the string that corresponds to the SKU type */
    MessageBuffer = GetMessage(SuiteTypeMessage);
    if (!MessageBuffer)
    {
        /* We won't have it, but this isn't critical */
        SAC_DBG(SAC_DBG_INIT, "SAC InitializeMachineInformation: Failed to get product type.\n");
    }
    else
    {
        /* Calculate the size we need to hold the string */
        Size = wcslen(MessageBuffer);
        ASSERT(Size > 0);
        RealSize = Size * sizeof(WCHAR) + sizeof(UNICODE_NULL);
 
        /* Allocate a buffer for it */
        ProductType = SacAllocatePool(RealSize, GLOBAL_BLOCK_TAG);
        if (!ProductType)
        {
            SAC_DBG(SAC_DBG_INIT, "SAC InitializeMachineInformation: Failed product type memory allocation.\n");
            goto Fail;
        }
 
        /* Copy the string and set the pointer */
        RtlCopyMemory(ProductType, MessageBuffer, RealSize);
        MachineInformation->ProductType = ProductType;
    }
 
    /* Check if this is a SP version or RTM version */
    if (VersionInformation.wServicePackMajor)
    {
        /* This is a service pack, allocate a buffer for the version */
        ServicePack = SacAllocatePool(0x18, GLOBAL_BLOCK_TAG);
        if (ServicePack)
        {
            /* Build the buffer and set a pointer to it */
            swprintf(ServicePack,
                     L"%d.%d",
                     VersionInformation.wServicePackMajor,
                     VersionInformation.wServicePackMinor);
            MachineInformation->ServicePack = ServicePack;
 
            /* We've collected all the machine info and are done! */
            return;
        }
 
        /* This is the failure path */
        SAC_DBG(SAC_DBG_INIT, "SAC InitializeMachineInformation: Failed service pack memory allocation.\n");
    }
    else
    {
        /* Get a generic string that indicates there's no service pack */
        MessageBuffer = GetMessage(SAC_NO_DATA_MSG);
        Size = wcslen(MessageBuffer);
        ASSERT(Size > 0);
        RealSize = Size * sizeof(WCHAR) + sizeof(UNICODE_NULL);
 
        /* Allocate memory for the "no service pack" string */
        ServicePack = SacAllocatePool(RealSize, GLOBAL_BLOCK_TAG);
        if (ServicePack)
        {
            /* Copy the buffer and set a pointer to it */
            RtlCopyMemory(ServicePack, MessageBuffer, RealSize);
            MachineInformation->ServicePack = ServicePack;
 
            /* We've collected all the machine info and are done! */
            return;
        }
 
        SAC_DBG(SAC_DBG_INIT, "SAC InitializeMachineInformation: Failed service pack memory allocation.\n");
    }
 
Fail:
    /* In the failure path, always cleanup the machine information buffer */
    if (MachineInformation)
    {
        SacFreePool(MachineInformation);
    }
    SAC_DBG(SAC_DBG_ENTRY_EXIT, "SAC Initialize Machine Information : Exiting with error.\n");
}

Referenced by InitializeGlobalData().

◆ InitializeMemoryManagement()

BOOLEAN NTAPI InitializeMemoryManagement ( VOID )

Definition at line 23 of file memory.c.

{
    PSAC_MEMORY_ENTRY Entry;
    SAC_DBG(SAC_DBG_ENTRY_EXIT, "Entering\n");
 
    /* Allocate a nonpaged heap for us to use */
    GlobalMemoryList = ExAllocatePoolWithTagPriority(NonPagedPool,
                                                     SAC_MEMORY_LIST_SIZE,
                                                     INITIAL_BLOCK_TAG,
                                                     HighPoolPriority);
    if (GlobalMemoryList)
    {
        /* Initialize a lock for it */
        KeInitializeSpinLock(&MemoryLock);
 
        /* Initialize the head of the list */
        GlobalMemoryList->Signature = GLOBAL_MEMORY_SIGNATURE;
        GlobalMemoryList->LocalDescriptor = (PSAC_MEMORY_ENTRY)(GlobalMemoryList + 1);
        GlobalMemoryList->Size = SAC_MEMORY_LIST_SIZE - sizeof(SAC_MEMORY_LIST);
        GlobalMemoryList->Next = NULL;
 
        /* Initialize the first free entry */
        Entry = GlobalMemoryList->LocalDescriptor;
        Entry->Signature = LOCAL_MEMORY_SIGNATURE;
        Entry->Tag = FREE_POOL_TAG;
        Entry->Size = GlobalMemoryList->Size - sizeof(SAC_MEMORY_ENTRY);
 
        /* All done */
        SAC_DBG(SAC_DBG_ENTRY_EXIT, "Exiting with TRUE.\n");
        return TRUE;
    }
 
    /* No pool available to manage our heap */
    SAC_DBG(SAC_DBG_ENTRY_EXIT, "Exiting with FALSE. No pool.\n");
    return FALSE;
}

Referenced by InitializeGlobalData().

◆ MyAllocatePool()

PVOID NTAPI MyAllocatePool	(	IN SIZE_T	PoolSize,
		IN ULONG	Tag,
		IN PCHAR	File,
		IN ULONG	Line
	)

Definition at line 91 of file memory.c.

{
    PVOID p;
    p = ExAllocatePoolWithTag(NonPagedPool, PoolSize, 'HACK');
    RtlZeroMemory(p, PoolSize);
    SAC_DBG(SAC_DBG_MM, "Returning block 0x%X.\n", p);
    return p;
#if 0
    KIRQL OldIrql;
    PSAC_MEMORY_LIST GlobalDescriptor, NewDescriptor;
    PSAC_MEMORY_ENTRY LocalDescriptor, NextDescriptor;
    ULONG GlobalSize, ActualSize;
    PVOID Buffer;
 
    ASSERT(Tag != FREE_POOL_TAG);
    SAC_DBG(SAC_DBG_MM, "Entering.\n");
 
    /* Acquire the memory allocation lock and align the size request */
    KeAcquireSpinLock(&MemoryLock, &OldIrql);
    PoolSize = ALIGN_UP(PoolSize, ULONGLONG);
 
#if _USE_SAC_HEAP_ALLOCATOR_
    GlobalDescriptor = GlobalMemoryList;
    KeAcquireSpinLock(&MemoryLock, &OldIrql);
    while (GlobalDescriptor)
    {
        ASSERT(GlobalMemoryList->Signature == GLOBAL_MEMORY_SIGNATURE);
 
        LocalDescriptor = GlobalDescriptor->LocalDescriptor;
 
        GlobalSize = GlobalDescriptor->Size;
        while (GlobalSize)
        {
            ASSERT(LocalDescriptor->Signature == LOCAL_MEMORY_SIGNATURE);
 
            if ((LocalDescriptor->Tag == FREE_POOL_TAG) &&
                (LocalDescriptor->Size >= PoolSize))
            {
                break;
            }
 
            GlobalSize -= (LocalDescriptor->Size + sizeof(SAC_MEMORY_ENTRY));
 
            LocalDescriptor =
                (PSAC_MEMORY_ENTRY)((ULONG_PTR)LocalDescriptor +
                LocalDescriptor->Size +
                sizeof(SAC_MEMORY_ENTRY));
        }
 
        GlobalDescriptor = GlobalDescriptor->Next;
    }
 
    if (!GlobalDescriptor)
    {
        KeReleaseSpinLock(&MemoryLock, OldIrql);
 
        ActualSize = min(
            PAGE_SIZE,
            PoolSize + sizeof(SAC_MEMORY_ENTRY) + sizeof(SAC_MEMORY_LIST));
 
        SAC_DBG(SAC_DBG_MM, "Allocating new space.\n");
 
        NewDescriptor = ExAllocatePoolWithTagPriority(NonPagedPool,
                                                      ActualSize,
                                                      ALLOC_BLOCK_TAG,
                                                      HighPoolPriority);
        if (!NewDescriptor)
        {
            SAC_DBG(SAC_DBG_MM, "No more memory, returning NULL.\n");
            return NULL;
        }
 
        KeAcquireSpinLock(&MemoryLock, &OldIrql);
 
        NewDescriptor->Signature = GLOBAL_MEMORY_SIGNATURE;
        NewDescriptor->LocalDescriptor = (PSAC_MEMORY_ENTRY)(NewDescriptor + 1);
        NewDescriptor->Size = ActualSize - 16;
        NewDescriptor->Next = GlobalMemoryList;
 
        GlobalMemoryList = NewDescriptor;
 
        LocalDescriptor = NewDescriptor->LocalDescriptor;
        LocalDescriptor->Signature = LOCAL_MEMORY_SIGNATURE;
        LocalDescriptor->Tag = FREE_POOL_TAG;
        LocalDescriptor->Size =
            GlobalMemoryList->Size - sizeof(SAC_MEMORY_ENTRY);
    }
 
    SAC_DBG(SAC_DBG_MM, "Found a good sized block.\n");
    ASSERT(LocalDescriptor->Tag == FREE_POOL_TAG);
    ASSERT(LocalDescriptor->Signature == LOCAL_MEMORY_SIGNATURE);
 
    if (LocalDescriptor->Size > (PoolSize + sizeof(SAC_MEMORY_ENTRY)))
    {
        NextDescriptor =
            (PSAC_MEMORY_ENTRY)((ULONG_PTR)LocalDescriptor +
            PoolSize +
            sizeof(SAC_MEMORY_ENTRY));
        if (NextDescriptor->Tag == FREE_POOL_TAG)
        {
            NextDescriptor->Tag = FREE_POOL_TAG;
            NextDescriptor->Signature = LOCAL_MEMORY_SIGNATURE;
            NextDescriptor->Size =
                (LocalDescriptor->Size - PoolSize - sizeof(SAC_MEMORY_ENTRY));
 
            LocalDescriptor->Size = PoolSize;
        }
    }
#else
    /* Shut the compiler up */
    NewDescriptor = GlobalDescriptor = NULL;
    GlobalSize = (ULONG)NewDescriptor;
    ActualSize = GlobalSize;
    NextDescriptor = (PVOID)ActualSize;
    NewDescriptor = (PVOID)NextDescriptor;
 
    /* Use the NT pool allocator */
    LocalDescriptor = ExAllocatePoolWithTag(NonPagedPool,
                                            PoolSize + sizeof(*LocalDescriptor),
                                            Tag);
    LocalDescriptor->Size = PoolSize;
#endif
    /* Set the tag, and release the lock */
    LocalDescriptor->Tag = Tag;
    KeReleaseSpinLock(&MemoryLock, OldIrql);
 
    /* Update our performance counters */
    InterlockedIncrement(&TotalAllocations);
    InterlockedExchangeAdd(&TotalBytesAllocated, LocalDescriptor->Size);
 
    /* Return the buffer and zero it */
    SAC_DBG(SAC_DBG_MM, "Returning block 0x%X.\n", LocalDescriptor);
    Buffer = LocalDescriptor + 1;
    RtlZeroMemory(Buffer, PoolSize);
    return Buffer;
#endif
}

◆ MyFreePool()

VOID NTAPI MyFreePool ( IN PVOID * Block )

Definition at line 234 of file memory.c.

{
#if 0
    PSAC_MEMORY_ENTRY NextDescriptor;
    PSAC_MEMORY_ENTRY ThisDescriptor, FoundDescriptor;
    PSAC_MEMORY_ENTRY LocalDescriptor = (PVOID)((ULONG_PTR)(*Block) - sizeof(SAC_MEMORY_ENTRY));
    ULONG GlobalSize, LocalSize;
    PSAC_MEMORY_LIST GlobalDescriptor;
    KIRQL OldIrql;
    SAC_DBG(SAC_DBG_MM, "Entering with block 0x%X.\n", LocalDescriptor);
 
    /* Make sure this was a valid entry */
    ASSERT(LocalDescriptor->Size > 0);
    ASSERT(LocalDescriptor->Signature == LOCAL_MEMORY_SIGNATURE);
 
    /* Update performance counters */
    InterlockedIncrement(&TotalFrees);
    InterlockedExchangeAdd(&TotalBytesFreed, LocalDescriptor->Size);
 
    /* Acquire the memory allocation lock */
    GlobalDescriptor = GlobalMemoryList;
    KeAcquireSpinLock(&MemoryLock, &OldIrql);
 
#if _USE_SAC_HEAP_ALLOCATOR_
    while (GlobalDescriptor)
    {
        ASSERT(GlobalMemoryList->Signature == GLOBAL_MEMORY_SIGNATURE);
 
        FoundDescriptor = NULL;
 
        ThisDescriptor = GlobalDescriptor->LocalDescriptor;
 
        GlobalSize = GlobalDescriptor->Size;
        while (GlobalSize)
        {
            ASSERT(ThisDescriptor->Signature == LOCAL_MEMORY_SIGNATURE);
 
            if (ThisDescriptor == LocalDescriptor) break;
 
            GlobalSize -= (ThisDescriptor->Size + sizeof(SAC_MEMORY_ENTRY));
 
            ThisDescriptor =
                (PSAC_MEMORY_ENTRY)((ULONG_PTR)ThisDescriptor +
                ThisDescriptor->Size +
                sizeof(SAC_MEMORY_ENTRY));
        }
 
        if (ThisDescriptor == LocalDescriptor) break;
 
        GlobalDescriptor = GlobalDescriptor->Next;
    }
 
    if (!GlobalDescriptor)
    {
        KeReleaseSpinLock(&MemoryLock, OldIrql);
        SAC_DBG(SAC_DBG_MM, "Could not find block.\n");
        return;
    }
 
    ASSERT(ThisDescriptor->Signature == LOCAL_MEMORY_SIGNATURE);
 
    if (LocalDescriptor->Tag == FREE_POOL_TAG)
    {
        KeReleaseSpinLock(&MemoryLock, OldIrql);
        SAC_DBG(SAC_DBG_MM, "Attempted to free something twice.\n");
        return;
    }
 
    LocalSize = LocalDescriptor->Size;
    LocalDescriptor->Tag = FREE_POOL_TAG;
 
    if (GlobalSize > (LocalSize + sizeof(SAC_MEMORY_ENTRY)))
    {
        NextDescriptor =
            (PSAC_MEMORY_ENTRY)((ULONG_PTR)LocalDescriptor +
            LocalSize +
            sizeof(SAC_MEMORY_ENTRY));
        if (NextDescriptor->Tag == FREE_POOL_TAG)
        {
            NextDescriptor->Tag = 0;
            NextDescriptor->Signature = 0;
 
            LocalDescriptor->Size +=
                (NextDescriptor->Size + sizeof(SAC_MEMORY_ENTRY));
        }
    }
 
    if ((FoundDescriptor) && (FoundDescriptor->Tag == FREE_POOL_TAG))
    {
        LocalDescriptor->Signature = 0;
        LocalDescriptor->Tag = 0;
 
        FoundDescriptor->Size +=
            (LocalDescriptor->Size + sizeof(SAC_MEMORY_ENTRY));
    }
#else
    /* Shut the compiler up */
    LocalSize = GlobalSize = 0;
    ThisDescriptor = (PVOID)LocalSize;
    NextDescriptor = (PVOID)GlobalSize;
    GlobalDescriptor = (PVOID)ThisDescriptor;
    FoundDescriptor = (PVOID)GlobalDescriptor;
    GlobalDescriptor = (PVOID)NextDescriptor;
    NextDescriptor = (PVOID)FoundDescriptor;
 
    /* Use the NT pool allocator*/
    ExFreePool(LocalDescriptor);
#endif
 
    /* Release the lock, delete the address, and return */
    KeReleaseSpinLock(&MemoryLock, OldIrql);
#endif
    SAC_DBG(SAC_DBG_MM, "exiting: 0x%p.\n", *Block);
    ExFreePoolWithTag(*Block, 'HACK');
    *Block = NULL;
}

◆ PreloadGlobalMessageTable()

NTSTATUS NTAPI PreloadGlobalMessageTable ( IN PVOID ImageBase )

Definition at line 280 of file util.c.

{
    NTSTATUS Status, Status2;
    ULONG MessageId, TotalLength, TextSize, i;
    PWCHAR StringBuffer;
    PMESSAGE_RESOURCE_ENTRY MessageEntry;
    PAGED_CODE();
    SAC_DBG(SAC_DBG_ENTRY_EXIT, "SAC PreloadGlobalMessageTable: Entering.\n");
 
    /* Nothing to do if we already have a table */
    Status = STATUS_SUCCESS;
    if (GlobalMessageTable) goto Exit;
 
    /* Loop through up to 200 messages */
    TotalLength = 0;
    for (MessageId = 1; MessageId != SAC_MAX_MESSAGES; MessageId++)
    {
        /* Find this message in the message table */
        Status2 = RtlFindMessage(ImageBase,
                                 RT_MESSAGETABLE,
                                 MAKELANGID(LANG_NEUTRAL, SUBLANG_NEUTRAL),
                                 MessageId,
                                 &MessageEntry);
        if (NT_SUCCESS(Status2))
        {
            /* Make sure it's Unicode */
            ASSERT(MessageEntry->Flags & MESSAGE_RESOURCE_UNICODE);
 
            /* Remove the space taken up by the OS header, and add our own */
            TotalLength += MessageEntry->Length -
                           FIELD_OFFSET(MESSAGE_RESOURCE_ENTRY, Text) +
                           sizeof(SAC_MESSAGE_ENTRY);
 
            /* One more in the table */
            GlobalMessageTableCount++;
        }
    }
 
    /* We should've found at least one message... */
    if (!TotalLength)
    {
        /* Bail out otherwise */
        SAC_DBG(SAC_DBG_INIT, "SAC PreloadGlobalMessageTable: No Messages.\n");
        Status = STATUS_INVALID_PARAMETER;
        goto Exit;
    }
 
    /* Allocate space for the buffers and headers */
    GlobalMessageTable = SacAllocatePool(TotalLength, GLOBAL_BLOCK_TAG);
    if (!GlobalMessageTable)
    {
        /* Bail out if we couldn't allocate it */
        Status = STATUS_NO_MEMORY;
        goto Exit;
    }
 
    /* All the buffers are going to be at the end of the table */
    StringBuffer = (PWCHAR)(&GlobalMessageTable[GlobalMessageTableCount]);
 
    /* Now loop over our entries again */
    for (i = 0, MessageId = 1; MessageId != SAC_MAX_MESSAGES; MessageId++)
    {
        /* Make sure the message is still there! */
        Status2 = RtlFindMessage(ImageBase,
                                 RT_MESSAGETABLE,
                                 MAKELANGID(LANG_NEUTRAL, SUBLANG_NEUTRAL),
                                 MessageId,
                                 &MessageEntry);
        if (NT_SUCCESS(Status2))
        {
            /* Write the entry in the message table*/
            GlobalMessageTable[i].Index = MessageId;
            GlobalMessageTable[i].Buffer = StringBuffer;
 
            /* The structure includes the size of the header, elide it */
            TextSize = MessageEntry->Length -
                       FIELD_OFFSET(MESSAGE_RESOURCE_ENTRY, Text);
 
            /* Format the message into the entry. It should be same or smaller */
            SacFormatMessage(StringBuffer, (PWCHAR)MessageEntry->Text, TextSize);
            ASSERT((ULONG)(wcslen(StringBuffer)*sizeof(WCHAR)) <= TextSize);
 
            /* Move to the next buffer space */
            StringBuffer += (TextSize / sizeof(WCHAR));
 
            /* Move to the next entry, make sure the status is full success */
            i++;
            Status = STATUS_SUCCESS;
        }
    }
 
Exit:
    /* All done, return the status code */
    SAC_DBG(SAC_DBG_ENTRY_EXIT, "SAC TearDownGlobalMessageTable: Exiting with status 0x%0x\n", Status);
    return Status;
}

Referenced by InitializeGlobalData().

◆ RawChannelCreate()

NTSTATUS NTAPI RawChannelCreate ( IN PSAC_CHANNEL Channel )

Definition at line 17 of file rawchan.c.

{
    CHECK_PARAMETER(Channel);
 
    /* Allocate the output buffer */
    Channel->OBuffer = SacAllocatePool(SAC_RAW_OBUFFER_SIZE, GLOBAL_BLOCK_TAG);
    CHECK_ALLOCATION(Channel->OBuffer);
 
    /* Allocate the input buffer */
    Channel->IBuffer = SacAllocatePool(SAC_RAW_IBUFFER_SIZE, GLOBAL_BLOCK_TAG);
    CHECK_ALLOCATION(Channel->IBuffer);
 
    /* Reset all flags and return success */
    Channel->OBufferIndex = 0;
    Channel->OBufferFirstGoodIndex = 0;
    Channel->ChannelHasNewIBufferData = FALSE;
    Channel->ChannelHasNewOBufferData = FALSE;
    return STATUS_SUCCESS;
}

Referenced by ChannelInitializeVTable().

◆ RawChannelDestroy()

NTSTATUS NTAPI RawChannelDestroy ( IN PSAC_CHANNEL Channel )

Definition at line 39 of file rawchan.c.

{
    CHECK_PARAMETER(Channel);
 
    /* Free the buffer and then destroy the channel */
    if (Channel->OBuffer) SacFreePool(Channel->OBuffer);
    if (Channel->IBuffer) SacFreePool(Channel->IBuffer);
    return ChannelDestroy(Channel);
}

Referenced by ChannelInitializeVTable().

◆ RawChannelIBufferIsFull()

NTSTATUS NTAPI RawChannelIBufferIsFull	(	IN PSAC_CHANNEL	Channel,
		OUT PBOOLEAN	BufferStatus
	)

Definition at line 297 of file rawchan.c.

{
    CHECK_PARAMETER1(Channel);
    CHECK_PARAMETER2(BufferStatus);
 
    /* If the index is beyond the length, the buffer must be full */
    *BufferStatus = RawChannelGetIBufferIndex(Channel) > SAC_RAW_IBUFFER_SIZE;
    return STATUS_SUCCESS;
}

Referenced by ChannelInitializeVTable(), and RawChannelIWrite().

◆ RawChannelIBufferLength()

ULONG NTAPI RawChannelIBufferLength ( IN PSAC_CHANNEL Channel )

Definition at line 310 of file rawchan.c.

{
    ASSERT(Channel);
 
    /* The index is the current length (since we're 0-based) */
    return RawChannelGetIBufferIndex(Channel);
}

Referenced by ChannelInitializeVTable().

◆ RawChannelIRead()

NTSTATUS NTAPI RawChannelIRead	(	IN PSAC_CHANNEL	Channel,
		IN PCHAR	Buffer,
		IN ULONG	BufferSize,
		IN PULONG	ReturnBufferSize
	)

Definition at line 246 of file rawchan.c.

{
    ULONG CopyChars;
    CHECK_PARAMETER1(Channel);
    CHECK_PARAMETER2(Buffer);
    CHECK_PARAMETER_WITH_STATUS(BufferSize > 0, STATUS_INVALID_BUFFER_SIZE);
 
    /* Assume failure */
    *ReturnBufferSize = 0;
 
    /* Check how many bytes are in the buffer */
    if (Channel->ChannelInputBufferLength(Channel) == 0)
    {
        /* Apparently nothing. Make sure the flag indicates so too */
        ASSERT(ChannelHasNewIBufferData(Channel) == FALSE);
    }
    else
    {
        /* Use the smallest number of bytes either in the buffer or requested */
        CopyChars = min(Channel->ChannelInputBufferLength(Channel), BufferSize);
        ASSERT(CopyChars <= Channel->ChannelInputBufferLength(Channel));
 
        /* Copy them into the caller's buffer */
        RtlCopyMemory(Buffer, Channel->IBuffer, CopyChars);
 
        /* Update the channel's index past the copied (read) bytes */
        RawChannelSetIBufferIndex(Channel,
                                  RawChannelGetIBufferIndex(Channel) - CopyChars);
 
        /* Are there still bytes that haven't been read yet? */
        if (Channel->ChannelInputBufferLength(Channel))
        {
            /* Shift them up in the buffer */
            RtlMoveMemory(Channel->IBuffer,
                          &Channel->IBuffer[CopyChars],
                          Channel->ChannelInputBufferLength(Channel));
        }
 
        /* Return the number of bytes we actually copied */
        *ReturnBufferSize = CopyChars;
    }
 
    /* Return success */
    return STATUS_SUCCESS;
}

Referenced by ChannelInitializeVTable().

◆ RawChannelIReadLast()

WCHAR NTAPI RawChannelIReadLast ( IN PSAC_CHANNEL Channel )

Definition at line 320 of file rawchan.c.

{
    UCHAR LastChar = 0;
    ASSERT(Channel);
 
    /* Check if there's anything to read in the buffer */
    if (Channel->ChannelInputBufferLength(Channel))
    {
        /* Go back one character */
        RawChannelSetIBufferIndex(Channel,
                                  RawChannelGetIBufferIndex(Channel) - 1);
 
        /* Read it, and clear its current value */
        LastChar = Channel->IBuffer[RawChannelGetIBufferIndex(Channel)];
        Channel->IBuffer[RawChannelGetIBufferIndex(Channel)] = ANSI_NULL;
    }
 
    /* Return the last character */
    return LastChar;
}

Referenced by ChannelInitializeVTable().

◆ RawChannelIWrite()

NTSTATUS NTAPI RawChannelIWrite	(	IN PSAC_CHANNEL	Channel,
		IN PCHAR	Buffer,
		IN ULONG	BufferSize
	)

Definition at line 343 of file rawchan.c.

{
    NTSTATUS Status;
    BOOLEAN IsFull;
    ULONG Index;
    CHECK_PARAMETER1(Channel);
    CHECK_PARAMETER2(Buffer);
    CHECK_PARAMETER_WITH_STATUS(BufferSize > 0, STATUS_INVALID_BUFFER_SIZE);
 
    /* First, check if the input buffer still has space */
    Status = RawChannelIBufferIsFull(Channel, &IsFull);
    if (!NT_SUCCESS(Status)) return Status;
    if (IsFull) return STATUS_UNSUCCESSFUL;
 
    /* Get the current buffer index */
    Index = RawChannelGetIBufferIndex(Channel);
    if ((SAC_RAW_IBUFFER_SIZE - Index) < BufferSize)
    {
        return STATUS_INSUFFICIENT_RESOURCES;
    }
 
    /* Copy the new data */
    RtlCopyMemory(&Channel->IBuffer[Index], Buffer, BufferSize);
 
    /* Update the index */
    RawChannelSetIBufferIndex(Channel, BufferSize + Index);
 
    /* Signal the event, if one was set */
    if (Channel->Flags & SAC_CHANNEL_FLAG_HAS_NEW_DATA_EVENT)
    {
        ChannelSetEvent(Channel, HasNewDataEvent);
    }
 
    /* All done */
    return STATUS_SUCCESS;
}

Referenced by ChannelInitializeVTable().

◆ RawChannelOEcho()

NTSTATUS NTAPI RawChannelOEcho	(	IN PSAC_CHANNEL	Channel,
		IN PCHAR	String,
		IN ULONG	Length
	)

Definition at line 115 of file rawchan.c.

{
    NTSTATUS Status = STATUS_SUCCESS;
 
    CHECK_PARAMETER1(Channel);
    CHECK_PARAMETER2(String);
 
    if (Length)
    {
        Status = ConMgrWriteData(Channel, String, Length);
        if (NT_SUCCESS(Status)) ConMgrFlushData(Channel);
    }
 
    return Status;
}

Referenced by ChannelInitializeVTable(), and RawChannelOWrite().

◆ RawChannelOFlush()

NTSTATUS NTAPI RawChannelOFlush ( IN PSAC_CHANNEL Channel )

Definition at line 172 of file rawchan.c.

{
    NTSTATUS Status;
    ULONG ByteCount;
    CHAR Dummy;
    CHECK_PARAMETER1(Channel);
 
    while (ChannelHasNewOBufferData(Channel))
    {
        Status = RawChannelORead(Channel, &Dummy, sizeof(Dummy), &ByteCount);
        if (!NT_SUCCESS(Status)) return Status;
 
        CHECK_PARAMETER_WITH_STATUS(ByteCount == 1, STATUS_UNSUCCESSFUL);
 
        Status = ConMgrWriteData(Channel, &Dummy, sizeof(Dummy));
        if (!NT_SUCCESS(Status)) return Status;
    }
 
    return ConMgrFlushData(Channel);
}

Referenced by ChannelInitializeVTable().

◆ RawChannelORead()

NTSTATUS NTAPI RawChannelORead	(	IN PSAC_CHANNEL	Channel,
		IN PCHAR	Buffer,
		IN ULONG	BufferSize,
		OUT PULONG	ByteCount
	)

Definition at line 58 of file rawchan.c.

{
    NTSTATUS Status;
    ULONG NextIndex;
 
    CHECK_PARAMETER1(Channel);
    CHECK_PARAMETER2(Buffer);
    CHECK_PARAMETER3(BufferSize > 0);
    CHECK_PARAMETER4(ByteCount);
 
    *ByteCount = 0;
 
    if (ChannelHasNewOBufferData(Channel))
    {
        Status = STATUS_SUCCESS;
 
        while (TRUE)
        {
            Buffer[(*ByteCount)++] = Channel->OBuffer[Channel->OBufferFirstGoodIndex];
 
            NextIndex = (Channel->OBufferFirstGoodIndex + 1) & (SAC_OBUFFER_SIZE - 1);
            Channel->OBufferFirstGoodIndex = NextIndex;
 
            if (NextIndex == Channel->OBufferIndex)
            {
                _InterlockedExchange(&Channel->ChannelHasNewOBufferData, 0);
                break;
            }
 
            ASSERT(*ByteCount > 0);
 
            if (*ByteCount >= BufferSize) break;
        }
    }
    else
    {
        Status = STATUS_NO_DATA_DETECTED;
    }
 
    if (Channel->OBufferFirstGoodIndex == Channel->OBufferIndex)
    {
        ASSERT(ChannelHasNewOBufferData(Channel) == FALSE);
    }
 
    if (ChannelHasNewOBufferData(Channel) == FALSE)
    {
        ASSERT(Channel->OBufferFirstGoodIndex == Channel->OBufferIndex);
    }
 
    return Status;
}

Referenced by ChannelInitializeVTable(), and RawChannelOFlush().

◆ RawChannelOWrite()

NTSTATUS NTAPI RawChannelOWrite	(	IN PSAC_CHANNEL	Channel,
		IN PCHAR	String,
		IN ULONG	Length
	)

Definition at line 195 of file rawchan.c.

{
    CHECK_PARAMETER1(Channel);
    CHECK_PARAMETER2(String);
 
    if ((ConMgrIsWriteEnabled(Channel)) && (Channel->WriteEnabled))
    {
        return RawChannelOEcho(Channel, String, Length);
    }
 
    return RawChannelOWrite2(Channel, String, Length);
}

Referenced by ChannelInitializeVTable().

◆ RegisterBlueScreenMachineInformation()

NTSTATUS NTAPI RegisterBlueScreenMachineInformation ( VOID )

Definition at line 1104 of file util.c.

{
    PWCHAR XmlBuffer;
    PHEADLESS_CMD_SET_BLUE_SCREEN_DATA BsBuffer;
    SIZE_T Length, HeaderLength, TotalLength;
    NTSTATUS Status;
    ULONG i;
 
    /* Create the XML buffer and make sure it's OK */
    Status = TranslateMachineInformationXML(&XmlBuffer, NULL);
    CHECK_PARAMETER_WITH_STATUS(NT_SUCCESS(Status), Status);
    CHECK_PARAMETER_WITH_STATUS(XmlBuffer, STATUS_UNSUCCESSFUL);
 
    /* Compute the sizes and allocate a buffer for it */
    Length = wcslen(XmlBuffer);
    HeaderLength = strlen("MACHINEINFO");
    TotalLength = HeaderLength +
                  Length +
                  sizeof(*BsBuffer) +
                  2 * sizeof(ANSI_NULL);
    BsBuffer = SacAllocatePool(TotalLength, GLOBAL_BLOCK_TAG);
    CHECK_PARAMETER_WITH_STATUS(BsBuffer, STATUS_NO_MEMORY);
 
    /* Copy the XML property name */
    strcpy((PCHAR)BsBuffer->Data, "MACHINEINFO");
    BsBuffer->ValueIndex = HeaderLength + sizeof(ANSI_NULL);
 
    /* Copy the data and NULL-terminate it */
    for (i = 0; i < Length; i++)
    {
        BsBuffer->Data[BsBuffer->ValueIndex + i] = XmlBuffer[i];
    }
    BsBuffer->Data[BsBuffer->ValueIndex + i] = ANSI_NULL;
 
    /* Let the OS save the buffer for later */
    Status = HeadlessDispatch(HeadlessCmdSetBlueScreenData,
                              BsBuffer,
                              TotalLength,
                              NULL,
                              NULL);
 
    /* Failure or not, we don't need this anymore */
    SacFreePool(BsBuffer);
    SacFreePool(XmlBuffer);
 
    /* Return the result */
    SAC_DBG(SAC_DBG_ENTRY_EXIT, "SAC Initialize Machine Information: Exiting.\n");
    return Status;
}

Referenced by InitializeGlobalData().

◆ SacAcquireLock()

FORCEINLINE VOID SacAcquireLock ( IN PSAC_CHANNEL_LOCK Lock )

Definition at line 1262 of file sacdrv.h.

{
    KeWaitForSingleObject(&Lock->Lock, Executive, KernelMode, FALSE, NULL);
    ASSERT(Lock->RefCount == 0);
    _InterlockedIncrement(&Lock->RefCount);
}

◆ SacAcquireMutexLock()

FORCEINLINE VOID SacAcquireMutexLock ( VOID )

Definition at line 1308 of file sacdrv.h.

{
    KeWaitForSingleObject(&CurrentChannelLock, Executive, KernelMode, FALSE, NULL);
    ASSERT(CurrentChannelRefCount == 0);
    _InterlockedIncrement(&CurrentChannelRefCount);
}

Referenced by ConMgrChannelOWrite(), ConMgrEventMessage(), ConMgrInitialize(), and ConMgrSerialPortConsumer().

◆ SacAssertMutexLockHeld()

FORCEINLINE VOID SacAssertMutexLockHeld ( VOID )

Definition at line 1286 of file sacdrv.h.

{
    ASSERT(CurrentChannelRefCount == 1);
    ASSERT(KeReadStateMutex(&CurrentChannelLock) == 0);
}

Referenced by ConMgrAdvanceCurrentChannel(), ConMgrDisplayCurrentChannel(), ConMgrResetCurrentChannel(), and ConMgrSetCurrentChannel().

◆ SacInitializeLock()

FORCEINLINE VOID SacInitializeLock ( IN PSAC_CHANNEL_LOCK Lock )

Definition at line 1252 of file sacdrv.h.

{
    KeInitializeSemaphore(&Lock->Lock, 1, 1);
}

Referenced by ChanMgrInitialize(), and ChannelCreate().

◆ SacInitializeMutexLock()

FORCEINLINE VOID SacInitializeMutexLock ( VOID )

Definition at line 1297 of file sacdrv.h.

{
    KeInitializeMutex(&CurrentChannelLock, 0);
    CurrentChannelRefCount = 0;
}

Referenced by ConMgrInitialize().

◆ SacPutSimpleMessage()

BOOLEAN NTAPI SacPutSimpleMessage ( IN ULONG MessageIndex )

Definition at line 57 of file conmgr.c.

{
    PWCHAR MessageBuffer;
    BOOLEAN Result;
 
    /* Get the message */
    MessageBuffer = GetMessage(MessageIndex);
    if (MessageBuffer)
    {
        /* Output it */
        SacPutString(MessageBuffer);
        Result = TRUE;
    }
    else
    {
        Result = FALSE;
    }
 
    /* All done */
    return Result;
}

Referenced by ConMgrEventMessage(), ConMgrInitialize(), ConMgrProcessInputLine(), ConMgrSerialPortConsumer(), DoFullInfoCommand(), DoPagingCommand(), DoRebootCommand(), DoTlistCommand(), and PrintHelpMessage().

◆ SacPutString()

VOID NTAPI SacPutString ( IN PWCHAR String )

Definition at line 41 of file conmgr.c.

{
    NTSTATUS Status;
 
    /* Write the string on the main SAC channel */
    Status = ChannelOWrite(SacChannel,
                           (PCHAR)String,
                           wcslen(String) * sizeof(WCHAR));
    if (!NT_SUCCESS(Status))
    {
        SAC_DBG(SAC_DBG_INIT, "SAC XmlMgrSacPutString: OWrite failed\n");
    }
}

Referenced by ConMgrEventMessage(), ConMgrSerialPortConsumer(), DoRebootCommand(), DoTlistCommand(), and SacPutSimpleMessage().

◆ SacReleaseLock()

FORCEINLINE VOID SacReleaseLock ( IN PSAC_CHANNEL_LOCK Lock )

Definition at line 1274 of file sacdrv.h.

{
    ASSERT(Lock->RefCount == 1);
    _InterlockedDecrement(&Lock->RefCount);
    KeReleaseSemaphore(&Lock->Lock, SEMAPHORE_INCREMENT, 1, FALSE);
}

◆ SacReleaseMutexLock()

FORCEINLINE VOID SacReleaseMutexLock ( VOID )

Definition at line 1320 of file sacdrv.h.

{
    ASSERT(CurrentChannelRefCount == 1);
    _InterlockedDecrement(&CurrentChannelRefCount);
    KeReleaseMutex(&CurrentChannelLock, FALSE);
}

Referenced by ConMgrChannelOWrite(), ConMgrEventMessage(), ConMgrInitialize(), and ConMgrSerialPortConsumer().

◆ SacTranslateUnicodeToUtf8()

BOOLEAN NTAPI SacTranslateUnicodeToUtf8	(	IN PWCHAR	SourceBuffer,
		IN ULONG	SourceBufferLength,
		OUT PCHAR	DestinationBuffer,
		IN ULONG	DestinationBufferSize,
		OUT PULONG	UTF8Count,
		OUT PULONG	ProcessedCount
	)

Definition at line 91 of file util.c.

{
    *UTF8Count = 0;
    *ProcessedCount = 0;
 
    while ((*SourceBuffer) &&
           (*UTF8Count < DestinationBufferSize) &&
           (*ProcessedCount < SourceBufferLength))
    {
        if (*SourceBuffer & 0xFF80)
        {
            if (*SourceBuffer & 0xF800)
            {
                if ((*UTF8Count + 3) >= DestinationBufferSize) break;
                DestinationBuffer[*UTF8Count] = ((*SourceBuffer >> 12) & 0xF) | 0xE0;
                ++*UTF8Count;
                DestinationBuffer[*UTF8Count] = ((*SourceBuffer >> 6) & 0x3F) | 0x80;
            }
            else
            {
                if ((*UTF8Count + 2) >= DestinationBufferSize) break;
                DestinationBuffer[*UTF8Count] = ((*SourceBuffer >> 6) & 31) | 0xC0;
            }
            ++*UTF8Count;
            DestinationBuffer[*UTF8Count] = (*SourceBuffer & 0x3F) | 0x80;
        }
        else
        {
            DestinationBuffer[*UTF8Count] = (*SourceBuffer & 0x7F);
        }
 
        ++*UTF8Count;
        ++*ProcessedCount;
        ++SourceBuffer;
    }
 
    ASSERT(*ProcessedCount <= SourceBufferLength);
    ASSERT(*UTF8Count <= DestinationBufferSize);
    return TRUE;
}

Referenced by UTF8EncodeAndSend(), VTUTF8ChannelOEcho(), and VTUTF8ChannelOFlush().

◆ SacTranslateUtf8ToUnicode()

BOOLEAN NTAPI SacTranslateUtf8ToUnicode	(	IN CHAR	Utf8Char,
		IN PCHAR	Utf8Buffer,
		OUT PWCHAR	Utf8Value
	)

Definition at line 41 of file util.c.

{
    ULONG i;
 
    /* Find out how many valid characters we have in the buffer */
    i = 0;
    while (Utf8Buffer[i++] && (i < 3));
 
    /* If we have at least 3, shift everything by a byte */
    if (i >= 3)
    {
        /* The last input character goes at the end */
        Utf8Buffer[0] = Utf8Buffer[1];
        Utf8Buffer[1] = Utf8Buffer[2];
        Utf8Buffer[2] = Utf8Char;
    }
    else
    {
        /* We don't have more than 3 characters, place the input at the index */
        Utf8Buffer[i] = Utf8Char;
    }
 
    /* Print to debugger */
    SAC_DBG(SAC_DBG_ENTRY_EXIT, "SacTranslateUtf8ToUnicode - About to decode the UTF8 buffer.\n");
    SAC_DBG(SAC_DBG_ENTRY_EXIT, "                                  UTF8[0]: 0x%02lx UTF8[1]: 0x%02lx UTF8[2]: 0x%02lx\n",
            Utf8Buffer[0],
            Utf8Buffer[1],
            Utf8Buffer[2]);
 
    /* Is this a simple ANSI character? */
    if (!(Utf8Char & 0x80))
    {
        /* Return it as Unicode, nothing left to do */
        SAC_DBG(SAC_DBG_ENTRY_EXIT, "SACDRV: SacTranslateUTf8ToUnicode - Case1\n");
        *Utf8Value = (WCHAR)Utf8Char;
        Utf8Buffer[0] = Utf8Buffer[1];
        Utf8Buffer[1] = Utf8Buffer[2];
        Utf8Buffer[2] = UNICODE_NULL;
        return TRUE;
    }
 
    /* Anything else is not yet supported */
    ASSERT(FALSE);
    return FALSE;
}

Referenced by VTUTF8ChannelIWrite().

◆ SerialBufferGetChar()

NTSTATUS NTAPI SerialBufferGetChar ( OUT PCHAR Char )

Definition at line 1212 of file util.c.

{
    /* Check if nothing's been produced yet */
    if (SerialPortConsumerIndex == SerialPortProducerIndex)
    {
        return STATUS_NO_DATA_DETECTED;
    }
 
    /* Consume the produced character and clear it*/
    *Char = SerialPortBuffer[SerialPortConsumerIndex];
    SerialPortBuffer[SerialPortConsumerIndex] = ANSI_NULL;
 
    /* Advance the index and return success */
    _InterlockedExchange(&SerialPortConsumerIndex,
                         (SerialPortConsumerIndex + 1) &
                         (SAC_SERIAL_PORT_BUFFER_SIZE - 1));
    return STATUS_SUCCESS;
}

Referenced by ConMgrSerialPortConsumer().

◆ TearDownGlobalMessageTable()

NTSTATUS NTAPI TearDownGlobalMessageTable ( VOID )

Definition at line 379 of file util.c.

{
    SAC_DBG(SAC_DBG_ENTRY_EXIT, "SAC TearDownGlobalMessageTable: Entering.\n");
 
    /* Free the table if one existed */
    if (GlobalMessageTable) SacFreePool(GlobalMessageTable);
 
    SAC_DBG(SAC_DBG_ENTRY_EXIT, "SAC TearDownGlobalMessageTable: Exiting\n");
    return STATUS_SUCCESS;
}

Referenced by FreeGlobalData(), and InitializeGlobalData().

◆ TimerDpcRoutine()

VOID NTAPI TimerDpcRoutine	(	IN PKDPC	Dpc,
		IN PVOID	DeferredContext,
		IN PVOID	SystemArgument1,
		IN PVOID	SystemArgument2
	)

Definition at line 61 of file dispatch.c.

{
    HEADLESS_RSP_GET_BYTE ByteValue;
    SIZE_T ValueSize;
    BOOLEAN GotChar;
    NTSTATUS Status;
    PSAC_DEVICE_EXTENSION SacExtension;
 
    /* Update our counter */
    _InterlockedExchangeAdd(&TimerDpcCount, 1);
 
    /* Set defaults and loop for new characters */
    GotChar = FALSE;
    ValueSize = sizeof(ByteValue);
    do
    {
        /* Ask the kernel for a byte */
        Status = HeadlessDispatch(HeadlessCmdGetByte,
                                  NULL,
                                  0,
                                  &ByteValue,
                                  &ValueSize);
 
        /* Break out if there's nothing interesting */
        if (!NT_SUCCESS(Status)) break;
        if (!ByteValue.Value) break;
 
        /* Update the serial port buffer */
        SerialPortBuffer[SerialPortProducerIndex] = ByteValue.Value;
        GotChar = TRUE;
 
        /* Update the index, let it roll-over if needed */
        _InterlockedExchange(&SerialPortProducerIndex,
                             (SerialPortProducerIndex + 1) &
                             (SAC_SERIAL_PORT_BUFFER_SIZE - 1));
    } while (ByteValue.Value);
 
    /* Did we get anything */
    if (GotChar)
    {
        /* Signal the worker thread that there is work to do */
        SacExtension = DeferredContext;
        KeSetEvent(&SacExtension->Event, SacExtension->PriorityBoost, FALSE);
    }
}

Referenced by InitializeDeviceData().

◆ TranslateMachineInformationXML()

NTSTATUS NTAPI TranslateMachineInformationXML	(	IN PWCHAR *	Buffer,
		IN PWCHAR	ExtraData
	)

Definition at line 541 of file util.c.

{
    NTSTATUS Status;
    SIZE_T Size;
    PWCHAR p;
    CHECK_PARAMETER1(Buffer);
 
    /* Start by believing the world is beautiful */
    Status = STATUS_SUCCESS;
 
    /* First, the header */
    Size = wcslen(L"<machine-info>\r\n");
 
    /* Do we have a machine name? */
    if (MachineInformation->MachineName)
    {
        /* Go and add it in */
        Size += wcslen(MachineInformation->MachineName);
        Size += wcslen(L"<name>%s</name>\r\n");
    }
 
    /* Do we have a GUID? */
    if (MachineInformation->MachineGuid)
    {
        /* Go and add it in */
        Size += wcslen(MachineInformation->MachineGuid);
        Size += wcslen(L"<guid>%s</guid>\r\n");
    }
 
    /* Do we know the processor? */
    if (MachineInformation->ProcessorArchitecture)
    {
        /* Go and add it in */
        Size += wcslen(MachineInformation->ProcessorArchitecture);
        Size += wcslen(L"<processor-architecture>%s</processor-architecture>\r\n");
    }
 
    /* Do we have the version? */
    if (MachineInformation->MajorVersion)
    {
        /* Go and add it in */
        Size += wcslen(MachineInformation->MajorVersion);
        Size += wcslen(L"<os-version>%s</os-version>\r\n");
    }
 
    /* Do we have the build? */
    if (MachineInformation->BuildNumber)
    {
        /* Go and add it in */
        Size += wcslen(MachineInformation->BuildNumber);
        Size += wcslen(L"<os-build-number>%s</os-build-number>\r\n");
    }
 
    /* Do we have the product type? */
    if (MachineInformation->ProductType)
    {
        /* Go and add it in */
        Size += wcslen(MachineInformation->ProductType);
        Size += wcslen(L"<os-product>%s</os-product>\r\n");
    }
 
    /* Do we have a service pack? */
    if (MachineInformation->ServicePack)
    {
        /* Go and add it in */
        Size += wcslen(MachineInformation->ServicePack);
        Size += wcslen(L"<os-service-pack>%s</os-service-pack>\r\n");
    }
 
    /* Anything else we need to know? Add it in too */
    if (ExtraData) Size += wcslen(ExtraData);
 
    /* Finally, add the footer */
    Size += wcslen(L"</machine-info>\r\n");
 
    /* Convert to bytes and add a NULL */
    Size += sizeof(ANSI_NULL);
    Size *= sizeof(WCHAR);
 
    /* Allocate space for the buffer */
    p = SacAllocatePool(Size, GLOBAL_BLOCK_TAG);
    *Buffer = p;
    if (!p) return STATUS_NO_MEMORY;
 
    wcscpy(p, L"<machine-info>\r\n");
    p += wcslen(L"<machine-info>\r\n");
 
    if (MachineInformation->MachineName)
    {
        p += swprintf(p,
                      L"<name>%s</name>\r\n",
                      MachineInformation->MachineName);
    }
 
    if (MachineInformation->MachineGuid)
    {
        p += swprintf(p,
                      L"<guid>%s</guid>\r\n",
                      MachineInformation->MachineGuid);
    }
 
    if (MachineInformation->ProcessorArchitecture)
    {
        p += swprintf(p,
                      L"<processor-architecture>%s</processor-architecture>\r\n",
                      MachineInformation->ProcessorArchitecture);
    }
 
    if (MachineInformation->MajorVersion)
    {
        p += swprintf(p,
                      L"<os-version>%s</os-version>\r\n",
                      MachineInformation->MajorVersion);
    }
 
    if (MachineInformation->BuildNumber)
    {
        p += swprintf(p,
                      L"<os-build-number>%s</os-build-number>\r\n",
                      MachineInformation->BuildNumber);
    }
 
    if (MachineInformation->ProductType)
    {
        p += swprintf(p,
                      L"<os-product>%s</os-product>\r\n",
                      MachineInformation->ProductType);
    }
 
    if (MachineInformation->ServicePack)
    {
        p += swprintf(p,
                      L"<os-service-pack>%s</os-service-pack>\r\n",
                      MachineInformation->ServicePack);
    }
 
    if (ExtraData)
    {
        wcscpy(p, ExtraData);
        p += wcslen(ExtraData);
    }
 
    wcscpy(p, L"</machine-info>\r\n");
    SAC_DBG(SAC_DBG_ENTRY_EXIT, "MachineInformation: %S\n", *Buffer);
    ASSERT((((ULONG)wcslen(*Buffer) + 1) * sizeof(WCHAR)) <= Size);
    return Status;
}

Referenced by InitializeDeviceData(), and RegisterBlueScreenMachineInformation().

◆ UnloadHandler()

VOID NTAPI UnloadHandler ( IN PDRIVER_OBJECT DriverObject )

Definition at line 112 of file dispatch.c.

{
    PDEVICE_OBJECT DeviceObject, NextDevice;
    SAC_DBG(SAC_DBG_ENTRY_EXIT, "SAC UnloadHandler: Entering.\n");
 
    /* Go over every device part of the driver */
    DeviceObject = DriverObject->DeviceObject;
    while (DeviceObject)
    {
        /* Free and delete the information about this device */
        NextDevice = DeviceObject->NextDevice;
        FreeDeviceData(DeviceObject);
        IoDeleteDevice(DeviceObject);
 
        /* Move on to the next one */
        DeviceObject = NextDevice;
    }
 
    /* Free the driver data and exit */
    FreeGlobalData();
    SAC_DBG(SAC_DBG_ENTRY_EXIT, "SAC UnloadHandler: Exiting.\n");
}

◆ UTF8EncodeAndSend()

NTSTATUS NTAPI UTF8EncodeAndSend ( IN PWCHAR String )

Definition at line 165 of file util.c.

{
    ULONG ProcessedCount, Utf8Count, i;
    NTSTATUS Status = STATUS_SUCCESS;
 
    /* Call the translator routine */
    if (SacTranslateUnicodeToUtf8(String,
                                  wcslen(String),
                                  Utf8ConversionBuffer,
                                  Utf8ConversionBufferSize,
                                  &Utf8Count,
                                  &ProcessedCount))
    {
        /* Loop every character */
        for (i = 0; i < Utf8Count; i++)
        {
            /* Send it to the terminal */
            Status = HeadlessDispatch(HeadlessCmdPutData,
                                      &Utf8ConversionBuffer[i],
                                      sizeof(Utf8ConversionBuffer[i]),
                                      NULL,
                                      NULL);
            if (!NT_SUCCESS(Status)) break;
        }
    }
    else
    {
        /* Conversion failed */
        Status = STATUS_UNSUCCESSFUL;
    }
 
    /* All done */
    return Status;
}

Referenced by InitializeDeviceData().

◆ VerifyEventWaitable()

BOOLEAN NTAPI VerifyEventWaitable	(	IN HANDLE	Handle,
		OUT PVOID *	WaitObject,
		OUT PVOID *	ActualWaitObject
	)

Definition at line 1172 of file util.c.

{
    PVOID Object;
    NTSTATUS Status;
    POBJECT_TYPE ObjectType;
 
    /* Reference the object */
    Status = ObReferenceObjectByHandle(Handle,
                                       EVENT_ALL_ACCESS,
                                       NULL,
                                       KernelMode,
                                       &Object,
                                       NULL);
    *WaitObject = Object;
    if (!NT_SUCCESS(Status))
    {
        SAC_DBG(SAC_DBG_INIT, "SAC VerifyEventWaitable: Unable to reference event object (%lx)\n", Status);
        return FALSE;
    }
 
    /* Check if the object itself is NOT being used */
    ObjectType = OBJECT_TO_OBJECT_HEADER(Object)->Type;
    if (ObjectType->TypeInfo.UseDefaultObject == FALSE)
    {
        /* Get the actual object that's being used for the wait */
        *ActualWaitObject = (PVOID)((ULONG_PTR)Object +
                                    (ULONG_PTR)ObjectType->DefaultObject);
        return TRUE;
    }
 
    /* Drop the reference we took */
    SAC_DBG(SAC_DBG_INIT, "SAC VerifyEventWaitable: event object not waitable!\n");
    ObDereferenceObject(*WaitObject);
    return FALSE;
}

◆ VTUTF8ChannelCreate()

NTSTATUS NTAPI VTUTF8ChannelCreate ( IN PSAC_CHANNEL Channel )

Definition at line 677 of file vtutf8chan.c.

{
    NTSTATUS Status;
    CHECK_PARAMETER(Channel);
 
    /* Allocate the output buffer */
    Channel->OBuffer = SacAllocatePool(SAC_VTUTF8_OBUFFER_SIZE, GLOBAL_BLOCK_TAG);
    CHECK_ALLOCATION(Channel->OBuffer);
 
    /* Allocate the input buffer */
    Channel->IBuffer = SacAllocatePool(SAC_VTUTF8_IBUFFER_SIZE, GLOBAL_BLOCK_TAG);
    CHECK_ALLOCATION(Channel->IBuffer);
 
    /* Initialize the output stream */
    Status = VTUTF8ChannelOInit(Channel);
    if (NT_SUCCESS(Status)) return Status;
 
    /* Reset all flags and return success */
    _InterlockedExchange(&Channel->ChannelHasNewOBufferData, 0);
    _InterlockedExchange(&Channel->ChannelHasNewIBufferData, 0);
    return STATUS_SUCCESS;
}

Referenced by ChannelInitializeVTable().

◆ VTUTF8ChannelDestroy()

NTSTATUS NTAPI VTUTF8ChannelDestroy ( IN PSAC_CHANNEL Channel )

Definition at line 702 of file vtutf8chan.c.

{
    CHECK_PARAMETER(Channel);
 
    /* Free the buffer and then destroy the channel */
    if (Channel->OBuffer) SacFreePool(Channel->OBuffer);
    if (Channel->IBuffer) SacFreePool(Channel->IBuffer);
    return ChannelDestroy(Channel);
}

Referenced by ChannelInitializeVTable().

◆ VTUTF8ChannelIBufferIsFull()

NTSTATUS NTAPI VTUTF8ChannelIBufferIsFull	(	IN PSAC_CHANNEL	Channel,
		OUT PBOOLEAN	BufferStatus
	)

Definition at line 1291 of file vtutf8chan.c.

{
    CHECK_PARAMETER1(Channel);
 
    /* If the index is beyond the length, the buffer must be full */
    *BufferStatus = VTUTF8ChannelGetIBufferIndex(Channel) > SAC_VTUTF8_IBUFFER_SIZE;
    return STATUS_SUCCESS;
}

Referenced by ChannelInitializeVTable(), and VTUTF8ChannelIWrite().

◆ VTUTF8ChannelIBufferLength()

ULONG NTAPI VTUTF8ChannelIBufferLength ( IN PSAC_CHANNEL Channel )

Definition at line 1303 of file vtutf8chan.c.

{
    ASSERT(Channel);
 
    /* The index is the length, so divide by two to get character count */
    return VTUTF8ChannelGetIBufferIndex(Channel) / sizeof(WCHAR);
}

Referenced by ChannelInitializeVTable().

◆ VTUTF8ChannelIRead()

NTSTATUS NTAPI VTUTF8ChannelIRead	(	IN PSAC_CHANNEL	Channel,
		IN PCHAR	Buffer,
		IN ULONG	BufferSize,
		IN PULONG	ReturnBufferSize
	)

Definition at line 1234 of file vtutf8chan.c.

{
    ULONG CopyChars, ReadLength;
    CHECK_PARAMETER1(Channel);
    CHECK_PARAMETER2(Buffer);
    CHECK_PARAMETER_WITH_STATUS(BufferSize > 0, STATUS_INVALID_BUFFER_SIZE);
 
    /* Assume failure */
    *ReturnBufferSize = 0;
 
    /* Check how many bytes are in the buffer */
    if (Channel->ChannelInputBufferLength(Channel) == 0)
    {
        /* Apparently nothing. Make sure the flag indicates so too */
        ASSERT(ChannelHasNewIBufferData(Channel) == FALSE);
    }
    else
    {
        /* Use the smallest number of bytes either in the buffer or requested */
        ReadLength = min(Channel->ChannelInputBufferLength(Channel) * sizeof(WCHAR),
                         BufferSize);
 
        /* Do some cheezy buffer alignment */
        CopyChars = ReadLength / sizeof(WCHAR);
        ReadLength = CopyChars * sizeof(WCHAR);
        ASSERT(CopyChars <= Channel->ChannelInputBufferLength(Channel));
 
        /* Copy them into the caller's buffer */
        RtlCopyMemory(Buffer, Channel->IBuffer, ReadLength);
 
        /* Update the channel's index past the copied (read) bytes */
        VTUTF8ChannelSetIBufferIndex(Channel,
            VTUTF8ChannelGetIBufferIndex(Channel) - ReadLength);
 
        /* Are there still bytes that haven't been read yet? */
        if (Channel->ChannelInputBufferLength(Channel))
        {
            /* Shift them up in the buffer */
            RtlMoveMemory(Channel->IBuffer,
                          &Channel->IBuffer[ReadLength],
                          Channel->ChannelInputBufferLength(Channel) *
                          sizeof(WCHAR));
        }
 
        /* Return the number of bytes we actually copied */
        *ReturnBufferSize = ReadLength;
    }
 
    /* Return success */
    return STATUS_SUCCESS;
}

Referenced by ChannelInitializeVTable().

◆ VTUTF8ChannelIReadLast()

WCHAR NTAPI VTUTF8ChannelIReadLast ( IN PSAC_CHANNEL Channel )

Definition at line 1313 of file vtutf8chan.c.

{
    PWCHAR LastCharLocation;
    WCHAR LastChar = 0;
    ASSERT(Channel);
 
    /* Check if there's anything to read in the buffer */
    if (Channel->ChannelInputBufferLength(Channel))
    {
        /* Go back one character */
        VTUTF8ChannelSetIBufferIndex(Channel,
                                     VTUTF8ChannelGetIBufferIndex(Channel) -
                                     sizeof(WCHAR));
 
        /* Read it, and clear its current value */
        LastCharLocation = (PWCHAR)&Channel->IBuffer[VTUTF8ChannelGetIBufferIndex(Channel)];
        LastChar = *LastCharLocation;
        *LastCharLocation = UNICODE_NULL;
    }
 
    /* Return the last character */
    return LastChar;
}

Referenced by ChannelInitializeVTable().

◆ VTUTF8ChannelIWrite()

NTSTATUS NTAPI VTUTF8ChannelIWrite	(	IN PSAC_CHANNEL	Channel,
		IN PCHAR	Buffer,
		IN ULONG	BufferSize
	)

Definition at line 1339 of file vtutf8chan.c.

{
    NTSTATUS Status;
    BOOLEAN IsFull;
    ULONG Index, i;
    CHECK_PARAMETER1(Channel);
    CHECK_PARAMETER2(Buffer);
    CHECK_PARAMETER_WITH_STATUS(BufferSize > 0, STATUS_INVALID_BUFFER_SIZE);
 
    /* First, check if the input buffer still has space */
    Status = VTUTF8ChannelIBufferIsFull(Channel, &IsFull);
    if (!NT_SUCCESS(Status)) return Status;
    if (IsFull) return STATUS_UNSUCCESSFUL;
 
    /* Get the current buffer index */
    Index = VTUTF8ChannelGetIBufferIndex(Channel);
    if ((SAC_VTUTF8_IBUFFER_SIZE - Index) < BufferSize)
    {
        return STATUS_INSUFFICIENT_RESOURCES;
    }
 
    /* Copy the new data */
    for (i = 0; i < BufferSize; i++)
    {
        /* Convert the character */
        if (SacTranslateUtf8ToUnicode(Buffer[i],
                                      IncomingUtf8ConversionBuffer,
                                      &IncomingUnicodeValue))
        {
            /* Write it into the buffer */
            *(PWCHAR)&Channel->IBuffer[VTUTF8ChannelGetIBufferIndex(Channel)] =
                IncomingUnicodeValue;
 
            /* Update the index */
            Index = VTUTF8ChannelGetIBufferIndex(Channel);
            VTUTF8ChannelSetIBufferIndex(Channel, Index + sizeof(WCHAR));
        }
    }
 
    /* Signal the event, if one was set */
    if (Channel->Flags & SAC_CHANNEL_FLAG_HAS_NEW_DATA_EVENT)
    {
        ChannelSetEvent(Channel, HasNewDataEvent);
    }
 
    /* All done */
    return STATUS_SUCCESS;
}

Referenced by ChannelInitializeVTable().

◆ VTUTF8ChannelOEcho()

NTSTATUS NTAPI VTUTF8ChannelOEcho	(	IN PSAC_CHANNEL	Channel,
		IN PCHAR	String,
		IN ULONG	Length
	)

Definition at line 1077 of file vtutf8chan.c.

{
    NTSTATUS Status = STATUS_SUCCESS;
    PWSTR pwch;
    ULONG i, k, TranslatedCount, UTF8TranslationSize;
    BOOLEAN Result;
    CHECK_PARAMETER1(Channel);
    CHECK_PARAMETER2(String);
 
    /* Return success if there's nothing to echo */
    if (!(Size / sizeof(WCHAR))) return Status;
 
    /* Start with the input string */
    pwch = (PWCHAR)String;
 
    /* First, figure out how much is outside of the block length alignment */
    k = (Size / sizeof(WCHAR)) % MAX_UTF8_ENCODE_BLOCK_LENGTH;
    if (k)
    {
        /* Translate the misaligned portion */
        Result = SacTranslateUnicodeToUtf8(pwch,
                                           k,
                                           Utf8ConversionBuffer,
                                           Utf8ConversionBufferSize,
                                           &UTF8TranslationSize,
                                           &TranslatedCount);
        ASSERT(k == TranslatedCount);
        if (!Result)
        {
            /* If we couldn't translate, write failure to break out below */
            Status = STATUS_UNSUCCESSFUL;
        }
        else
        {
            /* Write the misaligned portion into the buffer */
            Status = ConMgrWriteData(Channel,
                                     Utf8ConversionBuffer,
                                     UTF8TranslationSize);
        }
 
        /* If translation or write failed, bail out */
        if (!NT_SUCCESS(Status)) goto Return;
    }
 
    /* Push the string to its new location (this could be a noop if aligned) */
    pwch += k;
 
    /* Now figure out how many aligned blocks we have, and loop each one */
    k = (Size / sizeof(WCHAR)) / MAX_UTF8_ENCODE_BLOCK_LENGTH;
    for (i = 0; i < k; i++)
    {
        /* Translate the aligned block */
        Result = SacTranslateUnicodeToUtf8(pwch,
                                           MAX_UTF8_ENCODE_BLOCK_LENGTH,
                                           Utf8ConversionBuffer,
                                           Utf8ConversionBufferSize,
                                           &UTF8TranslationSize,
                                           &TranslatedCount);
        ASSERT(MAX_UTF8_ENCODE_BLOCK_LENGTH == TranslatedCount);
        ASSERT(UTF8TranslationSize > 0);
        if (!Result)
        {
            /* Set failure here, we'll break out below */
            Status = STATUS_UNSUCCESSFUL;
        }
        else
        {
            /* Move the string location to the next aligned block */
            pwch += MAX_UTF8_ENCODE_BLOCK_LENGTH;
 
            /* Write the aligned block into the buffer */
            Status = ConMgrWriteData(Channel,
                                     Utf8ConversionBuffer,
                                     UTF8TranslationSize);
        }
 
        /* If translation or write failed, bail out */
        if (!NT_SUCCESS(Status)) break;
    }
 
Return:
    ASSERT(pwch == (PWSTR)(String + Size));
    if (NT_SUCCESS(Status)) Status = ConMgrFlushData(Channel);
    return Status;
}

Referenced by ChannelInitializeVTable(), and VTUTF8ChannelOWrite().

◆ VTUTF8ChannelOFlush()

NTSTATUS NTAPI VTUTF8ChannelOFlush ( IN PSAC_CHANNEL Channel )

Definition at line 725 of file vtutf8chan.c.

{
    NTSTATUS Status;
    PSAC_VTUTF8_SCREEN Screen;
    INT Color[2], Position[2];
    ULONG Utf8ProcessedCount, Utf8Count, R, C, ForeColor, BackColor, Attribute;
    PWCHAR TmpBuffer;
    BOOLEAN Overflow = FALSE;
    CHECK_PARAMETER(Channel);
 
    /* Set the cell buffer position */
    Screen = (PSAC_VTUTF8_SCREEN)Channel->OBuffer;
 
    /* Allocate a temporary buffer */
    TmpBuffer = SacAllocatePool(40, GLOBAL_BLOCK_TAG);
    if (!TmpBuffer)
    {
        Status = STATUS_NO_MEMORY;
        goto Quickie;
    }
 
    /* First, clear the screen */
    Status = VTUTF8ChannelAnsiDispatch(Channel,
                                       SacAnsiClearScreen,
                                       NULL,
                                       0);
    if (!NT_SUCCESS(Status)) goto Quickie;
 
    /* Next, reset the cursor position */
    Position[1] = 0;
    Position[0] = 0;
    Status = VTUTF8ChannelAnsiDispatch(Channel,
                                       SacAnsiSetPosition,
                                       Position,
                                       sizeof(Position));
    if (!NT_SUCCESS(Status)) goto Quickie;
 
    /* Finally, reset the attributes */
    Status = VTUTF8ChannelAnsiDispatch(Channel,
                                       SacAnsiClearAttributes,
                                       NULL,
                                       0);
    if (!NT_SUCCESS(Status)) goto Quickie;
 
    /* Now set the current cell attributes */
    Attribute = Channel->CellFlags;
    Status = VTUTF8ChannelProcessAttributes(Channel, Attribute);
    if (!NT_SUCCESS(Status)) goto Quickie;
 
    /* And set the current cell colors */
    ForeColor = Channel->CellForeColor;
    BackColor = Channel->CellBackColor;
    Color[1] = BackColor;
    Color[0] = ForeColor;
    Status = VTUTF8ChannelAnsiDispatch(Channel,
                                       SacAnsiSetColors,
                                       Color,
                                       sizeof(Color));
    if (!NT_SUCCESS(Status)) goto Quickie;
 
    /* Now loop all the characters in the cell buffer */
    for (R = 0; R < SAC_VTUTF8_ROW_HEIGHT; R++)
    {
        /* Across every row */
        for (C = 0; C < SAC_VTUTF8_COL_WIDTH; C++)
        {
            /* Check if there's been a change in colors */
            if ((Screen->Cell[R][C].CellBackColor != BackColor) ||
                (Screen->Cell[R][C].CellForeColor != ForeColor))
            {
                /* New colors are being drawn -- are we also on a new row now? */
                if (Overflow)
                {
                    /* Reposition the cursor correctly */
                    Position[1] = R;
                    Position[0] = C;
                    Status = VTUTF8ChannelAnsiDispatch(Channel,
                                                       SacAnsiSetPosition,
                                                       Position,
                                                       sizeof(Position));
                    if (!NT_SUCCESS(Status)) goto Quickie;
                    Overflow = FALSE;
                }
 
                /* Cache the new colors */
                ForeColor = Screen->Cell[R][C].CellForeColor;
                BackColor = Screen->Cell[R][C].CellBackColor;
 
                /* Set them on the screen */
                Color[1] = BackColor;
                Color[0] = ForeColor;
                Status = VTUTF8ChannelAnsiDispatch(Channel,
                                                   SacAnsiSetColors,
                                                   Color,
                                                   sizeof(Color));
                if (!NT_SUCCESS(Status)) goto Quickie;
            }
 
            /* Check if there's been a change in attributes */
            if (Screen->Cell[R][C].CellFlags != Attribute)
            {
                /* Yep! Are we also on a new row now? */
                if (Overflow)
                {
                    /* Reposition the cursor correctly */
                    Position[1] = R;
                    Position[0] = C;
                    Status = VTUTF8ChannelAnsiDispatch(Channel,
                                                       SacAnsiSetPosition,
                                                       Position,
                                                       sizeof(Position));
                    if (!NT_SUCCESS(Status)) goto Quickie;
                    Overflow = FALSE;
                }
 
                /* Set the new attributes on screen */
                Attribute = Screen->Cell[R][C].CellFlags;
                Status = VTUTF8ChannelProcessAttributes(Channel, Attribute);
                if (!NT_SUCCESS(Status)) goto Quickie;
            }
 
            /* Time to write the character -- are we on a new row now? */
            if (Overflow)
            {
                /* Reposition the cursor correctly */
                Position[1] = R;
                Position[0] = C;
                Status = VTUTF8ChannelAnsiDispatch(Channel,
                                                   SacAnsiSetPosition,
                                                   Position,
                                                   sizeof(Position));
                if (!NT_SUCCESS(Status)) goto Quickie;
                Overflow = FALSE;
            }
 
            /* Write the character into our temporary buffer */
            *TmpBuffer = Screen->Cell[R][C].Char;
            TmpBuffer[1] = UNICODE_NULL;
 
            /* Convert it to UTF-8 */
            if (!SacTranslateUnicodeToUtf8(TmpBuffer,
                                           1,
                                           Utf8ConversionBuffer,
                                           Utf8ConversionBufferSize,
                                           &Utf8Count,
                                           &Utf8ProcessedCount))
            {
                /* Bail out if this failed */
                Status = STATUS_UNSUCCESSFUL;
                goto Quickie;
            }
 
            /* Make sure we have a remaining valid character */
            if (Utf8Count)
            {
                /* Write it out on the wire */
                Status = ConMgrWriteData(Channel, Utf8ConversionBuffer, Utf8Count);
                if (!NT_SUCCESS(Status)) goto Quickie;
            }
        }
 
        /* All the characters on the row are done, indicate we need a reset */
        Overflow = TRUE;
    }
 
    /* Everything is done, set the position one last time */
    Position[1] = Channel->CursorRow;
    Position[0] = Channel->CursorCol;
    Status = VTUTF8ChannelAnsiDispatch(Channel,
                                       SacAnsiSetPosition,
                                       Position,
                                       sizeof(Position));
    if (!NT_SUCCESS(Status)) goto Quickie;
 
    /* Set the current attribute one last time */
    Status = VTUTF8ChannelProcessAttributes(Channel, Channel->CellFlags);
    if (!NT_SUCCESS(Status)) goto Quickie;
 
    /* Set the current colors one last time */
    Color[1] = Channel->CellBackColor;
    Color[0] = Channel->CellForeColor;
    Status = VTUTF8ChannelAnsiDispatch(Channel,
                                       SacAnsiSetColors,
                                       Color,
                                       sizeof(Color));
    if (!NT_SUCCESS(Status)) goto Quickie;
 
    /* Flush all the data out on the wire */
    Status = ConMgrFlushData(Channel);
 
Quickie:
    /* We're done, free the temporary buffer */
    if (TmpBuffer) SacFreePool(TmpBuffer);
 
    /* Indicate that all new data has been flushed now */
    if (NT_SUCCESS(Status))
    {
        _InterlockedExchange(&Channel->ChannelHasNewOBufferData, 0);
    }
 
    /* Return the result */
    return Status;
}

Referenced by ChannelInitializeVTable().

◆ VTUTF8ChannelORead()

NTSTATUS NTAPI VTUTF8ChannelORead	(	IN PSAC_CHANNEL	Channel,
		IN PCHAR	Buffer,
		IN ULONG	BufferSize,
		OUT PULONG	ByteCount
	)

Definition at line 714 of file vtutf8chan.c.

{
    ASSERT(FALSE);
    return STATUS_NOT_IMPLEMENTED;
}

Referenced by ChannelInitializeVTable().

◆ VTUTF8ChannelOWrite()

NTSTATUS NTAPI VTUTF8ChannelOWrite	(	IN PSAC_CHANNEL	Channel,
		IN PCHAR	String,
		IN ULONG	Length
	)

Definition at line 1167 of file vtutf8chan.c.

{
    NTSTATUS Status;
    CHECK_PARAMETER1(Channel);
    CHECK_PARAMETER2(String);
 
    /* Call the lower level function */
    Status = VTUTF8ChannelOWrite2(Channel, (PWCHAR)String, Length / sizeof(WCHAR));
    if (NT_SUCCESS(Status))
    {
        /* Is the channel enabled for output? */
        if ((ConMgrIsWriteEnabled(Channel)) && (Channel->WriteEnabled))
        {
            /* Go ahead and output it */
            Status = VTUTF8ChannelOEcho(Channel, String, Length);
        }
        else
        {
            /* Otherwise, just remember that we have new data */
            _InterlockedExchange(&Channel->ChannelHasNewOBufferData, 1);
        }
    }
 
    /* We're done */
    return Status;
}

Referenced by ChannelInitializeVTable().

Variable Documentation

◆ CommandConsoleLaunchingEnabled

BOOLEAN CommandConsoleLaunchingEnabled

extern

Definition at line 16 of file data.c.

Referenced by ConMgrProcessInputLine(), and InitializeGlobalData().

◆ CurrentChannelLock

KMUTEX CurrentChannelLock

extern

Definition at line 24 of file conmgr.c.

Referenced by SacAcquireMutexLock(), SacAssertMutexLockHeld(), SacInitializeMutexLock(), and SacReleaseMutexLock().

◆ CurrentChannelRefCount

LONG CurrentChannelRefCount

extern

Definition at line 23 of file conmgr.c.

Referenced by SacAcquireMutexLock(), SacAssertMutexLockHeld(), SacInitializeMutexLock(), and SacReleaseMutexLock().

◆ GlobalDoThreads

BOOLEAN GlobalDoThreads

Definition at line 1243 of file sacdrv.h.

◆ GlobalMessageTable

PSAC_MESSAGE_ENTRY GlobalMessageTable

extern

Definition at line 31 of file util.c.

Referenced by GetMessage(), PreloadGlobalMessageTable(), and TearDownGlobalMessageTable().

◆ GlobalPagingNeeded

BOOLEAN GlobalPagingNeeded

extern

Definition at line 35 of file conmgr.c.

Referenced by ConMgrProcessInputLine(), and DoPagingCommand().

◆ SACDebug

ULONG SACDebug

extern

Definition at line 15 of file data.c.

◆ SerialPortBuffer

PCHAR SerialPortBuffer

extern

Definition at line 35 of file util.c.

Referenced by FreeGlobalData(), InitializeGlobalData(), SerialBufferGetChar(), and TimerDpcRoutine().

◆ SerialPortConsumerIndex

LONG SerialPortConsumerIndex

extern

Definition at line 34 of file util.c.

Referenced by SerialBufferGetChar().

◆ SerialPortProducerIndex

LONG SerialPortProducerIndex

Definition at line 1241 of file sacdrv.h.

Referenced by TimerDpcRoutine().

◆ Utf8ConversionBuffer

PCHAR Utf8ConversionBuffer

extern

Definition at line 17 of file util.c.

Referenced by InitializeGlobalData(), UTF8EncodeAndSend(), VTUTF8ChannelOEcho(), and VTUTF8ChannelOFlush().

◆ Utf8ConversionBufferSize

ULONG Utf8ConversionBufferSize

extern

Definition at line 18 of file util.c.

Referenced by InitializeGlobalData(), UTF8EncodeAndSend(), VTUTF8ChannelOEcho(), and VTUTF8ChannelOFlush().

Variables
ULONG	SACDebug

PSAC_MESSAGE_ENTRY	GlobalMessageTable

KMUTEX	CurrentChannelLock

LONG	CurrentChannelRefCount

PCHAR	SerialPortBuffer

LONG	SerialPortConsumerIndex

LONG	SerialPortProducerIndex

PCHAR	Utf8ConversionBuffer

BOOLEAN	GlobalPagingNeeded

BOOLEAN	GlobalDoThreads

ULONG	Utf8ConversionBufferSize

BOOLEAN	CommandConsoleLaunchingEnabled

Classes

Macros

Typedefs

Enumerations

Functions

Variables

Macro Definition Documentation

◆ ALLOC_BLOCK_TAG

◆ CHANNEL_BLOCK_TAG

◆ ChannelClearEvent

◆ ChannelInitializeEvent

◆ ChannelLockAttributes

◆ ChannelLockCreates

◆ ChannelLockIBuffer

◆ ChannelLockOBuffer

◆ ChannelSetEvent

◆ ChannelSlotLock

◆ ChannelSlotUnlock

◆ ChannelUninitializeEvent

◆ ChannelUnlockAttributes

◆ ChannelUnlockCreates

◆ ChannelUnlockIBuffer

◆ ChannelUnlockOBuffer

◆ CHECK_ALLOCATION

◆ CHECK_PARAMETER

◆ CHECK_PARAMETER1

◆ CHECK_PARAMETER2

◆ CHECK_PARAMETER3

◆ CHECK_PARAMETER4

◆ CHECK_PARAMETER_WITH_STATUS

◆ FREE_POOL_TAG

◆ GENERIC_TAG

◆ GLOBAL_BLOCK_TAG

◆ GLOBAL_MEMORY_SIGNATURE

◆ INITIAL_BLOCK_TAG

◆ LOCAL_MEMORY_SIGNATURE

◆ MAX_UTF8_ENCODE_BLOCK_LENGTH

◆ SAC_CELL_FLAG_BLINK

◆ SAC_CELL_FLAG_BOLD

◆ SAC_CELL_FLAG_INVERTED

◆ SAC_CHANNEL_DESCRIPTION_SIZE

◆ SAC_CHANNEL_FLAG_APPLICATION

◆ SAC_CHANNEL_FLAG_CLOSE_EVENT

◆ SAC_CHANNEL_FLAG_HAS_NEW_DATA_EVENT

◆ SAC_CHANNEL_FLAG_INTERNAL

◆ SAC_CHANNEL_FLAG_LOCK_EVENT

◆ SAC_CHANNEL_FLAG_REDRAW_EVENT

◆ SAC_CHANNEL_NAME_SIZE

◆ SAC_DBG

◆ SAC_DBG_ENTRY_EXIT

◆ SAC_DBG_INIT

◆ SAC_DBG_MACHINE

◆ SAC_DBG_MM

◆ SAC_DBG_UTIL

◆ SAC_MAX_CHANNELS

◆ SAC_MAX_MESSAGES

◆ SAC_MEMORY_LIST_SIZE

◆ SAC_OBUFFER_SIZE

◆ SAC_RAW_IBUFFER_SIZE

◆ SAC_RAW_OBUFFER_SIZE

◆ SAC_SERIAL_PORT_BUFFER_SIZE

◆ SAC_VTUTF8_COL_HEIGHT

◆ SAC_VTUTF8_COL_WIDTH

◆ SAC_VTUTF8_IBUFFER_SIZE

◆ SAC_VTUTF8_OBUFFER_SIZE

◆ SAC_VTUTF8_ROW_HEIGHT

◆ SacAllocatePool

◆ SacFreePool

◆ SECURITY_BLOCK_TAG

◆ VT_220_BACKTAB

◆ VT_ANSI_BACKTAB_CHAR

◆ VT_ANSI_COMMAND

◆ VT_ANSI_CUP_CURSOR_CHAR

◆ VT_ANSI_CURSOR_DOWN

◆ VT_ANSI_CURSOR_DOWN_CHAR

◆ VT_ANSI_CURSOR_LEFT

◆ VT_ANSI_CURSOR_LEFT_CHAR

◆ VT_ANSI_CURSOR_RIGHT

◆ VT_ANSI_CURSOR_RIGHT_CHAR

◆ VT_ANSI_CURSOR_UP