server/object.h

   1 /*
   2  * Wine server objects
   3  *
   4  * Copyright (C) 1998 Alexandre Julliard
   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., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  19  */
  20
  21 #ifndef __WINE_SERVER_OBJECT_H
  22 #define __WINE_SERVER_OBJECT_H
  23
  24 #ifdef HAVE_SYS_POLL_H
  25 #include <sys/poll.h>
  26 #endif
  27
  28 #include <sys/time.h>
  29 #include "wine/server_protocol.h"
  30 #include "list.h"
  31
  32 #define DEBUG_OBJECTS
  33
  34 /* kernel objects */
  35
  36 struct namespace;
  37 struct object;
  38 struct object_name;
  39 struct thread;
  40 struct process;
  41 struct file;
  42 struct wait_queue_entry;
  43 struct async;
  44 struct async_queue;
  45
  46 /* operations valid on all objects */
  47 struct object_ops
  48 {
  49     /* size of this object type */
  50     size_t size;
  51     /* dump the object (for debugging) */
  52     void (*dump)(struct object *,int);
  53     /* add a thread to the object wait queue */
  54     int  (*add_queue)(struct object *,struct wait_queue_entry *);
  55     /* remove a thread from the object wait queue */
  56     void (*remove_queue)(struct object *,struct wait_queue_entry *);
  57     /* is object signaled? */
  58     int  (*signaled)(struct object *,struct thread *);
  59     /* wait satisfied; return 1 if abandoned */
  60     int  (*satisfied)(struct object *,struct thread *);
  61     /* return an fd object that can be used to read/write from the object */
  62     struct fd *(*get_fd)(struct object *);
  63     /* destroy on refcount == 0 */
  64     void (*destroy)(struct object *);
  65 };
  66
  67 struct object
  68 {
  69     unsigned int              refcount;    /* reference count */
  70     const struct object_ops  *ops;
  71     struct wait_queue_entry  *head;
  72     struct wait_queue_entry  *tail;
  73     struct object_name       *name;
  74 #ifdef DEBUG_OBJECTS
  75     struct list               obj_list;
  76 #endif
  77 };
  78
  79 struct wait_queue_entry
  80 {
  81     struct wait_queue_entry *next;
  82     struct wait_queue_entry *prev;
  83     struct object           *obj;
  84     struct thread           *thread;
  85 };
  86
  87 extern void *mem_alloc( size_t size );  /* malloc wrapper */
  88 extern void *memdup( const void *data, size_t len );
  89 extern void *alloc_object( const struct object_ops *ops );
  90 extern void dump_object_name( struct object *obj );
  91 extern void *create_named_object( struct namespace *namespace, const struct object_ops *ops,
  92                                   const WCHAR *name, size_t len );
  93 extern struct namespace *create_namespace( unsigned int hash_size, int case_sensitive );
  94 /* grab/release_object can take any pointer, but you better make sure */
  95 /* that the thing pointed to starts with a struct object... */
  96 extern struct object *grab_object( void *obj );
  97 extern void release_object( void *obj );
  98 extern struct object *find_object( const struct namespace *namespace, const WCHAR *name, size_t len );
  99 extern int no_add_queue( struct object *obj, struct wait_queue_entry *entry );
 100 extern int no_satisfied( struct object *obj, struct thread *thread );
 101 extern struct fd *no_get_fd( struct object *obj );
 102 extern void no_destroy( struct object *obj );
 103 #ifdef DEBUG_OBJECTS
 104 extern void dump_objects(void);
 105 #endif
 106
 107 /* event functions */
 108
 109 struct event;
 110
 111 extern struct event *create_event( const WCHAR *name, size_t len,
 112                                    int manual_reset, int initial_state );
 113 extern struct event *get_event_obj( struct process *process, obj_handle_t handle, unsigned int access );
 114 extern void pulse_event( struct event *event );
 115 extern void set_event( struct event *event );
 116 extern void reset_event( struct event *event );
 117
 118 /* mutex functions */
 119
 120 extern void abandon_mutexes( struct thread *thread );
 121
 122 /* serial functions */
 123
 124 int get_serial_async_timeout(struct object *obj, int type, int count);
 125
 126 /* socket functions */
 127
 128 extern void sock_init(void);
 129
 130 /* debugger functions */
 131
 132 extern int set_process_debugger( struct process *process, struct thread *debugger );
 133 extern void generate_debug_event( struct thread *thread, int code, void *arg );
 134 extern void generate_startup_debug_events( struct process *process, void *entry );
 135 extern void debug_exit_thread( struct thread *thread );
 136
 137 /* mapping functions */
 138
 139 extern int get_page_size(void);
 140
 141 /* registry functions */
 142
 143 extern void init_registry(void);
 144 extern void flush_registry(void);
 145 extern void close_registry(void);
 146 extern void registry_close_handle( struct object *obj, obj_handle_t hkey );
 147
 148 /* signal functions */
 149
 150 extern void init_signals(void);
 151 extern void close_signals(void);
 152
 153 /* atom functions */
 154
 155 extern void close_atom_table(void);
 156 extern int grab_global_atom( atom_t atom );
 157 extern void release_global_atom( atom_t atom );
 158
 159 /* global variables */
 160
 161   /* command-line options */
 162 extern int debug_level;
 163 extern int master_socket_timeout;
 164 extern int foreground;
 165 extern const char *server_argv0;
 166
 167   /* server start time used for GetTickCount() */
 168 extern unsigned int server_start_ticks;
 169
 170 /* name space for synchronization objects */
 171 extern struct namespace *sync_namespace;
 172
 173 #endif  /* __WINE_SERVER_OBJECT_H */