object.h 10.6 KB
Newer Older
Alexandre Julliard's avatar
Alexandre Julliard committed
1 2 3 4
/*
 * Wine server objects
 *
 * Copyright (C) 1998 Alexandre Julliard
5 6 7 8 9 10 11 12 13 14 15 16 17
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * 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
Alexandre Julliard's avatar
Alexandre Julliard committed
19 20 21 22 23
 */

#ifndef __WINE_SERVER_OBJECT_H
#define __WINE_SERVER_OBJECT_H

Steven Edwards's avatar
Steven Edwards committed
24
#ifdef HAVE_SYS_POLL_H
25
#include <sys/poll.h>
Steven Edwards's avatar
Steven Edwards committed
26 27
#endif

Alexandre Julliard's avatar
Alexandre Julliard committed
28
#include <sys/time.h>
29
#include "wine/server_protocol.h"
30
#include "wine/list.h"
Alexandre Julliard's avatar
Alexandre Julliard committed
31

32 33
#define DEBUG_OBJECTS

Alexandre Julliard's avatar
Alexandre Julliard committed
34 35
/* kernel objects */

36
struct namespace;
Alexandre Julliard's avatar
Alexandre Julliard committed
37 38
struct object;
struct object_name;
Alexandre Julliard's avatar
Alexandre Julliard committed
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;
Alexandre Julliard's avatar
Alexandre Julliard committed
48

49 50 51 52

struct unicode_str
{
    const WCHAR *str;
53
    data_size_t  len;
54 55
};

56
/* operations valid on all objects */
Alexandre Julliard's avatar
Alexandre Julliard committed
57 58
struct object_ops
{
59 60
    /* size of this object type */
    size_t size;
61 62
    /* dump the object (for debugging) */
    void (*dump)(struct object *,int);
63 64
    /* return the object type */
    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 68 69
    /* remove a thread from the object wait queue */
    void (*remove_queue)(struct object *,struct wait_queue_entry *);
    /* is object signaled? */
70
    int  (*signaled)(struct object *,struct wait_queue_entry *);
71 72
    /* wait satisfied */
    void (*satisfied)(struct object *,struct wait_queue_entry *);
73 74
    /* signal an object */
    int  (*signal)(struct object *, unsigned int);
75 76
    /* return an fd object that can be used to read/write from the object */
    struct fd *(*get_fd)(struct object *);
77 78
    /* map access rights to the specific rights for this object */
    unsigned int (*map_access)(struct object *, unsigned int);
79 80 81 82
    /* returns the security descriptor of the object */
    struct security_descriptor *(*get_sd)( struct object * );
    /* sets the security descriptor of the object */
    int (*set_sd)( struct object *, const struct security_descriptor *, unsigned int );
83 84
    /* lookup a name if an object has a namespace */
    struct object *(*lookup_name)(struct object *, struct unicode_str *,unsigned int);
85 86 87 88
    /* link an object's name into a parent object */
    int (*link_name)(struct object *, struct object_name *, struct object *);
    /* unlink an object's name from its parent */
    void (*unlink_name)(struct object *, struct object_name *);
89 90 91
    /* open a file object to access this object */
    struct object *(*open_file)(struct object *, unsigned int access, unsigned int sharing,
                                unsigned int options);
92 93
    /* return list of kernel objects */
    struct list *(*get_kernel_obj_list)(struct object *);
94 95
    /* close a handle to this object */
    int (*close_handle)(struct object *,struct process *,obj_handle_t);
96 97
    /* destroy on refcount == 0 */
    void (*destroy)(struct object *);
Alexandre Julliard's avatar
Alexandre Julliard committed
98 99 100 101
};

struct object
{
102
    unsigned int              refcount;    /* reference count */
103
    unsigned int              handle_count;/* handle count */
Alexandre Julliard's avatar
Alexandre Julliard committed
104
    const struct object_ops  *ops;
105
    struct list               wait_queue;
Alexandre Julliard's avatar
Alexandre Julliard committed
106
    struct object_name       *name;
107
    struct security_descriptor *sd;
108
#ifdef DEBUG_OBJECTS
109
    struct list               obj_list;
110
#endif
Alexandre Julliard's avatar
Alexandre Julliard committed
111 112
};

113 114 115 116 117 118 119 120 121
struct object_name
{
    struct list         entry;           /* entry in the hash list */
    struct object      *obj;             /* object owning this name */
    struct object      *parent;          /* parent object */
    data_size_t         len;             /* name length in bytes */
    WCHAR               name[1];
};

122 123
struct wait_queue_entry
{
124 125 126
    struct list         entry;
    struct object      *obj;
    struct thread_wait *wait;
127 128
};

Alexandre Julliard's avatar
Alexandre Julliard committed
129
extern void *mem_alloc( size_t size );  /* malloc wrapper */
130
extern void *memdup( const void *data, size_t len );
131
extern void *alloc_object( const struct object_ops *ops );
132
extern void namespace_add( struct namespace *namespace, struct object_name *ptr );
133
extern const WCHAR *get_object_name( struct object *obj, data_size_t *len );
134
extern WCHAR *get_object_full_name( struct object *obj, data_size_t *ret_len );
135
extern void dump_object_name( struct object *obj );
136 137
extern struct object *lookup_named_object( struct object *root, const struct unicode_str *name,
                                           unsigned int attr, struct unicode_str *name_left );
138
extern void *create_named_object( struct object *parent, const struct object_ops *ops,
139 140
                                  const struct unicode_str *name, unsigned int attributes,
                                  const struct security_descriptor *sd );
141 142
extern void *open_named_object( struct object *parent, const struct object_ops *ops,
                                const struct unicode_str *name, unsigned int attributes );
