Performance Validator Help

Zoom Window Out
Larger Text | Smaller Text
Hide Page Header
Show Expanding Text
Print Topic
Send Mail Feedback
Share This Topic
Save Permalink URL

Extensions, services and tools

Including stublib.h in my project doesn't compile. Why?

You may encounter problems when including stublib.h in order to link directly with Performance Validator.

Include path problems

Ensure that your project C preprocessor include paths reference both of the stub and stublib subdirectories in the installation directory of Performance Validator.

For example, if Performance Validator is installed in:

C:\Program Files (x86)\Software Verify\C++ Performance Validator

Then add the following paths for all configurations; Debug, Release, etc:

C:\Program Files (x86)\Software Verify\C++ Performance Validator\stub

C:\Program Files (x86)\Software Verify\C++ Performance Validator\stublib

Compiler errors

If you include stublib.h, your project must have included windows.h first, (or see below for an alternative).

If you fail to include windows.h then stublib.h will refer to some none-existent datatypes, causing compiler errors similar to the ones shown below.

Here's an example program that will not compile:

#include "stdafx.h"
#include "stublib.h"

int main(int argc, char* argv[])
{
return 0;
}

See the compiler errors from the above code

--------------------Configuration: testMV_allEnum - Win32 Debug--------------------

Compiling...

testMV_allEnum.cpp

c:\program files\software verification\performance validator\stub\allenum.h(70) : error C2146: syntax error : missing ';' before identifier 'lRequest'

c:\program files\software verification\performance validator\stub\allenum.h(70) : error C2501: 'LONG' : missing storage-class or type specifiers

c:\program files\software verification\performance validator\stub\allenum.h(70) : error C2501: 'lRequest' : missing storage-class or type specifiers

c:\program files\software verification\performance validator\stub\allenum.h(71) : error C2146: syntax error : missing ';' before identifier 'reserved3'

c:\program files\software verification\performance validator\stub\allenum.h(71) : error C2501: 'DWORD' : missing storage-class or type specifiers

c:\program files\software verification\performance validator\stub\allenum.h(71) : error C2501: 'reserved3' : missing storage-class or type specifiers

c:\program files\software verification\performance validator\stub\allenum.h(73) : error C2143: syntax error : missing ';' before '*'

c:\program files\software verification\performance validator\stub\allenum.h(73) : error C2501: 'BYTE' : missing storage-class or type specifiers

c:\program files\software verification\performance validator\stub\allenum.h(74) : error C2501: 'dde_pbData' : missing storage-class or type specifiers

To fix this problem simply include windows.h before stublib.h

#include "stdafx.h"
#include <windows.h> // new line to fix compile errors
#include "stublib.h"

int main(int argc, char* argv[])
{
return 0;
}

Can't include windows.h?

If including windows.h is not an option, you can just define the following types:

#define LONG long
#define DWORD unsigned long
#define BYTE unsigned char
#define HANDLE void *

What do I do if I cannot use svlMVStubService.lib?

You may find that you can't use svlPVStubService.lib / svlPVStubService_x64.lib because your linker doesn't understand the format of the lib file.

If that happens you can use the code below to compile the two functions that would be provided by those libraries.

See the header file

#ifndef _SVL_PVSTUB_SERVICE_H
#define _SVL_PVSTUB_SERVICE_H

#include "svlServiceError.h"

// IMPORTANT.
// If you use svlPVStub_LoadPerformanceValidator() to load svlPerformanceValidatorStub.dll into your
// application, you must also use svlPVStub_UnloadPerformanceValidator() to unload the DLL prior to
// your application being closed down. Failure to do so will almost certainly result in a crash.
// It does not matter how the application is closed down, you must ensure that you use
// svlPVStub_UnloadPerformanceValidator() to unload the DLL if you have loaded it.
//
// The DLL prepares itself in different ways and shuts itself down differently depending on if
// it is:-
// a) Directly linked to the application for use with the API or injected with Performance Validator.
//    When the DLL is used in this manner to DLL expects to oversee and manage the application
//    shutdown.
// b) Loaded by using svlPVStub_LoadPerformanceValidator().
//    When the DLL is used in this manner to DLL expects to be removed prior to application shutdown
//    and the behaviour of the DLL is undefined once you enter the program shutdown sequence.
//
//     This difference in behaviour is intentional and is done to allow the use of the stub DLL in
//     services.

