object.c 13.9 KB
Newer Older
Alexandre Julliard's avatar
Alexandre Julliard committed
1 2 3 4
/*
 * Server-side objects
 *
 * Copyright (C) 1998 Alexandre Julliard
5 6 7 8 9 10 11 12 13 14 15 16 17
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * 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
Alexandre Julliard's avatar
Alexandre Julliard committed
19 20
 */

21 22 23
#include "config.h"
#include "wine/port.h"

Alexandre Julliard's avatar
Alexandre Julliard committed
24
#include <assert.h>
Alexandre Julliard's avatar
Alexandre Julliard committed
25
#include <limits.h>
Alexandre Julliard's avatar
Alexandre Julliard committed
26
#include <stdlib.h>
27
#include <stdio.h>
Alexandre Julliard's avatar
Alexandre Julliard committed
28
#include <string.h>
29
#include <unistd.h>
30
#include <stdarg.h>
Alexandre Julliard's avatar
Alexandre Julliard committed
31

32 33
#include "ntstatus.h"
#define WIN32_NO_STATUS
34 35
#include "winternl.h"

36
#include "file.h"
37
#include "process.h"
38
#include "thread.h"
39
#include "unicode.h"
40
#include "security.h"
Alexandre Julliard's avatar
Alexandre Julliard committed
41

Alexandre Julliard's avatar
Alexandre Julliard committed
42 43 44

struct object_name
{
45 46 47
    struct list         entry;           /* entry in the hash list */
    struct object      *obj;             /* object owning this name */
    struct object      *parent;          /* parent object */
48
    data_size_t         len;             /* name length in bytes */
49
    WCHAR               name[1];
Alexandre Julliard's avatar
Alexandre Julliard committed
50 51
};

52 53 54 55 56
struct namespace
{
    unsigned int        hash_size;       /* size of hash table */
    struct list         names[1];        /* array of hash entry lists */
};
Alexandre Julliard's avatar
Alexandre Julliard committed
57 58


59
#ifdef DEBUG_OBJECTS
60
static struct list object_list = LIST_INIT(object_list);
61
static struct list static_object_list = LIST_INIT(static_object_list);
62 63 64

void dump_objects(void)
{
65 66
    struct list *p;

67 68 69 70 71 72
    LIST_FOR_EACH( p, &static_object_list )
    {
        struct object *ptr = LIST_ENTRY( p, struct object, obj_list );
        fprintf( stderr, "%p:%d: ", ptr, ptr->refcount );
        ptr->ops->dump( ptr, 1 );
    }
73
    LIST_FOR_EACH( p, &object_list )
74
    {
75
        struct object *ptr = LIST_ENTRY( p, struct object, obj_list );
76 77 78 79
        fprintf( stderr, "%p:%d: ", ptr, ptr->refcount );
        ptr->ops->dump( ptr, 1 );
    }
}
80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98

void close_objects(void)
{
    struct list *ptr;

    /* release the static objects */
    while ((ptr = list_head( &static_object_list )))
    {
        struct object *obj = LIST_ENTRY( ptr, struct object, obj_list );
        /* move it back to the standard list before freeing */
        list_remove( &obj->obj_list );
        list_add_head( &object_list, &obj->obj_list );
        release_object( obj );
    }

    dump_objects();  /* dump any remaining objects */
}

#endif  /* DEBUG_OBJECTS */
99

Alexandre Julliard's avatar
Alexandre Julliard committed
100 101
/*****************************************************************/

102
/* malloc replacement */
Alexandre Julliard's avatar
Alexandre Julliard committed
103 104 105 106
void *mem_alloc( size_t size )
{
    void *ptr = malloc( size );
    if (ptr) memset( ptr, 0x55, size );
107
    else set_error( STATUS_NO_MEMORY );
Alexandre Julliard's avatar
Alexandre Julliard committed
108 109 110
    return ptr;
}

111 112 113
/* duplicate a block of memory */
void *memdup( const void *data, size_t len )
{
Alexandre Julliard's avatar
Alexandre Julliard committed
114
    void *ptr = malloc( len );
115
    if (ptr) memcpy( ptr, data, len );
116
    else set_error( STATUS_NO_MEMORY );
117 118 119 120
    return ptr;
}


Alexandre Julliard's avatar
Alexandre Julliard committed
121 122
/*****************************************************************/

123
static int get_name_hash( const struct namespace *namespace, const WCHAR *name, data_size_t len )
Alexandre Julliard's avatar
Alexandre Julliard committed
124
{
125
    WCHAR hash = 0;
126
    len /= sizeof(WCHAR);
127
    while (len--) hash ^= tolowerW(*name++);
128
    return hash % namespace->hash_size;
Alexandre Julliard's avatar
Alexandre Julliard committed
129 130
}