143
extern void unlink_named_object( struct object *obj );
144
extern void make_object_static( struct object *obj );
145
extern struct namespace *create_namespace( unsigned int hash_size );
146
extern void free_kernel_objects( struct object *obj );
Alexandre Julliard's avatar
Alexandre Julliard committed
147 148 149 150
/* grab/release_object can take any pointer, but you better make sure */
/* that the thing pointed to starts with a struct object... */
extern struct object *grab_object( void *obj );
extern void release_object( void *obj );
151
extern struct object *find_object( const struct namespace *namespace, const struct unicode_str *name,
152
                                   unsigned int attributes );
153
extern struct object *find_object_index( const struct namespace *namespace, unsigned int index );
154
extern struct object_type *no_get_type( struct object *obj );
155
extern int no_add_queue( struct object *obj, struct wait_queue_entry *entry );
156
extern void no_satisfied( struct object *obj, struct wait_queue_entry *entry );
157
extern int no_signal( struct object *obj, unsigned int access );
158
extern struct fd *no_get_fd( struct object *obj );
159
extern unsigned int no_map_access( struct object *obj, unsigned int access );
160 161
extern struct security_descriptor *default_get_sd( struct object *obj );
extern int default_set_sd( struct object *obj, const struct security_descriptor *sd, unsigned int set_info );
162 163
extern int set_sd_defaults_from_token( struct object *obj, const struct security_descriptor *sd,
                                       unsigned int set_info, struct token *token );
164
extern struct object *no_lookup_name( struct object *obj, struct unicode_str *name, unsigned int attributes );
165
extern int no_link_name( struct object *obj, struct object_name *name, struct object *parent );
166
extern void default_unlink_name( struct object *obj, struct object_name *name );
167 168
extern struct object *no_open_file( struct object *obj, unsigned int access, unsigned int sharing,
                                    unsigned int options );
169
extern struct list *no_kernel_obj_list( struct object *obj );
170
extern int no_close_handle( struct object *obj, struct process *process, obj_handle_t handle );
171
extern void no_destroy( struct object *obj );
172 173
#ifdef DEBUG_OBJECTS
extern void dump_objects(void);
174
extern void close_objects(void);
175
#endif
Alexandre Julliard's avatar
Alexandre Julliard committed
176

177 178 179
/* event functions */

struct event;
180
struct keyed_event;
181

182
extern struct event *create_event( struct object *root, const struct unicode_str *name,
183 184
                                   unsigned int attr, int manual_reset, int initial_state,
                                   const struct security_descriptor *sd );
185
extern struct keyed_event *create_keyed_event( struct object *root, const struct unicode_str *name,
186
                                               unsigned int attr, const struct security_descriptor *sd );
187
extern struct event *get_event_obj( struct process *process, obj_handle_t handle, unsigned int access );
188
extern struct keyed_event *get_keyed_event_obj( struct process *process, obj_handle_t handle, unsigned int access );
189 190 191 192
extern void pulse_event( struct event *event );
extern void set_event( struct event *event );
extern void reset_event( struct event *event );

Alexandre Julliard's avatar
Alexandre Julliard committed
193 194 195 196
/* mutex functions */

extern void abandon_mutexes( struct thread *thread );

197 198
/* serial functions */

199
int get_serial_async_timeout(struct object *obj, int type, int count);
200

201 202 203 204
/* socket functions */

extern void sock_init(void);

205 206
/* debugger functions */

207
extern int set_process_debugger( struct process *process, struct thread *debugger );
208 209
extern void generate_debug_event( struct thread *thread, int code, const void *arg );
extern void generate_startup_debug_events( struct process *process, client_ptr_t entry );
210
extern void debug_exit_thread( struct thread *thread );
211

212 213
/* registry functions */

214
extern unsigned int get_prefix_cpu_mask(void);
215
extern void init_registry(void);
216
extern void flush_registry(void);
217

218 219
/* signal functions */

220 221 222
extern void start_watchdog(void);
extern void stop_watchdog(void);
extern int watchdog_triggered(void);
223 224
extern void init_signals(void);

225 226
/* atom functions */

227 228
extern atom_t add_global_atom( struct winstation *winstation, const struct unicode_str *str );
extern atom_t find_global_atom( struct winstation *winstation, const struct unicode_str *str );
229 230
extern int grab_global_atom( struct winstation *winstation, atom_t atom );
extern void release_global_atom( struct winstation *winstation, atom_t atom );
231

232 233
/* directory functions */

234
extern struct object *get_root_directory(void);
235
extern struct object *get_directory_obj( struct process *process, obj_handle_t handle );
236
extern struct object_type *get_object_type( const struct unicode_str *name );
237
extern int directory_link_name( struct object *obj, struct object_name *name, struct object *parent );
238 239
extern void init_directories(void);

240 241
/* symbolic link functions */

242 243 244
extern struct object *create_obj_symlink( struct object *root, const struct unicode_str *name,
                                          unsigned int attr, struct object *target,
                                          const struct security_descriptor *sd );
245

246
/* global variables */
247

248
  /* command-line options */
Alexandre Julliard's avatar
Alexandre Julliard committed
249
extern int debug_level;
250
extern int foreground;
251
extern timeout_t master_socket_timeout;
252
extern const char *server_argv0;
Alexandre Julliard's avatar
Alexandre Julliard committed
253

254
  /* server start time used for GetTickCount() */
255
extern timeout_t server_start_time;
256

257 258 259 260
#define KEYEDEVENT_WAIT       0x0001
#define KEYEDEVENT_WAKE       0x0002
#define KEYEDEVENT_ALL_ACCESS (STANDARD_RIGHTS_REQUIRED | 0x0003)

Alexandre Julliard's avatar
Alexandre Julliard committed
261
#endif  /* __WINE_SERVER_OBJECT_H */