/*
- * Copyright (C) 2019 - Jérémie Galarneau <jeremie.galarneau@efficios.com>
+ * Copyright (C) 2019 Jérémie Galarneau <jeremie.galarneau@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.
+ * SPDX-License-Identifier: GPL-2.0-only
*
- * 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 _COMPAT_DIRECTORY_HANDLE_H
#define _COMPAT_DIRECTORY_HANDLE_H
-#include <common/macros.h>
#include <common/credentials.h>
+#include <common/macros.h>
+#include <sys/stat.h>
#include <urcu/ref.h>
+#ifdef __cplusplus
+extern "C" {
+#endif
+
enum lttng_directory_handle_rmdir_recursive_flags {
LTTNG_DIRECTORY_HANDLE_FAIL_NON_EMPTY_FLAG = (1U << 0),
LTTNG_DIRECTORY_HANDLE_SKIP_NON_EMPTY_FLAG = (1U << 1),
* This wrapper provides a handle that is either a copy of a directory's path
* or a directory file descriptors, depending on the platform's capabilities.
*/
-#ifdef COMPAT_DIRFD
+#ifdef HAVE_DIRFD
+
+struct lttng_directory_handle;
+
+typedef void (*lttng_directory_handle_destroy_cb)(
+ struct lttng_directory_handle *handle, void *data);
+
struct lttng_directory_handle {
struct urcu_ref ref;
+ ino_t directory_inode;
int dirfd;
+ lttng_directory_handle_destroy_cb destroy_cb;
+ void *destroy_cb_data;
};
static inline
* The reference to the directory handle must be released using
* lttng_directory_handle_put().
*/
-LTTNG_HIDDEN
struct lttng_directory_handle *lttng_directory_handle_create(
const char *path);
* The reference to the directory handle must be released using
* lttng_directory_handle_put().
*/
-LTTNG_HIDDEN
struct lttng_directory_handle *lttng_directory_handle_create_from_handle(
const char *path,
const struct lttng_directory_handle *ref_handle);
* The reference to the directory handle must be released using
* lttng_directory_handle_put().
*/
-LTTNG_HIDDEN
struct lttng_directory_handle *lttng_directory_handle_create_from_dirfd(
int dirfd);
* The reference to the directory handle must be released using
* lttng_directory_handle_put().
*/
-LTTNG_HIDDEN
struct lttng_directory_handle *lttng_directory_handle_copy(
const struct lttng_directory_handle *handle);
/*
* Acquire a reference to a directory handle.
*/
-LTTNG_HIDDEN
bool lttng_directory_handle_get(struct lttng_directory_handle *handle);
/*
* Release a reference to a directory handle.
*/
-LTTNG_HIDDEN
void lttng_directory_handle_put(struct lttng_directory_handle *handle);
/*
* Create a subdirectory relative to a directory handle.
*/
-LTTNG_HIDDEN
int lttng_directory_handle_create_subdirectory(
const struct lttng_directory_handle *handle,
const char *subdirectory,
* Create a subdirectory relative to a directory handle
* as a given user.
*/
-LTTNG_HIDDEN
int lttng_directory_handle_create_subdirectory_as_user(
const struct lttng_directory_handle *handle,
const char *subdirectory,
/*
* Recursively create a directory relative to a directory handle.
*/
-LTTNG_HIDDEN
int lttng_directory_handle_create_subdirectory_recursive(
const struct lttng_directory_handle *handle,
const char *subdirectory_path,
* Recursively create a directory relative to a directory handle
* as a given user.
*/
-LTTNG_HIDDEN
int lttng_directory_handle_create_subdirectory_recursive_as_user(
const struct lttng_directory_handle *handle,
const char *subdirectory_path,
/*
* Open a file descriptor to a path relative to a directory handle.
*/
-LTTNG_HIDDEN
int lttng_directory_handle_open_file(
const struct lttng_directory_handle *handle,
const char *filename,
* Open a file descriptor to a path relative to a directory handle
* as a given user.
*/
-LTTNG_HIDDEN
int lttng_directory_handle_open_file_as_user(
const struct lttng_directory_handle *handle,
const char *filename,
/*
* Unlink a file to a path relative to a directory handle.
*/
-LTTNG_HIDDEN
int lttng_directory_handle_unlink_file(
const struct lttng_directory_handle *handle,
const char *filename);
/*
* Unlink a file to a path relative to a directory handle as a given user.
*/
-LTTNG_HIDDEN
int lttng_directory_handle_unlink_file_as_user(
const struct lttng_directory_handle *handle,
const char *filename,
* Rename a file from a path relative to a directory handle to a new
* name relative to another directory handle.
*/
-LTTNG_HIDDEN
int lttng_directory_handle_rename(
const struct lttng_directory_handle *old_handle,
const char *old_name,
* Rename a file from a path relative to a directory handle to a new
* name relative to another directory handle as a given user.
*/
-LTTNG_HIDDEN
int lttng_directory_handle_rename_as_user(
const struct lttng_directory_handle *old_handle,
const char *old_name,
/*
* Remove a subdirectory relative to a directory handle.
*/
-LTTNG_HIDDEN
int lttng_directory_handle_remove_subdirectory(
const struct lttng_directory_handle *handle,
const char *name);
/*
* Remove a subdirectory relative to a directory handle as a given user.
*/
-LTTNG_HIDDEN
int lttng_directory_handle_remove_subdirectory_as_user(
const struct lttng_directory_handle *handle,
const char *name,
* consists in empty directories.
* @flags: enum lttng_directory_handle_rmdir_recursive_flags
*/
-LTTNG_HIDDEN
int lttng_directory_handle_remove_subdirectory_recursive(
const struct lttng_directory_handle *handle,
const char *name, int flags);
* consists in empty directories as a given user.
* @flags: enum lttng_directory_handle_rmdir_recursive_flags
*/
-LTTNG_HIDDEN
int lttng_directory_handle_remove_subdirectory_recursive_as_user(
const struct lttng_directory_handle *handle,
const char *name,
const struct lttng_credentials *creds,
int flags);
+/*
+ * stat() a file relative to a directory handle.
+ */
+int lttng_directory_handle_stat(
+ const struct lttng_directory_handle *handle,
+ const char *name,
+ struct stat *stat_buf);
+
+/*
+ * Returns true if this directory handle is backed by a file
+ * descriptor, false otherwise.
+ */
+bool lttng_directory_handle_uses_fd(
+ const struct lttng_directory_handle *handle);
+
+/*
+ * Compare two directory handles.
+ *
+ * Returns true if the two directory handles are equal, false otherwise.
+ */
+bool lttng_directory_handle_equals(const struct lttng_directory_handle *lhs,
+ const struct lttng_directory_handle *rhs);
+
+
+#ifdef __cplusplus
+}
+#endif
+
#endif /* _COMPAT_PATH_HANDLE_H */
projects / lttng-tools.git / blobdiff