windows-server-2003/base/mvdm/vdmexts/help.c

/*++

Copyright (c) 1991  Microsoft Corporation

Module Name:

    help.c

Abstract:

    This module dumps out help info for VDMEXTS

Author:

    Neil Sandlin (NeilSa) 15-Jan-1996

Notes:


Revision History:

--*/

#include <precomp.h>
#pragma hdrstop

CHAR szAPIUSAGE[] = "Usage: !vdmexts.APIProfDmp [TblName] [APIspec]\n\n   where: TblName = kernel | user | gdi | keyboard | sound | shell | mmed\n                         (no TblName implies 'all tables')\n\n          APIspec = API # or API name";
CHAR szMSGUSAGE[] = "Usage: !vdmexts.MsgProfDmp [MessageName | MessageNum (decimal)]\n                         (no argument implies 'all messages')";

VOID
helpAPIProfDmp(
    VOID
    )
{
    PRINTF("\n\n%s\n", szAPIUSAGE);
}

VOID
helpMsgProfDmp(
    VOID
    )
{
    PRINTF("\n\n%s\n", szMSGUSAGE);
}


VOID
helpFilter(
    VOID
    )
{
    PRINTF("Usage: filter <option> <arg>\n\n");
    PRINTF(" where <option>=\n");
    PRINTF("<none>         - Dump current state\n");
    PRINTF("*              - Disables logging on all API classes\n");
    PRINTF("Reset          - Filter is reset to default state\n");
    PRINTF("CallId xxxx    - Adds api with given callid to list to be filtered\n");
    PRINTF("Task xxxx      - Filter on a Specific TaskID\n");
    PRINTF("Verbose        - Toggles Verbose Mode On/Off\n");
    PRINTF("Commdlg        - Toggles Filtering of Commdlg Calls On/Off\n");
    PRINTF("GDI            - Toggles Filtering of GDI Calls On/Off\n");
    PRINTF("Kernel         - Toggles Filtering of Kernel Calls On/Off\n");
    PRINTF("Kernel16       - Toggles Filtering of Kernel16 Calls On/Off\n");
    PRINTF("Keyboard       - Toggles Filtering of Keyboard Calls On/Off\n");
    PRINTF("MMedia         - Toggles Filtering of MMedia Calls On/Off\n");
    PRINTF("Sound          - Toggles Filtering of Sound Calls On/Off\n");
    PRINTF("User           - Toggles Filtering of User Calls On/Off\n");
    PRINTF("Winsock        - Toggles Filtering of Winsock Calls On/Off\n");
    PRINTF("\n");
}

VOID
help_denv(
    VOID
    )
{
    PRINTF("Dump environment block for current DOS process or given environment selector\n");
    PRINTF("\n");
    PRINTF("!denv <bPMode> <segEnv>\n");
    PRINTF("\n");
    PRINTF("Examples:\n");
    PRINTF("!denv             - Dumps environment for current DOS process\n");
    PRINTF("!denv 0 145d      - Dumps environment at &145d:0 (145d from PDB_environ of DOS process)\n");
    PRINTF("!denv 1 16b7      - Dumps environment at #16b7:0 (16b7 from !dt -v segEnvironment)\n");
    PRINTF("\n");
}

VOID
helpgdih16(
    VOID
    )
{
    PRINTF("Dumps info for 16-bit GDI handles\n");
    PRINTF("\n");
    PRINTF("!gdih16 [-v] <h16>\n");
    PRINTF("\n");
    PRINTF("Examples:\n");
    PRINTF("!gdih16 23        - Dumps the gdih32 associated with h16\n");
    PRINTF("!gdih16 -v 23     - verbose mode includes mapping table info\n");
    PRINTF("\n");
}

VOID
helpgdih32(
    VOID
    )
{
    PRINTF("Dumps info for 32-bit GDI handles\n");
    PRINTF("\n");
    PRINTF("!gdih32 [-v] <h32>\n");
    PRINTF("\n");
    PRINTF("Examples:\n");
    PRINTF("!gdih32 43502110    - Dumps the gdih16 associated with h32\n");
    PRINTF("!gdih32 -v 43502110 - verbose mode includes mapping table info\n");
    PRINTF("\n");
}

