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 modify
   5  * it under the terms of the GNU General Public License, version 2 only,
   6  * as published by the Free Software Foundation.
   7  *
   8  * This program 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
  11  * GNU General Public License for more details.
  12  *
  13  * You should have received a copy of the GNU General Public License along
  14  * with this program; if not, write to the Free Software Foundation, Inc.,
  15  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  16  */
  17
  18 #ifndef _LTT_UST_APP_H
  19 #define _LTT_UST_APP_H
  20
  21 #include <stdint.h>
  22
  23 #include "trace-ust.h"
  24
  25 /* lttng-ust supported version. */
  26 #define LTTNG_UST_COMM_MAJOR          2 /* comm protocol major version */
  27 #define UST_APP_MAJOR_VERSION         3 /* Internal UST version supported */
  28
  29 #define UST_APP_EVENT_LIST_SIZE 32
  30
  31 struct lttng_filter_bytecode;
  32 struct lttng_ust_filter_bytecode;
  33
  34 extern int ust_consumerd64_fd, ust_consumerd32_fd;
  35
  36 struct ust_app_ht_key {
  37         const char *name;
  38         const struct lttng_ust_filter_bytecode *filter;
  39         enum lttng_ust_loglevel_type loglevel;
  40 };
  41
  42 /*
  43  * Application registration data structure.
  44  */
  45 struct ust_register_msg {
  46         uint32_t major;
  47         uint32_t minor;
  48         pid_t pid;
  49         pid_t ppid;
  50         uid_t uid;
  51         gid_t gid;
  52         uint32_t bits_per_long;
  53         char name[16];
  54 };
  55
  56 /*
  57  * Global applications HT used by the session daemon. This table is indexed by
  58  * PID using the pid_n node and pid value of an ust_app.
  59  */
  60 struct lttng_ht *ust_app_ht;
  61
  62 /*
  63  * Global applications HT used by the session daemon. This table is indexed by
  64  * socket using the sock_n node and sock value of an ust_app.
  65  */
  66 struct lttng_ht *ust_app_ht_by_sock;
  67
  68 /* Stream list containing ust_app_stream. */
  69 struct ust_app_stream_list {
  70         unsigned int count;
  71         struct cds_list_head head;
  72 };
  73
  74 struct ust_app_ctx {
  75         int handle;
  76         struct lttng_ust_context ctx;
  77         struct lttng_ust_object_data *obj;
  78         struct lttng_ht_node_ulong node;
  79 };
  80
  81 struct ust_app_event {
  82         int enabled;
  83         int handle;
  84         struct lttng_ust_object_data *obj;
  85         struct lttng_ust_event attr;
  86         char name[LTTNG_UST_SYM_NAME_LEN];
  87         struct lttng_ht_node_str node;
  88         struct lttng_ust_filter_bytecode *filter;
  89 };
  90
  91 struct ust_app_stream {
  92         int handle;
  93         char pathname[PATH_MAX];
  94         /* Format is %s_%d respectively channel name and CPU number. */
  95         char name[DEFAULT_STREAM_NAME_LEN];
  96         struct lttng_ust_object_data *obj;
  97         /* Using a list of streams to keep order. */
  98         struct cds_list_head list;
  99 };
 100
 101 struct ust_app_channel {
 102         int enabled;
 103         int handle;
 104         char name[LTTNG_UST_SYM_NAME_LEN];
 105         struct lttng_ust_channel_attr attr;
 106         struct lttng_ust_object_data *obj;
 107         struct ust_app_stream_list streams;
 108         struct lttng_ht *ctx;
 109         struct lttng_ht *events;
 110         struct lttng_ht_node_str node;
 111 };
 112
 113 struct ust_app_session {
 114         int enabled;
 115         /* started: has the session been in started state at any time ? */
 116         int started;  /* allows detection of start vs restart. */
 117         int handle;   /* used has unique identifier for app session */
 118         int id;       /* session unique identifier */
 119         struct ltt_ust_metadata *metadata;
 120         struct lttng_ht *channels; /* Registered channels */
 121         struct lttng_ht_node_ulong node;
 122         char path[PATH_MAX];
 123         /* UID/GID of the user owning the session */
 124         uid_t uid;
 125         gid_t gid;
 126         struct cds_list_head teardown_node;
 127 };
 128
 129 /*
 130  * Registered traceable applications. Libust registers to the session daemon
 131  * and a linked list is kept of all running traceable app.
 132  */
 133 struct ust_app {
 134         int sock;
 135         pid_t pid;
 136         pid_t ppid;
 137         uid_t uid;           /* User ID that owns the apps */
 138         gid_t gid;           /* Group ID that owns the apps */
 139         int bits_per_long;
 140         int compatible; /* If the lttng-ust tracer version does not match the
 141                                            supported version of the session daemon, this flag is
 142                                            set to 0 (NOT compatible) else 1. */
 143         struct lttng_ust_tracer_version version;
 144         uint32_t v_major;    /* Verion major number */
 145         uint32_t v_minor;    /* Verion minor number */
 146         char name[17];       /* Process name (short) */
 147         struct lttng_ht *sessions;
 148         struct lttng_ht_node_ulong pid_n;
 149         struct lttng_ht_node_ulong sock_n;
 150         /*
 151          * This is a list of ust app session that, once the app is going into
 152          * teardown mode, in the RCU call, each node in this list is removed and
 153          * deleted.
 154          *
 155          * Element of the list are added when an application unregisters after each
 156          * ht_del of ust_app_session associated to this app. This list is NOT used
 157          * when a session is destroyed.
 158          */
 159         struct cds_list_head teardown_head;
 160 };
 161
 162 #ifdef HAVE_LIBLTTNG_UST_CTL
 163
 164 int ust_app_register(struct ust_register_msg *msg, int sock);
 165 static inline
 166 int ust_app_register_done(int sock)
 167 {
 168         return ustctl_register_done(sock);
 169 }
 170 void ust_app_unregister(int sock);
 171 unsigned long ust_app_list_count(void);
 172 int ust_app_start_trace(struct ltt_ust_session *usess, struct ust_app *app);
 173 int ust_app_stop_trace(struct ltt_ust_session *usess, struct ust_app *app);
 174 int ust_app_start_trace_all(struct ltt_ust_session *usess);
 175 int ust_app_stop_trace_all(struct ltt_ust_session *usess);
 176 int ust_app_destroy_trace_all(struct ltt_ust_session *usess);
 177 int ust_app_list_events(struct lttng_event **events);
 178 int ust_app_list_event_fields(struct lttng_event_field **fields);
 179 int ust_app_create_channel_glb(struct ltt_ust_session *usess,
 180                 struct ltt_ust_channel *uchan);
 181 int ust_app_create_event_glb(struct ltt_ust_session *usess,
 182                 struct ltt_ust_channel *uchan, struct ltt_ust_event *uevent);
 183 int ust_app_disable_event_pid(struct ltt_ust_session *usess,
 184                 struct ltt_ust_channel *uchan, struct ltt_ust_event *uevent,
 185                 pid_t pid);
 186 int ust_app_enable_event_pid(struct ltt_ust_session *usess,
 187                 struct ltt_ust_channel *uchan, struct ltt_ust_event *uevent,
 188                 pid_t pid);
 189 int ust_app_disable_channel_glb(struct ltt_ust_session *usess,
 190                 struct ltt_ust_channel *uchan);
 191 int ust_app_enable_channel_glb(struct ltt_ust_session *usess,
 192                 struct ltt_ust_channel *uchan);
 193 int ust_app_enable_event_glb(struct ltt_ust_session *usess,
 194                 struct ltt_ust_channel *uchan, struct ltt_ust_event *uevent);
 195 int ust_app_disable_all_event_glb(struct ltt_ust_session *usess,
 196                 struct ltt_ust_channel *uchan);
 197 int ust_app_enable_all_event_glb(struct ltt_ust_session *usess,
 198                 struct ltt_ust_channel *uchan);
 199 int ust_app_disable_event_glb(struct ltt_ust_session *usess,
 200                 struct ltt_ust_channel *uchan, struct ltt_ust_event *uevent);
 201 int ust_app_add_ctx_channel_glb(struct ltt_ust_session *usess,
 202                 struct ltt_ust_channel *uchan, struct ltt_ust_context *uctx);
 203 void ust_app_global_update(struct ltt_ust_session *usess, int sock);
 204
 205 void ust_app_clean_list(void);
 206 void ust_app_ht_alloc(void);
 207 struct lttng_ht *ust_app_get_ht(void);
 208 struct ust_app *ust_app_find_by_pid(pid_t pid);
 209 int ust_app_validate_version(int sock);
 210 int ust_app_calibrate_glb(struct lttng_ust_calibrate *calibrate);
 211
 212 #else /* HAVE_LIBLTTNG_UST_CTL */
 213
 214 static inline
 215 int ust_app_destroy_trace_all(struct ltt_ust_session *usess)
 216 {
 217         return 0;
 218 }
 219 static inline
 220 int ust_app_start_trace(struct ltt_ust_session *usess, struct ust_app *app)
 221 {
 222         return 0;
 223 }
 224 static inline
 225 int ust_app_start_trace_all(struct ltt_ust_session *usess)
 226 {
 227         return 0;
 228 }
 229 static inline
 230 int ust_app_stop_trace_all(struct ltt_ust_session *usess)
 231 {
 232         return 0;
 233 }
 234 static inline
 235 int ust_app_list_events(struct lttng_event **events)
 236 {
 237         return -ENOSYS;
 238 }
 239 static inline
 240 int ust_app_list_event_fields(struct lttng_event_field **fields)
 241 {
 242         return -ENOSYS;
 243 }
 244 static inline
 245 int ust_app_register(struct ust_register_msg *msg, int sock)
 246 {
 247         return -ENOSYS;
 248 }
 249 static inline
 250 int ust_app_register_done(int sock)
 251 {
 252         return -ENOSYS;
 253 }
 254 static inline
 255 void ust_app_unregister(int sock)
 256 {
 257 }
 258 static inline
 259 unsigned int ust_app_list_count(void)
 260 {
 261         return 0;
 262 }
 263 static inline
 264 void ust_app_lock_list(void)
 265 {
 266 }
 267 static inline
 268 void ust_app_unlock_list(void)
 269 {
 270 }
 271 static inline
 272 void ust_app_clean_list(void)
 273 {
 274 }
 275 static inline
 276 struct ust_app_list *ust_app_get_list(void)
 277 {
 278         return NULL;
 279 }
 280 static inline
 281 struct ust_app *ust_app_get_by_pid(pid_t pid)
 282 {
 283         return NULL;
 284 }
 285 static inline
 286 struct lttng_ht *ust_app_get_ht(void)
 287 {
 288         return NULL;
 289 }
 290 static inline
 291 void ust_app_ht_alloc(void)
 292 {}
 293 static inline
 294 void ust_app_global_update(struct ltt_ust_session *usess, int sock)
 295 {}
 296 static inline
 297 int ust_app_disable_channel_glb(struct ltt_ust_session *usess,
 298                 struct ltt_ust_channel *uchan)
 299 {
 300         return 0;
 301 }
 302 static inline
 303 int ust_app_enable_channel_glb(struct ltt_ust_session *usess,
 304                 struct ltt_ust_channel *uchan)
 305 {
 306         return 0;
 307 }
 308 static inline
 309 int ust_app_create_channel_glb(struct ltt_ust_session *usess,
 310                 struct ltt_ust_channel *uchan)
 311 {
 312         return 0;
 313 }
 314 static inline
 315 int ust_app_disable_all_event_glb(struct ltt_ust_session *usess,
 316                 struct ltt_ust_channel *uchan)
 317 {
 318         return 0;
 319 }
 320 static inline
 321 int ust_app_enable_all_event_glb(struct ltt_ust_session *usess,
 322                 struct ltt_ust_channel *uchan)
 323 {
 324         return 0;
 325 }
 326 static inline
 327 int ust_app_create_event_glb(struct ltt_ust_session *usess,
 328                 struct ltt_ust_channel *uchan, struct ltt_ust_event *uevent)
 329 {
 330         return 0;
 331 }
 332 static inline
 333 int ust_app_disable_event_glb(struct ltt_ust_session *usess,
 334                 struct ltt_ust_channel *uchan, struct ltt_ust_event *uevent)
 335 {
 336         return 0;
 337 }
 338 static inline
 339 int ust_app_enable_event_glb(struct ltt_ust_session *usess,
 340                 struct ltt_ust_channel *uchan, struct ltt_ust_event *uevent)
 341 {
 342         return 0;
 343 }
 344 static inline
 345 int ust_app_add_ctx_channel_glb(struct ltt_ust_session *usess,
 346                 struct ltt_ust_channel *uchan, struct ltt_ust_context *uctx)
 347 {
 348         return 0;
 349 }
 350 static inline
 351 int ust_app_enable_event_pid(struct ltt_ust_session *usess,
 352                 struct ltt_ust_channel *uchan, struct ltt_ust_event *uevent,
 353                 pid_t pid)
 354 {
 355         return 0;
 356 }
 357 static inline
 358 int ust_app_disable_event_pid(struct ltt_ust_session *usess,
 359                 struct ltt_ust_channel *uchan, struct ltt_ust_event *uevent,
 360                 pid_t pid)
 361 {
 362         return 0;
 363 }
 364 static inline
 365 int ust_app_validate_version(int sock)
 366 {
 367         return 0;
 368 }
 369 static inline
 370 int ust_app_calibrate_glb(struct lttng_ust_calibrate *calibrate)
 371 {
 372         return 0;
 373 }
 374
 375 #endif /* HAVE_LIBLTTNG_UST_CTL */
 376
 377 #endif /* _LTT_UST_APP_H */