Update comments regarding the power of 2 constraint on sub-buffer sizes
[lttng-tools.git] / src / bin / lttng-sessiond / snapshot.h
CommitLineData
6dc3064a
DG
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
30struct consumer_output;
31
32struct snapshot_output {
33 uint32_t id;
34 uint64_t max_size;
1bfe7328
DG
35 /* Number of snapshot taken with that output. */
36 uint64_t nb_snapshot;
6dc3064a
DG
37 char name[NAME_MAX];
38 struct consumer_output *consumer;
39 int kernel_sockets_copied;
40 int ust_sockets_copied;
10a50311
JD
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];
6dc3064a
DG
47
48 /* Indexed by ID. */
49 struct lttng_ht_node_ulong node;
50};
51
52struct snapshot {
53 unsigned long next_output_id;
54 size_t nb_output;
1bfe7328
DG
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;
6dc3064a
DG
60 struct lttng_ht *output_ht;
61};
62
63/* Snapshot object. */
64struct snapshot *snapshot_alloc(void);
65void snapshot_destroy(struct snapshot *obj);
66int snapshot_init(struct snapshot *obj);
67void snapshot_delete_output(struct snapshot *snapshot,
68 struct snapshot_output *output);
69void snapshot_add_output(struct snapshot *snapshot,
70 struct snapshot_output *output);
71
72/* Snapshot output object. */
73struct snapshot_output *snapshot_output_alloc(void);
74void snapshot_output_destroy(struct snapshot_output *obj);
75int 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);
27babd3a
DG
79int 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);
6dc3064a
DG
83struct snapshot_output *snapshot_find_output_by_id(uint32_t id,
84 struct snapshot *snapshot);
eb240553
DG
85struct snapshot_output *snapshot_find_output_by_name(const char *name,
86 struct snapshot *snapshot);
6dc3064a
DG
87
88#endif /* SNAPSHOT_H */
This page took 0.032594 seconds and 4 git commands to generate.