]> git.cworth.org Git - apitrace/blobdiff - cli/cli_trim.cpp
Rename trim::CallSet to trace::FastCallSet
[apitrace] / cli / cli_trim.cpp
index afad283bd8f491a563c267506d6e9f60bec1a096..342e66b02e831c2b22a5d9a63d4a17e98c9a48d1 100644 (file)
@@ -53,10 +53,15 @@ usage(void)
         "        --calls=CALLSET      Include specified calls in the trimmed output.\n"
         "        --frames=FRAMESET    Include specified frames in the trimmed output.\n"
         "        --deps               Include additional calls to satisfy dependencies\n"
-        "        --prune              Omit uninteresting calls from the trace output\n"
+        "        --no-deps            Do not include any more calls than requestd\n"
+        "        --prune              Omit calls without side effects from the output\n"
+        "        --no-prune           Do not omit any requested calls\n"
         "    -a, --auto               Trim automatically to calls specified in --calls/--frames\n"
         "                             Equivalent to both --deps and --prune\n"
+        "        --exact              Trim to exactly the calls specified in --calls/--frames\n"
+        "                             Equivalent to both --no-deps and --no-prune\n"
         "        --print-callset      Print the final set of calls included in output\n"
+        "        --trim-spec=SPEC     Only performing trimming as described in SPEC\n"
         "        --thread=THREAD_ID   Only retain calls from specified thread\n"
         "    -o, --output=TRACE_FILE  Output trace file\n"
     ;
@@ -77,21 +82,47 @@ help()
         "        --deps               Perform dependency analysis and include dependent\n"
         "                             calls as needed, (even if those calls were not\n"
         "                             explicitly requested with --calls or --frames).\n"
+        "                             (On by default. See --no-deps or --exact)\n"
+        "        --no-deps            Do not perform dependency analysis. Output will\n"
+        "                             not include any additional calls beyond those\n"
+        "                             explicitly requested with --calls or --frames).\n"
         "\n"
         "        --prune              Omit calls with no side effects, even if the call\n"
         "                             is within the range specified by --calls/--frames.\n"
+        "                             (On by default. See --no-prune or --exact)\n"
+        "\n"
+        "        --no-prune           Never omit any calls from the range specified\n"
+        "                             --calls/--frames.\n"
         "\n"
         "    -a, --auto               Use dependency analysis and pruning\n"
         "                             of uninteresting calls the resulting trace may\n"
         "                             include more and less calls than specified.\n"
         "                             This option is equivalent\n"
-        "                             to passing both --deps and --prune.\n"
+        "                             to passing both --deps and --prune and is on by\n"
+        "                             default (see --no-deps, --no-prune and --exact)\n"
+        "\n"
+        "        --exact              Trim output to exact the calls or frames\n"
+        "                             specified with --calls or --frames.\n"
+        "                             This option is equivalent\n"
+        "                             to passing both --no-deps and --no-prune.\n"
         "\n"
         "        --print-callset      Print to stdout the final set of calls included\n"
         "                             in the trim output. This can be useful for\n"
-        "                             tweaking trimmed callset from --auto on the\n"
+        "                             tweaking the trimmed callset from --auto on the\n"
         "                             command-line.\n"
         "                             Use --calls=@FILE to read callset from a file.\n"
+        "        --trim-spec=SPEC     Specifies which classes of calls will be trimmed.\n"
+        "                             This option only has an effect if dependency\n"
+        "                             analysis is enabled. The argument is a comma-\n"
+        "                             separated list of names from the following:\n"
+        "\n"
+       "                               no-side-effects  Calls with no side effects\n"
+       "                               textures         Calls to setup unused textures\n"
+       "                               shaders          Calls to setup unused shaders\n"
+        "                               drawing          Calls that draw\n"
+        "\n"
+        "                             The default trim specification includes all of\n"
+        "                             the above, (as much as possible will be trimmed).\n"
         "\n"
         "        --thread=THREAD_ID   Only retain calls from specified thread\n"
         "\n"
@@ -104,13 +135,17 @@ enum {
     CALLS_OPT = CHAR_MAX + 1,
     FRAMES_OPT,
     DEPS_OPT,
+    NO_DEPS_OPT,
     PRUNE_OPT,
+    NO_PRUNE_OPT,
     THREAD_OPT,
     PRINT_CALLSET_OPT,
+    TRIM_SPEC_OPT,
+    EXACT_OPT
 };
 
 const static char *
