X-Git-Url: https://git.lttng.org/?p=lttng-tools.git;a=blobdiff_plain;f=src%2Fcommon%2Fcompat%2Fdirectory-handle.h;h=f50cef67455edd403d647002e25ecee75f016972;hp=ceebc941e724ea690003698eb7c469789f3f2dba;hb=d295668767ac8234e83984e1812d342d03293d88;hpb=578e21bdc951a54e34fe539b64e446557b703206 diff --git a/src/common/compat/directory-handle.h b/src/common/compat/directory-handle.h index ceebc941e..f50cef674 100644 --- a/src/common/compat/directory-handle.h +++ b/src/common/compat/directory-handle.h @@ -32,6 +32,14 @@ struct lttng_directory_handle { int dirfd; }; + +static inline +int lttng_directory_handle_get_dirfd( + const struct lttng_directory_handle *handle) +{ + return handle->dirfd; +} + #else struct lttng_directory_handle { char *base_path; @@ -40,9 +48,7 @@ struct lttng_directory_handle { /* * Initialize a directory handle to the provided path. Passing a NULL path - * returns a handle to the current working directory. The working directory - * is not sampled; it will be accessed at the time of use of the functions - * of this API. + * returns a handle to the current working directory. * * An initialized directory handle must be finalized using * lttng_directory_handle_fini(). @@ -51,6 +57,35 @@ LTTNG_HIDDEN int lttng_directory_handle_init(struct lttng_directory_handle *handle, const char *path); +/* + * Initialize 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 + * to highlight the fact that there is an inherent race between the creation of + * a directory and the creation of a handle to it. + * + * Passing a NULL path effectively copies the original handle. + * + * An initialized directory handle must be finalized using + * lttng_directory_handle_fini(). + */ +LTTNG_HIDDEN +int lttng_directory_handle_init_from_handle( + struct lttng_directory_handle *new_handle, + const char *path, + const struct lttng_directory_handle *handle); + +/* + * Initialize 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(). + */ LTTNG_HIDDEN int lttng_directory_handle_init_from_dirfd( struct lttng_directory_handle *handle, int dirfd); @@ -62,6 +97,18 @@ LTTNG_HIDDEN int lttng_directory_handle_copy(const struct lttng_directory_handle *handle, struct lttng_directory_handle *new_copy); +/* + * 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. + */ +LTTNG_HIDDEN +struct lttng_directory_handle +lttng_directory_handle_move(struct lttng_directory_handle *original); + /* * Release the resources of a directory handle. */ @@ -106,4 +153,61 @@ int lttng_directory_handle_create_subdirectory_recursive_as_user( const char *subdirectory_path, mode_t mode, const struct lttng_credentials *creds); +LTTNG_HIDDEN +int lttng_directory_handle_open_file( + const struct lttng_directory_handle *handle, + const char *filename, + int flags, mode_t mode); + +LTTNG_HIDDEN +int lttng_directory_handle_open_file_as_user( + const struct lttng_directory_handle *handle, + const char *filename, + int flags, mode_t mode, + const struct lttng_credentials *creds); + +LTTNG_HIDDEN +int lttng_directory_handle_unlink_file( + const struct lttng_directory_handle *handle, + const char *filename); + +LTTNG_HIDDEN +int lttng_directory_handle_unlink_file_as_user( + const struct lttng_directory_handle *handle, + const char *filename, + const struct lttng_credentials *creds); + +LTTNG_HIDDEN +int lttng_directory_handle_rename( + const struct lttng_directory_handle *handle, + const char *old, const char *new); + +LTTNG_HIDDEN +int lttng_directory_handle_rename_as_user( + const struct lttng_directory_handle *handle, + const char *old, const char *new, + const struct lttng_credentials *creds); + +LTTNG_HIDDEN +int lttng_directory_handle_rmdir( + const struct lttng_directory_handle *handle, + const char *name); + +LTTNG_HIDDEN +int lttng_directory_handle_rmdir_as_user( + const struct lttng_directory_handle *handle, + const char *name, + const struct lttng_credentials *creds); + +LTTNG_HIDDEN +int lttng_directory_handle_rmdir_recursive( + const struct lttng_directory_handle *handle, + const char *name); + +LTTNG_HIDDEN +int lttng_directory_handle_rmdir_recursive_as_user( + const struct lttng_directory_handle *handle, + const char *name, + const struct lttng_credentials *creds); + #endif /* _COMPAT_PATH_HANDLE_H */