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