xref: /OK3568_Linux_fs/kernel/tools/lib/api/fd/array.h (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1*4882a593Smuzhiyun /* SPDX-License-Identifier: GPL-2.0 */
2*4882a593Smuzhiyun #ifndef __API_FD_ARRAY__
3*4882a593Smuzhiyun #define __API_FD_ARRAY__
4*4882a593Smuzhiyun 
5*4882a593Smuzhiyun #include <stdio.h>
6*4882a593Smuzhiyun 
7*4882a593Smuzhiyun struct pollfd;
8*4882a593Smuzhiyun 
9*4882a593Smuzhiyun /**
10*4882a593Smuzhiyun  * struct fdarray: Array of file descriptors
11*4882a593Smuzhiyun  *
12*4882a593Smuzhiyun  * @priv: Per array entry priv area, users should access just its contents,
13*4882a593Smuzhiyun  *	  not set it to anything, as it is kept in synch with @entries, being
14*4882a593Smuzhiyun  *	  realloc'ed, * for instance, in fdarray__{grow,filter}.
15*4882a593Smuzhiyun  *
16*4882a593Smuzhiyun  *	  I.e. using 'fda->priv[N].idx = * value' where N < fda->nr is ok,
17*4882a593Smuzhiyun  *	  but doing 'fda->priv = malloc(M)' is not allowed.
18*4882a593Smuzhiyun  */
19*4882a593Smuzhiyun struct fdarray {
20*4882a593Smuzhiyun 	int	       nr;
21*4882a593Smuzhiyun 	int	       nr_alloc;
22*4882a593Smuzhiyun 	int	       nr_autogrow;
23*4882a593Smuzhiyun 	struct pollfd *entries;
24*4882a593Smuzhiyun 	struct priv {
25*4882a593Smuzhiyun 		union {
26*4882a593Smuzhiyun 			int    idx;
27*4882a593Smuzhiyun 			void   *ptr;
28*4882a593Smuzhiyun 		};
29*4882a593Smuzhiyun 		unsigned int flags;
30*4882a593Smuzhiyun 	} *priv;
31*4882a593Smuzhiyun };
32*4882a593Smuzhiyun 
33*4882a593Smuzhiyun enum fdarray_flags {
34*4882a593Smuzhiyun 	fdarray_flag__default	    = 0x00000000,
35*4882a593Smuzhiyun 	fdarray_flag__nonfilterable = 0x00000001
36*4882a593Smuzhiyun };
37*4882a593Smuzhiyun 
38*4882a593Smuzhiyun void fdarray__init(struct fdarray *fda, int nr_autogrow);
39*4882a593Smuzhiyun void fdarray__exit(struct fdarray *fda);
40*4882a593Smuzhiyun 
41*4882a593Smuzhiyun struct fdarray *fdarray__new(int nr_alloc, int nr_autogrow);
42*4882a593Smuzhiyun void fdarray__delete(struct fdarray *fda);
43*4882a593Smuzhiyun 
44*4882a593Smuzhiyun int fdarray__add(struct fdarray *fda, int fd, short revents, enum fdarray_flags flags);
45*4882a593Smuzhiyun int fdarray__poll(struct fdarray *fda, int timeout);
46*4882a593Smuzhiyun int fdarray__filter(struct fdarray *fda, short revents,
47*4882a593Smuzhiyun 		    void (*entry_destructor)(struct fdarray *fda, int fd, void *arg),
48*4882a593Smuzhiyun 		    void *arg);
49*4882a593Smuzhiyun int fdarray__grow(struct fdarray *fda, int extra);
50*4882a593Smuzhiyun int fdarray__fprintf(struct fdarray *fda, FILE *fp);
51*4882a593Smuzhiyun 
fdarray__available_entries(struct fdarray * fda)52*4882a593Smuzhiyun static inline int fdarray__available_entries(struct fdarray *fda)
53*4882a593Smuzhiyun {
54*4882a593Smuzhiyun 	return fda->nr_alloc - fda->nr;
55*4882a593Smuzhiyun }
56*4882a593Smuzhiyun 
57*4882a593Smuzhiyun #endif /* __API_FD_ARRAY__ */
58