-shortOptions = "ho:x";
+shortOptions = "aho:x";
 
 const static struct option
 longOptions[] = {
@@ -118,11 +153,15 @@ longOptions[] = {
     {"calls", required_argument, 0, CALLS_OPT},
     {"frames", required_argument, 0, FRAMES_OPT},
     {"deps", no_argument, 0, DEPS_OPT},
+    {"no-deps", no_argument, 0, NO_DEPS_OPT},
     {"prune", no_argument, 0, PRUNE_OPT},
+    {"no-prune", no_argument, 0, NO_PRUNE_OPT},
     {"auto", no_argument, 0, 'a'},
+    {"exact", no_argument, 0, EXACT_OPT},
     {"thread", required_argument, 0, THREAD_OPT},
     {"output", required_argument, 0, 'o'},
     {"print-callset", no_argument, 0, PRINT_CALLSET_OPT},
+    {"trim-spec", required_argument, 0, TRIM_SPEC_OPT},
     {0, 0, 0, 0}
 };
 
@@ -153,6 +192,9 @@ struct trim_options {
 
     /* Print resulting callset */
     int print_callset;
+
+    /* What kind of trimming to perform. */
+    TrimFlags trim_flags;
 };
 
 static int
@@ -160,8 +202,8 @@ trim_trace(const char *filename, struct trim_options *options)
 {
     trace::ParseBookmark beginning;
     trace::Parser p;
-    TraceAnalyzer analyzer;
-    std::set<unsigned> *required;
+    TraceAnalyzer analyzer(options->trim_flags);
+    trace::FastCallSet *required;
     unsigned frame;
     int call_range_first, call_range_last;
 
@@ -178,11 +220,11 @@ trim_trace(const char *filename, struct trim_options *options)
     trace::Call *call;
     while ((call = p.parse_call())) {
 
-        /* There's no use doing any work past the last call or frame
+        /* There's no use doing any work past the last call and frame
          * requested by the user. */
-        if (call->no > options->calls.getLast() ||
-            frame > options->frames.getLast()) {
-            
+        if ((options->calls.empty() || call->no > options->calls.getLast()) &&
+            (options->frames.empty() || frame > options->frames.getLast())) {
+
             delete call;
             break;
         }
@@ -192,8 +234,8 @@ trim_trace(const char *filename, struct trim_options *options)
             goto NEXT;
         }
 
-        /* Also, prune if uninteresting (unless the user asked for no pruning. */
-        if (options->prune_uninteresting && call->flags & trace::CALL_FLAG_VERBOSE) {
+        /* Also, prune if no side effects (unless the user asked for no pruning. */
+        if (options->prune_uninteresting && call->flags & trace::CALL_FLAG_NO_SIDE_EFFECTS) {
             goto NEXT;
         }
 
@@ -246,15 +288,15 @@ trim_trace(const char *filename, struct trim_options *options)
     call_range_last = -1;
     while ((call = p.parse_call())) {
 
-        /* There's no use doing any work past the last call or frame
+        /* There's no use doing any work past the last call and frame
          * requested by the user. */
-        if (call->no > options->calls.getLast() ||
-            frame > options->frames.getLast()) {
+        if ((options->calls.empty() || call->no > options->calls.getLast()) &&
+            (options->frames.empty() || frame > options->frames.getLast())) {
 
             break;
         }
 
-        if (required->find(call->no) != required->end()) {
+        if (required->contains(call->no)) {
             writer.writeCall(call);
 
             if (options->print_callset) {
@@ -288,6 +330,42 @@ trim_trace(const char *filename, struct trim_options *options)
     return 0;
 }
 
+static int
+parse_trim_spec(const char *trim_spec, TrimFlags *flags)
+{
+    std::string spec(trim_spec), word;
+    size_t start = 0, comma = 0;
+    *flags = 0;
+
+    while (start < spec.size()) {
+        comma = spec.find(',', start);
+
+        if (comma == std::string::npos)
+            word = std::string(spec, start);
+        else
+            word = std::string(spec, start, comma - start);
+
+        if (strcmp(word.c_str(), "no-side-effects") == 0)
+            *flags |= TRIM_FLAG_NO_SIDE_EFFECTS;
+        else if (strcmp(word.c_str(), "textures") == 0)
+            *flags |= TRIM_FLAG_TEXTURES;
+        else if (strcmp(word.c_str(), "shaders") == 0)
+            *flags |= TRIM_FLAG_SHADERS;
+        else if (strcmp(word.c_str(), "drawing") == 0)
+            *flags |= TRIM_FLAG_DRAWING;
+        else {
+            return 1;
+        }
+
+        if (comma == std::string::npos)
+            break;
+
+        start = comma + 1;
+    }
+
+    return 0;
+}
+
 static int
 command(int argc, char *argv[])
 {
@@ -295,11 +373,12 @@ command(int argc, char *argv[])
 
     options.calls = trace::CallSet(trace::FREQUENCY_NONE);
     options.frames = trace::CallSet(trace::FREQUENCY_NONE);
-    options.dependency_analysis = false;
-    options.prune_uninteresting = false;
+    options.dependency_analysis = true;
+    options.prune_uninteresting = true;
     options.output = "";
     options.thread = -1;
     options.print_callset = 0;
+    options.trim_flags = -1;
 
     int opt;
     while ((opt = getopt_long(argc, argv, shortOptions, longOptions, NULL)) != -1) {
@@ -316,13 +395,23 @@ command(int argc, char *argv[])
         case DEPS_OPT:
             options.dependency_analysis = true;
             break;
+        case NO_DEPS_OPT:
+            options.dependency_analysis = false;
+            break;
         case PRUNE_OPT:
             options.prune_uninteresting = true;
             break;
+        case NO_PRUNE_OPT:
+            options.prune_uninteresting = false;
+            break;
         case 'a':
             options.dependency_analysis = true;
             options.prune_uninteresting = true;
             break;
+        case EXACT_OPT:
+            options.dependency_analysis = false;
+            options.prune_uninteresting = false;
+            break;
         case THREAD_OPT:
             options.thread = atoi(optarg);
             break;
@@ -332,6 +421,13 @@ command(int argc, char *argv[])
         case PRINT_CALLSET_OPT:
             options.print_callset = 1;
             break;
+        case TRIM_SPEC_OPT:
+            if (parse_trim_spec(optarg, &options.trim_flags)) {
+                std::cerr << "error: illegal value for trim-spec: " << optarg << "\n";
+                std::cerr << "See \"apitrace help trim\" for help.\n";
+                return 1;
+            }
+            break;
         default:
             std::cerr << "error: unexpected option `" << opt << "`\n";
             usage();