131
/* allocate a name for an object */
132
static struct object_name *alloc_name( const struct unicode_str *name )
Alexandre Julliard's avatar
Alexandre Julliard committed
133 134 135
{
    struct object_name *ptr;

136
    if ((ptr = mem_alloc( sizeof(*ptr) + name->len - sizeof(ptr->name) )))
137
    {
138
        ptr->len = name->len;
139
        ptr->parent = NULL;
140
        memcpy( ptr->name, name->str, name->len );
141
    }
Alexandre Julliard's avatar
Alexandre Julliard committed
142 143 144
    return ptr;
}

145
/* free the name of an object */
Alexandre Julliard's avatar
Alexandre Julliard committed
146 147
static void free_name( struct object *obj )
{
148
    struct object_name *ptr = obj->name;
149
    list_remove( &ptr->entry );
150
    if (ptr->parent) release_object( ptr->parent );
151 152 153 154
    free( ptr );
}

/* set the name of an existing object */
155 156
static void set_object_name( struct namespace *namespace,
                             struct object *obj, struct object_name *ptr )
157
{
158
    int hash = get_name_hash( namespace, ptr->name, ptr->len );
159

160
    list_add_head( &namespace->names[hash], &ptr->entry );
161 162
    ptr->obj = obj;
    obj->name = ptr;
Alexandre Julliard's avatar
Alexandre Julliard committed
163 164
}

165
/* get the name of an existing object */
166
const WCHAR *get_object_name( struct object *obj, data_size_t *len )
167 168 169 170 171 172 173
{
    struct object_name *ptr = obj->name;
    if (!ptr) return NULL;
    *len = ptr->len;
    return ptr->name;
}

174
/* allocate and initialize an object */
175
void *alloc_object( const struct object_ops *ops )
176
{
177 178 179 180 181 182
    struct object *obj = mem_alloc( ops->size );
    if (obj)
    {
        obj->refcount = 1;
        obj->ops      = ops;
        obj->name     = NULL;
183
        obj->sd       = NULL;
184
        list_init( &obj->wait_queue );
185
#ifdef DEBUG_OBJECTS
186
        list_add_head( &object_list, &obj->obj_list );
187
#endif
188
        return obj;
189
    }
190
    return NULL;
191 192
}

193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209
void *create_object( struct namespace *namespace, const struct object_ops *ops,
                     const struct unicode_str *name, struct object *parent )
{
    struct object *obj;
    struct object_name *name_ptr;

    if (!(name_ptr = alloc_name( name ))) return NULL;
    if ((obj = alloc_object( ops )))
    {
        set_object_name( namespace, obj, name_ptr );
        if (parent) name_ptr->parent = grab_object( parent );
    }
    else
        free( name_ptr );
    return obj;
}

210
void *create_named_object( struct namespace *namespace, const struct object_ops *ops,
211
                           const struct unicode_str *name, unsigned int attributes )
Alexandre Julliard's avatar
Alexandre Julliard committed
212 213
{
    struct object *obj;
214

215
    if (!name || !name->len) return alloc_object( ops );
216

217
    if ((obj = find_object( namespace, name, attributes )))
Alexandre Julliard's avatar
Alexandre Julliard committed
218
    {
219 220 221
        if (attributes & OBJ_OPENIF && obj->ops == ops)
            set_error( STATUS_OBJECT_NAME_EXISTS );
        else
Alexandre Julliard's avatar
Alexandre Julliard committed
222
        {
223 224
            release_object( obj );
            obj = NULL;
225 226 227 228
            if (attributes & OBJ_OPENIF)
                set_error( STATUS_OBJECT_TYPE_MISMATCH );
            else
                set_error( STATUS_OBJECT_NAME_COLLISION );
Alexandre Julliard's avatar
Alexandre Julliard committed
229
        }
230
        return obj;
Alexandre Julliard's avatar
Alexandre Julliard committed
231
    }
232
    if ((obj = create_object( namespace, ops, name, NULL ))) clear_error();
Alexandre Julliard's avatar
Alexandre Julliard committed
233
    return obj;
Alexandre Julliard's avatar
Alexandre Julliard committed
234 235
}

236 237
/* dump the name of an object to stderr */
void dump_object_name( struct object *obj )
238
{
239 240 241 242
    if (!obj->name) fprintf( stderr, "name=\"\"" );
    else
    {
        fprintf( stderr, "name=L\"" );
243
        dump_strW( obj->name->name, obj->name->len/sizeof(WCHAR), stderr, "\"\"" );
244 245
        fputc( '\"', stderr );
    }
246 247
}

248 249 250 251 252 253 254
/* unlink a named object from its namespace, without freeing the object itself */
void unlink_named_object( struct object *obj )
{
    if (obj->name) free_name( obj );
    obj->name = NULL;
}

