[lttng-tools.git] / include / lttng / rotate-internal.h

/*
 * Copyright (C) 2017 - Julien Desfossez <jdesfossez@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.
 *
 * 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_ROTATE_INTERNAL_ABI_H
#define LTTNG_ROTATE_INTERNAL_ABI_H

#include <limits.h>
#include <stdint.h>
#include <stdbool.h>

#include <lttng/constant.h>
#include <lttng/rotation.h>
#include <common/macros.h>

/*
 * Object used as input parameter to the rotate session API for immediate
 * rotations.
 * This is opaque to the public library.
 */
struct lttng_rotation_immediate_attr {
	/* Session name to rotate. */
	char session_name[LTTNG_NAME_MAX];
	/* For the rotate pending request. */
	uint64_t rotate_id;
};

/*
 * Object returned by the rotate session API.
 * This is opaque to the public library.
 */
struct lttng_rotation_handle {
	char session_name[LTTNG_NAME_MAX];
	/*
	 * ID of the rotate command.
	 * This matches the session->rotate_count, so the handle is valid until
	 * the next rotate command. After that, the rotation_get_state command
	 * returns the "expired" state.
	 */
	uint64_t rotation_id;
	/*
	 * Where the rotated (readable) trace has been stored when the
	 * rotation is completed.
	 */
	struct {
		bool is_set;
		char path[LTTNG_PATH_MAX];
	} archive_location;
};

/*
 * Internal objects between lttng-ctl and the session daemon, the values
 * are then copied to the user's lttng_rotation_handle object.
 */

/* For the LTTNG_ROTATE_SESSION command. */
struct lttng_rotate_session_return {
	uint64_t rotation_id;
} LTTNG_PACKED;

/* For the LTTNG_ROTATION_GET_INFO command. */
struct lttng_rotation_get_info_return {
	/* Represents values defined in enum lttng_rotation_state. */
	int32_t status;
	char path[LTTNG_PATH_MAX];
} LTTNG_PACKED;

/* For the LTTNG_SESSION_GET_CURRENT_OUTPUT command. */
struct lttng_session_get_current_output_return {
	char path[LTTNG_PATH_MAX];
} LTTNG_PACKED;

#endif /* LTTNG_ROTATE_INTERNAL_ABI_H */
Commit	Line	Data
5c408ad8 JD	1	/*
	2	* Copyright (C) 2017 - Julien Desfossez <jdesfossez@efficios.com>
	3	*
	4	* This library is free software; you can redistribute it and/or modify it
	5	* under the terms of the GNU Lesser General Public License, version 2.1 only,
	6	* as published by the Free Software Foundation.
	7	*
	8	* This library is distributed in the hope that it will be useful, but WITHOUT
	9	* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
	10	* FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License
	11	* for more details.
	12	*
	13	* You should have received a copy of the GNU Lesser General Public License
	14	* along with this library; if not, write to the Free Software Foundation,
	15	* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
	16	*/
	17
	18	#ifndef LTTNG_ROTATE_INTERNAL_ABI_H
	19	#define LTTNG_ROTATE_INTERNAL_ABI_H
	20
	21	#include <limits.h>
	22	#include <stdint.h>
d68c9a04	23	#include <stdbool.h>
5c408ad8 JD	24
	25	#include <lttng/constant.h>
	26	#include <lttng/rotation.h>
	27	#include <common/macros.h>
	28
d68c9a04 JD	29	/*
	30	* Object used as input parameter to the rotate session API for immediate
	31	* rotations.
	32	* This is opaque to the public library.
	33	*/
	34	struct lttng_rotation_immediate_attr {
	35	/* Session name to rotate. */
	36	char session_name[LTTNG_NAME_MAX];
	37	/* For the rotate pending request. */
	38	uint64_t rotate_id;
	39	};
	40
	41	/*
	42	* Object returned by the rotate session API.
	43	* This is opaque to the public library.
	44	*/
	45	struct lttng_rotation_handle {
	46	char session_name[LTTNG_NAME_MAX];
	47	/*
	48	* ID of the rotate command.
	49	* This matches the session->rotate_count, so the handle is valid until
	50	* the next rotate command. After that, the rotation_get_state command
	51	* returns the "expired" state.
	52	*/
	53	uint64_t rotation_id;
	54	/*
	55	* Where the rotated (readable) trace has been stored when the
	56	* rotation is completed.
	57	*/
	58	struct {
	59	bool is_set;
	60	char path[LTTNG_PATH_MAX];
	61	} archive_location;
	62	};
	63
5c408ad8 JD	64	/*
5c408ad8 JD	65	* Internal objects between lttng-ctl and the session daemon, the values
d68c9a04	66	* are then copied to the user's lttng_rotation_handle object.
5c408ad8	67	*/
d68c9a04	68
5c408ad8 JD	69	/* For the LTTNG_ROTATE_SESSION command. */
5c408ad8 JD	70	struct lttng_rotate_session_return {
d68c9a04 JD	71	uint64_t rotation_id;
	72	} LTTNG_PACKED;
	73
	74	/* For the LTTNG_ROTATION_GET_INFO command. */
	75	struct lttng_rotation_get_info_return {
	76	/* Represents values defined in enum lttng_rotation_state. */
5c408ad8	77	int32_t status;
d68c9a04 JD	78	char path[LTTNG_PATH_MAX];
	79	} LTTNG_PACKED;
	80
	81	/* For the LTTNG_SESSION_GET_CURRENT_OUTPUT command. */
	82	struct lttng_session_get_current_output_return {
	83	char path[LTTNG_PATH_MAX];
5c408ad8 JD	84	} LTTNG_PACKED;
	85
	86	#endif /* LTTNG_ROTATE_INTERNAL_ABI_H */