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