fix: relayd: unaligned access in trace_chunk_registry_ht_key_hash

[lttng-tools.git] / include / lttng / endpoint.h

diff --git a/include/lttng/endpoint.h b/include/lttng/endpoint.h
index b93ed697e0616fca971e678e302f46c65863f00e..e27ac3b015b8b039c451dff6411fef20a2829b17 100644 (file)
--- a/include/lttng/endpoint.h
+++ b/include/lttng/endpoint.h
@@ -1,29 +1,46 @@
 /*
- * Copyright (C) 2017 - Jérémie Galarneau <jeremie.galarneau@efficios.com>
+ * Copyright (C) 2017 Jérémie Galarneau <jeremie.galarneau@efficios.com>
  *
- * This library is free software; you can redistribute it and/or modify it
- * under the terms of the GNU Lesser General Public License, version 2.1 only,
- * as published by the Free Software Foundation.
+ * SPDX-License-Identifier: LGPL-2.1-only
  *
- * This library 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 Lesser General Public License
- * for more details.
- *
- * You should have received a copy of the GNU Lesser General Public License
- * along with this library; if not, write to the Free Software Foundation,
- * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  */
 
 #ifndef LTTNG_ENDPOINT_H
 #define LTTNG_ENDPOINT_H
 
+#include <lttng/lttng-export.h>
+
 #ifdef __cplusplus
 extern "C" {
 #endif
 
-/* Default LTTng session daemon endpoint singleton. */
-extern struct lttng_endpoint *lttng_session_daemon_notification_endpoint;
+/*
+ * Default LTTng session daemon notification endpoint singleton.
+ *
+ * For use during the creation of a notification channel. This endpoint
+ * implements the following policy to connect to a session daemon's
+ * notification delivery channel:
+ *   - If the caller is root or part of the tracing group:
+ *     - Attempt to connect to the "root" (global) session daemon,
+ *     - Fallback to the session daemon running as the caller's user.
+ *   - Otherwise (caller is an unpriviliged user):
+ *     - Attempt to connect to the session daemon running as the caller's user.
+ */
+LTTNG_EXPORT extern struct lttng_endpoint *lttng_session_daemon_notification_endpoint;
+
+/*
+ * Default LTTng session daemon command endpoint singleton.
+ *
+ * For use as part of the invocation of a command. This endpoint
+ * implements the following policy to connect to a session daemon's
+ * command channel:
+ *   - If the caller is root or part of the tracing group:
+ *     - Attempt to connect to the "root" (global) session daemon,
+ *     - Fallback to the session daemon running as the caller's user.
+ *   - Otherwise (caller is an unpriviliged user):
+ *     - Attempt to connect to the session daemon running as the caller's user.
+ */
+LTTNG_EXPORT extern struct lttng_endpoint *lttng_session_daemon_command_endpoint;
 
 #ifdef __cplusplus
 }