Add communication data structure for kconsumerd

[lttng-tools.git] / liblttsessiondcomm / liblttsessiondcomm.h

diff --git a/liblttsessiondcomm/liblttsessiondcomm.h b/liblttsessiondcomm/liblttsessiondcomm.h
index 0e2c4f07f8814b0c290e1366b8861b7a3fd4e71c..e51b813175203516a5f73b309bf7949246279a97 100644 (file)
--- a/liblttsessiondcomm/liblttsessiondcomm.h
+++ b/liblttsessiondcomm/liblttsessiondcomm.h
@@ -1,4 +1,6 @@
-/* Copyright (C) 2011 - David Goulet <david.goulet@polymtl.ca>
+/*
+ * Copyright (C) 2011 - David Goulet <david.goulet@polymtl.ca>
+ *                      Julien Desfossez <julien.desfossez@polymtl.ca>
  *
  * This program is free software; you can redistribute it and/or
  * modify it under the terms of the GNU General Public License
@@ -22,20 +24,22 @@
 #include <limits.h>
 #include <uuid/uuid.h>
 
+#define LTTNG_RUNDIR                                           "/var/run/lttng"
+
 /* Default unix socket path */
-#define DEFAULT_GLOBAL_CLIENT_UNIX_SOCK                "/tmp/client-ltt-sessiond"
-#define DEFAULT_GLOBAL_APPS_UNIX_SOCK          "/tmp/apps-ltt-sessiond"
+#define DEFAULT_GLOBAL_CLIENT_UNIX_SOCK                LTTNG_RUNDIR "/client-ltt-sessiond"
+#define DEFAULT_GLOBAL_APPS_UNIX_SOCK          LTTNG_RUNDIR "/apps-ltt-sessiond"
 #define DEFAULT_HOME_APPS_UNIX_SOCK                    "%s/.apps-ltt-sessiond"
 #define DEFAULT_HOME_CLIENT_UNIX_SOCK          "%s/.client-ltt-sessiond"
 
+/* Kernel consumer path */
+#define KCONSUMERD_PATH                                                LTTNG_RUNDIR "/kconsumerd"
+#define KCONSUMERD_CMD_SOCK_PATH                       KCONSUMERD_PATH "/command"
+#define KCONSUMERD_ERR_SOCK_PATH                       KCONSUMERD_PATH "/error"
+
 /* Queue size of listen(2) */
 #define MAX_LISTEN 10
 
-/* Maximum amount of PID the list_apps command
- * can send back to the lttng client.
- */
-#define MAX_APPS_PID 20
-
 /* Get the error code index from 0 since
  * LTTCOMM_OK start at 1000
  */
@@ -50,6 +54,7 @@ enum lttcomm_command_type {
        LTTNG_GET_SUBBUF_NUM_SIZE,
        LTTNG_LIST_MARKERS,
        LTTNG_LIST_SESSIONS,
+       LTTNG_LIST_TRACES,
        LTTNG_LIST_TRACE_EVENTS,
        LTTNG_SETUP_TRACE,
        LTTNG_SET_SOCK_PATH,
@@ -77,10 +82,32 @@ enum lttcomm_return_code {
        LTTCOMM_CREATE_FAIL,    /* Create trace fail */
        LTTCOMM_SESSION_FAIL,   /* Create session fail */
        LTTCOMM_START_FAIL,             /* Start tracing fail */
+       LTTCOMM_STOP_FAIL,              /* Stop tracing fail */
        LTTCOMM_LIST_FAIL,              /* Listing apps fail */
+       LTTCOMM_NO_APPS,                /* No traceable application */
+       LTTCOMM_NO_SESS,                /* No sessions available */
+       LTTCOMM_NO_TRACE,               /* No trace exist */
+       LTTCOMM_FATAL,                  /* Session daemon had a fatal error */
+       LTTCOMM_NO_TRACEABLE,   /* Error for non traceable app */
+       LTTCOMM_SELECT_SESS,    /* Must select a session */
+       LTTCOMM_EXIST_SESS,             /* Session name already exist */
        LTTCOMM_NR,                             /* Last element */
 };
 
+/* commands for kconsumerd */
+enum lttcomm_consumerd_command {
+       LTTCOMM_ADD_STREAM = 1100,
+       LTTCOMM_UPDATE_STREAM, /* pause, delete, start depending on fd state */
+       LTTCOMM_STOP, /* delete all */
+};
+
+/* state of each fd in consumerd */
+enum lttcomm_kconsumerd_fd_state {
+       ACTIVE_FD,
+       PAUSE_FD,
+       DELETE_FD,
+};
+
 /*
  * Data structure for ltt-session received message
  */
@@ -118,7 +145,11 @@ struct lttcomm_session_msg {
 };
 
 /*
- * Data structure for the lttng client response
+ * Data structure for the lttng client response.
+ *
+ * This data structure is the control struct use in
+ * the header of the transmission. NEVER put variable
+ * size data in here.
  */
 struct lttcomm_lttng_msg {
        enum lttcomm_command_type cmd_type;
@@ -126,19 +157,35 @@ struct lttcomm_lttng_msg {
        uuid_t session_id;
        pid_t pid;
        char trace_name[NAME_MAX];
-       union {
-               /* UST_LIST_APPS */
-               struct {
-                       size_t size;
-                       pid_t pids[MAX_APPS_PID];
-               } list_apps;
-       } u;
+       unsigned int size_payload;
+};
+
+/*
+ * Data structures for the kconsumerd communications
+ *
+ * The header structure is sent to the kconsumerd daemon to inform
+ * how many lttcomm_kconsumerd_msg it is about to receive
+ */
+struct lttcomm_kconsumerd_header {
+       unsigned int payload_size;
+       enum lttcomm_consumerd_command cmd_type;
+       enum lttcomm_return_code ret_code;
+};
+
+/* lttcomm_kconsumerd_msg represents a file descriptor to consume the
+ * data and a path name to write it
+ */
+struct lttcomm_kconsumerd_msg {
+       char path_name[PATH_MAX];
+       int fd;
+       enum lttcomm_kconsumerd_fd_state state;
 };
 
 extern int lttcomm_create_unix_sock(const char *pathname);
 extern int lttcomm_connect_unix_sock(const char *pathname);
 extern int lttcomm_accept_unix_sock(int sock);
 extern int lttcomm_listen_unix_sock(int sock);
+extern int lttcomm_close_unix_sock(int sock);
 extern ssize_t lttcomm_recv_unix_sock(int sock, void *buf, size_t len);
 extern ssize_t lttcomm_send_unix_sock(int sock, void *buf, size_t len);
 extern const char *lttcomm_get_readable_code(enum lttcomm_return_code code);