2 * Copyright (C) 2019 - Jérémie Galarneau <jeremie.galarneau@efficios.com>
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.
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
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
18 #ifndef LTTNG_TRACE_CHUNK_H
19 #define LTTNG_TRACE_CHUNK_H
21 #include <common/compat/directory-handle.h>
22 #include <common/credentials.h>
23 #include <common/fd-tracker/fd-tracker.h>
24 #include <common/macros.h>
30 * A trace chunk is a group of directories and files forming a (or a set of)
31 * complete and independant trace(s). For instance, a trace archive chunk,
32 * a snapshot, or a regular LTTng trace are all instances of a trace archive.
34 * A trace chunk is always contained within a session output directory.
36 * This facility is used by the session daemon, consumer daemon(s), and relay
38 * - Control file (data stream, metadata, and index) creation relative to
39 * a given output directory,
40 * - Track the use of an output directory by other objects in order to
41 * know if/when an output directory can be safely consumed, renamed,
48 * A trace chunk can either be a owner or a user of its
49 * "chunk output directory".
51 * A "user" trace chunk is provided with a handle to the chunk output directory
52 * which can then be used to create subdirectories and files.
54 * An "owner" chunk, on top of being able to perform the operations of a "user"
55 * chunk can perform operations on its chunk output directory, such as renaming
58 * A trace chunk becomes an "owner" or "user" chunk based on which of
59 * 'lttng_trace_chunk_set_as_owner()' or 'lttng_trace_chunk_set_as_user()' is
60 * used. These methods are _exclusive_ and must only be used once on a
64 struct lttng_trace_chunk
;
67 enum lttng_trace_chunk_status
{
68 LTTNG_TRACE_CHUNK_STATUS_OK
,
69 LTTNG_TRACE_CHUNK_STATUS_NONE
,
70 LTTNG_TRACE_CHUNK_STATUS_INVALID_ARGUMENT
,
71 LTTNG_TRACE_CHUNK_STATUS_INVALID_OPERATION
,
72 LTTNG_TRACE_CHUNK_STATUS_ERROR
,
73 LTTNG_TRACE_CHUNK_STATUS_NO_FILE
,
76 enum lttng_trace_chunk_command_type
{
77 LTTNG_TRACE_CHUNK_COMMAND_TYPE_MOVE_TO_COMPLETED
= 0,
78 LTTNG_TRACE_CHUNK_COMMAND_TYPE_NO_OPERATION
= 1,
79 LTTNG_TRACE_CHUNK_COMMAND_TYPE_DELETE
= 2,
80 LTTNG_TRACE_CHUNK_COMMAND_TYPE_MAX
,
84 struct lttng_trace_chunk
*lttng_trace_chunk_create_anonymous(void);
87 struct lttng_trace_chunk
*lttng_trace_chunk_create(
89 time_t chunk_creation_time
,
93 void lttng_trace_chunk_set_fd_tracker(struct lttng_trace_chunk
*chunk
,
94 struct fd_tracker
*fd_tracker
);
97 * Copy a trace chunk. The copy that is returned is always a _user_
98 * mode chunk even if the source chunk was an _owner_ as there can never be
99 * two _owners_ of the same trace output.
102 struct lttng_trace_chunk
*lttng_trace_chunk_copy(
103 struct lttng_trace_chunk
*source_chunk
);
106 enum lttng_trace_chunk_status
lttng_trace_chunk_get_id(
107 struct lttng_trace_chunk
*chunk
, uint64_t *id
);
110 enum lttng_trace_chunk_status
lttng_trace_chunk_get_creation_timestamp(
111 struct lttng_trace_chunk
*chunk
, time_t *creation_ts
);
114 enum lttng_trace_chunk_status
lttng_trace_chunk_get_close_timestamp(
115 struct lttng_trace_chunk
*chunk
, time_t *close_ts
);
118 enum lttng_trace_chunk_status
lttng_trace_chunk_set_close_timestamp(
119 struct lttng_trace_chunk
*chunk
, time_t close_ts
);
122 enum lttng_trace_chunk_status
lttng_trace_chunk_get_name(
123 struct lttng_trace_chunk
*chunk
, const char **name
,
124 bool *name_overridden
);
127 bool lttng_trace_chunk_get_name_overridden(struct lttng_trace_chunk
*chunk
);
130 enum lttng_trace_chunk_status
lttng_trace_chunk_override_name(
131 struct lttng_trace_chunk
*chunk
, const char *name
);
134 enum lttng_trace_chunk_status
lttng_trace_chunk_rename_path(
135 struct lttng_trace_chunk
*chunk
, const char *path
);
138 enum lttng_trace_chunk_status
lttng_trace_chunk_get_credentials(
139 struct lttng_trace_chunk
*chunk
,
140 struct lttng_credentials
*credentials
);
143 enum lttng_trace_chunk_status
lttng_trace_chunk_set_credentials(
144 struct lttng_trace_chunk
*chunk
,
145 const struct lttng_credentials
*credentials
);
148 enum lttng_trace_chunk_status
lttng_trace_chunk_set_credentials_current_user(
149 struct lttng_trace_chunk
*chunk
);
152 enum lttng_trace_chunk_status
lttng_trace_chunk_set_as_owner(
153 struct lttng_trace_chunk
*chunk
,
154 struct lttng_directory_handle
*session_output_directory
);
157 enum lttng_trace_chunk_status
lttng_trace_chunk_set_as_user(
158 struct lttng_trace_chunk
*chunk
,
159 struct lttng_directory_handle
*chunk_directory
);
162 enum lttng_trace_chunk_status
163 lttng_trace_chunk_get_session_output_directory_handle(
164 struct lttng_trace_chunk
*chunk
,
165 struct lttng_directory_handle
**handle
);
168 enum lttng_trace_chunk_status
lttng_trace_chunk_borrow_chunk_directory_handle(
169 struct lttng_trace_chunk
*chunk
,
170 const struct lttng_directory_handle
**handle
);
173 enum lttng_trace_chunk_status
lttng_trace_chunk_create_subdirectory(
174 struct lttng_trace_chunk
*chunk
,
175 const char *subdirectory_path
);
178 enum lttng_trace_chunk_status
lttng_trace_chunk_open_file(
179 struct lttng_trace_chunk
*chunk
,
180 const char *filename
,
184 bool expect_no_file
);
187 enum lttng_trace_chunk_status
lttng_trace_chunk_open_fs_handle(
188 struct lttng_trace_chunk
*chunk
,
189 const char *filename
,
192 struct fs_handle
**out_handle
,
193 bool expect_no_file
);
196 int lttng_trace_chunk_unlink_file(struct lttng_trace_chunk
*chunk
,
197 const char *filename
);
200 enum lttng_trace_chunk_status
lttng_trace_chunk_get_close_command(
201 struct lttng_trace_chunk
*chunk
,
202 enum lttng_trace_chunk_command_type
*command_type
);
205 enum lttng_trace_chunk_status
lttng_trace_chunk_set_close_command(
206 struct lttng_trace_chunk
*chunk
,
207 enum lttng_trace_chunk_command_type command_type
);
210 const char *lttng_trace_chunk_command_type_get_name(
211 enum lttng_trace_chunk_command_type command
);
213 /* Returns true on success. */
215 bool lttng_trace_chunk_get(struct lttng_trace_chunk
*chunk
);
218 void lttng_trace_chunk_put(struct lttng_trace_chunk
*chunk
);
220 #endif /* LTTNG_TRACE_CHUNK_H */