[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 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;
};

struct lttng_rotation_schedule {
	enum lttng_rotation_schedule_type type;
};

struct lttng_rotation_schedule_size_threshold {
	struct lttng_rotation_schedule parent;
	struct {
		bool set;
		uint64_t bytes;
	} size;
};

struct lttng_rotation_schedule_periodic {
	struct lttng_rotation_schedule parent;
	struct {
		bool set;
		uint64_t us;
	} period;
};

struct lttng_rotation_schedules {
	/*
	 * Only one rotation schedule per type is supported for now.
	 * Schedules are owned by this object.
	 */
	unsigned int count;
	struct lttng_rotation_schedule *schedules[2];
};

/*
 * 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. */
	int8_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.
			 */
			int8_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_SESSION_LIST_SCHEDULES command. */
struct lttng_session_list_schedules_return {
	struct {
		uint8_t set;
		uint64_t value;
	} periodic;
	struct {
		uint8_t set;
		uint64_t value;
	} 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 returned by the rotate session API.
	31	* This is opaque to the public library.
	32	*/
	33	struct lttng_rotation_handle {
	34	char session_name[LTTNG_NAME_MAX];
	35	/*
	36	* ID of the rotate command.
	37	* This matches the session->rotate_count, so the handle is valid until
	38	* the next rotate command. After that, the rotation_get_state command
	39	* returns the "expired" state.
	40	*/
	41	uint64_t rotation_id;
	42	/*
	43	* Where the rotated (readable) trace has been stored when the
	44	* rotation is completed.
	45	*/
dd73d57b	46	struct lttng_trace_archive_location *archive_location;
d68c9a04 JD	47	};
d68c9a04 JD	48
66ea93b1 JG	49	struct lttng_rotation_schedule {
	50	enum lttng_rotation_schedule_type type;
	51	};
	52
	53	struct lttng_rotation_schedule_size_threshold {
	54	struct lttng_rotation_schedule parent;
	55	struct {
	56	bool set;
	57	uint64_t bytes;
	58	} size;
	59	};
	60
	61	struct lttng_rotation_schedule_periodic {
	62	struct lttng_rotation_schedule parent;
	63	struct {
	64	bool set;
	65	uint64_t us;
	66	} period;
	67	};
	68
	69	struct lttng_rotation_schedules {
	70	/*
	71	* Only one rotation schedule per type is supported for now.
	72	* Schedules are owned by this object.
	73	*/
	74	unsigned int count;
	75	struct lttng_rotation_schedule *schedules[2];
	76	};
	77
5c408ad8 JD	78	/*
5c408ad8 JD	79	* Internal objects between lttng-ctl and the session daemon, the values
d68c9a04	80	* are then copied to the user's lttng_rotation_handle object.
5c408ad8	81	*/
d68c9a04	82
5c408ad8 JD	83	/* For the LTTNG_ROTATE_SESSION command. */
5c408ad8 JD	84	struct lttng_rotate_session_return {
d68c9a04 JD	85	uint64_t rotation_id;
	86	} LTTNG_PACKED;
	87
	88	/* For the LTTNG_ROTATION_GET_INFO command. */
	89	struct lttng_rotation_get_info_return {
	90	/* Represents values defined in enum lttng_rotation_state. */
5c408ad8	91	int32_t status;
dd73d57b	92	/* Represents values defined in enum lttng_rotation_state. */
05f8afa9	93	int8_t location_type;
dd73d57b JG	94	union {
	95	struct {
	96	char absolute_path[LTTNG_PATH_MAX];
	97	} LTTNG_PACKED local;
	98	struct {
	99	char host[LTTNG_HOST_NAME_MAX];
	100	/*
	101	* Represents values defined in
	102	* enum lttng_trace_archive_location_relay_protocol_type.
	103	*/
05f8afa9	104	int8_t protocol;
dd73d57b JG	105	struct {
	106	uint16_t control;
	107	uint16_t data;
	108	} LTTNG_PACKED ports;
	109	char relative_path[LTTNG_PATH_MAX];
	110	} LTTNG_PACKED relay;
	111	} location;
d68c9a04 JD	112	} LTTNG_PACKED;
	113
	114	/* For the LTTNG_SESSION_GET_CURRENT_OUTPUT command. */
	115	struct lttng_session_get_current_output_return {
	116	char path[LTTNG_PATH_MAX];
5c408ad8 JD	117	} LTTNG_PACKED;
5c408ad8 JD	118
66ea93b1 JG	119	/* For the LTTNG_SESSION_LIST_SCHEDULES command. */
	120	struct lttng_session_list_schedules_return {
	121	struct {
	122	uint8_t set;
	123	uint64_t value;
	124	} periodic;
	125	struct {
	126	uint8_t set;
	127	uint64_t value;
	128	} size;
329f3443 JD	129	} LTTNG_PACKED;
329f3443 JD	130
5c408ad8	131	#endif /* LTTNG_ROTATE_INTERNAL_ABI_H */