Function printHelp

benchmarks/genConfig.py:5–53

()

import sys, getopt

def printHelp():
  print \
"""
Generates a configuration file to be used in benchmarking NanoLog
(./BenchmarkConfig.h). Note that invoking this file will also
overwrite the contents of ../runtime/Config.h to refer to the
variables in ./BenchmarkConfig.h.

Usage:
        python genConfig.py options

Options:
    --disableOutput                 Drops the log messages by piping the
                                    results to /dev/null
    --disableCompaction             Entries will be memcpy'ed directly from
                                    the StagingBuffer to the OutputBuffer.
                                    The output produced will not be useable
                                    by the NanoLog Decompressor
    --discardEntriesAtStagingBuffer Drops messages after they've been placed
                                    into the staging buffer by record()
    --stagingBufferExp <exp>        Specifies the size of the StagingBuffer
                                    as 2^exp bytes (default 20)
    --outputBufferExp <exp>         Specifies the size of the OutputBuffer
                                    as 2^exp bytes (default 26)
    --releaseThresholdExp <exp>     Specifies the release threshold as 2^exp
                                    bytes (default 19)
    --pollInterval <us>             Amount of time (in us) that the NanoLog
                                    should wake from sleep to check for work
                                    (default 1)

    --threads <num>                 Number of producer threads (default 1).
                                    Each thread will run iterations of benchOp

    --iterations <num>              Number of iterations to run benchOp (below)
                                    (default 100000000)

    --benchOp <Nano Log Code>       C++ code to run <iteration> times
                                    (default "NANO_LOG("Simple log message with 0 parameters");)
                                    Note: variable int 'i' is accessible here

    --useSnappy                     Enable the logic to compress the NanoLog
                                    output with snappy https://github.com/google/snappy

Examples:

  python genConfig.py               Generates a default configuration

  python genConfig.py --benchOp "NANO_LOG(\"Test\");" --iterations=100
"""