1/* Copyright (C) 2005, 2006 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, write to the Free
16   Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
17   02111-1307 USA.  */
18
19#ifndef	_SYS_INOTIFY_H
20#define	_SYS_INOTIFY_H	1
21
22#include <stdint.h>
23
24
25/* Structure describing an inotify event.  */
26struct inotify_event
27{
28  int wd;		/* Watch descriptor.  */
29  uint32_t mask;	/* Watch mask.  */
30  uint32_t cookie;	/* Cookie to synchronize two events.  */
31  uint32_t len;		/* Length (including NULs) of name.  */
32  char name __flexarr;	/* Name.  */
33};
34
35
36/* Supported events suitable for MASK parameter of INOTIFY_ADD_WATCH.  */
37#define IN_ACCESS	 0x00000001	/* File was accessed.  */
38#define IN_MODIFY	 0x00000002	/* File was modified.  */
39#define IN_ATTRIB	 0x00000004	/* Metadata changed.  */
40#define IN_CLOSE_WRITE	 0x00000008	/* Writtable file was closed.  */
41#define IN_CLOSE_NOWRITE 0x00000010	/* Unwrittable file closed.  */
42#define IN_CLOSE	 (IN_CLOSE_WRITE | IN_CLOSE_NOWRITE) /* Close.  */
43#define IN_OPEN		 0x00000020	/* File was opened.  */
44#define IN_MOVED_FROM	 0x00000040	/* File was moved from X.  */
45#define IN_MOVED_TO      0x00000080	/* File was moved to Y.  */
46#define IN_MOVE		 (IN_MOVED_FROM | IN_MOVED_TO) /* Moves.  */
47#define IN_CREATE	 0x00000100	/* Subfile was created.  */
48#define IN_DELETE	 0x00000200	/* Subfile was deleted.  */
49#define IN_DELETE_SELF	 0x00000400	/* Self was deleted.  */
50#define IN_MOVE_SELF	 0x00000800	/* Self was moved.  */
51
52/* Events sent by the kernel.  */
53#define IN_UNMOUNT	 0x00002000	/* Backing fs was unmounted.  */
54#define IN_Q_OVERFLOW	 0x00004000	/* Event queued overflowed.  */
55#define IN_IGNORED	 0x00008000	/* File was ignored.  */
56
57/* Helper events.  */
58#define IN_CLOSE	 (IN_CLOSE_WRITE | IN_CLOSE_NOWRITE)	/* Close.  */
59#define IN_MOVE		 (IN_MOVED_FROM | IN_MOVED_TO)		/* Moves.  */
60
61/* Special flags.  */
62#define IN_ONLYDIR	 0x01000000	/* Only watch the path if it is a
63					   directory.  */
64#define IN_DONT_FOLLOW	 0x02000000	/* Do not follow a sym link.  */
65#define IN_MASK_ADD	 0x20000000	/* Add to the mask of an already
66					   existing watch.  */
67#define IN_ISDIR	 0x40000000	/* Event occurred against dir.  */
68#define IN_ONESHOT	 0x80000000	/* Only send event once.  */
69
70/* All events which a program can wait on.  */
71#define IN_ALL_EVENTS	 (IN_ACCESS | IN_MODIFY | IN_ATTRIB | IN_CLOSE_WRITE  \
72			  | IN_CLOSE_NOWRITE | IN_OPEN | IN_MOVED_FROM	      \
73			  | IN_MOVED_TO | IN_CREATE | IN_DELETE		      \
74			  | IN_DELETE_SELF | IN_MOVE_SELF)
75
76
77__BEGIN_DECLS
78
79/* Create and initialize inotify instance.  */
80extern int inotify_init (void) __THROW;
81
82/* Add watch of object NAME to inotify instance FD.  Notify about
83   events specified by MASK.  */
84extern int inotify_add_watch (int __fd, const char *__name, uint32_t __mask)
85  __THROW;
86
87/* Remove the watch specified by WD from the inotify instance FD.  */
88extern int inotify_rm_watch (int __fd, uint32_t __wd) __THROW;
89
90__END_DECLS
91
92#endif /* sys/inotify.h */
93