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