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