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 object_type;
  48
  49
  50 struct unicode_str
  51 {
  52     const WCHAR *str;
  53     data_size_t  len;
  54 };
  55
  56 /* object type descriptor */
  57 struct type_descr
  58 {
  59     struct unicode_str name;          /* type name */
  60     unsigned int       valid_access;  /* mask for valid access bits */
  61     generic_map_t      mapping;       /* generic access mapping */
  62     unsigned int       index;         /* index in global array of types */
  63     unsigned int       obj_count;     /* count of objects of this type */
  64     unsigned int       handle_count;  /* count of handles of this type */
  65     unsigned int       obj_max;       /* max count of objects of this type */
  66     unsigned int       handle_max;    /* max count of handles of this type */
  67 };
  68
  69 /* operations valid on all objects */
  70 struct object_ops
  71 {
  72     /* size of this object type */
  73     size_t size;
  74     /* type descriptor */
  75     struct type_descr *type;
  76     /* dump the object (for debugging) */
  77     void (*dump)(struct object *,int);
  78     /* add a thread to the object wait queue */
  79     int  (*add_queue)(struct object *,struct wait_queue_entry *);
  80     /* remove a thread from the object wait queue */
  81     void (*remove_queue)(struct object *,struct wait_queue_entry *);
  82     /* is object signaled? */
  83     int  (*signaled)(struct object *,struct wait_queue_entry *);
  84     /* wait satisfied */
  85     void (*satisfied)(struct object *,struct wait_queue_entry *);
  86     /* signal an object */
  87     int  (*signal)(struct object *, unsigned int);
  88     /* return an fd object that can be used to read/write from the object */
  89     struct fd *(*get_fd)(struct object *);
  90     /* map access rights to the specific rights for this object */
  91     unsigned int (*map_access)(struct object *, unsigned int);
  92     /* returns the security descriptor of the object */
  93     struct security_descriptor *(*get_sd)( struct object * );
  94     /* sets the security descriptor of the object */
  95     int (*set_sd)( struct object *, const struct security_descriptor *, unsigned int );
  96     /* get the object full name */
  97     WCHAR *(*get_full_name)(struct object *, data_size_t *);
  98     /* lookup a name if an object has a namespace */
  99     struct object *(*lookup_name)(struct object *, struct unicode_str *,unsigned int,struct object *);
 100     /* link an object's name into a parent object */
 101     int (*link_name)(struct object *, struct object_name *, struct object *);
 102     /* unlink an object's name from its parent */
 103     void (*unlink_name)(struct object *, struct object_name *);
 104     /* open a file object to access this object */
 105     struct object *(*open_file)(struct object *, unsigned int access, unsigned int sharing,
 106                                 unsigned int options);
 107     /* return list of kernel objects */
 108     struct list *(*get_kernel_obj_list)(struct object *);
 109     /* close a handle to this object */
 110     int (*close_handle)(struct object *,struct process *,obj_handle_t);
 111     /* destroy on refcount == 0 */
 112     void (*destroy)(struct object *);
 113 };
 114
 115 struct object
 116 {
 117     unsigned int              refcount;    /* reference count */
 118     unsigned int              handle_count;/* handle count */
 119     const struct object_ops  *ops;
 120     struct list               wait_queue;
 121     struct object_name       *name;
 122     struct security_descriptor *sd;
 123     unsigned int              is_permanent:1;
 124 #ifdef DEBUG_OBJECTS
 125     struct list               obj_list;
 126 #endif
 127 };
 128
 129 struct object_name
 130 {
 131     struct list         entry;           /* entry in the hash list */
 132     struct object      *obj;             /* object owning this name */
 133     struct object      *parent;          /* parent object */
 134     data_size_t         len;             /* name length in bytes */
 135     WCHAR               name[1];
 136 };
 137
 138 struct wait_queue_entry
 139 {
 140     struct list         entry;
 141     struct object      *obj;
 142     struct thread_wait *wait;
 143 };
 144
 145 extern void *mem_alloc( size_t size );  /* malloc wrapper */
 146 extern void *memdup( const void *data, size_t len );
 147 extern void *alloc_object( const struct object_ops *ops );
 148 extern void namespace_add( struct namespace *namespace, struct object_name *ptr );
 149 extern const WCHAR *get_object_name( struct object *obj, data_size_t *len );
 150 extern WCHAR *default_get_full_name( struct object *obj, data_size_t *ret_len );
 151 extern void dump_object_name( struct object *obj );
 152 extern struct object *lookup_named_object( struct object *root, const struct unicode_str *name,
 153                                            unsigned int attr, struct unicode_str *name_left );
 154 extern data_size_t get_path_element( const WCHAR *name, data_size_t len );
 155 extern void *create_named_object( struct object *parent, const struct object_ops *ops,
 156                                   const struct unicode_str *name, unsigned int attributes,
 157                                   const struct security_descriptor *sd );
 158 extern void *open_named_object( struct object *parent, const struct object_ops *ops,
 159                                 const struct unicode_str *name, unsigned int attributes );
 160 extern void unlink_named_object( struct object *obj );
 161 extern struct namespace *create_namespace( unsigned int hash_size );
 162 extern void free_kernel_objects( struct object *obj );
 163 /* grab/release_object can take any pointer, but you better make sure */
 164 /* that the thing pointed to starts with a struct object... */
 165 extern struct object *grab_object( void *obj );
 166 extern void release_object( void *obj );
 167 extern struct object *find_object( const struct namespace *namespace, const struct unicode_str *name,
 168                                    unsigned int attributes );
 169 extern struct object *find_object_index( const struct namespace *namespace, unsigned int index );
 170 extern int no_add_queue( struct object *obj, struct wait_queue_entry *entry );
 171 extern void no_satisfied( struct object *obj, struct wait_queue_entry *entry );
 172 extern int no_signal( struct object *obj, unsigned int access );
 173 extern struct fd *no_get_fd( struct object *obj );
 174 extern unsigned int default_map_access( struct object *obj, unsigned int access );
 175 extern struct security_descriptor *default_get_sd( struct object *obj );
 176 extern int default_set_sd( struct object *obj, const struct security_descriptor *sd, unsigned int set_info );
 177 extern int set_sd_defaults_from_token( struct object *obj, const struct security_descriptor *sd,
 178                                        unsigned int set_info, struct token *token );
 179 extern WCHAR *no_get_full_name( struct object *obj, data_size_t *ret_len );
 180 extern struct object *no_lookup_name( struct object *obj, struct unicode_str *name,
 181                                       unsigned int attributes, struct object *root );
 182 extern int no_link_name( struct object *obj, struct object_name *name, struct object *parent );
 183 extern void default_unlink_name( struct object *obj, struct object_name *name );
 184 extern struct object *no_open_file( struct object *obj, unsigned int access, unsigned int sharing,
 185                                     unsigned int options );
 186 extern struct list *no_kernel_obj_list( struct object *obj );
 187 extern int no_close_handle( struct object *obj, struct process *process, obj_handle_t handle );
 188 extern void no_destroy( struct object *obj );
 189 #ifdef DEBUG_OBJECTS
 190 extern void dump_objects(void);
 191 extern void close_objects(void);
 192 #endif
 193
 194 static inline void make_object_permanent( struct object *obj ) { obj->is_permanent = 1; }
 195 static inline void make_object_temporary( struct object *obj ) { obj->is_permanent = 0; }
 196
 197 static inline unsigned int map_access( unsigned int access, const generic_map_t *mapping )
 198 {
 199     if (access & GENERIC_READ)    access |= mapping->read;
 200     if (access & GENERIC_WRITE)   access |= mapping->write;
 201     if (access & GENERIC_EXECUTE) access |= mapping->exec;
 202     if (access & GENERIC_ALL)     access |= mapping->all;
 203     return access & ~(GENERIC_READ | GENERIC_WRITE | GENERIC_EXECUTE | GENERIC_ALL);
 204 }
 205
 206 /* event functions */
 207
 208 struct event;
 209 struct keyed_event;
 210
 211 extern struct event *create_event( struct object *root, const struct unicode_str *name,
 212                                    unsigned int attr, int manual_reset, int initial_state,
 213                                    const struct security_descriptor *sd );
 214 extern struct keyed_event *create_keyed_event( struct object *root, const struct unicode_str *name,
 215                                                unsigned int attr, const struct security_descriptor *sd );
 216 extern struct event *get_event_obj( struct process *process, obj_handle_t handle, unsigned int access );
 217 extern struct keyed_event *get_keyed_event_obj( struct process *process, obj_handle_t handle, unsigned int access );
 218 extern void pulse_event( struct event *event );
 219 extern void set_event( struct event *event );
 220 extern void reset_event( struct event *event );
 221
 222 /* mutex functions */
 223
 224 extern void abandon_mutexes( struct thread *thread );
 225
 226 /* serial functions */
 227
 228 int get_serial_async_timeout(struct object *obj, int type, int count);
 229
 230 /* socket functions */
 231
 232 extern void sock_init(void);
 233
 234 /* debugger functions */
 235
 236 extern void generate_debug_event( struct thread *thread, int code, const void *arg );
 237 extern void resume_delayed_debug_events( struct thread *thread );
 238 extern void generate_startup_debug_events( struct process *process );
 239
 240 /* registry functions */
 241
 242 extern unsigned int get_prefix_cpu_mask(void);
 243 extern void init_registry(void);
 244 extern void flush_registry(void);
 245
 246 /* signal functions */
 247
 248 extern void start_watchdog(void);
 249 extern void stop_watchdog(void);
 250 extern int watchdog_triggered(void);
 251 extern void init_signals(void);
 252
 253 /* atom functions */
 254
 255 extern atom_t add_global_atom( struct winstation *winstation, const struct unicode_str *str );
 256 extern atom_t find_global_atom( struct winstation *winstation, const struct unicode_str *str );
 257 extern int grab_global_atom( struct winstation *winstation, atom_t atom );
 258 extern void release_global_atom( struct winstation *winstation, atom_t atom );
 259
 260 /* directory functions */
 261
 262 extern struct object *get_root_directory(void);
 263 extern struct object *get_directory_obj( struct process *process, obj_handle_t handle );
 264 extern int directory_link_name( struct object *obj, struct object_name *name, struct object *parent );
 265 extern void init_directories( struct fd *intl_fd );
 266
 267 /* symbolic link functions */
 268
 269 extern struct object *create_obj_symlink( struct object *root, const struct unicode_str *name,
 270                                           unsigned int attr, struct object *target,
 271                                           const struct security_descriptor *sd );
 272 extern struct object *create_symlink( struct object *root, const struct unicode_str *name,
 273                                       unsigned int attr, const struct unicode_str *target,
 274                                       const struct security_descriptor *sd );
 275
 276 /* global variables */
 277
 278   /* command-line options */
 279 extern int debug_level;
 280 extern int foreground;
 281 extern timeout_t master_socket_timeout;
 282 extern const char *server_argv0;
 283
 284   /* server start time used for GetTickCount() */
 285 extern timeout_t server_start_time;
 286
 287 /* object types */
 288 extern struct type_descr no_type;
 289 extern struct type_descr objtype_type;
 290 extern struct type_descr directory_type;
 291 extern struct type_descr symlink_type;
 292 extern struct type_descr token_type;
 293 extern struct type_descr job_type;
 294 extern struct type_descr process_type;
 295 extern struct type_descr thread_type;
 296 extern struct type_descr debug_obj_type;
 297 extern struct type_descr event_type;
 298 extern struct type_descr mutex_type;
 299 extern struct type_descr semaphore_type;
 300 extern struct type_descr timer_type;
 301 extern struct type_descr keyed_event_type;
 302 extern struct type_descr winstation_type;
 303 extern struct type_descr desktop_type;
 304 extern struct type_descr device_type;
 305 extern struct type_descr completion_type;
 306 extern struct type_descr file_type;
 307 extern struct type_descr mapping_type;
 308 extern struct type_descr key_type;
 309
 310 #define KEYEDEVENT_WAIT       0x0001
 311 #define KEYEDEVENT_WAKE       0x0002
 312 #define KEYEDEVENT_ALL_ACCESS (STANDARD_RIGHTS_REQUIRED | 0x0003)
 313
 314 #endif  /* __WINE_SERVER_OBJECT_H */