git.oblomov.eu Git - wine/blob - server/atom.c

   1 /*
   2  * Server-side atom management
   3  *
   4  * Copyright (C) 1999, 2000 Alexandre Julliard
   5  * Copyright (C) 2000 Turchanov Sergei
   6  *
   7  * This library is free software; you can redistribute it and/or
   8  * modify it under the terms of the GNU Lesser General Public
   9  * License as published by the Free Software Foundation; either
  10  * version 2.1 of the License, or (at your option) any later version.
  11  *
  12  * This library is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15  * Lesser General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU Lesser General Public
  18  * License along with this library; if not, write to the Free Software
  19  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
  20  */
  21
  22 #include "config.h"
  23 #include "wine/port.h"
  24
  25 #include <assert.h>
  26 #include <stdlib.h>
  27 #include <stdio.h>
  28 #include <string.h>
  29
  30 #include "ntstatus.h"
  31 #define WIN32_NO_STATUS
  32
  33 #include "unicode.h"
  34 #include "request.h"
  35 #include "object.h"
  36 #include "process.h"
  37 #include "handle.h"
  38 #include "user.h"
  39 #include "winuser.h"
  40 #include "winternl.h"
  41
  42 #define HASH_SIZE     37
  43 #define MIN_HASH_SIZE 4
  44 #define MAX_HASH_SIZE 0x200
  45
  46 #define MAX_ATOM_LEN  255
  47 #define MIN_STR_ATOM  0xc000
  48 #define MAX_ATOMS     0x4000
  49
  50 struct atom_entry
  51 {
  52     struct atom_entry *next;   /* hash table list */
  53     struct atom_entry *prev;   /* hash table list */
  54     int                count;  /* reference count */
  55     short              pinned; /* whether the atom is pinned or not */
  56     atom_t             atom;   /* atom handle */
  57     unsigned short     hash;   /* string hash */
  58     unsigned short     len;    /* string len */
  59     WCHAR              str[1]; /* atom string */
  60 };
  61
  62 struct atom_table
  63 {
  64     struct object       obj;                 /* object header */
  65     int                 count;               /* count of atom handles */
  66     int                 last;                /* last handle in-use */
  67     struct atom_entry **handles;             /* atom handles */
  68     int                 entries_count;       /* humber of hash entries */
  69     struct atom_entry **entries;             /* hash table entries */
  70 };
  71
  72 static void atom_table_dump( struct object *obj, int verbose );
  73 static void atom_table_destroy( struct object *obj );
  74
  75 static const struct object_ops atom_table_ops =
  76 {
  77     sizeof(struct atom_table),    /* size */
  78     atom_table_dump,              /* dump */
  79     no_add_queue,                 /* add_queue */
  80     NULL,                         /* remove_queue */
  81     NULL,                         /* signaled */
  82     NULL,                         /* satisfied */
  83     no_signal,                    /* signal */
  84     no_get_fd,                    /* get_fd */
  85     no_map_access,                /* map_access */
  86     default_get_sd,               /* get_sd */
  87     default_set_sd,               /* set_sd */
  88     no_lookup_name,               /* lookup_name */
  89     no_open_file,                 /* open_file */
  90     no_close_handle,              /* close_handle */
  91     atom_table_destroy            /* destroy */
  92 };
  93
  94 static struct atom_table *global_table;
  95
  96 /* create an atom table */
  97 static struct atom_table *create_table(int entries_count)
  98 {
  99     struct atom_table *table;
 100
 101     if ((table = alloc_object( &atom_table_ops )))
 102     {
 103         if ((entries_count < MIN_HASH_SIZE) ||
 104             (entries_count > MAX_HASH_SIZE)) entries_count = HASH_SIZE;
 105         table->entries_count = entries_count;
 106         if (!(table->entries = malloc( sizeof(*table->entries) * table->entries_count )))
 107         {
 108             set_error( STATUS_NO_MEMORY );
 109             goto fail;
 110         }
 111         memset( table->entries, 0, sizeof(*table->entries) * table->entries_count );
 112         table->count = 64;
 113         table->last  = -1;
 114         if ((table->handles = mem_alloc( sizeof(*table->handles) * table->count )))
 115             return table;
 116 fail:
 117         release_object( table );
 118         table = NULL;
 119     }
 120     return table;
 121 }
 122
 123 /* retrieve an entry pointer from its atom */
 124 static struct atom_entry *get_atom_entry( struct atom_table *table, atom_t atom )
 125 {
 126     struct atom_entry *entry = NULL;
 127     if (table && (atom >= MIN_STR_ATOM) && (atom <= MIN_STR_ATOM + table->last))
 128         entry = table->handles[atom - MIN_STR_ATOM];
 129     if (!entry) set_error( STATUS_INVALID_HANDLE );
 130     return entry;
 131 }
 132
 133 /* add an atom entry in the table and return its handle */
 134 static atom_t add_atom_entry( struct atom_table *table, struct atom_entry *entry )
 135 {
 136     int i;
 137     for (i = 0; i <= table->last; i++)
 138         if (!table->handles[i]) goto found;
 139     if (i == table->count)
 140     {
 141         struct atom_entry **new_table = NULL;
 142         int new_size = table->count + table->count / 2;
 143         if (new_size > MAX_ATOMS) new_size = MAX_ATOMS;
 144         if (new_size > table->count)
 145             new_table = realloc( table->handles, sizeof(*table->handles) * new_size );
 146         if (!new_table)
 147         {
 148             set_error( STATUS_NO_MEMORY );
 149             return 0;
 150         }
 151         table->count = new_size;
 152         table->handles = new_table;
 153     }
 154     table->last = i;
 155  found:
 156     table->handles[i] = entry;
 157     entry->atom = i + MIN_STR_ATOM;
 158     return entry->atom;
 159 }
 160
 161 /* compute the hash code for a string */
 162 static unsigned short atom_hash( struct atom_table *table, const WCHAR *str, data_size_t len )
 163 {
 164     unsigned int i;
 165     unsigned short hash = 0;
 166     for (i = 0; i < len; i++) hash ^= toupperW(str[i]) + i;
 167     return hash % table->entries_count;
 168 }
 169
 170 /* dump an atom table */
 171 static void atom_table_dump( struct object *obj, int verbose )
 172 {
 173     int i;
 174     struct atom_table *table = (struct atom_table *)obj;
 175     assert( obj->ops == &atom_table_ops );
 176
 177     fprintf( stderr, "Atom table size=%d entries=%d\n",
 178              table->last + 1, table->entries_count );
 179     if (!verbose) return;
 180     for (i = 0; i <= table->last; i++)
 181     {
 182         struct atom_entry *entry = table->handles[i];
 183         if (!entry) continue;
 184         fprintf( stderr, "  %04x: ref=%d pinned=%c hash=%d \"",
 185                  entry->atom, entry->count, entry->pinned ? 'Y' : 'N', entry->hash );
 186         dump_strW( entry->str, entry->len, stderr, "\"\"");
 187         fprintf( stderr, "\"\n" );
 188     }
 189 }
 190
 191 /* destroy the atom table */
 192 static void atom_table_destroy( struct object *obj )
 193 {
 194     int i;
 195     struct atom_table *table = (struct atom_table *)obj;
 196     assert( obj->ops == &atom_table_ops );
 197     if (table->handles)
 198     {
 199         for (i = 0; i <= table->last; i++) free( table->handles[i] );
 200         free( table->handles );
 201     }
 202     free( table->entries );
 203 }
 204
 205 /* find an atom entry in its hash list */
 206 static struct atom_entry *find_atom_entry( struct atom_table *table, const WCHAR *str,
 207                                            data_size_t len, unsigned short hash )
 208 {
 209     struct atom_entry *entry = table->entries[hash];
 210     while (entry)
 211     {
 212         if (entry->len == len && !memicmpW( entry->str, str, len )) break;
 213         entry = entry->next;
 214     }
 215     return entry;
 216 }
 217
 218 /* add an atom to the table */
 219 static atom_t add_atom( struct atom_table *table, const WCHAR *str, data_size_t len )
 220 {
 221     struct atom_entry *entry;
 222     unsigned short hash = atom_hash( table, str, len );
 223     atom_t atom = 0;
 224
 225     if (!len)
 226     {
 227         set_error( STATUS_OBJECT_NAME_INVALID );
 228         return 0;
 229     }
 230     if (len > MAX_ATOM_LEN)
 231     {
 232         set_error( STATUS_INVALID_PARAMETER );
 233         return 0;
 234     }
 235     if ((entry = find_atom_entry( table, str, len, hash )))  /* exists already */
 236     {
 237         entry->count++;
 238         return entry->atom;
 239     }
 240
 241     if ((entry = mem_alloc( sizeof(*entry) + (len - 1) * sizeof(WCHAR) )))
 242     {
 243         if ((atom = add_atom_entry( table, entry )))
 244         {
 245             entry->prev  = NULL;
 246             if ((entry->next = table->entries[hash])) entry->next->prev = entry;
 247             table->entries[hash] = entry;
 248             entry->count  = 1;
 249             entry->pinned = 0;
 250             entry->hash   = hash;
 251             entry->len    = len;
 252             memcpy( entry->str, str, len * sizeof(WCHAR) );
 253         }
 254         else free( entry );
 255     }
 256     else set_error( STATUS_NO_MEMORY );
 257     return atom;
 258 }
 259
 260 /* delete an atom from the table */
 261 static void delete_atom( struct atom_table *table, atom_t atom, int if_pinned )
 262 {
 263     struct atom_entry *entry = get_atom_entry( table, atom );
 264     if (!entry) return;
 265     if (entry->pinned && !if_pinned) set_error( STATUS_WAS_LOCKED );
 266     else if (!--entry->count)
 267     {
 268         if (entry->next) entry->next->prev = entry->prev;
 269         if (entry->prev) entry->prev->next = entry->next;
 270         else table->entries[entry->hash] = entry->next;
 271         table->handles[atom - MIN_STR_ATOM] = NULL;
 272         free( entry );
 273     }
 274 }
 275
 276 /* find an atom in the table */
 277 static atom_t find_atom( struct atom_table *table, const WCHAR *str, data_size_t len )
 278 {
 279     struct atom_entry *entry;
 280
 281     if (!len)
 282     {
 283         set_error( STATUS_OBJECT_NAME_INVALID );
 284         return 0;
 285     }
 286     if (len > MAX_ATOM_LEN)
 287     {
 288         set_error( STATUS_INVALID_PARAMETER );
 289         return 0;
 290     }
 291     if (table && (entry = find_atom_entry( table, str, len, atom_hash(table, str, len) )))
 292         return entry->atom;
 293     set_error( STATUS_OBJECT_NAME_NOT_FOUND );
 294     return 0;
 295 }
 296
 297 static struct atom_table *get_global_table( struct winstation *winstation, int create )
 298 {
 299     struct atom_table *table = winstation ? winstation->atom_table : global_table;
 300     if (!table)
 301     {
 302         if (create)
 303         {
 304             table = create_table( HASH_SIZE );
 305             if (winstation) winstation->atom_table = table;
 306             else
 307             {
 308                 global_table = table;
 309                 make_object_static( &global_table->obj );
 310             }
 311         }
 312         else set_error( STATUS_OBJECT_NAME_NOT_FOUND );
 313     }
 314     return table;
 315 }
 316
 317 static struct atom_table *get_table( obj_handle_t h, int create )
 318 {
 319     struct atom_table *table = NULL;
 320
 321     if (h)
 322     {
 323         table = (struct atom_table *)get_handle_obj( current->process, h, 0, &atom_table_ops );
 324     }
 325     else
 326     {
 327         table = get_global_table( NULL, 1 );
 328         if (table) grab_object( table );
 329     }
 330     return table;
 331 }
 332
 333 /* add an atom in the global table; used for window properties */
 334 atom_t add_global_atom( struct winstation *winstation, const WCHAR *str, data_size_t len )
 335 {
 336     struct atom_table *global_table = get_global_table( winstation, 1 );
 337     if (!global_table) return 0;
 338     return add_atom( global_table, str, len );
 339 }
 340
 341 /* find an atom in the global table; used for window properties */
 342 atom_t find_global_atom( struct winstation *winstation, const WCHAR *str, data_size_t len )
 343 {
 344     struct atom_table *global_table = get_global_table( winstation, 0 );
 345     struct atom_entry *entry;
 346
 347     if (!len || len > MAX_ATOM_LEN || !global_table) return 0;
 348     if ((entry = find_atom_entry( global_table, str, len, atom_hash(global_table, str, len) )))
 349         return entry->atom;
 350     return 0;
 351 }
 352
 353 /* increment the ref count of a global atom; used for window properties */
 354 int grab_global_atom( struct winstation *winstation, atom_t atom )
 355 {
 356     if (atom >= MIN_STR_ATOM)
 357     {
 358         struct atom_table *global_table = get_global_table( winstation, 0 );
 359         if (global_table)
 360         {
 361             struct atom_entry *entry = get_atom_entry( global_table, atom );
 362             if (entry) entry->count++;
 363             return (entry != NULL);
 364         }
 365         else return 0;
 366     }
 367     else return 1;
 368 }
 369
 370 /* decrement the ref count of a global atom; used for window properties */
 371 void release_global_atom( struct winstation *winstation, atom_t atom )
 372 {
 373     if (atom >= MIN_STR_ATOM)
 374     {
 375         struct atom_table *global_table = get_global_table( winstation, 0 );
 376         if (global_table) delete_atom( global_table, atom, 1 );
 377     }
 378 }
 379
 380 /* add a global atom */
 381 DECL_HANDLER(add_atom)
 382 {
 383     struct atom_table *table = get_table( req->table, 1 );
 384     if (table)
 385     {
 386         reply->atom = add_atom( table, get_req_data(), get_req_data_size() / sizeof(WCHAR) );
 387         release_object( table );
 388     }
 389 }
 390
 391 /* delete a global atom */
 392 DECL_HANDLER(delete_atom)
 393 {
 394     struct atom_table *table = get_table( req->table, 0 );
 395     if (table)
 396     {
 397         delete_atom( table, req->atom, 0 );
 398         release_object( table );
 399     }
 400 }
 401
 402 /* find a global atom */
 403 DECL_HANDLER(find_atom)
 404 {
 405     struct atom_table *table = get_table( req->table, 0 );
 406     if (table)
 407     {
 408         reply->atom = find_atom( table, get_req_data(), get_req_data_size() / sizeof(WCHAR) );
 409         release_object( table );
 410     }
 411 }
 412
 413 /* get global atom name */
 414 DECL_HANDLER(get_atom_information)
 415 {
 416     struct atom_table *table = get_table( req->table, 0 );
 417     if (table)
 418     {
 419         struct atom_entry *entry;
 420
 421         if ((entry = get_atom_entry( table, req->atom )))
 422         {
 423             data_size_t len = entry->len * sizeof(WCHAR);
 424             if (get_reply_max_size())
 425                 set_reply_data( entry->str, min( len, get_reply_max_size()));
 426             reply->count = entry->count;
 427             reply->pinned = entry->pinned;
 428             reply->total = len;
 429         }
 430         else reply->count = -1;
 431         release_object( table );
 432     }
 433 }
 434
 435 /* set global atom name */
 436 DECL_HANDLER(set_atom_information)
 437 {
 438     struct atom_table *table = get_table( req->table, 0 );
 439     if (table)
 440     {
 441         struct atom_entry *entry;
 442
 443         if ((entry = get_atom_entry( table, req->atom )))
 444         {
 445             if (req->pinned) entry->pinned = 1;
 446         }
 447         release_object( table );
 448     }
 449 }
 450
 451 /* init a (local) atom table */
 452 DECL_HANDLER(init_atom_table)
 453 {
 454     struct atom_table* table = create_table( req->entries );
 455
 456     if (table)
 457     {
 458         reply->table = alloc_handle( current->process, table, 0, 0 );
 459         release_object( table );
 460     }
 461 }
 462
 463 /* set global atom name */
 464 DECL_HANDLER(empty_atom_table)
 465 {
 466     struct atom_table *table = get_table( req->table, 1 );
 467     if (table)
 468     {
 469         int i;
 470         struct atom_entry *entry;
 471
 472         for (i = 0; i <= table->last; i++)
 473         {
 474             entry = table->handles[i];
 475             if (entry && (!entry->pinned || req->if_pinned))
 476             {
 477                 if (entry->next) entry->next->prev = entry->prev;
 478                 if (entry->prev) entry->prev->next = entry->next;
 479                 else table->entries[entry->hash] = entry->next;
 480                 table->handles[i] = NULL;
 481                 free( entry );
 482             }
 483         }
 484         release_object( table );
 485     }
 486 }