2 * Server-side directory object management
4 * Copyright (C) 2005 Vitaliy Margolen
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.
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.
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., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
23 #include "wine/port.h"
29 #include <sys/types.h>
32 #define WIN32_NO_STATUS
42 #define HASH_SIZE 7 /* default hash size */
46 struct object obj
; /* object header */
49 static void object_type_dump( struct object
*obj
, int verbose
);
50 static struct object_type
*object_type_get_type( struct object
*obj
);
52 static const struct object_ops object_type_ops
=
54 sizeof(struct object_type
), /* size */
55 object_type_dump
, /* dump */
56 object_type_get_type
, /* get_type */
57 no_add_queue
, /* add_queue */
58 NULL
, /* remove_queue */
61 no_signal
, /* signal */
62 no_get_fd
, /* get_fd */
63 no_map_access
, /* map_access */
64 default_get_sd
, /* get_sd */
65 default_set_sd
, /* set_sd */
66 no_lookup_name
, /* lookup_name */
67 directory_link_name
, /* link_name */
68 default_unlink_name
, /* unlink_name */
69 no_open_file
, /* open_file */
70 no_kernel_obj_list
, /* get_kernel_obj_list */
71 no_close_handle
, /* close_handle */
72 no_destroy
/* destroy */
78 struct object obj
; /* object header */
79 struct namespace *entries
; /* directory's name space */
82 static void directory_dump( struct object
*obj
, int verbose
);
83 static struct object_type
*directory_get_type( struct object
*obj
);
84 static struct object
*directory_lookup_name( struct object
*obj
, struct unicode_str
*name
,
86 static void directory_destroy( struct object
*obj
);
88 static const struct object_ops directory_ops
=
90 sizeof(struct directory
), /* size */
91 directory_dump
, /* dump */
92 directory_get_type
, /* get_type */
93 no_add_queue
, /* add_queue */
94 NULL
, /* remove_queue */
97 no_signal
, /* signal */
98 no_get_fd
, /* get_fd */
99 default_fd_map_access
, /* map_access */
100 default_get_sd
, /* get_sd */
101 default_set_sd
, /* set_sd */
102 directory_lookup_name
, /* lookup_name */
103 directory_link_name
, /* link_name */
104 default_unlink_name
, /* unlink_name */
105 no_open_file
, /* open_file */
106 no_kernel_obj_list
, /* get_kernel_obj_list */
107 no_close_handle
, /* close_handle */
108 directory_destroy
/* destroy */
111 static struct directory
*root_directory
;
112 static struct directory
*dir_objtype
;
115 static void object_type_dump( struct object
*obj
, int verbose
)
117 fputs( "Object type\n", stderr
);
120 static struct object_type
*object_type_get_type( struct object
*obj
)
122 static const WCHAR name
[] = {'O','b','j','e','c','t','T','y','p','e'};
123 static const struct unicode_str str
= { name
, sizeof(name
) };
124 return get_object_type( &str
);
127 static void directory_dump( struct object
*obj
, int verbose
)
129 fputs( "Directory\n", stderr
);
132 static struct object_type
*directory_get_type( struct object
*obj
)
134 static const WCHAR name
[] = {'D','i','r','e','c','t','o','r','y'};
135 static const struct unicode_str str
= { name
, sizeof(name
) };
136 return get_object_type( &str
);
139 static struct object
*directory_lookup_name( struct object
*obj
, struct unicode_str
*name
,
142 struct directory
*dir
= (struct directory
*)obj
;
143 struct object
*found
;
144 struct unicode_str tmp
;
146 assert( obj
->ops
== &directory_ops
);
148 if (!name
) return NULL
; /* open the directory itself */
151 tmp
.len
= get_path_element( name
->str
, name
->len
);
153 if ((found
= find_object( dir
->entries
, &tmp
, attr
)))
155 /* Skip trailing \\ and move to the next element */
156 if (tmp
.len
< name
->len
)
158 tmp
.len
+= sizeof(WCHAR
);
159 name
->str
+= tmp
.len
/ sizeof(WCHAR
);
160 name
->len
-= tmp
.len
;
170 if (name
->str
) /* not the last element */
172 if (tmp
.len
== 0) /* Double backslash */
173 set_error( STATUS_OBJECT_NAME_INVALID
);
174 else if (tmp
.len
< name
->len
) /* Path still has backslashes */
175 set_error( STATUS_OBJECT_PATH_NOT_FOUND
);
180 int directory_link_name( struct object
*obj
, struct object_name
*name
, struct object
*parent
)
182 struct directory
*dir
= (struct directory
*)parent
;
184 if (parent
->ops
!= &directory_ops
)
186 set_error( STATUS_OBJECT_TYPE_MISMATCH
);
189 namespace_add( dir
->entries
, name
);
190 name
->parent
= grab_object( parent
);
194 static void directory_destroy( struct object
*obj
)
196 struct directory
*dir
= (struct directory
*)obj
;
197 assert( obj
->ops
== &directory_ops
);
198 free( dir
->entries
);
201 static struct directory
*create_directory( struct object
*root
, const struct unicode_str
*name
,
202 unsigned int attr
, unsigned int hash_size
,
203 const struct security_descriptor
*sd
)
205 struct directory
*dir
;
207 if ((dir
= create_named_object( root
, &directory_ops
, name
, attr
, sd
)) &&
208 get_error() != STATUS_OBJECT_NAME_EXISTS
)
210 if (!(dir
->entries
= create_namespace( hash_size
)))
212 release_object( dir
);
219 struct object
*get_root_directory(void)
221 return grab_object( root_directory
);
224 /* return a directory object for creating/opening some object; no access rights are required */
225 struct object
*get_directory_obj( struct process
*process
, obj_handle_t handle
)
227 return get_handle_obj( process
, handle
, 0, &directory_ops
);
230 /* retrieve an object type, creating it if needed */
231 struct object_type
*get_object_type( const struct unicode_str
*name
)
233 struct object_type
*type
;
235 if ((type
= create_named_object( &dir_objtype
->obj
, &object_type_ops
, name
, OBJ_OPENIF
, NULL
)))
237 if (get_error() != STATUS_OBJECT_NAME_EXISTS
)
240 make_object_static( &type
->obj
);
247 /* Global initialization */
249 static void create_session( unsigned int id
)
252 static const WCHAR dir_sessionsW
[] = {'S','e','s','s','i','o','n','s'};
253 static const WCHAR dir_bnolinksW
[] = {'B','N','O','L','I','N','K','S'};
254 static const WCHAR dir_bnoW
[] = {'B','a','s','e','N','a','m','e','d','O','b','j','e','c','t','s'};
255 static const WCHAR dir_dosdevicesW
[] = {'D','o','s','D','e','v','i','c','e','s'};
256 static const WCHAR dir_windowsW
[] = {'W','i','n','d','o','w','s'};
257 static const WCHAR dir_winstationsW
[] = {'W','i','n','d','o','w','S','t','a','t','i','o','n','s'};
258 static const struct unicode_str dir_sessions_str
= {dir_sessionsW
, sizeof(dir_sessionsW
)};
259 static const struct unicode_str dir_bnolinks_str
= {dir_bnolinksW
, sizeof(dir_bnolinksW
)};
260 static const struct unicode_str dir_bno_str
= {dir_bnoW
, sizeof(dir_bnoW
)};
261 static const struct unicode_str dir_dosdevices_str
= {dir_dosdevicesW
, sizeof(dir_dosdevicesW
)};
262 static const struct unicode_str dir_windows_str
= {dir_windowsW
, sizeof(dir_windowsW
)};
263 static const struct unicode_str dir_winstations_str
= {dir_winstationsW
, sizeof(dir_winstationsW
)};
266 static const WCHAR link_globalW
[] = {'G','l','o','b','a','l'};
267 static const WCHAR link_localW
[] = {'L','o','c','a','l'};
268 static const WCHAR link_sessionW
[] = {'S','e','s','s','i','o','n'};
269 static const struct unicode_str link_global_str
= {link_globalW
, sizeof(link_globalW
)};
270 static const struct unicode_str link_local_str
= {link_localW
, sizeof(link_localW
)};
271 static const struct unicode_str link_session_str
= {link_sessionW
, sizeof(link_sessionW
)};
273 static struct directory
*dir_bno_global
, *dir_sessions
, *dir_bnolinks
;
274 struct directory
*dir_id
, *dir_bno
, *dir_dosdevices
, *dir_windows
, *dir_winstation
;
275 struct object
*link_global
, *link_local
, *link_session
, *link_bno
, *link_windows
;
276 struct unicode_str id_str
;
282 dir_bno_global
= create_directory( &root_directory
->obj
, &dir_bno_str
, 0, HASH_SIZE
, NULL
);
283 dir_sessions
= create_directory( &root_directory
->obj
, &dir_sessions_str
, 0, HASH_SIZE
, NULL
);
284 dir_bnolinks
= create_directory( &dir_sessions
->obj
, &dir_bnolinks_str
, 0, HASH_SIZE
, NULL
);
285 make_object_static( (struct object
*)dir_bno_global
);
286 make_object_static( (struct object
*)dir_bnolinks
);
287 make_object_static( (struct object
*)dir_sessions
);
290 sprintf( id_strA
, "%u", id
);
291 id_strW
= ascii_to_unicode_str( id_strA
, &id_str
);
292 dir_id
= create_directory( &dir_sessions
->obj
, &id_str
, 0, HASH_SIZE
, NULL
);
293 dir_dosdevices
= create_directory( &dir_id
->obj
, &dir_dosdevices_str
, 0, HASH_SIZE
, NULL
);
295 /* for session 0, directories are created under the root */
298 dir_bno
= (struct directory
*)grab_object( dir_bno_global
);
299 dir_windows
= create_directory( &root_directory
->obj
, &dir_windows_str
, 0, HASH_SIZE
, NULL
);
300 link_bno
= create_obj_symlink( &dir_id
->obj
, &dir_bno_str
, 0, &dir_bno
->obj
, NULL
);
301 link_windows
= create_obj_symlink( &dir_id
->obj
, &dir_windows_str
, 0, &dir_windows
->obj
, NULL
);
302 make_object_static( link_bno
);
303 make_object_static( link_windows
);
307 /* use a larger hash table for this one since it can contain a lot of objects */
308 dir_bno
= create_directory( &dir_id
->obj
, &dir_bno_str
, 0, 37, NULL
);
309 dir_windows
= create_directory( &dir_id
->obj
, &dir_windows_str
, 0, HASH_SIZE
, NULL
);
311 dir_winstation
= create_directory( &dir_windows
->obj
, &dir_winstations_str
, 0, HASH_SIZE
, NULL
);
313 link_global
= create_obj_symlink( &dir_bno
->obj
, &link_global_str
, 0, &dir_bno_global
->obj
, NULL
);
314 link_local
= create_obj_symlink( &dir_bno
->obj
, &link_local_str
, 0, &dir_bno
->obj
, NULL
);
315 link_session
= create_obj_symlink( &dir_bno
->obj
, &link_session_str
, 0, &dir_bnolinks
->obj
, NULL
);
316 link_bno
= create_obj_symlink( &dir_bnolinks
->obj
, &id_str
, 0, &dir_bno
->obj
, NULL
);
317 make_object_static( link_global
);
318 make_object_static( link_local
);
319 make_object_static( link_session
);
320 make_object_static( link_bno
);
322 make_object_static( &dir_dosdevices
->obj
);
323 make_object_static( &dir_winstation
->obj
);
324 release_object( dir_windows
);
325 release_object( dir_bno
);
326 release_object( dir_id
);
330 void init_directories(void)
333 static const WCHAR dir_globalW
[] = {'?','?'};
334 static const WCHAR dir_driverW
[] = {'D','r','i','v','e','r'};
335 static const WCHAR dir_deviceW
[] = {'D','e','v','i','c','e'};
336 static const WCHAR dir_objtypeW
[] = {'O','b','j','e','c','t','T','y','p','e','s'};
337 static const WCHAR dir_kernelW
[] = {'K','e','r','n','e','l','O','b','j','e','c','t','s'};
338 static const struct unicode_str dir_global_str
= {dir_globalW
, sizeof(dir_globalW
)};
339 static const struct unicode_str dir_driver_str
= {dir_driverW
, sizeof(dir_driverW
)};
340 static const struct unicode_str dir_device_str
= {dir_deviceW
, sizeof(dir_deviceW
)};
341 static const struct unicode_str dir_objtype_str
= {dir_objtypeW
, sizeof(dir_objtypeW
)};
342 static const struct unicode_str dir_kernel_str
= {dir_kernelW
, sizeof(dir_kernelW
)};
345 static const WCHAR link_dosdevW
[] = {'D','o','s','D','e','v','i','c','e','s'};
346 static const WCHAR link_globalW
[] = {'G','l','o','b','a','l'};
347 static const WCHAR link_nulW
[] = {'N','U','L'};
348 static const WCHAR link_pipeW
[] = {'P','I','P','E'};
349 static const WCHAR link_mailslotW
[] = {'M','A','I','L','S','L','O','T'};
350 static const WCHAR link_coninW
[] = {'C','O','N','I','N','$'};
351 static const WCHAR link_conoutW
[] = {'C','O','N','O','U','T','$'};
352 static const WCHAR link_conW
[] = {'C','O','N'};
353 static const WCHAR link_currentinW
[] = {'\\','D','e','v','i','c','e','\\','C','o','n','D','r','v',
354 '\\','C','u','r','r','e','n','t','I','n'};
355 static const WCHAR link_currentoutW
[] = {'\\','D','e','v','i','c','e','\\','C','o','n','D','r','v',
356 '\\','C','u','r','r','e','n','t','O','u','t'};
357 static const WCHAR link_consoleW
[] = {'\\','D','e','v','i','c','e','\\','C','o','n','D','r','v',
358 '\\','C','o','n','s','o','l','e'};
359 static const struct unicode_str link_dosdev_str
= {link_dosdevW
, sizeof(link_dosdevW
)};
360 static const struct unicode_str link_global_str
= {link_globalW
, sizeof(link_globalW
)};
361 static const struct unicode_str link_nul_str
= {link_nulW
, sizeof(link_nulW
)};
362 static const struct unicode_str link_pipe_str
= {link_pipeW
, sizeof(link_pipeW
)};
363 static const struct unicode_str link_mailslot_str
= {link_mailslotW
, sizeof(link_mailslotW
)};
364 static const struct unicode_str link_con_str
= {link_conW
, sizeof(link_conW
)};
365 static const struct unicode_str link_conin_str
= {link_coninW
, sizeof(link_coninW
)};
366 static const struct unicode_str link_conout_str
= {link_conoutW
, sizeof(link_conoutW
)};
367 static const struct unicode_str link_currentin_str
= {link_currentinW
, sizeof(link_currentinW
)};
368 static const struct unicode_str link_currentout_str
= {link_currentoutW
, sizeof(link_currentoutW
)};
369 static const struct unicode_str link_console_str
= {link_consoleW
, sizeof(link_consoleW
)};
372 static const WCHAR named_pipeW
[] = {'N','a','m','e','d','P','i','p','e'};
373 static const WCHAR mailslotW
[] = {'M','a','i','l','S','l','o','t'};
374 static const WCHAR condrvW
[] = {'C','o','n','D','r','v'};
375 static const WCHAR nullW
[] = {'N','u','l','l'};
376 static const struct unicode_str named_pipe_str
= {named_pipeW
, sizeof(named_pipeW
)};
377 static const struct unicode_str mailslot_str
= {mailslotW
, sizeof(mailslotW
)};
378 static const struct unicode_str condrv_str
= {condrvW
, sizeof(condrvW
)};
379 static const struct unicode_str null_str
= {nullW
, sizeof(nullW
)};
382 static const WCHAR event_low_memW
[] = {'L','o','w','M','e','m','o','r','y','C','o','n','d','i','t','i','o','n'};
383 static const WCHAR event_low_pagedW
[] = {'L','o','w','P','a','g','e','d','P','o','o','l','C','o','n','d','i','t','i','o','n'};
384 static const WCHAR event_low_nonpgW
[] = {'L','o','w','N','o','n','P','a','g','e','d','P','o','o','l','C','o','n','d','i','t','i','o','n'};
385 static const WCHAR event_high_memW
[] = {'H','i','g','h','M','e','m','o','r','y','C','o','n','d','i','t','i','o','n'};
386 static const WCHAR event_high_pagedW
[] = {'H','i','g','h','P','a','g','e','d','P','o','o','l','C','o','n','d','i','t','i','o','n'};
387 static const WCHAR event_high_nonpgW
[] = {'H','i','g','h','N','o','n','P','a','g','e','d','P','o','o','l','C','o','n','d','i','t','i','o','n'};
388 static const WCHAR keyed_event_crit_sectW
[] = {'C','r','i','t','S','e','c','O','u','t','O','f','M','e','m','o','r','y','E','v','e','n','t'};
389 static const struct unicode_str kernel_events
[] =
391 { event_low_memW
, sizeof(event_low_memW
) },
392 { event_low_pagedW
, sizeof(event_low_pagedW
) },
393 { event_low_nonpgW
, sizeof(event_low_nonpgW
) },
394 { event_high_memW
, sizeof(event_high_memW
) },
395 { event_high_pagedW
, sizeof(event_high_pagedW
) },
396 { event_high_nonpgW
, sizeof(event_high_nonpgW
) }
398 static const struct unicode_str keyed_event_crit_sect_str
= {keyed_event_crit_sectW
, sizeof(keyed_event_crit_sectW
)};
401 static const WCHAR user_dataW
[] = {'_','_','w','i','n','e','_','u','s','e','r','_','s','h','a','r','e','d','_','d','a','t','a'};
402 static const struct unicode_str user_data_str
= {user_dataW
, sizeof(user_dataW
)};
404 struct directory
*dir_driver
, *dir_device
, *dir_global
, *dir_kernel
;
405 struct object
*link_dosdev
, *link_global
, *link_nul
, *link_pipe
, *link_mailslot
;
406 struct object
*link_conin
, *link_conout
, *link_con
;
407 struct object
*named_pipe_device
, *mailslot_device
, *null_device
, *user_data_mapping
, *console_device
;
408 struct keyed_event
*keyed_event
;
411 root_directory
= create_directory( NULL
, NULL
, 0, HASH_SIZE
, NULL
);
412 dir_driver
= create_directory( &root_directory
->obj
, &dir_driver_str
, 0, HASH_SIZE
, NULL
);
413 dir_device
= create_directory( &root_directory
->obj
, &dir_device_str
, 0, HASH_SIZE
, NULL
);
414 dir_objtype
= create_directory( &root_directory
->obj
, &dir_objtype_str
, 0, HASH_SIZE
, NULL
);
415 dir_kernel
= create_directory( &root_directory
->obj
, &dir_kernel_str
, 0, HASH_SIZE
, NULL
);
416 dir_global
= create_directory( &root_directory
->obj
, &dir_global_str
, 0, HASH_SIZE
, NULL
);
417 make_object_static( &root_directory
->obj
);
418 make_object_static( &dir_driver
->obj
);
419 make_object_static( &dir_objtype
->obj
);
422 named_pipe_device
= create_named_pipe_device( &dir_device
->obj
, &named_pipe_str
);
423 mailslot_device
= create_mailslot_device( &dir_device
->obj
, &mailslot_str
);
424 console_device
= create_console_device( &dir_device
->obj
, &condrv_str
);
425 null_device
= create_unix_device( &dir_device
->obj
, &null_str
, "/dev/null" );
426 make_object_static( named_pipe_device
);
427 make_object_static( mailslot_device
);
428 make_object_static( null_device
);
429 make_object_static( console_device
);
436 link_dosdev
= create_obj_symlink( &root_directory
->obj
, &link_dosdev_str
, 0, &dir_global
->obj
, NULL
);
437 link_global
= create_obj_symlink( &dir_global
->obj
, &link_global_str
, 0, &dir_global
->obj
, NULL
);
438 link_nul
= create_obj_symlink( &dir_global
->obj
, &link_nul_str
, 0, null_device
, NULL
);
439 link_pipe
= create_obj_symlink( &dir_global
->obj
, &link_pipe_str
, 0, named_pipe_device
, NULL
);
440 link_mailslot
= create_obj_symlink( &dir_global
->obj
, &link_mailslot_str
, 0, mailslot_device
, NULL
);
441 link_conin
= create_symlink( &dir_global
->obj
, &link_conin_str
, 0, &link_currentin_str
, NULL
);
442 link_conout
= create_symlink( &dir_global
->obj
, &link_conout_str
, 0, &link_currentout_str
, NULL
);
443 link_con
= create_symlink( &dir_global
->obj
, &link_con_str
, 0, &link_console_str
, NULL
);
444 make_object_static( link_dosdev
);
445 make_object_static( link_global
);
446 make_object_static( link_nul
);
447 make_object_static( link_pipe
);
448 make_object_static( link_mailslot
);
449 make_object_static( link_conin
);
450 make_object_static( link_conout
);
451 make_object_static( link_con
);
454 for (i
= 0; i
< ARRAY_SIZE( kernel_events
); i
++)
456 struct event
*event
= create_event( &dir_kernel
->obj
, &kernel_events
[i
], 0, 1, 0, NULL
);
457 make_object_static( (struct object
*)event
);
459 keyed_event
= create_keyed_event( &dir_kernel
->obj
, &keyed_event_crit_sect_str
, 0, NULL
);
460 make_object_static( (struct object
*)keyed_event
);
462 /* user data mapping */
463 user_data_mapping
= create_user_data_mapping( &dir_kernel
->obj
, &user_data_str
, 0, NULL
);
464 make_object_static( user_data_mapping
);
466 /* the objects hold references so we can release these directories */
467 release_object( dir_global
);
468 release_object( dir_device
);
469 release_object( dir_kernel
);
472 /* create a directory object */
473 DECL_HANDLER(create_directory
)
475 struct unicode_str name
;
477 struct directory
*dir
;
478 const struct security_descriptor
*sd
;
479 const struct object_attributes
*objattr
= get_req_object_attributes( &sd
, &name
, &root
);
481 if (!objattr
) return;
483 if ((dir
= create_directory( root
, &name
, objattr
->attributes
, HASH_SIZE
, sd
)))
485 reply
->handle
= alloc_handle( current
->process
, dir
, req
->access
, objattr
->attributes
);
486 release_object( dir
);
489 if (root
) release_object( root
);
492 /* open a directory object */
493 DECL_HANDLER(open_directory
)
495 struct unicode_str name
= get_req_unicode_str();
497 reply
->handle
= open_object( current
->process
, req
->rootdir
, req
->access
,
498 &directory_ops
, &name
, req
->attributes
);
501 /* get a directory entry by index */
502 DECL_HANDLER(get_directory_entry
)
504 struct directory
*dir
= (struct directory
*)get_handle_obj( current
->process
, req
->handle
,
505 DIRECTORY_QUERY
, &directory_ops
);
508 struct object
*obj
= find_object_index( dir
->entries
, req
->index
);
511 data_size_t name_len
, type_len
= 0;
512 const WCHAR
*type_name
= NULL
;
513 const WCHAR
*name
= get_object_name( obj
, &name_len
);
514 struct object_type
*type
= obj
->ops
->get_type( obj
);
516 if (type
) type_name
= get_object_name( &type
->obj
, &type_len
);
518 if (name_len
+ type_len
<= get_reply_max_size())
520 void *ptr
= set_reply_data_size( name_len
+ type_len
);
523 reply
->name_len
= name_len
;
524 memcpy( ptr
, name
, name_len
);
525 memcpy( (char *)ptr
+ name_len
, type_name
, type_len
);
528 else set_error( STATUS_BUFFER_OVERFLOW
);
530 if (type
) release_object( type
);
531 release_object( obj
);
533 release_object( dir
);
537 /* query object type name information */
538 DECL_HANDLER(get_object_type
)
541 struct object_type
*type
;
544 if (!(obj
= get_handle_obj( current
->process
, req
->handle
, 0, NULL
))) return;
546 if ((type
= obj
->ops
->get_type( obj
)))
548 if ((name
= get_object_name( &type
->obj
, &reply
->total
)))
549 set_reply_data( name
, min( reply
->total
, get_reply_max_size() ) );
550 release_object( type
);
552 release_object( obj
);