-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Relevant changes are in quark.7 and quark-test.8, the rest is just adding cross references and publishing the html files for github.io.
- Loading branch information
Showing
25 changed files
with
290 additions
and
34 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,128 @@ | ||
| <!DOCTYPE html> | ||
| <html> | ||
| <head> | ||
| <meta charset="utf-8"/> | ||
| <meta name="viewport" content="width=device-width, initial-scale=1.0"/> | ||
| <link rel="stylesheet" href="mandoc.css" type="text/css" media="all"/> | ||
| <title>QUARK-TEST(8)</title> | ||
| </head> | ||
| <body> | ||
| <table class="head"> | ||
| <tr> | ||
| <td class="head-ltitle">QUARK-TEST(8)</td> | ||
| <td class="head-vol">System Manager's Manual</td> | ||
| <td class="head-rtitle">QUARK-TEST(8)</td> | ||
| </tr> | ||
| </table> | ||
| <div class="manual-text"> | ||
| <section class="Sh"> | ||
| <h1 class="Sh" id="NAME"><a class="permalink" href="#NAME">NAME</a></h1> | ||
| <p class="Pp"><code class="Nm">quark-test</code> — | ||
| <span class="Nd">quark's test utility</span></p> | ||
| </section> | ||
| <section class="Sh"> | ||
| <h1 class="Sh" id="SYNOPSIS"><a class="permalink" href="#SYNOPSIS">SYNOPSIS</a></h1> | ||
| <table class="Nm"> | ||
| <tr> | ||
| <td><code class="Nm">quark-test</code></td> | ||
| <td>[<code class="Fl">-bkv</code>] [<var class="Ar">tests ...</var>]</td> | ||
| </tr> | ||
| </table> | ||
| <br/> | ||
| <table class="Nm"> | ||
| <tr> | ||
| <td><code class="Nm">quark-test <code class="Fl">-l</code></code></td> | ||
| <td></td> | ||
| </tr> | ||
| </table> | ||
| <br/> | ||
| <table class="Nm"> | ||
| <tr> | ||
| <td><code class="Nm">quark-test <code class="Fl">-N</code></code></td> | ||
| <td></td> | ||
| </tr> | ||
| </table> | ||
| <br/> | ||
| <table class="Nm"> | ||
| <tr> | ||
| <td><code class="Nm">quark-test <code class="Fl">-V</code></code></td> | ||
| <td></td> | ||
| </tr> | ||
| </table> | ||
| </section> | ||
| <h1 class="Sh" id="DESCRIPTION"><a class="permalink" href="#DESCRIPTION">DESCRIPTION</a></h1> | ||
| The <code class="Nm">quark-test</code> program runs tests for | ||
| <a class="Xr" href="quark.7.html">quark(7)</a>. It is designed as one big fat | ||
| binary so that you can easily run it with quark's custom | ||
| <span class="Pa">initramfs.gz</span>. Without any arguments, | ||
| <code class="Nm">quark-test</code> will run all tests in both KPROBE and EBPF | ||
| as backend. | ||
| <p class="Pp">Each test runs a separate sub-process in order to avoid address | ||
| space contaminaton between two tests. The number of failed tests is the | ||
| return value of <code class="Nm">quark-test</code>.</p> | ||
| <p class="Pp">The options are as follows:</p> | ||
| <dl class="Bl-tag"> | ||
| <dt id="b"><a class="permalink" href="#b"><code class="Fl">-b</code></a></dt> | ||
| <dd>Run only EBPF tests.</dd> | ||
| <dt id="k"><a class="permalink" href="#k"><code class="Fl">-k</code></a></dt> | ||
| <dd>Run only KPROBE tests.</dd> | ||
| <dt id="l"><a class="permalink" href="#l"><code class="Fl">-l</code></a></dt> | ||
| <dd>Prints all available tests on stdout.</dd> | ||
| <dt id="N"><a class="permalink" href="#N"><code class="Fl">-N</code></a></dt> | ||
| <dd>This is a nop flag, literally, <code class="Nm">quark-test</code> will | ||
| just exit with 0. Some tests must fork and exec things in order to collect | ||
| events, this keeps the binary self contained by forking and execing itself | ||
| as we don't have access to system utilities in | ||
| <span class="Pa">initramfs.gz</span>.</dd> | ||
| <dt id="v"><a class="permalink" href="#v"><code class="Fl">-v</code></a></dt> | ||
| <dd>Increase | ||
| <a class="permalink" href="#quark_verbose"><i class="Em" id="quark_verbose">quark_verbose</i></a>, | ||
| can be issued multiple times.</dd> | ||
| <dt id="V"><a class="permalink" href="#V"><code class="Fl">-V</code></a></dt> | ||
| <dd>Print version and exit.</dd> | ||
| </dl> | ||
| <section class="Sh"> | ||
| <h1 class="Sh" id="EXIT_STATUS"><a class="permalink" href="#EXIT_STATUS">EXIT | ||
| STATUS</a></h1> | ||
| <p class="Pp"><code class="Nm">quark-test</code> exits with the number of failed | ||
| tests, or non-zero if <code class="Nm">quark-test</code> itself fails.</p> | ||
| </section> | ||
| <section class="Sh"> | ||
| <h1 class="Sh" id="EXAMPLES"><a class="permalink" href="#EXAMPLES">EXAMPLES</a></h1> | ||
| <div class="Bd Li"> | ||
| <pre>$ quark-test -k | ||
|
|
||
| t_probe @ kprobe: ok | ||
| t_fork_exec_exit @ kprobe: ok | ||
| failed tests 0 | ||
|
|
||
| $ quark-test t_fork_exec_exit | ||
|
|
||
| t_fork_exec_exit @ ebpf: ok | ||
| t_fork_exec_exit @ kprobe: ok | ||
| failed tests 0</pre> | ||
| </div> | ||
| </section> | ||
| <section class="Sh"> | ||
| <h1 class="Sh" id="SEE_ALSO"><a class="permalink" href="#SEE_ALSO">SEE | ||
| ALSO</a></h1> | ||
| <p class="Pp"><a class="Xr" href="quark_event_dump.3.html">quark_event_dump(3)</a>, | ||
| <a class="Xr" href="quark_process_lookup.3.html">quark_process_lookup(3)</a>, | ||
| <a class="Xr" href="quark_queue_block.3.html">quark_queue_block(3)</a>, | ||
| <a class="Xr" href="quark_queue_close.3.html">quark_queue_close(3)</a>, | ||
| <a class="Xr" href="quark_queue_get_epollfd.3.html">quark_queue_get_epollfd(3)</a>, | ||
| <a class="Xr" href="quark_queue_get_events.3.html">quark_queue_get_events(3)</a>, | ||
| <a class="Xr" href="quark_queue_get_stats.3.html">quark_queue_get_stats(3)</a>, | ||
| <a class="Xr" href="quark_queue_open.3.html">quark_queue_open(3)</a>, | ||
| <a class="Xr" href="quark-btf.8.html">quark-btf(8)</a>, | ||
| <a class="Xr" href="quark-mon.8.html">quark-mon(8)</a></p> | ||
| </section> | ||
| </div> | ||
| <table class="foot"> | ||
| <tr> | ||
| <td class="foot-date">October 25, 2024</td> | ||
| <td class="foot-os">Linux</td> | ||
| </tr> | ||
| </table> | ||
| </body> | ||
| </html> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.