X-Git-Url: https://git.lttng.org/?p=lttng-tools.git;a=blobdiff_plain;f=src%2Fcommon%2Fcompat%2Fdirectory-handle.h;h=9a107201987f129ee4bd7dbdd12a359893fffebd;hp=0ad5c851072ab68de75788aeeb42c657dbd19e8c;hb=7966af5763c4aaca39df9bbfa9277ff15715c720;hpb=0e98551307eb5a7a59cc74982b386dc95f4c4f89 diff --git a/src/common/compat/directory-handle.h b/src/common/compat/directory-handle.h index 0ad5c8510..9a1072019 100644 --- a/src/common/compat/directory-handle.h +++ b/src/common/compat/directory-handle.h @@ -1,27 +1,22 @@ /* - * Copyright (C) 2019 - Jérémie Galarneau + * Copyright (C) 2019 Jérémie Galarneau * - * 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 #include +#include +#include #include +#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), @@ -34,11 +29,19 @@ enum lttng_directory_handle_rmdir_recursive_flags { * 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 @@ -62,7 +65,6 @@ struct lttng_directory_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( const char *path); @@ -79,7 +81,6 @@ struct lttng_directory_handle *lttng_directory_handle_create( * 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); @@ -94,7 +95,6 @@ struct lttng_directory_handle *lttng_directory_handle_create_from_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); @@ -104,26 +104,22 @@ struct lttng_directory_handle *lttng_directory_handle_create_from_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, @@ -133,7 +129,6 @@ int lttng_directory_handle_create_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, @@ -142,7 +137,6 @@ int lttng_directory_handle_create_subdirectory_as_user( /* * 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, @@ -152,7 +146,6 @@ int lttng_directory_handle_create_subdirectory_recursive( * 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, @@ -161,7 +154,6 @@ int lttng_directory_handle_create_subdirectory_recursive_as_user( /* * 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, @@ -171,7 +163,6 @@ int lttng_directory_handle_open_file( * 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, @@ -181,7 +172,6 @@ int lttng_directory_handle_open_file_as_user( /* * 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); @@ -189,7 +179,6 @@ int lttng_directory_handle_unlink_file( /* * 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, @@ -199,7 +188,6 @@ int lttng_directory_handle_unlink_file_as_user( * 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, @@ -210,7 +198,6 @@ int lttng_directory_handle_rename( * 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, @@ -221,7 +208,6 @@ int lttng_directory_handle_rename_as_user( /* * 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); @@ -229,7 +215,6 @@ int lttng_directory_handle_remove_subdirectory( /* * 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, @@ -240,7 +225,6 @@ int lttng_directory_handle_remove_subdirectory_as_user( * 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); @@ -250,20 +234,38 @@ int lttng_directory_handle_remove_subdirectory_recursive( * 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. */ -LTTNG_HIDDEN 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 */