i#4111: Generate doxygen suitable for embedding in jekyll (#4748)

Creates a second version of the doxygen html output suitable for
embedding in our jekyll-based web site.  This version turns off the
doxygen treeview, but then borrows the javascript menu files from the
treeview version.  We then edit the html to remove the headers, and
edit the menu files for inlining into our web site's single array.

Furthermore, we generate keyword search term data so that searches
using lunr for functions or types result in direct links to their
anchors within their pages.  It generates keyword tokens for each
component of an underscore-separated multi-word type, along with
tokens for each prefix (e.g., so that "dr_mutex" will find
"dr_mutex_*").

Adds installation into a "docs_embed" directory.

Adds deployment logic to package.cmake to copy the embedded html to a
top level "html_embed", along with new steps in the ci-package GA
workflow to take the embedded html files and push them to the
dynamorio.github.io repository.

Issue: #4111, #4740
6 files changed
tree: 44106044cbd49a1f7a7421b2a57bd87912fc4a5c
  1. .github/
  2. api/
  3. clients/
  4. core/
  5. ext/
  6. libutil/
  7. make/
  8. suite/
  9. third_party/
  10. tools/
  11. .clang-format
  12. ACKNOWLEDGEMENTS
  13. CMakeLists.txt
  14. CONTRIBUTING.md
  15. CTestConfig.cmake
  16. License.txt
  17. README
  18. README.md
README.md

DynamoRIO

DynamoRIO logo

About DynamoRIO

DynamoRIO is a runtime code manipulation system that supports code transformations on any part of a program, while it executes. DynamoRIO exports an interface for building dynamic tools for a wide variety of uses: program analysis and understanding, profiling, instrumentation, optimization, translation, etc. Unlike many dynamic tool systems, DynamoRIO is not limited to insertion of callouts/trampolines and allows arbitrary modifications to application instructions via a powerful IA-32/AMD64/ARM/AArch64 instruction manipulation library. DynamoRIO provides efficient, transparent, and comprehensive manipulation of unmodified applications running on stock operating systems (Windows, Linux, or Android) and commodity IA-32, AMD64, ARM, and AArch64 hardware. Mac OSX support is in progress.

Existing DynamoRIO-based tools

Tools built on DynamoRIO and provided in our release package include:

  • The memory debugging tool Dr. Memory
  • The multi-process cache simulator and memory address trace collection and analysis platform drcachesim
  • The legacy processor emulator drcpusim
  • The “strace for Windows” tool drstrace
  • The code coverage tool drcov
  • The library tracing tool drltrace
  • The disassembly tool drdisas
  • The memory tracing tool memtrace
  • The basic block tracing tool bbbuf
  • The instruction counting tool inscount

Building your own custom tools

DynamoRIO‘s powerful API abstracts away the details of the underlying infrastructure and allows the tool builder to concentrate on analyzing or modifying the application’s runtime code stream. API documentation is included in the release package and can also be browsed online. Slides from our past tutorials are also available.

Downloading DynamoRIO

DynamoRIO is available free of charge as a binary package for both Windows and Linux. DynamoRIO's source code is available under a BSD license.

Obtaining Help

Use the discussion list to ask questions.

To report a bug, use the issue tracker.

See also the DynamoRIO home page: http://dynamorio.org/