[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 used as input parameter to the lttng_rotate_schedule API for
 * automatic rotations.
 * This is opaque to the public library.
 */
struct lttng_rotation_schedule_attr {
	/* Session name to rotate. */
	char session_name[LTTNG_NAME_MAX];
	/* > 0 if a timer is set. */
	uint64_t timer_us;
	/* > 0 if the session should rotate when it has written that many bytes. */
	uint64_t size;
} LTTNG_PACKED;

/*
 * 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 lttng_trace_archive_location *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;
	/* Represents values defined in enum lttng_rotation_state. */
	uint8_t location_type;
	union {
		struct {
			char absolute_path[LTTNG_PATH_MAX];
		} LTTNG_PACKED local;
		struct {
			char host[LTTNG_HOST_NAME_MAX];
			/*
			 * Represents values defined in
			 * enum lttng_trace_archive_location_relay_protocol_type.
			 */
			uint8_t protocol;
			struct {
				uint16_t control;
				uint16_t data;
			} LTTNG_PACKED ports;
			char relative_path[LTTNG_PATH_MAX];
		} LTTNG_PACKED relay;
	} location;
} LTTNG_PACKED;

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

/* For the LTTNG_ROTATION_SCHEDULE_GET_TIMER_PERIOD command. */
struct lttng_rotation_schedule_get_timer_period {
	uint64_t rotate_timer;
} LTTNG_PACKED;

/* For the LTTNG_ROTATION_SCHEDULE_GET_SIZE command. */
struct lttng_rotation_schedule_get_size {
	uint64_t rotate_size;
} 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
259c2674 JD	41	/*
	42	* Object used as input parameter to the lttng_rotate_schedule API for
	43	* automatic rotations.
	44	* This is opaque to the public library.
	45	*/
	46	struct lttng_rotation_schedule_attr {
	47	/* Session name to rotate. */
	48	char session_name[LTTNG_NAME_MAX];
	49	/* > 0 if a timer is set. */
	50	uint64_t timer_us;
90936dcf JD	51	/* > 0 if the session should rotate when it has written that many bytes. */
90936dcf JD	52	uint64_t size;
259c2674 JD	53	} LTTNG_PACKED;
259c2674 JD	54
d68c9a04 JD	55	/*
	56	* Object returned by the rotate session API.
	57	* This is opaque to the public library.
	58	*/
	59	struct lttng_rotation_handle {
	60	char session_name[LTTNG_NAME_MAX];
	61	/*
	62	* ID of the rotate command.
	63	* This matches the session->rotate_count, so the handle is valid until
	64	* the next rotate command. After that, the rotation_get_state command
	65	* returns the "expired" state.
	66	*/
	67	uint64_t rotation_id;
	68	/*
	69	* Where the rotated (readable) trace has been stored when the
	70	* rotation is completed.
	71	*/
dd73d57b	72	struct lttng_trace_archive_location *archive_location;
d68c9a04 JD	73	};
d68c9a04 JD	74
5c408ad8 JD	75	/*
5c408ad8 JD	76	* Internal objects between lttng-ctl and the session daemon, the values
d68c9a04	77	* are then copied to the user's lttng_rotation_handle object.
5c408ad8	78	*/
d68c9a04	79
5c408ad8 JD	80	/* For the LTTNG_ROTATE_SESSION command. */
5c408ad8 JD	81	struct lttng_rotate_session_return {
d68c9a04 JD	82	uint64_t rotation_id;
	83	} LTTNG_PACKED;
	84
	85	/* For the LTTNG_ROTATION_GET_INFO command. */
	86	struct lttng_rotation_get_info_return {
	87	/* Represents values defined in enum lttng_rotation_state. */
5c408ad8	88	int32_t status;
dd73d57b JG	89	/* Represents values defined in enum lttng_rotation_state. */
	90	uint8_t location_type;
	91	union {
	92	struct {
	93	char absolute_path[LTTNG_PATH_MAX];
	94	} LTTNG_PACKED local;
	95	struct {
	96	char host[LTTNG_HOST_NAME_MAX];
	97	/*
	98	* Represents values defined in
	99	* enum lttng_trace_archive_location_relay_protocol_type.
	100	*/
	101	uint8_t protocol;
	102	struct {
	103	uint16_t control;
	104	uint16_t data;
	105	} LTTNG_PACKED ports;
	106	char relative_path[LTTNG_PATH_MAX];
	107	} LTTNG_PACKED relay;
	108	} location;
d68c9a04 JD	109	} LTTNG_PACKED;
	110
	111	/* For the LTTNG_SESSION_GET_CURRENT_OUTPUT command. */
	112	struct lttng_session_get_current_output_return {
	113	char path[LTTNG_PATH_MAX];
5c408ad8 JD	114	} LTTNG_PACKED;
5c408ad8 JD	115
329f3443 JD	116	/* For the LTTNG_ROTATION_SCHEDULE_GET_TIMER_PERIOD command. */
	117	struct lttng_rotation_schedule_get_timer_period {
	118	uint64_t rotate_timer;
	119	} LTTNG_PACKED;
	120
	121	/* For the LTTNG_ROTATION_SCHEDULE_GET_SIZE command. */
	122	struct lttng_rotation_schedule_get_size {
	123	uint64_t rotate_size;
	124	} LTTNG_PACKED;
	125
5c408ad8	126	#endif /* LTTNG_ROTATE_INTERNAL_ABI_H */