X-Git-Url: https://git.lttng.org/?p=lttng-tools.git;a=blobdiff_plain;f=src%2Fbin%2Flttng-sessiond%2Fust-registry.h;h=12614c5d531e08979ea7a20b3eae003e6bd19de7;hp=414975cafc4b1f3b209e49ce5900c7373e18f2dd;hb=86eff0042bf0b9e6277b281c4f3a680d997790d2;hpb=e9404c27e7cc9d841785e6c4292c1add19fbc1cc

diff --git a/src/bin/lttng-sessiond/ust-registry.h b/src/bin/lttng-sessiond/ust-registry.h
index 414975caf..12614c5d5 100644
--- a/src/bin/lttng-sessiond/ust-registry.h
+++ b/src/bin/lttng-sessiond/ust-registry.h
@@ -1,18 +1,8 @@
 /*
- * Copyright (C) 2013 - David Goulet <dgoulet@efficios.com>
+ * Copyright (C) 2013 David Goulet <dgoulet@efficios.com>
  *
- * This program is free software; you can redistribute it and/or modify it
- * under the terms of the GNU General Public License, version 2 only, as
- * published by the Free Software Foundation.
+ * SPDX-License-Identifier: GPL-2.0-only
  *
- * This program is distributed in the hope that it will be useful, but WITHOUT
- * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
- * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
- * more details.
- *
- * You should have received a copy of the GNU General Public License along with
- * this program; if not, write to the Free Software Foundation, Inc., 51
- * Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  */
 
 #ifndef LTTNG_UST_REGISTRY_H
@@ -22,9 +12,9 @@
 #include <stdint.h>
 
 #include <common/hashtable/hashtable.h>
-#include <common/compat/uuid.h>
+#include <common/uuid.h>
 
-#include "ust-ctl.h"
+#include "lttng-ust-ctl.h"
 
 #define CTF_SPEC_MAJOR	1
 #define CTF_SPEC_MINOR	8
@@ -48,7 +38,7 @@ struct ust_registry_session {
 	/* Next enumeration ID available. */
 	uint64_t next_enum_id;
 	/* Universal unique identifier used by the tracer. */
-	unsigned char uuid[UUID_LEN];
+	unsigned char uuid[LTTNG_UUID_LEN];
 
 	/* session ABI description */
 
@@ -71,6 +61,32 @@ struct ust_registry_session {
 	/* Current version of the metadata. */
 	uint64_t metadata_version;
 
+	/*
+	 * Those fields are only used when a session is created with
+	 * the --shm-path option. In this case, the metadata is output
+	 * twice: once to the consumer, as ususal, but a second time
+	 * also in the shm path directly. This is done so that a copy
+	 * of the metadata that is as fresh as possible is available
+	 * on the event of a crash.
+	 *
+	 * root_shm_path contains the shm-path provided by the user, along with
+	 * the session's name and timestamp:
+	 *   e.g. /tmp/my_shm/my_session-20180612-135822
+	 *
+	 * shm_path contains the full path of the memory buffers:
+	 *   e.g. /tmp/my_shm/my_session-20180612-135822/ust/uid/1000/64-bit
+	 *
+	 * metadata_path contains the full path to the metadata file that
+	 * is kept for the "crash buffer" extraction:
+	 *  e.g. /tmp/my_shm/my_session-20180612-135822/ust/uid/1000/64-bit/metadata
+	 *
+	 * Note that this is not the trace's final metadata file. It is
+	 * only meant to be used to read the contents of the ring buffers
+	 * in the event of a crash.
+	 *
+	 * metadata_fd is a file descriptor that points to the file at
+	 * 'metadata_path'.
+	 */
 	char root_shm_path[PATH_MAX];
 	char shm_path[PATH_MAX];
 	char metadata_path[PATH_MAX];
@@ -105,6 +121,10 @@ struct ust_registry_session {
 	 */
 	uint32_t major;
 	uint32_t minor;
+
+	/* The id of the parent session */
+	uint64_t tracing_id;
+	uid_t tracing_uid;
 };
 
 struct ust_registry_channel {
@@ -265,7 +285,9 @@ int ust_registry_session_init(struct ust_registry_session **sessionp,
 		const char *root_shm_path,
 		const char *shm_path,
 		uid_t euid,
-		gid_t egid);
+		gid_t egid,
+		uint64_t tracing_id,
+		uid_t tracing_uid);
 void ust_registry_session_destroy(struct ust_registry_session *session);
 
 int ust_registry_create_event(struct ust_registry_session *session,
@@ -325,7 +347,15 @@ int ust_registry_session_init(struct ust_registry_session **sessionp,
 		uint32_t uint32_t_alignment,
 		uint32_t uint64_t_alignment,
 		uint32_t long_alignment,
-		int byte_order)
+		int byte_order,
+		uint32_t major,
+		uint32_t minor,
+		const char *root_shm_path,
+		const char *shm_path,
+		uid_t euid,
+		gid_t egid,
+		uint64_t tracing_id,
+		uid_t tracing_uid)
 {
 	return 0;
 }