Home > Articles > Operating Systems, Server > Microsoft Servers

Interfacing To The Spy Device

Now that you know how w2k_mem.exe is used, it's time to see how it works. Rather than discuss command line parsing and dispatching, let's see how this application communicates with the spy device inside w2k_spy.sys.

Device I/O Control Revisited

The kernel-mode side of IOCTL communication has already been shown in Listings 4-6 and 4-7. The spy device simply sits waiting for I/O Request Packets (IRPs) and handles some of them, especially those tagged IRP_MJ_DEVICE_CONTROL, which request some forbidden actions to be executed, at least forbidden in the context of the user-mode application that sends these requests. It does so by calling the Win32 API function DeviceIoControl(), prototyped in Listing 4-27. The dwIoControlCode, lpInBuffer, nInBufferSize, lpOutBuffer, nOutBufferSize, and lpBytesReturned arguments should look familiar to you. In fact, they correspond 1:1 to the dCode, pInput, dInput, pOutput, dOutput, and pdInfo arguments of the SpyDispatcher() function in Listing 4-7. The remaining arguments are explained quickly. hDevice is the handle to the spy device, and lpOverlapped optionally points to an OVERLAPPED structure required for asynchronous IOCTL. We are not going to send asynchronous requests, so this argument will always be NULL.

Listing 4-28 is a collection of wrapper functions that perform basic IOCTL operations. The most basic function is IoControl(), which calls DeviceIoControl() and tests the reported output data size. Because w2k_mem.exe sizes its output buffers accurately, the number of output bytes should always be equal to the buffer size. ReadBinary() is a simplified version of IoControl() for IOCTL functions that don't require input data. ReadCpuInfo(), ReadSegment(), and ReadPhysical() are specifically tailored to the spy functions SPY_IO_CPU_INFO, SPY_IO_SEGMENT, and SPY_IO_PHYSICAL, because these are the most frequently used IOCTL functions. Encapsulating them in C functions makes the code much more readable.

Listing 4-27. Prototype of DeviceIoControl()

BOOL WINAPI DeviceIoControl (HANDLE      hDevice,
DWORD       dwIoControlCode,
                             PVOID       lpInBuffer,
                             DWORD       nInBufferSize,
                             PVOID       lpOutBuffer,
                             DWORD       nOutBufferSize,
                             PDWORD      lpBytesReturned,
                             POVERLAPPED lpOverlapped);

Listing 4-28. Various IOCTL Wrappers

BOOL WINAPI IoControl (HANDLE hDevice,
                       DWORD  dCode,
                       PVOID  pInput,
                       DWORD  dInput,
                       PVOID  pOutput,
                       DWORD  dOutput)
    DWORD dData = 0;

    return DeviceIoControl (hDevice, dCode,
                            pInput,  dInput,
                            pOutput, dOutput,
                            &dData,  NULL)
           (dData == dOutput);

// -----------------------------------------------------------------

BOOL WINAPI ReadBinary (HANDLE hDevice,
                        DWORD  dCode,
                        PVOID  pOutput,
                        DWORD  dOutput)
    return IoControl (hDevice, dCode, NULL, 0, pOutput, dOutput);

// -----------------------------------------------------------------

BOOL WINAPI ReadCpuInfo (HANDLE        hDevice,
                         PSPY_CPU_INFO psci)
    return IoControl (hDevice, SPY_IO_CPU_INFO,
                      NULL,    0,
                      psci,    SPY_CPU_INFO_);
    }// -----------------------------------------------------------------

BOOL WINAPI ReadSegment (HANDLE       hDevice,
                         DWORD        dSelector,
                         PSPY_SEGMENT pss)
    return IoControl (hDevice,    SPY_IO_SEGMENT,
                      &dSelector, DWORD_,
                      pss,        SPY_SEGMENT_);

// -----------------------------------------------------------------

BOOL WINAPI ReadPhysical (HANDLE            hDevice,
                          PVOID             pLinear,
                          PPHYSICAL_ADDRESS ppa)
    return IoControl (hDevice,  SPY_IO_PHYSICAL,
                      &pLinear, PVOID_,
                      ppa,      PHYSICAL_ADDRESS_)
           (ppa->LowPart || ppa->HighPart);

