Make dump functions const.
[wine] / server / change.c
1 /*
2  * Server-side change notification management
3  *
4  * Copyright (C) 1998 Alexandre Julliard
5  *
6  * This library is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU Lesser General Public
8  * License as published by the Free Software Foundation; either
9  * version 2.1 of the License, or (at your option) any later version.
10  *
11  * This library is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14  * Lesser General Public License for more details.
15  *
16  * You should have received a copy of the GNU Lesser General Public
17  * License along with this library; if not, write to the Free Software
18  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
19  */
20
21 #include "config.h"
22 #include "wine/port.h"
23
24 #include <assert.h>
25 #include <fcntl.h>
26 #include <stdio.h>
27 #include <stdlib.h>
28 #include <signal.h>
29 #include <sys/stat.h>
30
31 #include "ntstatus.h"
32 #define WIN32_NO_STATUS
33 #include "windef.h"
34
35 #include "file.h"
36 #include "handle.h"
37 #include "thread.h"
38 #include "request.h"
39 #include "winternl.h"
40
41 #ifdef linux
42 #ifndef F_NOTIFY
43 #define F_NOTIFY 1026
44 #define DN_ACCESS       0x00000001      /* File accessed */
45 #define DN_MODIFY       0x00000002      /* File modified */
46 #define DN_CREATE       0x00000004      /* File created */
47 #define DN_DELETE       0x00000008      /* File removed */
48 #define DN_RENAME       0x00000010      /* File renamed */
49 #define DN_ATTRIB       0x00000020      /* File changed attibutes */
50 #define DN_MULTISHOT    0x80000000      /* Don't remove notifier */
51 #endif
52 #endif
53
54 struct change
55 {
56     struct object  obj;      /* object header */
57     struct fd     *fd;       /* file descriptor to the directory */
58     struct list    entry;    /* entry in global change notifications list */
59     int            subtree;  /* watch all the subtree */
60     unsigned int   filter;   /* notification filter */
61     int            notified; /* SIGIO counter */
62     long           signaled; /* the file changed */
63 };
64
65 static void change_dump( struct object *obj, int verbose );
66 static int change_signaled( struct object *obj, struct thread *thread );
67 static void change_destroy( struct object *obj );
68
69 static const struct object_ops change_ops =
70 {
71     sizeof(struct change),    /* size */
72     change_dump,              /* dump */
73     add_queue,                /* add_queue */
74     remove_queue,             /* remove_queue */
75     change_signaled,          /* signaled */
76     no_satisfied,             /* satisfied */
77     no_signal,                /* signal */
78     no_get_fd,                /* get_fd */
79     no_lookup_name,           /* lookup_name */
80     no_close_handle,          /* close_handle */
81     change_destroy            /* destroy */
82 };
83
84 static struct list change_list = LIST_INIT(change_list);
85
86 static void adjust_changes( int fd, unsigned int filter )
87 {
88 #if defined(F_SETSIG) && defined(F_NOTIFY)
89     unsigned int val;
90     if ( 0 > fcntl( fd, F_SETSIG, SIGIO) )
91         return;
92
93     val = DN_MULTISHOT;
94     if (filter & FILE_NOTIFY_CHANGE_FILE_NAME)
95         val |= DN_RENAME | DN_DELETE | DN_CREATE;
96     if (filter & FILE_NOTIFY_CHANGE_DIR_NAME)
97         val |= DN_RENAME | DN_DELETE | DN_CREATE;
98     if (filter & FILE_NOTIFY_CHANGE_ATTRIBUTES)
99         val |= DN_ATTRIB;
100     if (filter & FILE_NOTIFY_CHANGE_SIZE)
101         val |= DN_MODIFY;
102     if (filter & FILE_NOTIFY_CHANGE_LAST_WRITE)
103         val |= DN_MODIFY;
104     if (filter & FILE_NOTIFY_CHANGE_LAST_ACCESS)
105         val |= DN_ACCESS;
106     if (filter & FILE_NOTIFY_CHANGE_CREATION)
107         val |= DN_CREATE;
108     if (filter & FILE_NOTIFY_CHANGE_SECURITY)
109         val |= DN_ATTRIB;
110     fcntl( fd, F_NOTIFY, val );
111 #endif
112 }
113
114 /* insert change in the global list */
115 static inline void insert_change( struct change *change )
116 {
117     sigset_t sigset;
118
119     sigemptyset( &sigset );
120     sigaddset( &sigset, SIGIO );
121     sigprocmask( SIG_BLOCK, &sigset, NULL );
122     list_add_head( &change_list, &change->entry );
123     sigprocmask( SIG_UNBLOCK, &sigset, NULL );
124 }
125
126 /* remove change from the global list */
127 static inline void remove_change( struct change *change )
128 {
129     sigset_t sigset;
130
131     sigemptyset( &sigset );
132     sigaddset( &sigset, SIGIO );
133     sigprocmask( SIG_BLOCK, &sigset, NULL );
134     list_remove( &change->entry );
135     sigprocmask( SIG_UNBLOCK, &sigset, NULL );
136 }
137
138 static struct change *create_change_notification( struct fd *fd, int subtree, unsigned int filter )
139 {
140     struct change *change;
141     struct stat st;
142     int unix_fd = get_unix_fd( fd );
143
144     if (unix_fd == -1) return NULL;
145
146     if (fstat( unix_fd, &st ) == -1 || !S_ISDIR(st.st_mode))
147     {
148         set_error( STATUS_NOT_A_DIRECTORY );
149         return NULL;
150     }
151
152     if ((change = alloc_object( &change_ops )))
153     {
154         change->fd       = (struct fd *)grab_object( fd );
155         change->subtree  = subtree;
156         change->filter   = filter;
157         change->notified = 0;
158         change->signaled = 0;
159         insert_change( change );
160         adjust_changes( unix_fd, filter );
161     }
162     return change;
163 }
164
165 static void change_dump( struct object *obj, int verbose )
166 {
167     struct change *change = (struct change *)obj;
168     assert( obj->ops == &change_ops );
169     fprintf( stderr, "Change notification fd=%p sub=%d filter=%08x\n",
170              change->fd, change->subtree, change->filter );
171 }
172
173 static int change_signaled( struct object *obj, struct thread *thread )
174 {
175     struct change *change = (struct change *)obj;
176
177     return change->signaled != 0;
178 }
179
180 static void change_destroy( struct object *obj )
181 {
182     struct change *change = (struct change *)obj;
183
184     release_object( change->fd );
185     remove_change( change );
186 }
187
188 /* enter here directly from SIGIO signal handler */
189 void do_change_notify( int unix_fd )
190 {
191     struct list *ptr;
192
193     /* FIXME: this is O(n) ... probably can be improved */
194     LIST_FOR_EACH( ptr, &change_list )
195     {
196         struct change *change = LIST_ENTRY( ptr, struct change, entry );
197         if (get_unix_fd( change->fd ) != unix_fd) continue;
198         interlocked_xchg_add( &change->notified, 1 );
199         break;
200     }
201 }
202
203 /* SIGIO callback, called synchronously with the poll loop */
204 void sigio_callback(void)
205 {
206     struct list *ptr;
207
208     LIST_FOR_EACH( ptr, &change_list )
209     {
210         struct change *change = LIST_ENTRY( ptr, struct change, entry );
211         long count = interlocked_xchg( &change->notified, 0 );
212         if (count)
213         {
214             change->signaled += count;
215             if (change->signaled == count)  /* was it 0? */
216                 wake_up( &change->obj, 0 );
217         }
218     }
219 }
220
221 /* create a change notification */
222 DECL_HANDLER(create_change_notification)
223 {
224     struct change *change;
225     struct file *file;
226     struct fd *fd;
227
228     if (!(file = get_file_obj( current->process, req->handle, 0 ))) return;
229     fd = get_obj_fd( (struct object *)file );
230     release_object( file );
231     if (!fd) return;
232
233     if ((change = create_change_notification( fd, req->subtree, req->filter )))
234     {
235         reply->handle = alloc_handle( current->process, change,
236                                       STANDARD_RIGHTS_REQUIRED|SYNCHRONIZE, 0 );
237         release_object( change );
238     }
239     release_object( fd );
240 }
241
242 /* move to the next change notification */
243 DECL_HANDLER(next_change_notification)
244 {
245     struct change *change;
246
247     if ((change = (struct change *)get_handle_obj( current->process, req->handle,
248                                                    0, &change_ops )))
249     {
250         if (change->signaled > 0) change->signaled--;
251         release_object( change );
252     }
253 }