1 /* Copyright (C) 2005-2022 Free Software Foundation, Inc.
2    This file is part of the GNU C Library.
3 
4    The GNU C Library is free software; you can redistribute it and/or
5    modify it under the terms of the GNU Lesser General Public
6    License as published by the Free Software Foundation; either
7    version 2.1 of the License, or (at your option) any later version.
8 
9    The GNU C Library is distributed in the hope that it will be useful,
10    but WITHOUT ANY WARRANTY; without even the implied warranty of
11    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
12    Lesser General Public License for more details.
13 
14    You should have received a copy of the GNU Lesser General Public
15    License along with the GNU C Library; if not, see
16    <https://www.gnu.org/licenses/>.  */
17 
18 #ifndef	_SYS_INOTIFY_H
19 #define	_SYS_INOTIFY_H	1
20 
21 #include <stdint.h>
22 
23 /* Get the platform-dependent flags.  */
24 #include <bits/inotify.h>
25 
26 
27 /* Structure describing an inotify event.  */
28 struct inotify_event
29 {
30   int wd;		/* Watch descriptor.  */
31   uint32_t mask;	/* Watch mask.  */
32   uint32_t cookie;	/* Cookie to synchronize two events.  */
33   uint32_t len;		/* Length (including NULs) of name.  */
34   char name __flexarr;	/* Name.  */
35 };
36 
37 
38 /* Supported events suitable for MASK parameter of INOTIFY_ADD_WATCH.  */
39 #define IN_ACCESS	 0x00000001	/* File was accessed.  */
40 #define IN_MODIFY	 0x00000002	/* File was modified.  */
41 #define IN_ATTRIB	 0x00000004	/* Metadata changed.  */
42 #define IN_CLOSE_WRITE	 0x00000008	/* Writtable file was closed.  */
43 #define IN_CLOSE_NOWRITE 0x00000010	/* Unwrittable file closed.  */
44 #define IN_CLOSE	 (IN_CLOSE_WRITE | IN_CLOSE_NOWRITE) /* Close.  */
45 #define IN_OPEN		 0x00000020	/* File was opened.  */
46 #define IN_MOVED_FROM	 0x00000040	/* File was moved from X.  */
47 #define IN_MOVED_TO      0x00000080	/* File was moved to Y.  */
48 #define IN_MOVE		 (IN_MOVED_FROM | IN_MOVED_TO) /* Moves.  */
49 #define IN_CREATE	 0x00000100	/* Subfile was created.  */
50 #define IN_DELETE	 0x00000200	/* Subfile was deleted.  */
51 #define IN_DELETE_SELF	 0x00000400	/* Self was deleted.  */
52 #define IN_MOVE_SELF	 0x00000800	/* Self was moved.  */
53 
54 /* Events sent by the kernel.  */
55 #define IN_UNMOUNT	 0x00002000	/* Backing fs was unmounted.  */
56 #define IN_Q_OVERFLOW	 0x00004000	/* Event queued overflowed.  */
57 #define IN_IGNORED	 0x00008000	/* File was ignored.  */
58 
59 /* Helper events.  */
60 #define IN_CLOSE	 (IN_CLOSE_WRITE | IN_CLOSE_NOWRITE)	/* Close.  */
61 #define IN_MOVE		 (IN_MOVED_FROM | IN_MOVED_TO)		/* Moves.  */
62 
63 /* Special flags.  */
64 #define IN_ONLYDIR	 0x01000000	/* Only watch the path if it is a
65 					   directory.  */
66 #define IN_DONT_FOLLOW	 0x02000000	/* Do not follow a sym link.  */
67 #define IN_EXCL_UNLINK	 0x04000000	/* Exclude events on unlinked
68 					   objects.  */
69 #define IN_MASK_CREATE	 0x10000000	/* Only create watches.  */
70 #define IN_MASK_ADD	 0x20000000	/* Add to the mask of an already
71 					   existing watch.  */
72 #define IN_ISDIR	 0x40000000	/* Event occurred against dir.  */
73 #define IN_ONESHOT	 0x80000000	/* Only send event once.  */
74 
75 /* All events which a program can wait on.  */
76 #define IN_ALL_EVENTS	 (IN_ACCESS | IN_MODIFY | IN_ATTRIB | IN_CLOSE_WRITE  \
77 			  | IN_CLOSE_NOWRITE | IN_OPEN | IN_MOVED_FROM	      \
78 			  | IN_MOVED_TO | IN_CREATE | IN_DELETE		      \
79 			  | IN_DELETE_SELF | IN_MOVE_SELF)
80 
81 
82 __BEGIN_DECLS
83 
84 /* Create and initialize inotify instance.  */
85 extern int inotify_init (void) __THROW;
86 
87 /* Create and initialize inotify instance.  */
88 extern int inotify_init1 (int __flags) __THROW;
89 
90 /* Add watch of object NAME to inotify instance FD.  Notify about
91    events specified by MASK.  */
92 extern int inotify_add_watch (int __fd, const char *__name, uint32_t __mask)
93   __THROW;
94 
95 /* Remove the watch specified by WD from the inotify instance FD.  */
96 extern int inotify_rm_watch (int __fd, int __wd) __THROW;
97 
98 __END_DECLS
99 
100 #endif /* sys/inotify.h */
101