255 256 257 258 259 260 261 262 263
/* mark an object as being stored statically, i.e. only released at shutdown */
void make_object_static( struct object *obj )
{
#ifdef DEBUG_OBJECTS
    list_remove( &obj->obj_list );
    list_add_head( &static_object_list, &obj->obj_list );
#endif
}

Alexandre Julliard's avatar
Alexandre Julliard committed
264 265 266 267 268 269 270 271 272 273
/* grab an object (i.e. increment its refcount) and return the object */
struct object *grab_object( void *ptr )
{
    struct object *obj = (struct object *)ptr;
    assert( obj->refcount < INT_MAX );
    obj->refcount++;
    return obj;
}

/* release an object (i.e. decrement its refcount) */
Alexandre Julliard's avatar
Alexandre Julliard committed
274 275 276 277 278 279
void release_object( void *ptr )
{
    struct object *obj = (struct object *)ptr;
    assert( obj->refcount );
    if (!--obj->refcount)
    {
Alexandre Julliard's avatar
Alexandre Julliard committed
280
        /* if the refcount is 0, nobody can be in the wait queue */
281
        assert( list_empty( &obj->wait_queue ));
282
        obj->ops->destroy( obj );
Alexandre Julliard's avatar
Alexandre Julliard committed
283
        if (obj->name) free_name( obj );
284
        free( obj->sd );
285
#ifdef DEBUG_OBJECTS
286
        list_remove( &obj->obj_list );
287
        memset( obj, 0xaa, obj->ops->size );
288
#endif
289
        free( obj );
Alexandre Julliard's avatar
Alexandre Julliard committed
290 291 292 293
    }
}

/* find an object by its name; the refcount is incremented */
294
struct object *find_object( const struct namespace *namespace, const struct unicode_str *name,
295
                            unsigned int attributes )
Alexandre Julliard's avatar
Alexandre Julliard committed
296
{
297 298
    const struct list *list;
    struct list *p;
299

300
    if (!name || !name->len) return NULL;
301

302
    list = &namespace->names[ get_name_hash( namespace, name->str, name->len ) ];
303
    LIST_FOR_EACH( p, list )
304
    {
305
        const struct object_name *ptr = LIST_ENTRY( p, struct object_name, entry );
306
        if (ptr->len != name->len) continue;
307
        if (attributes & OBJ_CASE_INSENSITIVE)
308
        {
309 310
            if (!strncmpiW( ptr->name, name->str, name->len/sizeof(WCHAR) ))
                return grab_object( ptr->obj );
311
        }
312
        else
313
        {
314 315
            if (!memcmp( ptr->name, name->str, name->len ))
                return grab_object( ptr->obj );
316
        }
317 318
    }
    return NULL;
Alexandre Julliard's avatar
Alexandre Julliard committed
319
}
320

321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338
/* find an object by its index; the refcount is incremented */
struct object *find_object_index( const struct namespace *namespace, unsigned int index )
{
    unsigned int i;

    /* FIXME: not efficient at all */
    for (i = 0; i < namespace->hash_size; i++)
    {
        const struct object_name *ptr;
        LIST_FOR_EACH_ENTRY( ptr, &namespace->names[i], const struct object_name, entry )
        {
            if (!index--) return grab_object( ptr->obj );
        }
    }
    set_error( STATUS_NO_MORE_ENTRIES );
    return NULL;
}

339
/* allocate a namespace */
340
struct namespace *create_namespace( unsigned int hash_size )
341 342 343 344 345 346 347 348 349 350 351 352 353
{
    struct namespace *namespace;
    unsigned int i;

    namespace = mem_alloc( sizeof(*namespace) + (hash_size - 1) * sizeof(namespace->names[0]) );
    if (namespace)
    {
        namespace->hash_size      = hash_size;
        for (i = 0; i < hash_size; i++) list_init( &namespace->names[i] );
    }
    return namespace;
}

354
/* functions for unimplemented/default object operations */
355

356 357 358 359 360
struct object_type *no_get_type( struct object *obj )
{
    return NULL;
}

361 362
int no_add_queue( struct object *obj, struct wait_queue_entry *entry )
{
363
    set_error( STATUS_OBJECT_TYPE_MISMATCH );
364 365 366
    return 0;
}

367 368 369 370 371
int no_satisfied( struct object *obj, struct thread *thread )
{
    return 0;  /* not abandoned */
}

372 373 374 375 376 377
int no_signal( struct object *obj, unsigned int access )
{
    set_error( STATUS_OBJECT_TYPE_MISMATCH );
    return 0;
}

378
struct fd *no_get_fd( struct object *obj )
379
{
380
    set_error( STATUS_OBJECT_TYPE_MISMATCH );
381
    return NULL;
382 383
}

