Skip to content

Commit

Permalink
Update drmemory URLs in docs (#6676)
Browse files Browse the repository at this point in the history
Noticed the 404 while searching documentation.
Updates the drstrace, drltrace, and symquery pages to point to the online drmemory docs.
Updates the ArmIE and inscount sample links while at it.
  • Loading branch information
DebuggingSystems authored Feb 28, 2024
1 parent 423e173 commit 4ce6943
Show file tree
Hide file tree
Showing 2 changed files with 28 additions and 18 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ IA-32, AMD64, ARM, and AArch64 hardware. Mac OSX support is in progress.
## Existing DynamoRIO-based tools

DynamoRIO is the basis for some well-known external tools:
- The [Arm Instruction Emulator (ArmIE)](https://developer.arm.com/tools-and-software/server-and-hpc/arm-architecture-tools/arm-instruction-emulator)
- The [Arm Instruction Emulator (ArmIE)](https://developer.arm.com/Tools%20and%20Software/Arm%20Instruction%20Emulator)
- [WinAFL](https://github.com/googleprojectzero/winafl), the Windows fuzzing tool, as an instrumentation and code coverage engine
- The fine-grained profiler for ARM [DrCCTProf](https://xl10.github.io/blog/drcctprof.html)
- The portable and efficient framework for fine-grained value profilers [VClinic](https://github.com/VClinic/VClinic)
Expand All @@ -36,14 +36,14 @@ Tools built on DynamoRIO and available in the [release package](https://dynamori
- [Function call tracing](https://dynamorio.org/sec_drcachesim_tools.html#sec_tool_func_view)
- The legacy processor emulator
[drcpusim](https://dynamorio.org/page_drcpusim.html)
- The "strace for Windows" tool [drstrace](http://drmemory.org/strace_for_windows.html)
- The "strace for Windows" tool [drstrace](https://drmemory.org/page_drstrace.html)
- The code coverage tool [drcov](https://dynamorio.org/page_drcov.html)
- The library tracing tool [drltrace](http://dynamorio.org/page_drltrace.html)
- The memory address tracing tool [memtrace](https://github.com/DynamoRIO/dynamorio/blob/master/api/samples/memtrace_x86.c) ([drmemtrace](https://dynamorio.org/page_drcachesim.html)'s offline traces are faster with more surrounding infrastructure, but this is a simpler starting point for customized memory address tracing)
- The memory value tracing tool [memval](https://github.com/DynamoRIO/dynamorio/blob/master/api/samples/memval_simple.c)
- The instruction tracing tool [instrace](https://github.com/DynamoRIO/dynamorio/blob/master/api/samples/instrace_x86.c) ([drmemtrace](https://dynamorio.org/page_drcachesim.html)'s offline traces are faster with more surrounding infrastructure, but this is a simpler starting point for customized instruction tracing)
- The basic block tracing tool [bbbuf](https://github.com/DynamoRIO/dynamorio/blob/master/api/samples/bbbuf.c)
- The instruction counting tool [inscount](https://github.com/DynamoRIO/dynamorio/blob/master/api/samples/inscount.c)
- The instruction counting tool [inscount](https://github.com/DynamoRIO/dynamorio/blob/master/api/samples/inscount.cpp)
- The dynamic fuzz testing tool [Dr. Fuzz](http://drmemory.org/page_drfuzz.html)
- The disassembly tool [drdisas](https://dynamorio.org/page_drdisas.html)
- And more, including opcode counts, branch instrumentation, etc.: see [API samples](https://dynamorio.org/API_samples.html)
Expand Down
40 changes: 25 additions & 15 deletions api/docs/tool.gendox
Original file line number Diff line number Diff line change
Expand Up @@ -83,34 +83,44 @@ should point at the local documentation provided with the release package.
/**
\page page_drstrace System Call Tracer for Windows

\p drstrace is a system call tracing tool for Windows. It is part of the
<a href="http://drmemory.org">Dr. Memory tool suite</a>. It is also
included with DynamoRIO versions 5.0.0 and higher. If this documentation
is part of a DynamoRIO public release, <a
href="../../drmemory/drmemory/docs/html/page_drstrace.html">this link</a> should
\p drstrace is a system call tracing tool for Windows.
It is part of the
<a href="http://drmemory.org">Dr. Memory tool suite</a>. It is also
included with DynamoRIO versions 5.0.0 and higher.

If this documentation is part of a DynamoRIO public release,
<a href="../../drmemory/drmemory/docs/html/page_drstrace.html">this link</a> should
point at the local documentation provided with the release package.
<a href="https://drmemory.org/page_drstrace.html">This one</a> points to the online
documentation.
*/

/**
\page page_drltrace Library Call Tracer

\p drltrace is a library call tracing tool for all platforms. It is part of the
<a href="http://drmemory.org">Dr. Memory tool suite</a>. It is also
included with DynamoRIO versions 5.0.0 and higher. If this documentation
is part of a DynamoRIO public release, <a
href="../../drmemory/drmemory/docs/html/page_drltrace.html">this link</a> should
point at the local documentation provided with the release package.
<a href="http://drmemory.org">Dr. Memory tool suite</a>. It is also
included with DynamoRIO versions 5.0.0 and higher.

If this documentation is part of a DynamoRIO public release,
<a href="../../drmemory/drmemory/docs/html/page_drltrace.html">this link
</a> should point at the local documentation provided with the release package.
<a href="https://dynamorio.org/page_drltrace.html">This one</a> points to the online
documentation.
*/

/**
\page page_symquery Symbol Query Tool

\p symquery is a symbol querying tool that operates on Linux, Mac, and
Windows and supports the Windows PDB, Linux ELF, Mac Mach-O, and Windows
PECOFF formats with DWARF2 line information. It is part of the <a
href="http://drmemory.org">Dr. Memory tool suite</a>. It is also included
with DynamoRIO versions 5.0.0 and higher. If this documentation is part of
a DynamoRIO public release, <a
href="../../drmemory/drmemory/docs/html/page_symquery.html">this link</a>
PECOFF formats with DWARF2 line information. It is part of the
<a href="http://drmemory.org">Dr. Memory tool suite</a>. It is also included
with DynamoRIO versions 5.0.0 and higher.

If this documentation is part of a DynamoRIO public release,
<a href="../../drmemory/drmemory/docs/html/page_symquery.html">this link</a>
should point at the local documentation provided with the release package.
<a href="https://dynamorio.org/page_symquery.html">This one</a> points to the online
documentation.
*/

0 comments on commit 4ce6943

Please sign in to comment.