1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
|
// Copyright © Tavian Barnes <tavianator@tavianator.com>
// SPDX-License-Identifier: 0BSD
/**
* Asynchronous I/O queues.
*/
#ifndef BFS_IOQ_H
#define BFS_IOQ_H
#include <stddef.h>
/**
* An queue of asynchronous I/O operations.
*/
struct ioq;
/**
* An I/O queue response.
*/
struct ioq_res {
/** The opened directory. */
struct bfs_dir *dir;
/** The error code, if the operation failed. */
int error;
/** Arbitrary user data. */
void *ptr;
};
/**
* Create an I/O queue.
*
* @param depth
* The maximum depth of the queue.
* @param threads
* The maximum number of background threads.
* @return
* The new I/O queue, or NULL on failure.
*/
struct ioq *ioq_create(size_t depth, size_t threads);
/**
* Asynchronous bfs_opendir().
*
* @param ioq
* The I/O queue.
* @param dfd
* The base file descriptor.
* @param path
* The path to open, relative to dfd.
* @param ptr
* An arbitrary pointer to associate with the request.
* @return
* 0 on success, or -1 on failure.
*/
int ioq_opendir(struct ioq *ioq, int dfd, const char *path, void *ptr);
/**
* Pop a response from the queue.
*
* @param ioq
* The I/O queue.
* @return
* The next response, or NULL.
*/
struct ioq_res *ioq_pop(struct ioq *ioq);
/**
* Pop a response from the queue, without blocking.
*
* @param ioq
* The I/O queue.
* @return
* The next response, or NULL.
*/
struct ioq_res *ioq_trypop(struct ioq *ioq);
/**
* Free a response.
*
* @param ioq
* The I/O queue.
* @param res
* The response to free.
*/
void ioq_free(struct ioq *ioq, struct ioq_res *res);
/**
* Stop and destroy an I/O queue.
*/
void ioq_destroy(struct ioq *ioq);
#endif // BFS_IOQ_H
|