All functions shown so far in this section require a spy device handle. It's time that I show how to obtain it. It is actually a quite simple Win32 operation, similar to opening a file. Listing 4-29 shows the implementation of the command handler inside w2k_mem.exe. This code uses the API functions w2kFilePath(), w2kServiceLoad(), and w2kServiceUnload(), exported by the "SBS Windows 2000 Utility Library" w2k_lib.dll, included on the companion CD of this book. If you have read the section about the Windows 2000 Service Control Manager in Chapter 3, you already know w2kServiceLoad() and w2kServiceUnload() from Listing 3-8. These powerful functions load and unload kernel-mode device drivers on the fly and handle benign error situations, such as gracefully loading a driver that is already loaded. w2kFilePath() is a helpful utility function that derives a file path from a base path, given a file name or file extension. w2k_mem.exe calls it to obtain a fully qualified path to the spy driver executable that matches its own path.

Listing 4-29. Controlling the Spy Device

WORD awSpyFile      [] = SW(DRV_FILENAME);
WORD awSpyDevice    [] = SW(DRV_MODULE);
WORD awSpyDisplay   [] = SW(DRV_NAME);
WORD awSpyPath      [] = SW(DRV_PATH);

// -----------------------------------------------------------------

void WINAPI Execute (PPWORD ppwArguments,
                     DWORD  dArguments)
    DWORD            dOptions, dRequest, dReceive;
    WORD             awPath [MAX_PATH] = L"?";
    SC_HANDLE        hControl          = NULL;
    HANDLE           hDevice           = NULL;
    _printf (L"\r\nLoading \"%s\" (%s) ...\r\n",
             awSpyDisplay, awSpyDevice);

    if (w2kFilePath (NULL, awSpyFile, awPath, MAX_PATH))
        _printf (L"Driver: \"%s\"\r\n",

        hControl = w2kServiceLoad (awSpyDevice, awSpyDisplay,
                                   awPath, TRUE);
    if (hControl != NULL)
        _printf (L"Opening \"%s\" ...\r\n",

        hDevice = CreateFile (awSpyPath, GENERIC_READ,
                              FILE_SHARE_READ | FILE_SHARE_WRITE,
                              NULL, OPEN_EXISTING,
                              FILE_ATTRIBUTE_NORMAL, NULL);
    if (hDevice != INVALID_HANDLE_VALUE)
        if (ReadBinary (hDevice, SPY_IO_VERSION_INFO,
                        &svi, SPY_VERSION_INFO_))
            _printf (L"\r\n%s V%lu.%02lu ready\r\n",
                     svi.dVersion / 100, svi.dVersion % 100);
        dOptions = COMMAND_OPTION_NONE;
        dRequest = CommandParse (hDevice, ppwArguments, dArguments,
                                 TRUE, &dOptions);

        dOptions = COMMAND_OPTION_NONE;
        dReceive = CommandParse (hDevice, ppwArguments, dArguments,
                                 FALSE, &dOptions);
        if (dRequest)
            _printf (awSummary,
                     dRequest, (dRequest == 1 ? awByte : awBytes),                     
                     dReceive, (dReceive == 1 ? awByte : awBytes));
        _printf (L"\r\nClosing the spy device ...\r\n");
        CloseHandle (hDevice);
        _printf (L"Spy device not available.\r\n");
    if ((hControl != NULL) && gfSpyUnload)
        _printf (L"Unloading the spy device ...\r\n");
        w2kServiceUnload (hControl, awSpyDevice);

Please note the four global string definitions at the top of Listing 4-29. The constants DRV_FILENAME, DRV_MODULE, DRV_NAME, and DRV_PATH are drawn from the header file of the spy device driver, w2k_spy.h. Table 4-4 lists their current values. You will not find device-specific definitions in the source files of w2k_mem.exe. w2k_spy.h provides everything a client application needs. This is very important: If any device-specific definitions change in the future, there is no need to update any application files. Just rebuild the application with the updated spy header file, and everything will fall into place.

The w2kFilePath() call near the beginning of Listing 4-29 guarantees that the w2k_spy.sys file specified by the global string awSpyFile (cf. Table 4-4) is always loaded from the directory where w2k_mem.exe resides. Next, the code in Listing 4-29 passes the global strings awSpyDevice and awSpyDisplay (cf. Table 4-4) to w2kServiceLoad(), attempting to load and start the spy device driver. If the driver was not loaded yet, these strings will be stored in the driver's property list and can be retrieved by other applications; otherwise, the current property settings are retained. Although the w2kServiceLoad() call in Listing 4-29 returns a handle, this is not a handle that can be used in any IOCTL calls. To get a handle to the spy device, the Win32 multipurpose function CreateFile() must be used. This function opens or creates almost anything that can be opened or created on Windows 2000. You certainly have called this function a million times to get a file handle. CreateFile() can also open kernel-mode devices if the symbolic link name of the device is supplied in the format \\.\<SymbolicLink> for the lpFileName argument. The symbolic link of the spy device is named w2k_spy, so the first CreateFile() argument must be \\.\w2k_spy, which is the value of the global string variable awSpyPath according to Table 4-4.

Table 4-4. Device-Specific String Definitions

w2k_spy CONSTANT

w2k_mem VARIABLE










SBS Windows 2000 Spy Device




If CreateFile() succeeds, it returns a device handle that can be passed to DeviceIoControl(). The Execute() function in Listing 4-29 uses this handle immediately to query the version information of the spy device, which it displays on the screen if the IOCTL call succeeds. Next, the CommandParse() function is invoked twice with a different BOOL value for the fourth argument. The first call simply checks the command line for invalid parameters and displays any errors, and the second call actually executes all commands. I do not want to discuss in detail the command parser. The remaining code in Listing 4-29 is cleanup code that closes handles and optionally unloads the spy drives. The source code of w2k_mem.exe contains other interesting code snippets, but I will not discuss them here. Please see the files w2k_mem.c and w2k_mem.h in the \src\w2k_mem directory on the sample CD for further details.

The only notable thing left is the gfSpyUnload flag tested before unloading the spy driver. I have set this global flag to FALSE, so the driver will not be unloaded automatically. This enhances the performance of w2k_mem.exe and other w2k_spy. sys clients because loading a driver takes some time. The first client has to take the loading overhead, but all successors will benefit from having the driver already in memory. This setting also avoids conflict situations involving competitive clients, in which one client attempts to unload the driver while another one is still using it. Of course, Windows 2000 will not unload the driver unless all handles to its devices are closed, but it will put it into a STOP_PENDING state that will not allow new clients to access the device. However, if you don't run w2k_spy.sys in a multiclient environment, and you are updating the device driver frequently, you should probably set the gfSpyUnload flag to TRUE.

InformIT Promotional Mailings & Special Offers

I would like to receive exclusive offers and hear about products from InformIT and its family of brands. I can unsubscribe at any time.


Pearson Education, Inc., 221 River Street, Hoboken, New Jersey 07030, (Pearson) presents this site to provide information about products and services that can be purchased through this site.

This privacy notice provides an overview of our commitment to privacy and describes how we collect, protect, use and share personal information collected through this site. Please note that other Pearson websites and online products and services have their own separate privacy policies.

Collection and Use of Information

To conduct business and deliver products and services, Pearson collects and uses personal information in several ways in connection with this site, including:

Questions and Inquiries

For inquiries and questions, we collect the inquiry or question, together with name, contact details (email address, phone number and mailing address) and any other additional information voluntarily submitted to us through a Contact Us form or an email. We use this information to address the inquiry and respond to the question.

Online Store

For orders and purchases placed through our online store on this site, we collect order details, name, institution name and address (if applicable), email address, phone number, shipping and billing addresses, credit/debit card information, shipping options and any instructions. We use this information to complete transactions, fulfill orders, communicate with individuals placing orders or visiting the online store, and for related purposes.


Pearson may offer opportunities to provide feedback or participate in surveys, including surveys evaluating Pearson products, services or sites. Participation is voluntary. Pearson collects information requested in the survey questions and uses the information to evaluate, support, maintain and improve products, services or sites, develop new products and services, conduct educational research and for other purposes specified in the survey.

Contests and Drawings

Occasionally, we may sponsor a contest or drawing. Participation is optional. Pearson collects name, contact information and other information specified on the entry form for the contest or drawing to conduct the contest or drawing. Pearson may collect additional personal information from the winners of a contest or drawing in order to award the prize and for tax reporting purposes, as required by law.


If you have elected to receive email newsletters or promotional mailings and special offers but want to unsubscribe, simply email information@informit.com.

Service Announcements

On rare occasions it is necessary to send out a strictly service related announcement. For instance, if our service is temporarily suspended for maintenance we might send users an email. Generally, users may not opt-out of these communications, though they can deactivate their account information. However, these communications are not promotional in nature.

Customer Service

We communicate with users on a regular basis to provide requested services and in regard to issues relating to their account we reply via email or phone in accordance with the users' wishes when a user submits their information through our Contact Us form.

Other Collection and Use of Information

Application and System Logs

Pearson automatically collects log data to help ensure the delivery, availability and security of this site. Log data may include technical information about how a user or visitor connected to this site, such as browser type, type of computer/device, operating system, internet service provider and IP address. We use this information for support purposes and to monitor the health of the site, identify problems, improve service, detect unauthorized access and fraudulent activity, prevent and respond to security incidents and appropriately scale computing resources.

Web Analytics

Pearson may use third party web trend analytical services, including Google Analytics, to collect visitor information, such as IP addresses, browser types, referring pages, pages visited and time spent on a particular site. While these analytical services collect and report information on an anonymous basis, they may use cookies to gather web trend information. The information gathered may enable Pearson (but not the third party web trend services) to link information with application and system log data. Pearson uses this information for system administration and to identify problems, improve service, detect unauthorized access and fraudulent activity, prevent and respond to security incidents, appropriately scale computing resources and otherwise support and deliver this site and its services.

Cookies and Related Technologies

This site uses cookies and similar technologies to personalize content, measure traffic patterns, control security, track use and access of information on this site, and provide interest-based messages and advertising. Users can manage and block the use of cookies through their browser. Disabling or blocking certain cookies may limit the functionality of this site.

Do Not Track

This site currently does not respond to Do Not Track signals.


Pearson uses appropriate physical, administrative and technical security measures to protect personal information from unauthorized access, use and disclosure.


This site is not directed to children under the age of 13.


Pearson may send or direct marketing communications to users, provided that

  • Pearson will not use personal information collected or processed as a K-12 school service provider for the purpose of directed or targeted advertising.
  • Such marketing is consistent with applicable law and Pearson's legal obligations.
  • Pearson will not knowingly direct or send marketing communications to an individual who has expressed a preference not to receive marketing.
  • Where required by applicable law, express or implied consent to marketing exists and has not been withdrawn.

Pearson may provide personal information to a third party service provider on a restricted basis to provide marketing solely on behalf of Pearson or an affiliate or customer for whom Pearson is a service provider. Marketing preferences may be changed at any time.

Correcting/Updating Personal Information

If a user's personally identifiable information changes (such as your postal address or email address), we provide a way to correct or update that user's personal data provided to us. This can be done on the Account page. If a user no longer desires our service and desires to delete his or her account, please contact us at customer-service@informit.com and we will process the deletion of a user's account.


Users can always make an informed choice as to whether they should proceed with certain services offered by InformIT. If you choose to remove yourself from our mailing list(s) simply visit the following page and uncheck any communication you no longer want to receive: www.informit.com/u.aspx.

Sale of Personal Information

Pearson does not rent or sell personal information in exchange for any payment of money.

While Pearson does not sell personal information, as defined in Nevada law, Nevada residents may email a request for no sale of their personal information to NevadaDesignatedRequest@pearson.com.

Supplemental Privacy Statement for California Residents

California residents should read our Supplemental privacy statement for California residents in conjunction with this Privacy Notice. The Supplemental privacy statement for California residents explains Pearson's commitment to comply with California law and applies to personal information of California residents collected in connection with this site and the Services.

Sharing and Disclosure

Pearson may disclose personal information, as follows:

  • As required by law.
  • With the consent of the individual (or their parent, if the individual is a minor)
  • In response to a subpoena, court order or legal process, to the extent permitted or required by law
  • To protect the security and safety of individuals, data, assets and systems, consistent with applicable law
  • In connection the sale, joint venture or other transfer of some or all of its company or assets, subject to the provisions of this Privacy Notice
  • To investigate or address actual or suspected fraud or other illegal activities
  • To exercise its legal rights, including enforcement of the Terms of Use for this site or another contract
  • To affiliated Pearson companies and other companies and organizations who perform work for Pearson and are obligated to protect the privacy of personal information consistent with this Privacy Notice
  • To a school, organization, company or government agency, where Pearson collects or processes the personal information in a school setting or on behalf of such organization, company or government agency.


This web site contains links to other sites. Please be aware that we are not responsible for the privacy practices of such other sites. We encourage our users to be aware when they leave our site and to read the privacy statements of each and every web site that collects Personal Information. This privacy statement applies solely to information collected by this web site.

Requests and Contact

Please contact us about this Privacy Notice or if you have any requests or questions relating to the privacy of your personal information.

Changes to this Privacy Notice

We may revise this Privacy Notice through an updated posting. We will identify the effective date of the revision in the posting. Often, updates are made to provide greater clarity or to comply with changes in regulatory requirements. If the updates involve material changes to the collection, protection, use or disclosure of Personal Information, Pearson will provide notice of the change through a conspicuous notice on this site or other appropriate way. Continued use of the site after the effective date of a posted revision evidences acceptance. Please contact us if you have questions or concerns about the Privacy Notice or any objection to any revisions.

Last Update: November 17, 2020