2 * Copyright (C) 2020 Jérémie Galarneau <jeremie.galarneau@efficios.com>
4 * SPDX-License-Identifier: LGPL-2.1-only
11 #include <common/macros.h>
17 * Marks the handle as the most recently used and marks the 'fd' as
18 * "in-use". This prevents the tracker from recycling the underlying
19 * file descriptor while it is actively being used by a thread.
21 * Don't forget that the tracker may be initiating an fd 'suspension'
22 * from another thread as the need to free an fd slot may arise from any
23 * thread within the daemon.
25 * Note that a restorable fd should never be held for longer than
26 * strictly necessary (e.g. the duration of a syscall()).
28 * Returns the fd on success, otherwise a negative value may be returned
29 * if the restoration of the fd failed.
32 int fs_handle_get_fd(struct fs_handle
*handle
);
35 * Used by the caller to signal that it is no longer using the underlying fd and
36 * that it may be safely suspended.
39 void fs_handle_put_fd(struct fs_handle
*handle
);
42 * Unlink the file associated to an fs_handle. Note that the unlink
43 * operation will not be performed immediately. It will only be performed
44 * once all references to the underlying file (through other fs_handle objects)
47 * However, note that the file will be renamed so as to provide the observable
48 * effect of an unlink(), that is removing a name from the filesystem.
50 * Returns 0 on success, otherwise a negative value will be returned
51 * if the operation failed.
54 int fs_handle_unlink(struct fs_handle
*handle
);
57 * Frees the handle and discards the underlying fd.
60 int fs_handle_close(struct fs_handle
*handle
);
63 ssize_t
fs_handle_read(struct fs_handle
*handle
, void *buf
, size_t count
);
66 ssize_t
fs_handle_write(struct fs_handle
*handle
, const void *buf
, size_t count
);
69 int fs_handle_truncate(struct fs_handle
*handle
, off_t offset
);
72 int fs_handle_seek(struct fs_handle
*handle
, off_t offset
, int whence
);
74 #endif /* FS_HANDLE_H */
This page took 0.033043 seconds and 4 git commands to generate.