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