384 385
unsigned int no_map_access( struct object *obj, unsigned int access )
{
386 387 388 389 390
    if (access & GENERIC_READ)    access |= STANDARD_RIGHTS_READ;
    if (access & GENERIC_WRITE)   access |= STANDARD_RIGHTS_WRITE;
    if (access & GENERIC_EXECUTE) access |= STANDARD_RIGHTS_EXECUTE;
    if (access & GENERIC_ALL)     access |= STANDARD_RIGHTS_ALL;
    return access & ~(GENERIC_READ | GENERIC_WRITE | GENERIC_EXECUTE | GENERIC_ALL);
391 392
}

393 394 395 396 397 398
struct security_descriptor *default_get_sd( struct object *obj )
{
    return obj->sd;
}

int default_set_sd( struct object *obj, const struct security_descriptor *sd,
399 400 401 402 403 404 405 406
                    unsigned int set_info )
{
    struct security_descriptor new_sd, *new_sd_ptr;
    int present;
    const SID *owner, *group;
    const ACL *sacl, *dacl;
    char *ptr;

407
    if (!set_info) return 1;
408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467

    new_sd.control = sd->control & ~SE_SELF_RELATIVE;

    owner = sd_get_owner( sd );
    if (set_info & OWNER_SECURITY_INFORMATION && owner)
        new_sd.owner_len = sd->owner_len;
    else
    {
        owner = token_get_user( current->process->token );
        new_sd.owner_len = FIELD_OFFSET(SID, SubAuthority[owner->SubAuthorityCount]);
        new_sd.control |= SE_OWNER_DEFAULTED;
    }

    group = sd_get_group( sd );
    if (set_info & GROUP_SECURITY_INFORMATION && group)
        new_sd.group_len = sd->group_len;
    else
    {
        group = token_get_primary_group( current->process->token );
        new_sd.group_len = FIELD_OFFSET(SID, SubAuthority[group->SubAuthorityCount]);
        new_sd.control |= SE_GROUP_DEFAULTED;
    }

    new_sd.control |= SE_SACL_PRESENT;
    sacl = sd_get_sacl( sd, &present );
    if (set_info & SACL_SECURITY_INFORMATION && present)
        new_sd.sacl_len = sd->sacl_len;
    else
    {
        if (obj->sd) sacl = sd_get_sacl( obj->sd, &present );

        if (obj->sd && present)
            new_sd.sacl_len = obj->sd->sacl_len;
        else
        {
            new_sd.sacl_len = 0;
            new_sd.control |= SE_SACL_DEFAULTED;
        }
    }

    new_sd.control |= SE_DACL_PRESENT;
    dacl = sd_get_dacl( sd, &present );
    if (set_info & DACL_SECURITY_INFORMATION && present)
        new_sd.dacl_len = sd->dacl_len;
    else
    {
        if (obj->sd) dacl = sd_get_dacl( obj->sd, &present );

        if (obj->sd && present)
            new_sd.dacl_len = obj->sd->dacl_len;
        else
        {
            dacl = token_get_default_dacl( current->process->token );
            new_sd.dacl_len = dacl->AclSize;
            new_sd.control |= SE_DACL_DEFAULTED;
        }
    }

    ptr = mem_alloc( sizeof(new_sd) + new_sd.owner_len + new_sd.group_len +
                     new_sd.sacl_len + new_sd.dacl_len );
468
    if (!ptr) return 0;
469 470 471 472 473 474 475 476 477 478 479 480 481 482
    new_sd_ptr = (struct security_descriptor*)ptr;

    memcpy( ptr, &new_sd, sizeof(new_sd) );
    ptr += sizeof(new_sd);
    memcpy( ptr, owner, new_sd.owner_len );
    ptr += new_sd.owner_len;
    memcpy( ptr, group, new_sd.group_len );
    ptr += new_sd.group_len;
    memcpy( ptr, sacl, new_sd.sacl_len );
    ptr += new_sd.sacl_len;
    memcpy( ptr, dacl, new_sd.dacl_len );

    free( obj->sd );
    obj->sd = new_sd_ptr;
483
    return 1;
484 485
}

486 487 488 489 490 491
struct object *no_lookup_name( struct object *obj, struct unicode_str *name,
                               unsigned int attr )
{
    return NULL;
}

492 493 494 495 496 497 498
struct object *no_open_file( struct object *obj, unsigned int access, unsigned int sharing,
                             unsigned int options )
{
    set_error( STATUS_OBJECT_TYPE_MISMATCH );
    return NULL;
}

499 500 501 502 503
int no_close_handle( struct object *obj, struct process *process, obj_handle_t handle )
{
    return 1;  /* ok to close */
}

504 505 506
void no_destroy( struct object *obj )
{
}