server/directory.c

   1 /*
   2  * Server-side directory object management
   3  *
   4  * Copyright (C) 2005 Vitaliy Margolen
   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., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
  19  *
  20  */
  21
  22 #include "config.h"
  23 #include "wine/port.h"
  24
  25 #include <assert.h>
  26 #include <stdarg.h>
  27 #include <stdlib.h>
  28 #include <stdio.h>
  29 #include <sys/types.h>
  30
  31 #include "ntstatus.h"
  32 #define WIN32_NO_STATUS
  33 #include "winternl.h"
  34 #include "ddk/wdm.h"
  35
  36 #include "handle.h"
  37 #include "request.h"
  38 #include "process.h"
  39 #include "file.h"
  40 #include "unicode.h"
  41
  42 #define HASH_SIZE 7  /* default hash size */
  43
  44 struct object_type
  45 {
  46     struct object     obj;        /* object header */
  47 };
  48
  49 static void object_type_dump( struct object *obj, int verbose );
  50 static struct object_type *object_type_get_type( struct object *obj );
  51
  52 static const struct object_ops object_type_ops =
  53 {
  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 */
  59     NULL,                         /* signaled */
  60     NULL,                         /* satisfied */
  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 */
  73 };
  74
  75
  76 struct directory
  77 {
  78     struct object     obj;        /* object header */
  79     struct namespace *entries;    /* directory's name space */
  80 };
  81
  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,
  85                                              unsigned int attr );
  86 static void directory_destroy( struct object *obj );
  87
  88 static const struct object_ops directory_ops =
  89 {
  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 */
  95     NULL,                         /* signaled */
  96     NULL,                         /* satisfied */
  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 */
 109 };
 110
 111 static struct directory *root_directory;
 112 static struct directory *dir_objtype;
 113
 114
 115 static void object_type_dump( struct object *obj, int verbose )
 116 {
 117     fputs( "Object type\n", stderr );
 118 }
 119
 120 static struct object_type *object_type_get_type( struct object *obj )
 121 {
 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 );
 125 }
 126
 127 static void directory_dump( struct object *obj, int verbose )
 128 {
 129     fputs( "Directory\n", stderr );
 130 }
 131
 132 static struct object_type *directory_get_type( struct object *obj )
 133 {
 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 );
 137 }
 138
 139 static struct object *directory_lookup_name( struct object *obj, struct unicode_str *name,
 140                                              unsigned int attr )
 141 {
 142     struct directory *dir = (struct directory *)obj;
 143     struct object *found;
 144     struct unicode_str tmp;
 145     const WCHAR *p;
 146
 147     assert( obj->ops == &directory_ops );
 148
 149     if (!name) return NULL;  /* open the directory itself */
 150
 151     if (!(p = memchrW( name->str, '\\', name->len / sizeof(WCHAR) )))
 152         /* Last element in the path name */
 153         tmp.len = name->len;
 154     else
 155         tmp.len = (p - name->str) * sizeof(WCHAR);
 156
 157     tmp.str = name->str;
 158     if ((found = find_object( dir->entries, &tmp, attr )))
 159     {
 160         /* Skip trailing \\ */
 161         if (p)
 162         {
 163             p++;
 164             tmp.len += sizeof(WCHAR);
 165         }
 166         /* Move to the next element*/
 167         name->str = p;
 168         name->len -= tmp.len;
 169         return found;
 170     }
 171
 172     if (name->str)  /* not the last element */
 173     {
 174         if (tmp.len == 0) /* Double backslash */
 175             set_error( STATUS_OBJECT_NAME_INVALID );
 176         else if (p)  /* Path still has backslashes */
 177             set_error( STATUS_OBJECT_PATH_NOT_FOUND );
 178     }
 179     return NULL;
 180 }
 181
 182 int directory_link_name( struct object *obj, struct object_name *name, struct object *parent )
 183 {
 184     struct directory *dir = (struct directory *)parent;
 185
 186     if (parent->ops != &directory_ops)
 187     {
 188         set_error( STATUS_OBJECT_TYPE_MISMATCH );
 189         return 0;
 190     }
 191     namespace_add( dir->entries, name );
 192     name->parent = grab_object( parent );
 193     return 1;
 194 }
 195
 196 static void directory_destroy( struct object *obj )
 197 {
 198     struct directory *dir = (struct directory *)obj;
 199     assert( obj->ops == &directory_ops );
 200     free( dir->entries );
 201 }
 202
 203 static struct directory *create_directory( struct object *root, const struct unicode_str *name,
 204                                            unsigned int attr, unsigned int hash_size,
 205                                            const struct security_descriptor *sd )
 206 {
 207     struct directory *dir;
 208
 209     if ((dir = create_named_object( root, &directory_ops, name, attr, sd )) &&
 210         get_error() != STATUS_OBJECT_NAME_EXISTS)
 211     {
 212         if (!(dir->entries = create_namespace( hash_size )))
 213         {
 214             release_object( dir );
 215             return NULL;
 216         }
 217     }
 218     return dir;
 219 }
 220
 221 struct object *get_root_directory(void)
 222 {
 223     return grab_object( root_directory );
 224 }
 225
 226 /* return a directory object for creating/opening some object; no access rights are required */
 227 struct object *get_directory_obj( struct process *process, obj_handle_t handle )
 228 {
 229     return get_handle_obj( process, handle, 0, &directory_ops );
 230 }
 231
 232 /* retrieve an object type, creating it if needed */
 233 struct object_type *get_object_type( const struct unicode_str *name )
 234 {
 235     struct object_type *type;
 236
 237     if ((type = create_named_object( &dir_objtype->obj, &object_type_ops, name, OBJ_OPENIF, NULL )))
 238     {
 239         if (get_error() != STATUS_OBJECT_NAME_EXISTS)
 240         {
 241             grab_object( type );
 242             make_object_static( &type->obj );
 243         }
 244         clear_error();
 245     }
 246     return type;
 247 }
 248
 249 /* Global initialization */
 250
 251 static void create_session( unsigned int id )
 252 {
 253     /* directories */
 254     static const WCHAR dir_sessionsW[] = {'S','e','s','s','i','o','n','s'};
 255     static const WCHAR dir_bnolinksW[] = {'B','N','O','L','I','N','K','S'};
 256     static const WCHAR dir_bnoW[] = {'B','a','s','e','N','a','m','e','d','O','b','j','e','c','t','s'};
 257     static const WCHAR dir_dosdevicesW[] = {'D','o','s','D','e','v','i','c','e','s'};
 258     static const WCHAR dir_windowsW[] = {'W','i','n','d','o','w','s'};
 259     static const WCHAR dir_winstationsW[] = {'W','i','n','d','o','w','S','t','a','t','i','o','n','s'};
 260     static const struct unicode_str dir_sessions_str = {dir_sessionsW, sizeof(dir_sessionsW)};
 261     static const struct unicode_str dir_bnolinks_str = {dir_bnolinksW, sizeof(dir_bnolinksW)};
 262     static const struct unicode_str dir_bno_str = {dir_bnoW, sizeof(dir_bnoW)};
 263     static const struct unicode_str dir_dosdevices_str = {dir_dosdevicesW, sizeof(dir_dosdevicesW)};
 264     static const struct unicode_str dir_windows_str = {dir_windowsW, sizeof(dir_windowsW)};
 265     static const struct unicode_str dir_winstations_str = {dir_winstationsW, sizeof(dir_winstationsW)};
 266
 267     /* symlinks */
 268     static const WCHAR link_globalW[] = {'G','l','o','b','a','l'};
 269     static const WCHAR link_localW[]  = {'L','o','c','a','l'};
 270     static const WCHAR link_sessionW[] = {'S','e','s','s','i','o','n'};
 271     static const struct unicode_str link_global_str = {link_globalW, sizeof(link_globalW)};
 272     static const struct unicode_str link_local_str = {link_localW, sizeof(link_localW)};
 273     static const struct unicode_str link_session_str = {link_sessionW, sizeof(link_sessionW)};
 274
 275     static const WCHAR fmt_u[] = {'%','u',0};
 276     static struct directory *dir_bno_global, *dir_sessions, *dir_bnolinks;
 277     struct directory *dir_id, *dir_bno, *dir_dosdevices, *dir_windows, *dir_winstation;
 278     struct object *link_global, *link_local, *link_session, *link_bno, *link_windows;
 279     struct unicode_str id_str;
 280     WCHAR id_strW[10];
 281
 282     if (!id)
 283     {
 284         dir_bno_global = create_directory( &root_directory->obj, &dir_bno_str, 0, HASH_SIZE, NULL );
 285         dir_sessions   = create_directory( &root_directory->obj, &dir_sessions_str, 0, HASH_SIZE, NULL );
 286         dir_bnolinks   = create_directory( &dir_sessions->obj, &dir_bnolinks_str, 0, HASH_SIZE, NULL );
 287         make_object_static( (struct object *)dir_bno_global );
 288         make_object_static( (struct object *)dir_bnolinks );
 289         make_object_static( (struct object *)dir_sessions );
 290     }
 291
 292     sprintfW( id_strW, fmt_u, id );
 293     id_str.str = id_strW;
 294     id_str.len = strlenW( id_strW ) * sizeof(WCHAR);
 295     dir_id = create_directory( &dir_sessions->obj, &id_str, 0, HASH_SIZE, NULL );
 296     dir_dosdevices = create_directory( &dir_id->obj, &dir_dosdevices_str, 0, HASH_SIZE, NULL );
 297
 298     /* for session 0, directories are created under the root */
 299     if (!id)
 300     {
 301         dir_bno      = (struct directory *)grab_object( dir_bno_global );
 302         dir_windows  = create_directory( &root_directory->obj, &dir_windows_str, 0, HASH_SIZE, NULL );
 303         link_bno     = create_obj_symlink( &dir_id->obj, &dir_bno_str, 0, &dir_bno->obj, NULL );
 304         link_windows = create_obj_symlink( &dir_id->obj, &dir_windows_str, 0, &dir_windows->obj, NULL );
 305         make_object_static( link_bno );
 306         make_object_static( link_windows );
 307     }
 308     else
 309     {
 310         /* use a larger hash table for this one since it can contain a lot of objects */
 311         dir_bno     = create_directory( &dir_id->obj, &dir_bno_str, 0, 37, NULL );
 312         dir_windows = create_directory( &dir_id->obj, &dir_windows_str, 0, HASH_SIZE, NULL );
 313     }
 314     dir_winstation = create_directory( &dir_windows->obj, &dir_winstations_str, 0, HASH_SIZE, NULL );
 315
 316     link_global  = create_obj_symlink( &dir_bno->obj, &link_global_str, 0, &dir_bno_global->obj, NULL );
 317     link_local   = create_obj_symlink( &dir_bno->obj, &link_local_str, 0, &dir_bno->obj, NULL );
 318     link_session = create_obj_symlink( &dir_bno->obj, &link_session_str, 0, &dir_bnolinks->obj, NULL );
 319     link_bno     = create_obj_symlink( &dir_bnolinks->obj, &id_str, 0, &dir_bno->obj, NULL );
 320     make_object_static( link_global );
 321     make_object_static( link_local );
 322     make_object_static( link_session );
 323     make_object_static( link_bno );
 324
 325     make_object_static( &dir_dosdevices->obj );
 326     make_object_static( &dir_winstation->obj );
 327     release_object( dir_windows );
 328     release_object( dir_bno );
 329     release_object( dir_id );
 330 }
 331
 332 void init_directories(void)
 333 {
 334     /* Directories */
 335     static const WCHAR dir_globalW[] = {'?','?'};
 336     static const WCHAR dir_driverW[] = {'D','r','i','v','e','r'};
 337     static const WCHAR dir_deviceW[] = {'D','e','v','i','c','e'};
 338     static const WCHAR dir_objtypeW[] = {'O','b','j','e','c','t','T','y','p','e','s'};
 339     static const WCHAR dir_kernelW[] = {'K','e','r','n','e','l','O','b','j','e','c','t','s'};
 340     static const struct unicode_str dir_global_str = {dir_globalW, sizeof(dir_globalW)};
 341     static const struct unicode_str dir_driver_str = {dir_driverW, sizeof(dir_driverW)};
 342     static const struct unicode_str dir_device_str = {dir_deviceW, sizeof(dir_deviceW)};
 343     static const struct unicode_str dir_objtype_str = {dir_objtypeW, sizeof(dir_objtypeW)};
 344     static const struct unicode_str dir_kernel_str = {dir_kernelW, sizeof(dir_kernelW)};
 345
 346     /* symlinks */
 347     static const WCHAR link_dosdevW[] = {'D','o','s','D','e','v','i','c','e','s'};
 348     static const WCHAR link_globalW[] = {'G','l','o','b','a','l'};
 349     static const WCHAR link_nulW[]    = {'N','U','L'};
 350     static const WCHAR link_pipeW[]   = {'P','I','P','E'};
 351     static const WCHAR link_mailslotW[] = {'M','A','I','L','S','L','O','T'};
 352     static const struct unicode_str link_dosdev_str = {link_dosdevW, sizeof(link_dosdevW)};
 353     static const struct unicode_str link_global_str = {link_globalW, sizeof(link_globalW)};
 354     static const struct unicode_str link_nul_str    = {link_nulW, sizeof(link_nulW)};
 355     static const struct unicode_str link_pipe_str   = {link_pipeW, sizeof(link_pipeW)};
 356     static const struct unicode_str link_mailslot_str = {link_mailslotW, sizeof(link_mailslotW)};
 357
 358     /* devices */
 359     static const WCHAR named_pipeW[] = {'N','a','m','e','d','P','i','p','e'};
 360     static const WCHAR mailslotW[] = {'M','a','i','l','S','l','o','t'};
 361     static const WCHAR nullW[] = {'N','u','l','l'};
 362     static const struct unicode_str named_pipe_str = {named_pipeW, sizeof(named_pipeW)};
 363     static const struct unicode_str mailslot_str = {mailslotW, sizeof(mailslotW)};
 364     static const struct unicode_str null_str = {nullW, sizeof(nullW)};
 365
 366     /* events */
 367     static const WCHAR event_low_memW[] = {'L','o','w','M','e','m','o','r','y','C','o','n','d','i','t','i','o','n'};
 368     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'};
 369     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'};
 370     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'};
 371     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'};
 372     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'};
 373     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'};
 374     static const struct unicode_str kernel_events[] =
 375     {
 376         { event_low_memW, sizeof(event_low_memW) },
 377         { event_low_pagedW, sizeof(event_low_pagedW) },
 378         { event_low_nonpgW, sizeof(event_low_nonpgW) },
 379         { event_high_memW, sizeof(event_high_memW) },
 380         { event_high_pagedW, sizeof(event_high_pagedW) },
 381         { event_high_nonpgW, sizeof(event_high_nonpgW) }
 382     };
 383     static const struct unicode_str keyed_event_crit_sect_str = {keyed_event_crit_sectW, sizeof(keyed_event_crit_sectW)};
 384
 385     struct directory *dir_driver, *dir_device, *dir_global, *dir_kernel;
 386     struct object *link_dosdev, *link_global, *link_nul, *link_pipe, *link_mailslot;
 387     struct object *named_pipe_device, *mailslot_device, *null_device;
 388     struct keyed_event *keyed_event;
 389     unsigned int i;
 390
 391     root_directory = create_directory( NULL, NULL, 0, HASH_SIZE, NULL );
 392     dir_driver     = create_directory( &root_directory->obj, &dir_driver_str, 0, HASH_SIZE, NULL );
 393     dir_device     = create_directory( &root_directory->obj, &dir_device_str, 0, HASH_SIZE, NULL );
 394     dir_objtype    = create_directory( &root_directory->obj, &dir_objtype_str, 0, HASH_SIZE, NULL );
 395     dir_kernel     = create_directory( &root_directory->obj, &dir_kernel_str, 0, HASH_SIZE, NULL );
 396     dir_global     = create_directory( &root_directory->obj, &dir_global_str, 0, HASH_SIZE, NULL );
 397     make_object_static( &root_directory->obj );
 398     make_object_static( &dir_driver->obj );
 399     make_object_static( &dir_objtype->obj );
 400
 401     /* devices */
 402     named_pipe_device = create_named_pipe_device( &dir_device->obj, &named_pipe_str );
 403     mailslot_device   = create_mailslot_device( &dir_device->obj, &mailslot_str );
 404     null_device       = create_unix_device( &dir_device->obj, &null_str, "/dev/null" );
 405     make_object_static( named_pipe_device );
 406     make_object_static( mailslot_device );
 407     make_object_static( null_device );
 408
 409     /* sessions */
 410     create_session( 0 );
 411     create_session( 1 );
 412
 413     /* symlinks */
 414     link_dosdev    = create_obj_symlink( &root_directory->obj, &link_dosdev_str, 0, &dir_global->obj, NULL );
 415     link_global    = create_obj_symlink( &dir_global->obj, &link_global_str, 0, &dir_global->obj, NULL );
 416     link_nul       = create_obj_symlink( &dir_global->obj, &link_nul_str, 0, null_device, NULL );
 417     link_pipe      = create_obj_symlink( &dir_global->obj, &link_pipe_str, 0, named_pipe_device, NULL );
 418     link_mailslot  = create_obj_symlink( &dir_global->obj, &link_mailslot_str, 0, mailslot_device, NULL );
 419     make_object_static( link_dosdev );
 420     make_object_static( link_global );
 421     make_object_static( link_nul );
 422     make_object_static( link_pipe );
 423     make_object_static( link_mailslot );
 424
 425     /* events */
 426     for (i = 0; i < ARRAY_SIZE( kernel_events ); i++)
 427     {
 428         struct event *event = create_event( &dir_kernel->obj, &kernel_events[i], 0, 1, 0, NULL );
 429         make_object_static( (struct object *)event );
 430     }
 431     keyed_event = create_keyed_event( &dir_kernel->obj, &keyed_event_crit_sect_str, 0, NULL );
 432     make_object_static( (struct object *)keyed_event );
 433
 434     /* the objects hold references so we can release these directories */
 435     release_object( dir_global );
 436     release_object( dir_device );
 437     release_object( dir_kernel );
 438 }
 439
 440 /* create a directory object */
 441 DECL_HANDLER(create_directory)
 442 {
 443     struct unicode_str name;
 444     struct object *root;
 445     struct directory *dir;
 446     const struct security_descriptor *sd;
 447     const struct object_attributes *objattr = get_req_object_attributes( &sd, &name, &root );
 448
 449     if (!objattr) return;
 450
 451     if ((dir = create_directory( root, &name, objattr->attributes, HASH_SIZE, sd )))
 452     {
 453         reply->handle = alloc_handle( current->process, dir, req->access, objattr->attributes );
 454         release_object( dir );
 455     }
 456
 457     if (root) release_object( root );
 458 }
 459
 460 /* open a directory object */
 461 DECL_HANDLER(open_directory)
 462 {
 463     struct unicode_str name = get_req_unicode_str();
 464
 465     reply->handle = open_object( current->process, req->rootdir, req->access,
 466                                  &directory_ops, &name, req->attributes );
 467 }
 468
 469 /* get a directory entry by index */
 470 DECL_HANDLER(get_directory_entry)
 471 {
 472     struct directory *dir = (struct directory *)get_handle_obj( current->process, req->handle,
 473                                                                 DIRECTORY_QUERY, &directory_ops );
 474     if (dir)
 475     {
 476         struct object *obj = find_object_index( dir->entries, req->index );
 477         if (obj)
 478         {
 479             data_size_t name_len, type_len = 0;
 480             const WCHAR *type_name = NULL;
 481             const WCHAR *name = get_object_name( obj, &name_len );
 482             struct object_type *type = obj->ops->get_type( obj );
 483
 484             if (type) type_name = get_object_name( &type->obj, &type_len );
 485
 486             if (name_len + type_len <= get_reply_max_size())
 487             {
 488                 void *ptr = set_reply_data_size( name_len + type_len );
 489                 if (ptr)
 490                 {
 491                     reply->name_len = name_len;
 492                     memcpy( ptr, name, name_len );
 493                     memcpy( (char *)ptr + name_len, type_name, type_len );
 494                 }
 495             }
 496             else set_error( STATUS_BUFFER_OVERFLOW );
 497
 498             if (type) release_object( type );
 499             release_object( obj );
 500         }
 501         release_object( dir );
 502     }
 503 }
 504
 505 /* unlink a named object */
 506 DECL_HANDLER(unlink_object)
 507 {
 508     struct object *obj = get_handle_obj( current->process, req->handle, 0, NULL );
 509
 510     if (obj)
 511     {
 512         unlink_named_object( obj );
 513         release_object( obj );
 514     }
 515 }
 516
 517 /* query object type name information */
 518 DECL_HANDLER(get_object_type)
 519 {
 520     struct object *obj;
 521     struct object_type *type;
 522     const WCHAR *name;
 523
 524     if (!(obj = get_handle_obj( current->process, req->handle, 0, NULL ))) return;
 525
 526     if ((type = obj->ops->get_type( obj )))
 527     {
 528         if ((name = get_object_name( &type->obj, &reply->total )))
 529             set_reply_data( name, min( reply->total, get_reply_max_size() ) );
 530         release_object( type );
 531     }
 532     release_object( obj );
 533 }