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