#ifdef __cplusplus
extern "C" {
#endif

SVL_SERVICE_ERROR svlPVStub_LoadPerformanceValidator(serviceCallback_FUNC callback,
                                                     void                 *userParam);

SVL_SERVICE_ERROR svlPVStub_UnloadPerformanceValidator();

#ifdef __cplusplus
}
#endif

#endif

See the implementation file

#include "svlPVStubService.h"

#include <windows.h>
#include <tchar.h>

//-NAME---------------------------------
//.DESCRIPTION..........................
//.PARAMETERS...........................
//.RETURN.CODES.........................
//--------------------------------------

static HMODULE   hModule = NULL;

//-NAME---------------------------------
//.DESCRIPTION..........................
//.PARAMETERS...........................
//.RETURN.CODES.........................
//--------------------------------------

typedef void (*ENABLE_STUB_SYMBOL_FUNC)();

SVL_SERVICE_ERROR svlPVStub_LoadPerformanceValidator(serviceCallback_FUNC callback,
                                                     void                 *userParam)
{
   SVL_SERVICE_ERROR   errCode = SVL_OK;

   if (hModule == NULL)
   {
      hModule = LoadLibraryW(L"svlPerformanceValidatorStub.dll");     // change this to svlPerformanceValidatorStub6432.dll or svlPerformanceValidatorStub_x64.dll as appropriate
      if (hModule != NULL)
      {
         // DLL loaded, set the service callback function

         SETCALLBACK_FUNC   setCallbackFunc;

         setCallbackFunc = (SETCALLBACK_FUNC)GetProcAddress(hModule, "apiSetServiceCallback");
         if (setCallbackFunc != NULL)
         {
            (*setCallbackFunc)(callback, userParam);
         }

// now start the profiler

PROC *p;

p = GetProcAddress(hModule, "startProfiler");

if (p != NULL)

(*p)();

         // we don't need to turn on provision of symbols by the stub for Performance Validator, so skip that step
      }
      else
      {
         errCode = SVL_LOAD_FAILED;
      }
   }
   else
   {
      errCode = SVL_ALREADY_LOADED;
   }

   return errCode;
}

//-NAME---------------------------------
//.DESCRIPTION..........................
//.PARAMETERS...........................
//.RETURN.CODES.........................
//--------------------------------------

typedef void (*UNLOAD_FUNC)();
typedef HANDLE (*GET_STUB_HEAP_FUNC)();

SVL_SERVICE_ERROR svlPVStub_UnloadPerformanceValidator()
{
   SVL_SERVICE_ERROR   errCode = SVL_OK;

   if (hModule != NULL)
   {
      // get the stub heap before we shut down the DLL

      HANDLE         hStubHeap = NULL;
      GET_STUB_HEAP_FUNC   getHeapFunc;

      getHeapFunc = (GET_STUB_HEAP_FUNC)GetProcAddress(hModule, "apiGetInternalMVstubHeap");
      if (getHeapFunc != NULL)
      {
         hStubHeap = (*getHeapFunc)();
      }

      // get the unload stub function

      UNLOAD_FUNC   unloadFunc;

      unloadFunc = (UNLOAD_FUNC)GetProcAddress(hModule, "apiShutdownPerformanceValidator");
      if (unloadFunc != NULL)
      {
         (*unloadFunc)();

         // get the function

         HMODULE   hModule;

         hModule = GetModuleHandleW(L"svlPerformanceValidatorStub.dll");
         if (hModule != NULL)
         {
            // unload the stub

            FreeLibrary(hModule);

            // destroy the stub's heap (which was still in use whilst FreeLibrary() was in progress

            if (hStubHeap != NULL)
               HeapDestroy(hStubHeap);
            else
            {
               if (errCode == SVL_OK)
                  errCode = SVL_FAIL_TO_CLEANUP_INTERNAL_HEAP;
            }
         }
         else
         {
            errCode = SVL_FAIL_MODULE_HANDLE;
         }
      }
      else
      {
         errCode = SVL_FAIL_UNLOAD;
      }

      hModule = NULL;
   }
   else
      errCode = SVL_NOT_LOADED;

  return errCode;
}

ContentsContents
Index
Search

Please enable JavaScript to view this site.

Performance Validator Help