[lttng-tools.git] / src / bin / lttng-sessiond / snapshot.h

/*
 * Copyright (C) 2013 - David Goulet <dgoulet@efficios.com>
 *
 * This program is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License, version 2 only, as
 * published by the Free Software Foundation.
 *
 * This program 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 General Public License for
 * more details.
 *
 * You should have received a copy of the GNU General Public License along with
 * this program; if not, write to the Free Software Foundation, Inc., 51
 * Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 */

#ifndef SNAPSHOT_H
#define SNAPSHOT_H

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

#include <common/common.h>
#include <common/hashtable/hashtable.h>
#include <common/uri.h>

#include "consumer.h"

struct consumer_output;

struct snapshot_output {
	uint32_t id;
	uint64_t max_size;
	/* Number of snapshot taken with that output. */
	uint64_t nb_snapshot;
	char name[NAME_MAX];
	struct consumer_output *consumer;
	int kernel_sockets_copied;
	int ust_sockets_copied;
	/*
	 * Contains the string with "<date>-<time>" for when the snapshot command
	 * is triggered. This is to make sure every streams will use the same time
	 * for the directory output.
	 */
	char datetime[16];

	/* Indexed by ID. */
	struct lttng_ht_node_ulong node;
};

struct snapshot {
	unsigned long next_output_id;
	size_t nb_output;
	/*
	 * Number of snapshot taken for that object. This value is used with a
	 * temporary output of a snapshot record.
	 */
	uint64_t nb_snapshot;
	struct lttng_ht *output_ht;
};

/* Snapshot object. */
struct snapshot *snapshot_alloc(void);
void snapshot_destroy(struct snapshot *obj);
int snapshot_init(struct snapshot *obj);
void snapshot_delete_output(struct snapshot *snapshot,
		struct snapshot_output *output);
void snapshot_add_output(struct snapshot *snapshot,
		struct snapshot_output *output);

/* Snapshot output object. */
struct snapshot_output *snapshot_output_alloc(void);
void snapshot_output_destroy(struct snapshot_output *obj);
int snapshot_output_init(uint64_t max_size, const char *name,
		const char *ctrl_url, const char *data_url,
		struct consumer_output *consumer, struct snapshot_output *output,
		struct snapshot *snapshot);
int snapshot_output_init_with_uri(uint64_t max_size, const char *name,
		struct lttng_uri *uris, size_t nb_uri,
		struct consumer_output *consumer, struct snapshot_output *output,
		struct snapshot *snapshot);
struct snapshot_output *snapshot_find_output_by_id(uint32_t id,
		struct snapshot *snapshot);
struct snapshot_output *snapshot_find_output_by_name(const char *name,
		struct snapshot *snapshot);

#endif /* SNAPSHOT_H */
Commit	Line	Data
	1	/*
	2	* Copyright (C) 2013 - David Goulet <dgoulet@efficios.com>
	3	*
	4	* This program is free software; you can redistribute it and/or modify it
	5	* under the terms of the GNU General Public License, version 2 only, as
	6	* published by the Free Software Foundation.
	7	*
	8	* This program 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 General Public License for
	11	* more details.
	12	*
	13	* You should have received a copy of the GNU General Public License along with
	14	* this program; if not, write to the Free Software Foundation, Inc., 51
	15	* Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
	16	*/
	17
	18	#ifndef SNAPSHOT_H
	19	#define SNAPSHOT_H
	20
	21	#include <limits.h>
	22	#include <stdint.h>
	23
	24	#include <common/common.h>
	25	#include <common/hashtable/hashtable.h>
	26	#include <common/uri.h>
	27
	28	#include "consumer.h"
	29
	30	struct consumer_output;
	31
	32	struct snapshot_output {
	33	uint32_t id;
	34	uint64_t max_size;
	35	/* Number of snapshot taken with that output. */
	36	uint64_t nb_snapshot;
	37	char name[NAME_MAX];
	38	struct consumer_output *consumer;
	39	int kernel_sockets_copied;
	40	int ust_sockets_copied;
	41	/*
	42	* Contains the string with "<date>-<time>" for when the snapshot command
	43	* is triggered. This is to make sure every streams will use the same time
	44	* for the directory output.
	45	*/
	46	char datetime[16];
	47
	48	/* Indexed by ID. */
	49	struct lttng_ht_node_ulong node;
	50	};
	51
	52	struct snapshot {
	53	unsigned long next_output_id;
	54	size_t nb_output;
	55	/*
	56	* Number of snapshot taken for that object. This value is used with a
	57	* temporary output of a snapshot record.
	58	*/
	59	uint64_t nb_snapshot;
	60	struct lttng_ht *output_ht;
	61	};
	62
	63	/* Snapshot object. */
	64	struct snapshot *snapshot_alloc(void);
	65	void snapshot_destroy(struct snapshot *obj);
	66	int snapshot_init(struct snapshot *obj);
	67	void snapshot_delete_output(struct snapshot *snapshot,
	68	struct snapshot_output *output);
	69	void snapshot_add_output(struct snapshot *snapshot,
	70	struct snapshot_output *output);
	71
	72	/* Snapshot output object. */
	73	struct snapshot_output *snapshot_output_alloc(void);
	74	void snapshot_output_destroy(struct snapshot_output *obj);
	75	int snapshot_output_init(uint64_t max_size, const char *name,
	76	const char ctrl_url, const char data_url,
	77	struct consumer_output consumer, struct snapshot_output output,
	78	struct snapshot *snapshot);
	79	int snapshot_output_init_with_uri(uint64_t max_size, const char *name,
	80	struct lttng_uri *uris, size_t nb_uri,
	81	struct consumer_output consumer, struct snapshot_output output,
	82	struct snapshot *snapshot);
	83	struct snapshot_output *snapshot_find_output_by_id(uint32_t id,
	84	struct snapshot *snapshot);
	85	struct snapshot_output snapshot_find_output_by_name(const char name,
	86	struct snapshot *snapshot);
	87
	88	#endif /* SNAPSHOT_H */