X-Git-Url: https://git.lttng.org/?a=blobdiff_plain;f=include%2Flttng%2Fsession.h;h=9be506fc196bbda6e956134733739faac734a2ce;hb=c91ccadee5bfbc94a95540e17c879ce976caf6a2;hp=395df32450889d806aa0efd805a7a2cd67f4c219;hpb=780d4bb8ec9b4fa0ffd6d1ba2a2aa5d2f812611f;p=lttng-tools.git diff --git a/include/lttng/session.h b/include/lttng/session.h index 395df3245..9be506fc1 100644 --- a/include/lttng/session.h +++ b/include/lttng/session.h @@ -1,19 +1,9 @@ /* - * Copyright (C) 2014 - David Goulet - * Copyright (C) 2019 - Jérémie Galarneau + * Copyright (C) 2014 David Goulet + * Copyright (C) 2019 Jérémie Galarneau * - * 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_SESSION_H @@ -23,6 +13,10 @@ extern "C" { #endif +#include +#include + +struct lttng_handle; struct lttng_session_descriptor; struct lttng_destruction_handle; @@ -34,7 +28,7 @@ struct lttng_destruction_handle; * * The structures should be initialized to zero before use. */ -#define LTTNG_SESSION_PADDING1 12 +#define LTTNG_SESSION_PADDING1 8 struct lttng_session { char name[LTTNG_NAME_MAX]; /* @@ -47,11 +41,33 @@ struct lttng_session { * net://hostname/path:ctrl_port [data: data_port] */ char path[PATH_MAX]; - uint32_t enabled; /* enabled/started: 1, disabled/stopped: 0 */ + uint32_t enabled; /* enabled/started: 1, disabled/stopped: 0 */ uint32_t snapshot_mode; - unsigned int live_timer_interval; /* usec */ + unsigned int live_timer_interval; /* usec */ + /* + * End of public attributes. + * The remaining fields are used to deal with ABI management concerns. + */ + + /* + * 32-bit architectures are already naturally aligned on 4 bytes after + * 'live_timer_interval'. However, the offset does not result in a + * natural alignment on 64-bit architectures. Adding 4 bytes of + * padding here results in an aligned offset after 'alignement_padding' + * for both bitnesses. + * + * This was added since not all compilers appear to align unions in the + * same way. Some (e.g. MSVC) do not seem to impose an alignement + * constraint while others (e.g. gcc, clang, icc) seem to align it to + * ensure 'ptr' is naturally aligned. + */ + char alignment_padding[4]; union { + /* + * Ensure the 'extended' union has the same size for both + * 32-bit and 64-bit builds. + */ char padding[LTTNG_SESSION_PADDING1]; void *ptr; } extended; @@ -71,8 +87,8 @@ struct lttng_session { * Returns LTTNG_OK on success. See lttng-error.h for the meaning of the other * return codes. */ -extern enum lttng_error_code lttng_create_session_ext( - struct lttng_session_descriptor *session_descriptor); +LTTNG_EXPORT extern enum lttng_error_code +lttng_create_session_ext(struct lttng_session_descriptor *session_descriptor); /* * Create a tracing session using a name and an optional URL. @@ -82,7 +98,7 @@ extern enum lttng_error_code lttng_create_session_ext( * * Return 0 on success else a negative LTTng error code. */ -extern int lttng_create_session(const char *name, const char *url); +LTTNG_EXPORT extern int lttng_create_session(const char *name, const char *url); /* * Create a tracing session that will exclusively be used for snapshot meaning @@ -96,8 +112,7 @@ extern int lttng_create_session(const char *name, const char *url); * * Return 0 on success else a negative LTTng error code. */ -extern int lttng_create_session_snapshot(const char *name, - const char *snapshot_url); +LTTNG_EXPORT extern int lttng_create_session_snapshot(const char *name, const char *snapshot_url); /* * Create a session exclusively used for live reading. @@ -112,8 +127,8 @@ extern int lttng_create_session_snapshot(const char *name, * * Return 0 on success else a negative LTTng error code. */ -extern int lttng_create_session_live(const char *name, const char *url, - unsigned int timer_interval); +LTTNG_EXPORT extern int +lttng_create_session_live(const char *name, const char *url, unsigned int timer_interval); /* * Destroy a tracing session. @@ -132,7 +147,7 @@ extern int lttng_create_session_live(const char *name, const char *url, * * Return 0 on success else a negative LTTng error code. */ -extern int lttng_destroy_session(const char *name); +LTTNG_EXPORT extern int lttng_destroy_session(const char *name); /* * Destroy a tracing session. @@ -141,19 +156,19 @@ extern int lttng_destroy_session(const char *name); * an lttng_destruction_handle which can be used to wait for the completion * of the session's destruction. The lttng_destroy_handle can also be used * obtain the status and archive location of any implicit session - * rotation that may have occured during the session's destruction. + * rotation that may have occurred during the session's destruction. * * Returns LTTNG_OK on success. The returned handle is owned by the caller * and must be free'd using lttng_destruction_handle_destroy(). */ -extern enum lttng_error_code lttng_destroy_session_ext(const char *session_name, - struct lttng_destruction_handle **handle); +LTTNG_EXPORT extern enum lttng_error_code +lttng_destroy_session_ext(const char *session_name, struct lttng_destruction_handle **handle); /* * Behaves exactly like lttng_destroy_session but does not wait for data * availability. */ -extern int lttng_destroy_session_no_wait(const char *name); +LTTNG_EXPORT extern int lttng_destroy_session_no_wait(const char *name); /* * List all the tracing sessions. @@ -163,7 +178,7 @@ extern int lttng_destroy_session_no_wait(const char *name); * * On error, a negative LTTng error code is returned. */ -extern int lttng_list_sessions(struct lttng_session **sessions); +LTTNG_EXPORT extern int lttng_list_sessions(struct lttng_session **sessions); /* * Get the creation time of an lttng_session object on the session daemon. @@ -177,8 +192,8 @@ extern int lttng_list_sessions(struct lttng_session **sessions); * Returns LTTNG_OK on success. See lttng-error.h for the meaning of the other * return codes. */ -extern enum lttng_error_code lttng_session_get_creation_time( - const struct lttng_session *session, uint64_t *creation_time); +LTTNG_EXPORT extern enum lttng_error_code +lttng_session_get_creation_time(const struct lttng_session *session, uint64_t *creation_time); /* * Set the shared memory path for a session. @@ -189,41 +204,7 @@ extern enum lttng_error_code lttng_session_get_creation_time( * * Return 0 on success else a negative LTTng error code. */ -extern int lttng_set_session_shm_path(const char *session_name, - const char *shm_path); - -/* - * Add PID to session tracker. - * - * A pid argument >= 0 adds the PID to the session tracker. - * A pid argument of -1 means "track all PIDs". - * - * Return 0 on success else a negative LTTng error code. - */ -extern int lttng_track_pid(struct lttng_handle *handle, int pid); - -/* - * Remove PID from session tracker. - * - * A pid argument >= 0 removes the PID from the session tracker. - * A pid argument of -1 means "untrack all PIDs". - * - * Return 0 on success else a negative LTTng error code. - */ -extern int lttng_untrack_pid(struct lttng_handle *handle, int pid); - -/* - * List PIDs in the tracker. - * - * enabled is set to whether the PID tracker is enabled. - * pids is set to an allocated array of PIDs currently tracked. On - * success, pids must be freed by the caller. - * nr_pids is set to the number of entries contained by the pids array. - * - * Returns 0 on success, else a negative LTTng error code. - */ -extern int lttng_list_tracker_pids(struct lttng_handle *handle, - int *enabled, int32_t **pids, size_t *nr_pids); +LTTNG_EXPORT extern int lttng_set_session_shm_path(const char *session_name, const char *shm_path); #ifdef __cplusplus }