src/common/spawn-viewer.h

   1 #ifndef LTTNG_SPAWN_VIEWER_H
   2 #define LTTNG_SPAWN_VIEWER_H
   3
   4 /*
   5  * Copyright (C) 2020 Francis Deslauriers <francis.deslauriers@efficios.com>
   6  *
   7  * SPDX-License-Identifier: GPL-2.0-only
   8  *
   9  */
  10
  11 #include <lttng/lttng-export.h>
  12 #include <stdbool.h>
  13
  14 #if defined(__cplusplus)
  15 extern "C" {
  16 #endif
  17
  18 /*
  19  * Read the trace by `exec()ing` the provided viewer program if any. If
  20  * `opt_viewer` is NULL, try to read the trace with the default trace reader.
  21  * On success, this function doesn't return.
  22  * Returns -1 if the `opt_viewer` string or the default trace viewer can't be
  23  * `exec()`.
  24  *
  25  * This symbol was mistakenly made public before the 2.12 release. It can't
  26  * be removed (but it can be stubbed-out if necessary).
  27  */
  28 LTTNG_EXPORT int spawn_viewer(const char *trace_path, char *opt_viewer, bool opt_live_mode);
  29
  30 #if defined(__cplusplus)
  31 }
  32 #endif
  33
  34 #endif /* ifndef LTTNG_SPAWN_VIEWER_H */