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/macros.h>
22 #include <common/credentials.h>
23 #include <common/compat/directory-handle.h>
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.
33 * A trace chunk is always contained within a session output directory.
35 * This facility is used by the session daemon, consumer daemon(s), and relay
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,
47 * A trace chunk can either be a owner or a user of its
48 * "chunk output directory".
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.
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
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
63 struct lttng_trace_chunk
;
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
,
74 enum lttng_trace_chunk_command_type
{
75 LTTNG_TRACE_CHUNK_COMMAND_TYPE_MOVE_TO_COMPLETED
= 0,
76 LTTNG_TRACE_CHUNK_COMMAND_TYPE_MAX
80 struct lttng_trace_chunk
*lttng_trace_chunk_create_anonymous(void);
83 struct lttng_trace_chunk
*lttng_trace_chunk_create(
85 time_t chunk_creation_time
);
88 * Copy a trace chunk. The copy that is returned is always a _user_
89 * mode chunk even if the source chunk was an _owner_ as there can never be
90 * two _owners_ of the same trace output.
93 struct lttng_trace_chunk
*lttng_trace_chunk_copy(
94 struct lttng_trace_chunk
*source_chunk
);
97 enum lttng_trace_chunk_status
lttng_trace_chunk_get_id(
98 struct lttng_trace_chunk
*chunk
, uint64_t *id
);
101 enum lttng_trace_chunk_status
lttng_trace_chunk_get_creation_timestamp(
102 struct lttng_trace_chunk
*chunk
, time_t *creation_ts
);
105 enum lttng_trace_chunk_status
lttng_trace_chunk_get_close_timestamp(
106 struct lttng_trace_chunk
*chunk
, time_t *close_ts
);
109 enum lttng_trace_chunk_status
lttng_trace_chunk_set_close_timestamp(
110 struct lttng_trace_chunk
*chunk
, time_t close_ts
);
113 enum lttng_trace_chunk_status
lttng_trace_chunk_get_name(
114 struct lttng_trace_chunk
*chunk
, const char **name
,
115 bool *name_overridden
);
118 enum lttng_trace_chunk_status
lttng_trace_chunk_override_name(
119 struct lttng_trace_chunk
*chunk
, const char *name
);
122 enum lttng_trace_chunk_status
lttng_trace_chunk_get_credentials(
123 struct lttng_trace_chunk
*chunk
,
124 struct lttng_credentials
*credentials
);
127 enum lttng_trace_chunk_status
lttng_trace_chunk_set_credentials(
128 struct lttng_trace_chunk
*chunk
,
129 const struct lttng_credentials
*credentials
);
132 enum lttng_trace_chunk_status
lttng_trace_chunk_set_credentials_current_user(
133 struct lttng_trace_chunk
*chunk
);
136 enum lttng_trace_chunk_status
lttng_trace_chunk_set_as_owner(
137 struct lttng_trace_chunk
*chunk
,
138 struct lttng_directory_handle
*session_output_directory
);
141 enum lttng_trace_chunk_status
lttng_trace_chunk_set_as_user(
142 struct lttng_trace_chunk
*chunk
,
143 struct lttng_directory_handle
*chunk_directory
);
146 enum lttng_trace_chunk_status
lttng_trace_chunk_borrow_chunk_directory_handle(
147 struct lttng_trace_chunk
*chunk
,
148 const struct lttng_directory_handle
**handle
);
151 enum lttng_trace_chunk_status
lttng_trace_chunk_create_subdirectory(
152 struct lttng_trace_chunk
*chunk
,
153 const char *subdirectory_path
);
156 enum lttng_trace_chunk_status
lttng_trace_chunk_open_file(
157 struct lttng_trace_chunk
*chunk
, const char *filename
,
158 int flags
, mode_t mode
, int *out_fd
, bool expect_no_file
);
161 int lttng_trace_chunk_unlink_file(struct lttng_trace_chunk
*chunk
,
162 const char *filename
);
165 enum lttng_trace_chunk_status
lttng_trace_chunk_get_close_command(
166 struct lttng_trace_chunk
*chunk
,
167 enum lttng_trace_chunk_command_type
*command_type
);
170 enum lttng_trace_chunk_status
lttng_trace_chunk_set_close_command(
171 struct lttng_trace_chunk
*chunk
,
172 enum lttng_trace_chunk_command_type command_type
);
175 const char *lttng_trace_chunk_command_type_get_name(
176 enum lttng_trace_chunk_command_type command
);
178 /* Returns true on success. */
180 bool lttng_trace_chunk_get(struct lttng_trace_chunk
*chunk
);
183 void lttng_trace_chunk_put(struct lttng_trace_chunk
*chunk
);
185 #endif /* LTTNG_TRACE_CHUNK_H */