include/ust/ustctl.h

   1 /* Copyright (C) 2009  Pierre-Marc Fournier
   2  *
   3  * This library is free software; you can redistribute it and/or
   4  * modify it under the terms of the GNU Lesser General Public
   5  * License as published by the Free Software Foundation; either
   6  * version 2.1 of the License, or (at your option) any later version.
   7  *
   8  * This library is distributed in the hope that it will be useful,
   9  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  11  * Lesser General Public License for more details.
  12  *
  13  * You should have received a copy of the GNU Lesser General Public
  14  * License along with this library; if not, write to the Free Software
  15  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301 USA
  16  */
  17
  18 #ifndef _USTCTL_H
  19 #define _USTCTL_H
  20
  21 #include <stdio.h>
  22 #include <unistd.h>
  23 #include <getopt.h>
  24 #include <stdlib.h>
  25 #include <fcntl.h>
  26
  27 #define USTCTL_ERR_CONN         1 /* Process connection error */
  28 #define USTCTL_ERR_ARG          2 /* Invalid function argument */
  29 #define USTCTL_ERR_GEN          3 /* General ustctl error */
  30
  31 #define USTCTL_MS_CHR_OFF       '0' /* Marker state 'on' character */
  32 #define USTCTL_MS_CHR_ON        '1' /* Marker state 'on' character */
  33 #define USTCTL_MS_OFF           0   /* Marker state 'on' value */
  34 #define USTCTL_MS_ON            1   /* Marker state 'on' value */
  35
  36 #define USTCTL_SOCK_PATH        "/tmp/socks/"
  37
  38 /* Channel/marker/state/format string (cmsf) info. structure */
  39 struct ust_marker_status {
  40         char *channel; /* Channel name (end of ust_marker_status array if NULL) */
  41         char *ust_marker; /* Marker name (end of ust_marker_status array if NULL) */
  42         int state; /* State (0 := marker disabled, 1 := marker enabled) */
  43         char *fs; /* Format string (end of ust_marker_status array if NULL) */
  44 };
  45
  46 struct trace_event_status {
  47         char *name;
  48 };
  49
  50 extern pid_t *ustctl_get_online_pids(void);
  51
  52 extern int ustctl_connect_pid(pid_t pid);
  53
  54 extern int ustctl_set_ust_marker_state(int sock, const char *trace,
  55                                    const char *channel, const char *ust_marker,
  56                                    int state);
  57
  58 extern int ustctl_set_subbuf_size(int sock, const char *trace,
  59                                   const char *channel,
  60                                   unsigned int subbuf_size);
  61
  62 extern int ustctl_set_subbuf_num(int sock, const char *trace,
  63                                  const char *channel,
  64                                  unsigned int num);
  65
  66 extern int ustctl_get_subbuf_size(int sock, const char *trace,
  67                                   const char *channel);
  68
  69 extern int ustctl_get_subbuf_num(pid_t pid, const char *trace,
  70                                  const char *channel);
  71
  72 extern int ustctl_destroy_trace(int sock, const char *trace);
  73
  74 extern int ustctl_setup_and_start(int sock, const char *trace);
  75
  76 extern int ustctl_stop_trace(int sock, const char *trace);
  77
  78 extern int ustctl_create_trace(int sock, const char *trace);
  79
  80 extern int ustctl_start_trace(int sock, const char *trace);
  81
  82 extern int ustctl_alloc_trace(int sock, const char *trace);
  83
  84 extern int ustctl_free_cmsf(struct ust_marker_status *);
  85 extern int ustctl_free_tes(struct trace_event_status *);
  86 extern unsigned int ustctl_count_nl(const char *);
  87
  88 extern int ustctl_get_cmsf(int sock, struct ust_marker_status **);
  89
  90 extern int ustctl_get_tes(int sock, struct trace_event_status **);
  91
  92 extern int ustctl_set_sock_path(int sock, const char *sock_path);
  93
  94 extern int ustctl_get_sock_path(int sock, char **sock_path);
  95
  96 extern int ustctl_force_switch(int sock, const char *trace);
  97
  98 #endif /* _USTCTL_H */