s3: Modifications to generic notify structures to allow implementation of OneFS notify.
[nivanova/samba-autobuild/.git] / source3 / smbd / notify.c
1 /*
2    Unix SMB/CIFS implementation.
3    change notify handling
4    Copyright (C) Andrew Tridgell 2000
5    Copyright (C) Jeremy Allison 1994-1998
6    Copyright (C) Volker Lendecke 2007
7
8    This program is free software; you can redistribute it and/or modify
9    it under the terms of the GNU General Public License as published by
10    the Free Software Foundation; either version 3 of the License, or
11    (at your option) any later version.
12
13    This program is distributed in the hope that it will be useful,
14    but WITHOUT ANY WARRANTY; without even the implied warranty of
15    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16    GNU General Public License for more details.
17
18    You should have received a copy of the GNU General Public License
19    along with this program.  If not, see <http://www.gnu.org/licenses/>.
20 */
21
22 #include "includes.h"
23 #include "smbd/globals.h"
24
25 struct notify_change_request {
26         struct notify_change_request *prev, *next;
27         struct files_struct *fsp;       /* backpointer for cancel by mid */
28         struct smb_request *req;
29         uint32 filter;
30         uint32 max_param;
31         struct notify_mid_map *mid_map;
32         void *backend_data;
33 };
34
35 static void notify_fsp(files_struct *fsp, uint32 action, const char *name);
36
37 /*
38  * For NTCancel, we need to find the notify_change_request indexed by
39  * mid. Separate list here.
40  */
41
42 struct notify_mid_map {
43         struct notify_mid_map *prev, *next;
44         struct notify_change_request *req;
45         uint16 mid;
46 };
47
48 static bool notify_change_record_identical(struct notify_change *c1,
49                                         struct notify_change *c2)
50 {
51         /* Note this is deliberately case sensitive. */
52         if (c1->action == c2->action &&
53                         strcmp(c1->name, c2->name) == 0) {
54                 return True;
55         }
56         return False;
57 }
58
59 static bool notify_marshall_changes(int num_changes,
60                                 uint32 max_offset,
61                                 struct notify_change *changes,
62                                 prs_struct *ps)
63 {
64         int i;
65         UNISTR uni_name;
66
67         uni_name.buffer = NULL;
68
69         for (i=0; i<num_changes; i++) {
70                 struct notify_change *c;
71                 size_t namelen;
72                 uint32 u32_tmp; /* Temp arg to prs_uint32 to avoid
73                                  * signed/unsigned issues */
74
75                 /* Coalesce any identical records. */
76                 while (i+1 < num_changes &&
77                         notify_change_record_identical(&changes[i],
78                                                 &changes[i+1])) {
79                         i++;
80                 }
81
82                 c = &changes[i];
83
84                 if (!convert_string_allocate(NULL, CH_UNIX, CH_UTF16LE,
85                         c->name, strlen(c->name)+1, &uni_name.buffer,
86                         &namelen, True) || (uni_name.buffer == NULL)) {
87                         goto fail;
88                 }
89
90                 namelen -= 2;   /* Dump NULL termination */
91
92                 /*
93                  * Offset to next entry, only if there is one
94                  */
95
96                 u32_tmp = (i == num_changes-1) ? 0 : namelen + 12;
97                 if (!prs_uint32("offset", ps, 1, &u32_tmp)) goto fail;
98
99                 u32_tmp = c->action;
100                 if (!prs_uint32("action", ps, 1, &u32_tmp)) goto fail;
101
102                 u32_tmp = namelen;
103                 if (!prs_uint32("namelen", ps, 1, &u32_tmp)) goto fail;
104
105                 if (!prs_unistr("name", ps, 1, &uni_name)) goto fail;
106
107                 /*
108                  * Not NULL terminated, decrease by the 2 UCS2 \0 chars
109                  */
110                 prs_set_offset(ps, prs_offset(ps)-2);
111
112                 SAFE_FREE(uni_name.buffer);
113
114                 if (prs_offset(ps) > max_offset) {
115                         /* Too much data for client. */
116                         DEBUG(10, ("Client only wanted %d bytes, trying to "
117                                    "marshall %d bytes\n", (int)max_offset,
118                                    (int)prs_offset(ps)));
119                         return False;
120                 }
121         }
122
123         return True;
124
125  fail:
126         SAFE_FREE(uni_name.buffer);
127         return False;
128 }
129
130 /****************************************************************************
131  Setup the common parts of the return packet and send it.
132 *****************************************************************************/
133
134 static void change_notify_reply_packet(connection_struct *conn,
135                                        struct smb_request *req,
136                                        NTSTATUS error_code)
137 {
138         reply_outbuf(req, 18, 0);
139
140         if (!NT_STATUS_IS_OK(error_code)) {
141                 error_packet_set((char *)req->outbuf, 0, 0, error_code,
142                                  __LINE__,__FILE__);
143         }
144
145         show_msg((char *)req->outbuf);
146         if (!srv_send_smb(smbd_server_fd(), (char *)req->outbuf,
147                           req->encrypted, &req->pcd)) {
148                 exit_server_cleanly("change_notify_reply_packet: srv_send_smb "
149                                     "failed.");
150         }
151         TALLOC_FREE(req->outbuf);
152 }
153
154 void change_notify_reply(connection_struct *conn,
155                          struct smb_request *req, uint32 max_param,
156                          struct notify_change_buf *notify_buf)
157 {
158         prs_struct ps;
159
160         if (notify_buf->num_changes == -1) {
161                 change_notify_reply_packet(conn, req, NT_STATUS_OK);
162                 notify_buf->num_changes = 0;
163                 return;
164         }
165
166         prs_init_empty(&ps, NULL, MARSHALL);
167
168         if (!notify_marshall_changes(notify_buf->num_changes, max_param,
169                                         notify_buf->changes, &ps)) {
170                 /*
171                  * We exceed what the client is willing to accept. Send
172                  * nothing.
173                  */
174                 change_notify_reply_packet(conn, req, NT_STATUS_OK);
175                 goto done;
176         }
177
178         send_nt_replies(conn, req, NT_STATUS_OK, prs_data_p(&ps),
179                         prs_offset(&ps), NULL, 0);
180
181  done:
182         prs_mem_free(&ps);
183
184         TALLOC_FREE(notify_buf->changes);
185         notify_buf->num_changes = 0;
186 }
187
188 static void notify_callback(void *private_data, const struct notify_event *e)
189 {
190         files_struct *fsp = (files_struct *)private_data;
191         DEBUG(10, ("notify_callback called for %s\n", fsp->fsp_name));
192         notify_fsp(fsp, e->action, e->path);
193 }
194
195 NTSTATUS change_notify_create(struct files_struct *fsp, uint32 filter,
196                               bool recursive)
197 {
198         char *fullpath;
199         struct notify_entry e;
200         NTSTATUS status;
201
202         SMB_ASSERT(fsp->notify == NULL);
203
204         if (!(fsp->notify = TALLOC_ZERO_P(NULL, struct notify_change_buf))) {
205                 DEBUG(0, ("talloc failed\n"));
206                 return NT_STATUS_NO_MEMORY;
207         }
208
209         if (asprintf(&fullpath, "%s/%s", fsp->conn->connectpath,
210                      fsp->fsp_name) == -1) {
211                 DEBUG(0, ("asprintf failed\n"));
212                 return NT_STATUS_NO_MEMORY;
213         }
214
215         ZERO_STRUCT(e);
216         e.path = fullpath;
217         e.dir_fd = fsp->fh->fd;
218         e.dir_id = fsp->file_id;
219         e.filter = filter;
220         e.subdir_filter = 0;
221         if (recursive) {
222                 e.subdir_filter = filter;
223         }
224
225         status = notify_add(fsp->conn->notify_ctx, &e, notify_callback, fsp);
226         SAFE_FREE(fullpath);
227
228         return status;
229 }
230
231 NTSTATUS change_notify_add_request(struct smb_request *req,
232                                 uint32 max_param,
233                                 uint32 filter, bool recursive,
234                                 struct files_struct *fsp)
235 {
236         struct notify_change_request *request = NULL;
237         struct notify_mid_map *map = NULL;
238
239         DEBUG(10, ("change_notify_add_request: Adding request for %s: "
240                    "max_param = %d\n", fsp->fsp_name, (int)max_param));
241
242         if (!(request = talloc(NULL, struct notify_change_request))
243             || !(map = talloc(request, struct notify_mid_map))) {
244                 TALLOC_FREE(request);
245                 return NT_STATUS_NO_MEMORY;
246         }
247
248         request->mid_map = map;
249         map->req = request;
250
251         request->req = talloc_move(request, &req);
252         request->max_param = max_param;
253         request->filter = filter;
254         request->fsp = fsp;
255         request->backend_data = NULL;
256
257         DLIST_ADD_END(fsp->notify->requests, request,
258                       struct notify_change_request *);
259
260         map->mid = request->req->mid;
261         DLIST_ADD(notify_changes_by_mid, map);
262
263         /* Push the MID of this packet on the signing queue. */
264         srv_defer_sign_response(request->req->mid);
265
266         return NT_STATUS_OK;
267 }
268
269 static void change_notify_remove_request(struct notify_change_request *remove_req)
270 {
271         files_struct *fsp;
272         struct notify_change_request *req;
273
274         /*
275          * Paranoia checks, the fsp referenced must must have the request in
276          * its list of pending requests
277          */
278
279         fsp = remove_req->fsp;
280         SMB_ASSERT(fsp->notify != NULL);
281
282         for (req = fsp->notify->requests; req; req = req->next) {
283                 if (req == remove_req) {
284                         break;
285                 }
286         }
287
288         if (req == NULL) {
289                 smb_panic("notify_req not found in fsp's requests");
290         }
291
292         DLIST_REMOVE(fsp->notify->requests, req);
293         DLIST_REMOVE(notify_changes_by_mid, req->mid_map);
294         TALLOC_FREE(req);
295 }
296
297 /****************************************************************************
298  Delete entries by mid from the change notify pending queue. Always send reply.
299 *****************************************************************************/
300
301 void remove_pending_change_notify_requests_by_mid(uint16 mid)
302 {
303         struct notify_mid_map *map;
304
305         for (map = notify_changes_by_mid; map; map = map->next) {
306                 if (map->mid == mid) {
307                         break;
308                 }
309         }
310
311         if (map == NULL) {
312                 return;
313         }
314
315         change_notify_reply_packet(map->req->fsp->conn, map->req->req,
316                                    NT_STATUS_CANCELLED);
317         change_notify_remove_request(map->req);
318 }
319
320 /****************************************************************************
321  Delete entries by fnum from the change notify pending queue.
322 *****************************************************************************/
323
324 void remove_pending_change_notify_requests_by_fid(files_struct *fsp,
325                                                   NTSTATUS status)
326 {
327         if (fsp->notify == NULL) {
328                 return;
329         }
330
331         while (fsp->notify->requests != NULL) {
332                 change_notify_reply_packet(
333                         fsp->conn, fsp->notify->requests->req, status);
334                 change_notify_remove_request(fsp->notify->requests);
335         }
336 }
337
338 void notify_fname(connection_struct *conn, uint32 action, uint32 filter,
339                   const char *path)
340 {
341         char *fullpath;
342
343         if (path[0] == '.' && path[1] == '/') {
344                 path += 2;
345         }
346         if (asprintf(&fullpath, "%s/%s", conn->connectpath, path) == -1) {
347                 DEBUG(0, ("asprintf failed\n"));
348                 return;
349         }
350
351         notify_trigger(conn->notify_ctx, action, filter, fullpath);
352         SAFE_FREE(fullpath);
353 }
354
355 static void notify_fsp(files_struct *fsp, uint32 action, const char *name)
356 {
357         struct notify_change *change, *changes;
358         char *tmp;
359
360         if (fsp->notify == NULL) {
361                 /*
362                  * Nobody is waiting, don't queue
363                  */
364                 return;
365         }
366
367         /*
368          * Someone has triggered a notify previously, queue the change for
369          * later.
370          */
371
372         if ((fsp->notify->num_changes > 1000) || (name == NULL)) {
373                 /*
374                  * The real number depends on the client buf, just provide a
375                  * guard against a DoS here.
376                  */
377                 TALLOC_FREE(fsp->notify->changes);
378                 fsp->notify->num_changes = -1;
379                 return;
380         }
381
382         if (fsp->notify->num_changes == -1) {
383                 return;
384         }
385
386         if (!(changes = TALLOC_REALLOC_ARRAY(
387                       fsp->notify, fsp->notify->changes,
388                       struct notify_change, fsp->notify->num_changes+1))) {
389                 DEBUG(0, ("talloc_realloc failed\n"));
390                 return;
391         }
392
393         fsp->notify->changes = changes;
394
395         change = &(fsp->notify->changes[fsp->notify->num_changes]);
396
397         if (!(tmp = talloc_strdup(changes, name))) {
398                 DEBUG(0, ("talloc_strdup failed\n"));
399                 return;
400         }
401
402         string_replace(tmp, '/', '\\');
403         change->name = tmp;     
404
405         change->action = action;
406         fsp->notify->num_changes += 1;
407
408         if (fsp->notify->requests == NULL) {
409                 /*
410                  * Nobody is waiting, so don't send anything. The ot
411                  */
412                 return;
413         }
414
415         if (action == NOTIFY_ACTION_OLD_NAME) {
416                 /*
417                  * We have to send the two rename events in one reply. So hold
418                  * the first part back.
419                  */
420                 return;
421         }
422
423         /*
424          * Someone is waiting for the change, trigger the reply immediately.
425          *
426          * TODO: do we have to walk the lists of requests pending?
427          */
428
429         change_notify_reply(fsp->conn,
430                             fsp->notify->requests->req,
431                             fsp->notify->requests->max_param,
432                             fsp->notify);
433
434         change_notify_remove_request(fsp->notify->requests);
435 }
436
437 char *notify_filter_string(TALLOC_CTX *mem_ctx, uint32 filter)
438 {
439         char *result = NULL;
440
441         result = talloc_strdup(mem_ctx, "");
442
443         if (filter & FILE_NOTIFY_CHANGE_FILE_NAME)
444                 result = talloc_asprintf_append(result, "FILE_NAME|");
445         if (filter & FILE_NOTIFY_CHANGE_DIR_NAME)
446                 result = talloc_asprintf_append(result, "DIR_NAME|");
447         if (filter & FILE_NOTIFY_CHANGE_ATTRIBUTES)
448                 result = talloc_asprintf_append(result, "ATTRIBUTES|");
449         if (filter & FILE_NOTIFY_CHANGE_SIZE)
450                 result = talloc_asprintf_append(result, "SIZE|");
451         if (filter & FILE_NOTIFY_CHANGE_LAST_WRITE)
452                 result = talloc_asprintf_append(result, "LAST_WRITE|");
453         if (filter & FILE_NOTIFY_CHANGE_LAST_ACCESS)
454                 result = talloc_asprintf_append(result, "LAST_ACCESS|");
455         if (filter & FILE_NOTIFY_CHANGE_CREATION)
456                 result = talloc_asprintf_append(result, "CREATION|");
457         if (filter & FILE_NOTIFY_CHANGE_EA)
458                 result = talloc_asprintf_append(result, "EA|");
459         if (filter & FILE_NOTIFY_CHANGE_SECURITY)
460                 result = talloc_asprintf_append(result, "SECURITY|");
461         if (filter & FILE_NOTIFY_CHANGE_STREAM_NAME)
462                 result = talloc_asprintf_append(result, "STREAM_NAME|");
463         if (filter & FILE_NOTIFY_CHANGE_STREAM_SIZE)
464                 result = talloc_asprintf_append(result, "STREAM_SIZE|");
465         if (filter & FILE_NOTIFY_CHANGE_STREAM_WRITE)
466                 result = talloc_asprintf_append(result, "STREAM_WRITE|");
467
468         if (result == NULL) return NULL;
469         if (*result == '\0') return result;
470
471         result[strlen(result)-1] = '\0';
472         return result;
473 }
474
475 struct sys_notify_context *sys_notify_context_create(connection_struct *conn,
476                                                      TALLOC_CTX *mem_ctx, 
477                                                      struct event_context *ev)
478 {
479         struct sys_notify_context *ctx;
480
481         if (!(ctx = TALLOC_P(mem_ctx, struct sys_notify_context))) {
482                 DEBUG(0, ("talloc failed\n"));
483                 return NULL;
484         }
485
486         ctx->ev = ev;
487         ctx->conn = conn;
488         ctx->private_data = NULL;
489         return ctx;
490 }
491
492 NTSTATUS sys_notify_watch(struct sys_notify_context *ctx,
493                           struct notify_entry *e,
494                           void (*callback)(struct sys_notify_context *ctx, 
495                                            void *private_data,
496                                            struct notify_event *ev),
497                           void *private_data, void *handle)
498 {
499         return SMB_VFS_NOTIFY_WATCH(ctx->conn, ctx, e, callback, private_data,
500                                     handle);
501 }
502