include/lttng/lttng.h

   1 /*
   2  * Copyright (C) 2011 - David Goulet <david.goulet@polymtl.ca>
   3  *
   4  * This program is free software; you can redistribute it and/or
   5  * modify it under the terms of the GNU General Public License
   6  * as published by the Free Software Foundation; either version 2
   7  * of the License, or (at your option) any later version.
   8  *
   9  * This program is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  * GNU General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU General Public License
  15  * along with this program; if not, write to the Free Software
  16  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
  17  */
  18
  19 #ifndef _LIBLTTNGCTL_H
  20 #define _LIBLTTNGCTL_H
  21
  22 #include <limits.h>
  23 #include <uuid/uuid.h>
  24
  25 /* Default unix group name for tracing.
  26  */
  27 #define DEFAULT_TRACING_GROUP "tracing"
  28
  29 /* Environment variable to set session daemon
  30  * binary path.
  31  */
  32 #define LTTNG_SESSIOND_PATH_ENV "LTTNG_SESSIOND_PATH"
  33
  34 /* UUID string length (including \0) */
  35 #define UUID_STR_LEN 37
  36 /* UUID short string version length (including \0) */
  37 #define UUID_SHORT_STR_LEN 9
  38
  39 /* Trace type for lttng_trace.
  40  */
  41 enum lttng_trace_type {
  42         KERNEL, USERSPACE,
  43 };
  44
  45 /* Simple structure representing a session.
  46  */
  47 struct lttng_session {
  48         char name[NAME_MAX];
  49         uuid_t uuid;
  50 };
  51
  52 /* Simple trace representation.
  53  */
  54 struct lttng_trace {
  55         char name[NAME_MAX];
  56         pid_t pid;
  57         enum lttng_trace_type type;
  58 };
  59
  60 extern int lttng_create_session(char *name, uuid_t *session_id);
  61 extern int lttng_destroy_session(uuid_t *uuid);
  62 extern int lttng_connect_sessiond(void);
  63 extern int lttng_disconnect_sessiond(void);
  64 extern int lttng_set_tracing_group(const char *name);
  65 extern int lttng_check_session_daemon(void);
  66 extern const char *lttng_get_readable_code(int code);
  67 extern int lttng_ust_list_apps(pid_t **pids);
  68 extern int lttng_list_sessions(struct lttng_session **sessions);
  69 extern int lttng_list_traces(uuid_t *uuid, struct lttng_trace **traces);
  70 extern void lttng_set_current_session_uuid(uuid_t *uuid);
  71 extern int lttng_ust_create_trace(pid_t pid);
  72 extern int lttng_ust_start_trace(pid_t pid);
  73 extern int lttng_ust_stop_trace(pid_t pid);
  74
  75 #endif /* _LIBLTTNGCTL_H */