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 <stdbool.h>
  12
  13 #if defined(__cplusplus)
  14 extern "C" {
  15 #endif
  16
  17 /*
  18  * Read the trace by `exec()ing` the provided viewer program if any. If
  19  * `opt_viewer` is NULL, try to read the trace with the default trace reader.
  20  * On success, this function doesn't return.
  21  * Returns -1 if the `opt_viewer` string or the default trace viewer can't be
  22  * `exec()`.
  23  *
  24  * This symbol was mistakenly made public before the 2.12 release. It can't
  25  * be removed (but it can be stubbed-out if necessary).
  26  */
  27 int spawn_viewer(const char *trace_path, char *opt_viewer, bool opt_live_mode);
  28
  29 #if defined(__cplusplus)
  30 }
  31 #endif
  32
  33 #endif /* ifndef LTTNG_SPAWN_VIEWER_H */