X-Git-Url: https://git.lttng.org/?p=lttng-tools.git;a=blobdiff_plain;f=src%2Fcommon%2Fcompat%2Fdirectory-handle.h;h=b6ee8b3846fdc7a70a77f19c295ab49b23bd3555;hp=26da76bcc7d7a751971adee30a9cd252f2235a84;hb=9a1a997f2f22b556f63437d911b98c7b522b38e4;hpb=f75c5439a7fe3d47edf68098f249421b701fceaf diff --git a/src/common/compat/directory-handle.h b/src/common/compat/directory-handle.h index 26da76bcc..b6ee8b384 100644 --- a/src/common/compat/directory-handle.h +++ b/src/common/compat/directory-handle.h @@ -18,8 +18,10 @@ #ifndef _COMPAT_DIRECTORY_HANDLE_H #define _COMPAT_DIRECTORY_HANDLE_H -#include #include +#include +#include +#include enum lttng_directory_handle_rmdir_recursive_flags { LTTNG_DIRECTORY_HANDLE_FAIL_NON_EMPTY_FLAG = (1U << 0), @@ -35,6 +37,8 @@ enum lttng_directory_handle_rmdir_recursive_flags { */ #ifdef COMPAT_DIRFD struct lttng_directory_handle { + struct urcu_ref ref; + ino_t directory_inode; int dirfd; }; @@ -47,23 +51,24 @@ int lttng_directory_handle_get_dirfd( #else struct lttng_directory_handle { + struct urcu_ref ref; char *base_path; }; #endif /* - * Initialize a directory handle to the provided path. Passing a NULL path + * Create a directory handle to the provided path. Passing a NULL path * returns a handle to the current working directory. * - * An initialized directory handle must be finalized using - * lttng_directory_handle_fini(). + * The reference to the directory handle must be released using + * lttng_directory_handle_put(). */ LTTNG_HIDDEN -int lttng_directory_handle_init(struct lttng_directory_handle *handle, +struct lttng_directory_handle *lttng_directory_handle_create( const char *path); /* - * Initialize a new directory handle to a path relative to an existing handle. + * Create a new directory handle to a path relative to an existing handle. * * The provided path must already exist. Note that the creation of a * subdirectory and the creation of a handle are kept as separate operations @@ -72,53 +77,49 @@ int lttng_directory_handle_init(struct lttng_directory_handle *handle, * * Passing a NULL path effectively copies the original handle. * - * An initialized directory handle must be finalized using - * lttng_directory_handle_fini(). + * The reference to the directory handle must be released using + * lttng_directory_handle_put(). */ LTTNG_HIDDEN -int lttng_directory_handle_init_from_handle( - struct lttng_directory_handle *new_handle, +struct lttng_directory_handle *lttng_directory_handle_create_from_handle( const char *path, - const struct lttng_directory_handle *handle); + const struct lttng_directory_handle *ref_handle); /* - * Initialize a new directory handle from an existing directory fd. + * Create a new directory handle from an existing directory fd. * * The new directory handle assumes the ownership of the directory fd. * Note that this method should only be used in very specific cases, such as * re-creating a directory handle from a dirfd passed over a unix socket. * - * An initialized directory handle must be finalized using - * lttng_directory_handle_fini(). + * The reference to the directory handle must be released using + * lttng_directory_handle_put(). */ LTTNG_HIDDEN -int lttng_directory_handle_init_from_dirfd( - struct lttng_directory_handle *handle, int dirfd); +struct lttng_directory_handle *lttng_directory_handle_create_from_dirfd( + int dirfd); /* * Copy a directory handle. + * + * The reference to the directory handle must be released using + * lttng_directory_handle_put(). */ LTTNG_HIDDEN -int lttng_directory_handle_copy(const struct lttng_directory_handle *handle, - struct lttng_directory_handle *new_copy); +struct lttng_directory_handle *lttng_directory_handle_copy( + const struct lttng_directory_handle *handle); /* - * Move a directory handle. The original directory handle may no longer be - * used after this call. This call cannot fail; directly assign the - * return value to the new directory handle. - * - * It is safe (but unnecessary) to call lttng_directory_handle_fini on the - * original handle. + * Acquire a reference to a directory handle. */ LTTNG_HIDDEN -struct lttng_directory_handle -lttng_directory_handle_move(struct lttng_directory_handle *original); +bool lttng_directory_handle_get(struct lttng_directory_handle *handle); /* - * Release the resources of a directory handle. + * Release a reference to a directory handle. */ LTTNG_HIDDEN -void lttng_directory_handle_fini(struct lttng_directory_handle *handle); +void lttng_directory_handle_put(struct lttng_directory_handle *handle); /* * Create a subdirectory relative to a directory handle. @@ -257,4 +258,30 @@ int lttng_directory_handle_remove_subdirectory_recursive_as_user( const struct lttng_credentials *creds, int flags); +/* + * stat() a file relative to a directory handle. + */ +LTTNG_HIDDEN +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. + */ +LTTNG_HIDDEN +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); + #endif /* _COMPAT_PATH_HANDLE_H */