src/bin/lttng-sessiond/lttng-sessiond.h

   1 /*
   2  * Copyright (C) 2011 - David Goulet <david.goulet@polymtl.ca>
   3  * Copyright (C) 2013 - Raphaël Beamonte <raphael.beamonte@gmail.com>
   4  *
   5  * This program is free software; you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License, version 2 only,
   7  * as published by the Free Software Foundation.
   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 along
  15  * with this program; if not, write to the Free Software Foundation, Inc.,
  16  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  17  */
  18
  19 #ifndef _LTT_SESSIOND_H
  20 #define _LTT_SESSIOND_H
  21
  22 #include <urcu.h>
  23 #include <urcu/wfcqueue.h>
  24
  25 #include <common/sessiond-comm/sessiond-comm.h>
  26 #include <common/compat/poll.h>
  27 #include <common/compat/socket.h>
  28
  29 #include "session.h"
  30 #include "ust-app.h"
  31 #include "notification-thread.h"
  32 #include "sessiond-config.h"
  33
  34 extern const char default_home_dir[],
  35         default_tracing_group[],
  36         default_ust_sock_dir[],
  37         default_global_apps_pipe[];
  38
  39 /* Set in main.c at boot time of the daemon */
  40 extern int kernel_tracer_fd;
  41
  42 /* Notification thread handle. */
  43 extern struct notification_thread_handle *notification_thread_handle;
  44
  45 /*
  46  * This contains extra data needed for processing a command received by the
  47  * session daemon from the lttng client.
  48  */
  49 struct command_ctx {
  50         int ust_sock;
  51         unsigned int lttng_msg_size;
  52         struct ltt_session *session;
  53         struct lttcomm_lttng_msg *llm;
  54         struct lttcomm_session_msg *lsm;
  55         lttng_sock_cred creds;
  56 };
  57
  58 struct ust_command {
  59         int sock;
  60         struct ust_register_msg reg_msg;
  61         struct cds_wfcq_node node;
  62 };
  63
  64 /*
  65  * Queue used to enqueue UST registration request (ust_command) and synchronized
  66  * by a futex with a scheme N wakers / 1 waiters. See futex.c/.h
  67  */
  68 struct ust_cmd_queue {
  69         int32_t futex;
  70         struct cds_wfcq_head head;
  71         struct cds_wfcq_tail tail;
  72 };
  73
  74 /*
  75  * This is the wait queue containing wait nodes during the application
  76  * registration process.
  77  */
  78 struct ust_reg_wait_queue {
  79         unsigned long count;
  80         struct cds_list_head head;
  81 };
  82
  83 /*
  84  * Use by the dispatch registration to queue UST command socket to wait for the
  85  * notify socket.
  86  */
  87 struct ust_reg_wait_node {
  88         struct ust_app *app;
  89         struct cds_list_head head;
  90 };
  91
  92 /*
  93  * This pipe is used to inform the thread managing application notify
  94  * communication that a command is queued and ready to be processed.
  95  */
  96 extern int apps_cmd_notify_pipe[2];
  97
  98 /*
  99  * Used to notify that a hash table needs to be destroyed by dedicated
 100  * thread. Required by design because we don't want to move destroy
 101  * paths outside of large RCU read-side lock paths, and destroy cannot
 102  * be called by call_rcu thread, because it may hang (waiting for
 103  * call_rcu completion).
 104  */
 105 extern int ht_cleanup_pipe[2];
 106
 107 extern int kernel_poll_pipe[2];
 108
 109 /*
 110  * Populated when the daemon starts with the current page size of the system.
 111  * Set in main() with the current page size.
 112  */
 113 extern long page_size;
 114
 115 /* Application health monitoring */
 116 extern struct health_app *health_sessiond;
 117
 118 extern struct sessiond_config config;
 119
 120 extern int lttng_sessiond_ready;
 121
 122 extern int ust_consumerd64_fd, ust_consumerd32_fd;
 123
 124 /* Parent PID for --sig-parent option */
 125 extern pid_t ppid;
 126 /* Internal parent PID use with daemonize. */
 127 extern pid_t child_ppid;
 128
 129 int sessiond_init_thread_quit_pipe(void);
 130 int sessiond_check_thread_quit_pipe(int fd, uint32_t events);
 131 int sessiond_wait_for_quit_pipe(unsigned int timeout_us);
 132 int sessiond_notify_quit_pipe(void);
 133 void sessiond_close_quit_pipe(void);
 134
 135 int sessiond_set_thread_pollset(struct lttng_poll_event *events, size_t size);
 136 void sessiond_notify_ready(void);
 137 void sessiond_signal_parents(void);
 138
 139 void sessiond_set_client_thread_state(bool running);
 140 void sessiond_wait_client_thread_stopped(void);
 141
 142 #endif /* _LTT_SESSIOND_H */