c2fcd17e96059dc4ba584d3baa39ce23ae5e735f
[lttng-tools.git] / src / common / trace-chunk.h
1 /*
2 * Copyright (C) 2019 - Jérémie Galarneau <jeremie.galarneau@efficios.com>
3 *
4 * This program 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 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 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 program; 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_TRACE_CHUNK_H
19 #define LTTNG_TRACE_CHUNK_H
20
21 #include <common/macros.h>
22 #include <common/credentials.h>
23 #include <common/compat/directory-handle.h>
24 #include <stddef.h>
25 #include <stdint.h>
26 #include <stdbool.h>
27
28 /*
29 * A trace chunk is a group of directories and files forming a (or a set of)
30 * complete and independant trace(s). For instance, a trace archive chunk,
31 * a snapshot, or a regular LTTng trace are all instances of a trace archive.
32 *
33 * A trace chunk is always contained within a session output directory.
34 *
35 * This facility is used by the session daemon, consumer daemon(s), and relay
36 * daemon to:
37 * - Control file (data stream, metadata, and index) creation relative to
38 * a given output directory,
39 * - Track the use of an output directory by other objects in order to
40 * know if/when an output directory can be safely consumed, renamed,
41 * deleted, etc.
42 *
43 *
44 * OWNER VS USER
45 * ---
46 *
47 * A trace chunk can either be a owner or a user of its
48 * "chunk output directory".
49 *
50 * A "user" trace chunk is provided with a handle to the chunk output directory
51 * which can then be used to create subdirectories and files.
52 *
53 * An "owner" chunk, on top of being able to perform the operations of a "user"
54 * chunk can perform operations on its chunk output directory, such as renaming
55 * or deleting it.
56 *
57 * A trace chunk becomes an "owner" or "user" chunk based on which of
58 * 'lttng_trace_chunk_set_as_owner()' or 'lttng_trace_chunk_set_as_user()' is
59 * used. These methods are _exclusive_ and must only be used once on a
60 * trace chunk.
61 */
62
63 struct lttng_trace_chunk;
64
65 enum lttng_trace_chunk_status {
66 LTTNG_TRACE_CHUNK_STATUS_OK,
67 LTTNG_TRACE_CHUNK_STATUS_NONE,
68 LTTNG_TRACE_CHUNK_STATUS_INVALID_ARGUMENT,
69 LTTNG_TRACE_CHUNK_STATUS_INVALID_OPERATION,
70 LTTNG_TRACE_CHUNK_STATUS_ERROR,
71 LTTNG_TRACE_CHUNK_STATUS_NO_FILE,
72 };
73
74 enum lttng_trace_chunk_command_type {
75 LTTNG_TRACE_CHUNK_COMMAND_TYPE_MOVE_TO_COMPLETED = 0,
76 LTTNG_TRACE_CHUNK_COMMAND_TYPE_NO_OPERATION = 1,
77 LTTNG_TRACE_CHUNK_COMMAND_TYPE_DELETE = 2,
78 LTTNG_TRACE_CHUNK_COMMAND_TYPE_MAX,
79 };
80
81 LTTNG_HIDDEN
82 struct lttng_trace_chunk *lttng_trace_chunk_create_anonymous(void);
83
84 LTTNG_HIDDEN
85 struct lttng_trace_chunk *lttng_trace_chunk_create(
86 uint64_t chunk_id,
87 time_t chunk_creation_time,
88 const char *path);
89
90 /*
91 * Copy a trace chunk. The copy that is returned is always a _user_
92 * mode chunk even if the source chunk was an _owner_ as there can never be
93 * two _owners_ of the same trace output.
94 */
95 LTTNG_HIDDEN
96 struct lttng_trace_chunk *lttng_trace_chunk_copy(
97 struct lttng_trace_chunk *source_chunk);
98
99 LTTNG_HIDDEN
100 enum lttng_trace_chunk_status lttng_trace_chunk_get_id(
101 struct lttng_trace_chunk *chunk, uint64_t *id);
102
103 LTTNG_HIDDEN
104 enum lttng_trace_chunk_status lttng_trace_chunk_get_creation_timestamp(
105 struct lttng_trace_chunk *chunk, time_t *creation_ts);
106
107 LTTNG_HIDDEN
108 enum lttng_trace_chunk_status lttng_trace_chunk_get_close_timestamp(
109 struct lttng_trace_chunk *chunk, time_t *close_ts);
110
111 LTTNG_HIDDEN
112 enum lttng_trace_chunk_status lttng_trace_chunk_set_close_timestamp(
113 struct lttng_trace_chunk *chunk, time_t close_ts);
114
115 LTTNG_HIDDEN
116 enum lttng_trace_chunk_status lttng_trace_chunk_get_name(
117 struct lttng_trace_chunk *chunk, const char **name,
118 bool *name_overridden);
119
120 LTTNG_HIDDEN
121 bool lttng_trace_chunk_get_name_overridden(struct lttng_trace_chunk *chunk);
122
123 LTTNG_HIDDEN
124 enum lttng_trace_chunk_status lttng_trace_chunk_override_name(
125 struct lttng_trace_chunk *chunk, const char *name);
126
127 LTTNG_HIDDEN
128 enum lttng_trace_chunk_status lttng_trace_chunk_rename_path(
129 struct lttng_trace_chunk *chunk, const char *path);
130
131 LTTNG_HIDDEN
132 enum lttng_trace_chunk_status lttng_trace_chunk_get_credentials(
133 struct lttng_trace_chunk *chunk,
134 struct lttng_credentials *credentials);
135
136 LTTNG_HIDDEN
137 enum lttng_trace_chunk_status lttng_trace_chunk_set_credentials(
138 struct lttng_trace_chunk *chunk,
139 const struct lttng_credentials *credentials);
140
141 LTTNG_HIDDEN
142 enum lttng_trace_chunk_status lttng_trace_chunk_set_credentials_current_user(
143 struct lttng_trace_chunk *chunk);
144
145 LTTNG_HIDDEN
146 enum lttng_trace_chunk_status lttng_trace_chunk_set_as_owner(
147 struct lttng_trace_chunk *chunk,
148 struct lttng_directory_handle *session_output_directory);
149
150 LTTNG_HIDDEN
151 enum lttng_trace_chunk_status lttng_trace_chunk_set_as_user(
152 struct lttng_trace_chunk *chunk,
153 struct lttng_directory_handle *chunk_directory);
154
155 LTTNG_HIDDEN
156 enum lttng_trace_chunk_status lttng_trace_chunk_borrow_chunk_directory_handle(
157 struct lttng_trace_chunk *chunk,
158 const struct lttng_directory_handle **handle);
159
160 LTTNG_HIDDEN
161 enum lttng_trace_chunk_status lttng_trace_chunk_create_subdirectory(
162 struct lttng_trace_chunk *chunk,
163 const char *subdirectory_path);
164
165 LTTNG_HIDDEN
166 enum lttng_trace_chunk_status lttng_trace_chunk_open_file(
167 struct lttng_trace_chunk *chunk, const char *filename,
168 int flags, mode_t mode, int *out_fd, bool expect_no_file);
169
170 LTTNG_HIDDEN
171 int lttng_trace_chunk_unlink_file(struct lttng_trace_chunk *chunk,
172 const char *filename);
173
174 LTTNG_HIDDEN
175 enum lttng_trace_chunk_status lttng_trace_chunk_get_close_command(
176 struct lttng_trace_chunk *chunk,
177 enum lttng_trace_chunk_command_type *command_type);
178
179 LTTNG_HIDDEN
180 enum lttng_trace_chunk_status lttng_trace_chunk_set_close_command(
181 struct lttng_trace_chunk *chunk,
182 enum lttng_trace_chunk_command_type command_type);
183
184 LTTNG_HIDDEN
185 const char *lttng_trace_chunk_command_type_get_name(
186 enum lttng_trace_chunk_command_type command);
187
188 /* Returns true on success. */
189 LTTNG_HIDDEN
190 bool lttng_trace_chunk_get(struct lttng_trace_chunk *chunk);
191
192 LTTNG_HIDDEN
193 void lttng_trace_chunk_put(struct lttng_trace_chunk *chunk);
194
195 #endif /* LTTNG_TRACE_CHUNK_H */
This page took 0.048192 seconds and 3 git commands to generate.