Skip to content

HCK-CI/hcktrace

Repository files navigation

Utility for collecting driver logs during automatic tests

Usage

hcktrace install

  • creates c:\hcktrace directory and populates required helper binaries
  • installs hcktrace service (hcktrace.exe is copies itself to System32)
  • starts the service

hcktrace driver

  • device name: netkvm or other device (aligned with HCK-CI supported devices)
  • driver package path: full path to directory that contains $devicename.pdb file
  • level: 4 (default, INFO) or above (>4 will significantly increase log files and conversion time)

hcktrace test

  • starts ETW recording for specific driver
  • the record will be continued after reboot
  • testname: may be anything but 'stop' and 'end'

hcktrace test end

  • stops recording, saves log files, compresses them to c:\hcktrace\zip\some_name.zip
  • after that the HCK-CI can move c:\hcktrace\zip directory to workspace
  • zip files should be deleted from c:\hcktrace\zip after copy

Current status

  • Only netkvm driver supported

Notes

  • the executable must run as an admin
  • for 'install' call the original up-to-date binary
  • the service keeps its log in c:\hcktrace\servicelog.txt, collect this file if case of any problem with the tool

TODO

  • Add support for other drivers
  • Support clean uninstall to allow smooth running on a dirty system

How to build

Build requires Windows Driver Kit or Enterprise Windows Driver Kit (windows11 and up)

  • Mount DVD image of EWDK
  • Run "LaunchBuildEnv.cmd" at the root of the drive
  • "cd" to the directory the project
  • edit version.bat if needed
  • run "build.bat"
  • "package" directory will contain files to be placed to hcktrace directory under https://github.com/HCK-CI/extra-software

About

Service for driver's logs collection

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages