src/bin/lttng-sessiond/ust-app.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; only version 2
   7  * of the License.
   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 _LTT_UST_APP_H
  20 #define _LTT_UST_APP_H
  21
  22 #include <stdint.h>
  23
  24 #include "trace-ust.h"
  25
  26 /* lttng-ust supported version. */
  27 #define LTTNG_UST_COMM_MAJOR          2 /* comm protocol major version */
  28 #define UST_APP_MAJOR_VERSION         2 /* UST version supported */
  29
  30 #define UST_APP_EVENT_LIST_SIZE 32
  31
  32 extern int ust_consumerd64_fd, ust_consumerd32_fd;
  33
  34 /*
  35  * Application registration data structure.
  36  */
  37 struct ust_register_msg {
  38         uint32_t major;
  39         uint32_t minor;
  40         pid_t pid;
  41         pid_t ppid;
  42         uid_t uid;
  43         gid_t gid;
  44         uint32_t bits_per_long;
  45         char name[16];
  46 };
  47
  48 /*
  49  * Global applications HT used by the session daemon.
  50  */
  51 struct lttng_ht *ust_app_ht;
  52
  53 struct lttng_ht *ust_app_sock_key_map;
  54
  55 struct ust_app_key {
  56         pid_t pid;
  57         int sock;
  58         struct lttng_ht_node_ulong node;
  59 };
  60
  61 struct ust_app_ctx {
  62         int handle;
  63         struct lttng_ust_context ctx;
  64         struct lttng_ust_object_data *obj;
  65         struct lttng_ht_node_ulong node;
  66 };
  67
  68 struct ust_app_event {
  69         int enabled;
  70         int handle;
  71         struct lttng_ust_object_data *obj;
  72         struct lttng_ust_event attr;
  73         char name[LTTNG_UST_SYM_NAME_LEN];
  74         struct lttng_ht *ctx;
  75         struct lttng_ht_node_str node;
  76 };
  77
  78 struct ust_app_channel {
  79         int enabled;
  80         int handle;
  81         char name[LTTNG_UST_SYM_NAME_LEN];
  82         struct lttng_ust_channel attr;
  83         struct lttng_ust_object_data *obj;
  84         struct ltt_ust_stream_list streams;
  85         struct lttng_ht *ctx;
  86         struct lttng_ht *events;
  87         struct lttng_ht_node_str node;
  88 };
  89
  90 struct ust_app_session {
  91         int enabled;
  92         /* started: has the session been in started state at any time ? */
  93         int started;  /* allows detection of start vs restart. */
  94         int handle;   /* used has unique identifier for app session */
  95         int id;       /* session unique identifier */
  96         struct ltt_ust_metadata *metadata;
  97         struct lttng_ht *channels; /* Registered channels */
  98         struct lttng_ht_node_ulong node;
  99         char path[PATH_MAX];
 100         /* UID/GID of the user owning the session */
 101         uid_t uid;
 102         gid_t gid;
 103 };
 104
 105 /*
 106  * Registered traceable applications. Libust registers to the session daemon
 107  * and a linked list is kept of all running traceable app.
 108  */
 109 struct ust_app {
 110         pid_t ppid;
 111         uid_t uid;           /* User ID that owns the apps */
 112         gid_t gid;           /* Group ID that owns the apps */
 113         int bits_per_long;
 114         int compatible; /* If the lttng-ust tracer version does not match the
 115                                            supported version of the session daemon, this flag is
 116                                            set to 0 (NOT compatible) else 1. */
 117         struct lttng_ust_tracer_version version;
 118         uint32_t v_major;    /* Verion major number */
 119         uint32_t v_minor;    /* Verion minor number */
 120         char name[17];       /* Process name (short) */
 121         struct lttng_ht *sessions;
 122         struct lttng_ht_node_ulong node;
 123         struct ust_app_key key;
 124 };
 125
 126 #ifdef HAVE_LIBLTTNG_UST_CTL
 127
 128 int ust_app_register(struct ust_register_msg *msg, int sock);
 129 static inline
 130 int ust_app_register_done(int sock)
 131 {
 132         return ustctl_register_done(sock);
 133 }
 134 void ust_app_unregister(int sock);
 135 unsigned long ust_app_list_count(void);
 136 int ust_app_start_trace(struct ltt_ust_session *usess, struct ust_app *app);
 137 int ust_app_stop_trace(struct ltt_ust_session *usess, struct ust_app *app);
 138 int ust_app_start_trace_all(struct ltt_ust_session *usess);
 139 int ust_app_stop_trace_all(struct ltt_ust_session *usess);
 140 int ust_app_destroy_trace(struct ltt_ust_session *usess, struct ust_app *app);
 141 int ust_app_destroy_trace_all(struct ltt_ust_session *usess);
 142 int ust_app_list_events(struct lttng_event **events);
 143 int ust_app_create_channel_glb(struct ltt_ust_session *usess,
 144                 struct ltt_ust_channel *uchan);
 145 int ust_app_create_event_glb(struct ltt_ust_session *usess,
 146                 struct ltt_ust_channel *uchan, struct ltt_ust_event *uevent);
 147 int ust_app_disable_event_pid(struct ltt_ust_session *usess,
 148                 struct ltt_ust_channel *uchan, struct ltt_ust_event *uevent,
 149                 pid_t pid);
 150 int ust_app_enable_event_pid(struct ltt_ust_session *usess,
 151                 struct ltt_ust_channel *uchan, struct ltt_ust_event *uevent,
 152                 pid_t pid);
 153 int ust_app_disable_channel_glb(struct ltt_ust_session *usess,
 154                 struct ltt_ust_channel *uchan);
 155 int ust_app_enable_channel_glb(struct ltt_ust_session *usess,
 156                 struct ltt_ust_channel *uchan);
 157 int ust_app_enable_event_glb(struct ltt_ust_session *usess,
 158                 struct ltt_ust_channel *uchan, struct ltt_ust_event *uevent);
 159 int ust_app_disable_all_event_glb(struct ltt_ust_session *usess,
 160                 struct ltt_ust_channel *uchan);
 161 int ust_app_enable_all_event_glb(struct ltt_ust_session *usess,
 162                 struct ltt_ust_channel *uchan);
 163 int ust_app_disable_event_glb(struct ltt_ust_session *usess,
 164                 struct ltt_ust_channel *uchan, struct ltt_ust_event *uevent);
 165 int ust_app_add_ctx_event_glb(struct ltt_ust_session *usess,
 166                 struct ltt_ust_channel *uchan, struct ltt_ust_event *uevent,
 167                 struct ltt_ust_context *uctx);
 168 int ust_app_add_ctx_channel_glb(struct ltt_ust_session *usess,
 169                 struct ltt_ust_channel *uchan, struct ltt_ust_context *uctx);
 170 void ust_app_global_update(struct ltt_ust_session *usess, int sock);
 171
 172 void ust_app_clean_list(void);
 173 void ust_app_ht_alloc(void);
 174 struct lttng_ht *ust_app_get_ht(void);
 175 struct ust_app *ust_app_find_by_pid(pid_t pid);
 176 int ust_app_validate_version(int sock);
 177 int ust_app_calibrate_glb(struct lttng_ust_calibrate *calibrate);
 178
 179 #else /* HAVE_LIBLTTNG_UST_CTL */
 180
 181 static inline
 182 int ust_app_destroy_trace_all(struct ltt_ust_session *usess)
 183 {
 184         return 0;
 185 }
 186 static inline
 187 int ust_app_start_trace(struct ltt_ust_session *usess, struct ust_app *app)
 188 {
 189         return 0;
 190 }
 191 static inline
 192 int ust_app_start_trace_all(struct ltt_ust_session *usess)
 193 {
 194         return 0;
 195 }
 196 static inline
 197 int ust_app_stop_trace_all(struct ltt_ust_session *usess)
 198 {
 199         return 0;
 200 }
 201 static inline
 202 int ust_app_list_events(struct lttng_event **events)
 203 {
 204         return 0;
 205 }
 206 static inline
 207 int ust_app_register(struct ust_register_msg *msg, int sock)
 208 {
 209         return -ENOSYS;
 210 }
 211 static inline
 212 int ust_app_register_done(int sock)
 213 {
 214         return -ENOSYS;
 215 }
 216 static inline
 217 void ust_app_unregister(int sock)
 218 {
 219 }
 220 static inline
 221 unsigned int ust_app_list_count(void)
 222 {
 223         return 0;
 224 }
 225 static inline
 226 void ust_app_lock_list(void)
 227 {
 228 }
 229 static inline
 230 void ust_app_unlock_list(void)
 231 {
 232 }
 233 static inline
 234 void ust_app_clean_list(void)
 235 {
 236 }
 237 static inline
 238 struct ust_app_list *ust_app_get_list(void)
 239 {
 240         return NULL;
 241 }
 242 static inline
 243 struct ust_app *ust_app_get_by_pid(pid_t pid)
 244 {
 245         return NULL;
 246 }
 247 static inline
 248 struct lttng_ht *ust_app_get_ht(void)
 249 {
 250         return NULL;
 251 }
 252 static inline
 253 void ust_app_ht_alloc(void)
 254 {}
 255 static inline
 256 void ust_app_global_update(struct ltt_ust_session *usess, int sock)
 257 {}
 258 static inline
 259 int ust_app_disable_channel_glb(struct ltt_ust_session *usess,
 260                 struct ltt_ust_channel *uchan)
 261 {
 262         return 0;
 263 }
 264 static inline
 265 int ust_app_enable_channel_glb(struct ltt_ust_session *usess,
 266                 struct ltt_ust_channel *uchan)
 267 {
 268         return 0;
 269 }
 270 static inline
 271 int ust_app_create_channel_glb(struct ltt_ust_session *usess,
 272                 struct ltt_ust_channel *uchan)
 273 {
 274         return 0;
 275 }
 276 static inline
 277 int ust_app_disable_all_event_glb(struct ltt_ust_session *usess,
 278                 struct ltt_ust_channel *uchan)
 279 {
 280         return 0;
 281 }
 282 static inline
 283 int ust_app_enable_all_event_glb(struct ltt_ust_session *usess,
 284                 struct ltt_ust_channel *uchan)
 285 {
 286         return 0;
 287 }
 288 static inline
 289 int ust_app_create_event_glb(struct ltt_ust_session *usess,
 290                 struct ltt_ust_channel *uchan, struct ltt_ust_event *uevent)
 291 {
 292         return 0;
 293 }
 294 static inline
 295 int ust_app_disable_event_glb(struct ltt_ust_session *usess,
 296                 struct ltt_ust_channel *uchan, struct ltt_ust_event *uevent)
 297 {
 298         return 0;
 299 }
 300 static inline
 301 int ust_app_enable_event_glb(struct ltt_ust_session *usess,
 302                 struct ltt_ust_channel *uchan, struct ltt_ust_event *uevent)
 303 {
 304         return 0;
 305 }
 306 static inline
 307 int ust_app_add_ctx_event_glb(struct ltt_ust_session *usess,
 308                 struct ltt_ust_channel *uchan, struct ltt_ust_event *uevent,
 309                 struct ltt_ust_context *uctx)
 310 {
 311         return 0;
 312 }
 313 static inline
 314 int ust_app_add_ctx_channel_glb(struct ltt_ust_session *usess,
 315                 struct ltt_ust_channel *uchan, struct ltt_ust_context *uctx)
 316 {
 317         return 0;
 318 }
 319 static inline
 320 int ust_app_enable_event_pid(struct ltt_ust_session *usess,
 321                 struct ltt_ust_channel *uchan, struct ltt_ust_event *uevent,
 322                 pid_t pid)
 323 {
 324         return 0;
 325 }
 326 static inline
 327 int ust_app_disable_event_pid(struct ltt_ust_session *usess,
 328                 struct ltt_ust_channel *uchan, struct ltt_ust_event *uevent,
 329                 pid_t pid)
 330 {
 331         return 0;
 332 }
 333 static inline
 334 int ust_app_validate_version(int sock)
 335 {
 336         return 0;
 337 }
 338 static inline
 339 int ust_app_calibrate_glb(struct lttng_ust_calibrate *calibrate)
 340 {
 341         return 0;
 342 }
 343
 344 #endif /* HAVE_LIBLTTNG_UST_CTL */
 345
 346 #endif /* _LTT_UST_APP_H */