VOID
help(
    CMD_ARGLIST
) {
    CMD_INIT();

    if (GetNextToken()) {
        if (_strnicmp(lpArgumentString, "filter", 6) == 0) {
            helpFilter();
        } else if (_strnicmp(lpArgumentString, "apiprofdmp", 10) == 0) {
            helpAPIProfDmp();
        } else if (_strnicmp(lpArgumentString, "msgprofdmp", 10) == 0) {
            helpMsgProfDmp();
        } else if (_strnicmp(lpArgumentString, "denv", 4) == 0) {
            help_denv();
        } else if (_strnicmp(lpArgumentString, "hgdi16", 6) == 0) {
            helpgdih16();
        } else if (_strnicmp(lpArgumentString, "hgdi32", 6) == 0) {
            helpgdih32();
	    } else {
            PRINTF("No specific help information available for '%s'\n", lpArgumentString);
        }
        return;
    }
    if (!EXPRESSION("ntvdm!Ldt")) {
        PRINTF("\nWARNING: Symbols for NTVDM are not available.\n\n");
    }
    if (!EXPRESSION("wow32!gptdTaskHead")) {
        PRINTF("\nWOW commands are not currently available.\n\n");
    } else if (!EXPRESSION("wow32!iLogLevel")) {
        PRINTF("\nWOW32 is the free version: Some commands will be unavailable.\n\n");
    }

    PRINTF("------------- VDMEXTS Debug Extension help:--------------\n\n");
    PRINTF("help [cmd]             - Displays this list or gives details on command\n");
    PRINTF("ApiProfClr             - Clears the api profiling table\n");
    PRINTF("ApiProfDmp [options]   - Dumps the api profiling table\n");
    PRINTF("at 0xXXXX              - shows name associated with hex atom #\n");
    PRINTF("bp <addr>              - Sets a vdm breakpoint\n");
    PRINTF("bd/be <n>              - Disables/enables vdm breakpoint 'n'\n");
    PRINTF("bl                     - Lists vdm breakpoints\n");
    PRINTF("chkheap                - Checks WOW kernel's global heap\n");
    PRINTF("cia                    - Dump cursor/icon alias list\n");
    PRINTF("d<b|w|d> <addr> [len]  - Dump vdm memory\n");
    PRINTF("ddemem                 - Dump dde memory thunks\n");
    PRINTF("ddte <addr>            - Dump dispatch table entry pointed to by <addr>\n");
    PRINTF("denv <bProt> <selEnv>  - Dump environment for current task or given selector/segment\n");
    PRINTF("df [vector]            - Dump protect mode fault handler address\n");
    PRINTF("dfh [fh [pdb]]         - Dump DOS file handles for current or given PDB\n");
    PRINTF("dg <sel>               - Dump info on a selector\n");
    PRINTF("ddh [seg]              - Dump DOS heap chain starting at <seg>:0000\n");
    PRINTF("dgh [sel|ownersel]     - Dump WOW kernel's global heap\n");
    PRINTF("dhdib [@<address>]     - Dump dib.drv support structures (DIBINFO)\n");
    PRINTF("di [vector]            - Dump protect mode interrupt handler address\n");
    PRINTF("dma                    - Dump virtual DMA state\n");
    PRINTF("dpd                    - Dump DPMI DOS memory allocations\n");
    PRINTF("dpx                    - Dump DPMI extended memory allocations\n");
    PRINTF("dsft [sft]             - Dump all or specified DOS system file tables\n");
    PRINTF("dt [-v] <addr>         - Dump WOW Task Info\n");
    PRINTF("dwp <addr>             - Dump WOWPORT structure pointed to by <addr>\n");
    PRINTF("e<b|w|d> <addr> <data> - Edit vdm memory\n");
    PRINTF("filter [options]       - Manipulate logging filter\n");
    PRINTF("fs <text to find>      - Find text in 16:16 memory (case insensitive)\n");
    PRINTF("glock <sel>            - Increments the lock count on a moveable segment\n");
    PRINTF("gmem                   - Dumps Global/heap memory alloc'd by wow32\n");
    PRINTF("gunlock <sel>          - Decrements the lock count on a moveable segment\n");
    PRINTF("hgdi16 [-v] <h16>      - Returns 32-bit GDI handle for <h16>\n");
    PRINTF("hgdi32 [-v] <h32>      - Returns 16-bit GDI handle for <h32>\n");
    PRINTF("ica                    - Dump Interrupt Controller state\n");
    PRINTF("k                      - Stack trace\n");
    PRINTF("kb                     - Stack trace with symbols\n");
    PRINTF("LastLog                - Dumps Last Logged WOW APIs from Circular Buffer\n");
    PRINTF("lg [#num] [count]      - Dumps NTVDM history log\n");
    PRINTF("lgr [#num] [count]     - Dumps NTVDM history log (with regs)\n");
    PRINTF("lgt [1|2|3]            - Sets NTVDM history log timer resolution\n");
    PRINTF("lm <sel|modname>       - List loaded modules\n");
    PRINTF("ln [addr]              - Determine near symbols\n");
    PRINTF("LogFile [path]         - Create/close toggle for iloglevel capture to file\n");
    PRINTF("                         (path defaults to c:\\ilog.log)\n");
    PRINTF("MsgProfClr             - Clears the msg profiling table\n");
    PRINTF("MsgProfDmp [options]   - Dumps the msg profiling table\n");
    PRINTF("ntsd                   - Gets an NTSD prompt from the VDM prompt\n");
    PRINTF("r                      - Dump registers\n");
    PRINTF("rmcb                   - Dumps dpmi real mode callbacks\n");
    PRINTF("SetLogLevel xx         - Sets the WOW Logging Level\n");
    PRINTF("StepTrace              - Toggles Single Step Tracing On/Off\n");
    PRINTF("sx                     - Displays debugging options\n");
    PRINTF("sx<d|e> <flag>         - Disables/enables debugging options\n");
    PRINTF("u [addr] [len]         - Unassemble vdm code with symbols\n");
    PRINTF("wc <hwnd16>            - Dumps the window class structure of <hwnd16>\n");
    PRINTF("ww <hwnd16>            - Dumps the window structure of <hwnd16>\n");
    PRINTF("x <symbol>             - Get symbol's value\n");
#ifdef i386
    PRINTF("\n-------------- i386 specific commands\n");
    PRINTF("fpu                    - Dump 487 state\n");
    PRINTF("pdump                  - Dumps profile info to file \\profile.out\n");
    PRINTF("pint                   - Sets the profile interval\n");
    PRINTF("pstart                 - Causes profiling to start\n");
    PRINTF("pstop                  - Causes profiling to stop\n");
    PRINTF("vdmtib [addr]          - Dumps the register context in the vdmtib\n");
#endif
    PRINTF("\n\n");
    PRINTF("    where [options] can be displayed with 'help <cmd>'\n\n");
}