object.h 9.16 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 directory;
48
struct object_type;
Alexandre Julliard's avatar
Alexandre Julliard committed
49

50 51 52 53

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

57
/* operations valid on all objects */
Alexandre Julliard's avatar
Alexandre Julliard committed
58 59
struct object_ops
{
60 61
    /* size of this object type */
    size_t size;
62 63
    /* dump the object (for debugging) */
    void (*dump)(struct object *,int);
64 65
    /* return the object type */
    struct object_type *(*get_type)(struct object *);
66
    /* add a thread to the object wait queue */
67
    int  (*add_queue)(struct object *,struct wait_queue_entry *);
68 69 70 71 72 73
    /* remove a thread from the object wait queue */
    void (*remove_queue)(struct object *,struct wait_queue_entry *);
    /* is object signaled? */
    int  (*signaled)(struct object *,struct thread *);
    /* wait satisfied; return 1 if abandoned */
    int  (*satisfied)(struct object *,struct thread *);
74 75
    /* signal an object */
    int  (*signal)(struct object *, unsigned int);
76 77
    /* return an fd object that can be used to read/write from the object */
    struct fd *(*get_fd)(struct object *);
78 79
    /* map access rights to the specific rights for this object */
    unsigned int (*map_access)(struct object *, unsigned int);
80 81 82 83
    /* 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 );
84 85
    /* lookup a name if an object has a namespace */
    struct object *(*lookup_name)(struct object *, struct unicode_str *,unsigned int);
86 87 88
    /* open a file object to access this object */
    struct object *(*open_file)(struct object *, unsigned int access, unsigned int sharing,
                                unsigned int options);
89 90
    /* close a handle to this object */
    int (*close_handle)(struct object *,struct process *,obj_handle_t);
91 92
    /* destroy on refcount == 0 */
    void (*destroy)(struct object *);
Alexandre Julliard's avatar
Alexandre Julliard committed
93 94 95 96
};

struct object
{
97
    unsigned int              refcount;    /* reference count */
Alexandre Julliard's avatar
Alexandre Julliard committed
98
    const struct object_ops  *ops;
99
    struct list               wait_queue;
Alexandre Julliard's avatar
Alexandre Julliard committed
100
    struct object_name       *name;
101
    struct security_descriptor *sd;
102
#ifdef DEBUG_OBJECTS
103
    struct list               obj_list;
104
#endif
Alexandre Julliard's avatar
Alexandre Julliard committed
105 106
};

107 108
struct wait_queue_entry
{
109 110 111
    struct list     entry;
    struct object  *obj;
    struct thread  *thread;
112 113
};

Alexandre Julliard's avatar
Alexandre Julliard committed
114
extern void *mem_alloc( size_t size );  /* malloc wrapper */
115
extern void *memdup( const void *data, size_t len );
116
extern void *alloc_object( const struct object_ops *ops );
117
extern const WCHAR *get_object_name( struct object *obj, data_size_t *len );
118
extern WCHAR *get_object_full_name( struct object *obj, data_size_t *ret_len );
119
extern void dump_object_name( struct object *obj );
120 121
extern void *create_object( struct namespace *namespace, const struct object_ops *ops,
                            const struct unicode_str *name, struct object *parent );
122
extern void *create_named_object( struct namespace *namespace, const struct object_ops *ops,
123
                                  const struct unicode_str *name, unsigned int attributes );
124
extern void unlink_named_object( struct object *obj );
125
extern void make_object_static( struct object *obj );
126
extern struct namespace *create_namespace( unsigned int hash_size );
Alexandre Julliard's avatar
Alexandre Julliard committed
127 128 129 130
/* 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 );
131
extern struct object *find_object( const struct namespace *namespace, const struct unicode_str *name,
132
                                   unsigned int attributes );
133
extern struct object *find_object_index( const struct namespace *namespace, unsigned int index );
134
extern struct object_type *no_get_type( struct object *obj );
135
extern int no_add_queue( struct object *obj, struct wait_queue_entry *entry );
136
extern int no_satisfied( struct object *obj, struct thread *thread );
137
extern int no_signal( struct object *obj, unsigned int access );
138
extern struct fd *no_get_fd( struct object *obj );
139
extern unsigned int no_map_access( struct object *obj, unsigned int access );
140 141
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 );
142
extern struct object *no_lookup_name( struct object *obj, struct unicode_str *name, unsigned int attributes );
143 144
extern struct object *no_open_file( struct object *obj, unsigned int access, unsigned int sharing,
                                    unsigned int options );
145
extern int no_close_handle( struct object *obj, struct process *process, obj_handle_t handle );
146
extern void no_destroy( struct object *obj );
147 148
#ifdef DEBUG_OBJECTS
extern void dump_objects(void);
149
extern void close_objects(void);
150
#endif
Alexandre Julliard's avatar
Alexandre Julliard committed
151

152 153 154 155
/* event functions */

struct event;

156
extern struct event *create_event( struct directory *root, const struct unicode_str *name,
157 158
                                   unsigned int attr, int manual_reset, int initial_state,
                                   const struct security_descriptor *sd );
159
extern struct event *get_event_obj( struct process *process, obj_handle_t handle, unsigned int access );
160 161 162 163
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
164 165 166 167
/* mutex functions */

extern void abandon_mutexes( struct thread *thread );

168 169
/* serial functions */

170
int get_serial_async_timeout(struct object *obj, int type, int count);
171

172 173 174 175
/* socket functions */

extern void sock_init(void);

176 177
/* debugger functions */

178
extern int set_process_debugger( struct process *process, struct thread *debugger );
179 180
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 );
181
extern void debug_exit_thread( struct thread *thread );
182

183 184
/* registry functions */

185
extern unsigned int get_prefix_cpu_mask(void);
186
extern void init_registry(void);
187
extern void flush_registry(void);
188

189 190
/* signal functions */

191 192 193
extern void start_watchdog(void);
extern void stop_watchdog(void);
extern int watchdog_triggered(void);
194 195
extern void init_signals(void);

196 197
/* atom functions */

198 199
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 );
200 201
extern int grab_global_atom( struct winstation *winstation, atom_t atom );
extern void release_global_atom( struct winstation *winstation, atom_t atom );
202

203 204 205 206 207 208 209
/* directory functions */

extern struct directory *get_directory_obj( struct process *process, obj_handle_t handle, unsigned int access );
extern struct object *find_object_dir( struct directory *root, const struct unicode_str *name,
                                       unsigned int attr, struct unicode_str *name_left );
extern void *create_named_object_dir( struct directory *root, const struct unicode_str *name,
                                      unsigned int attr, const struct object_ops *ops );
210 211
extern void *open_object_dir( struct directory *root, const struct unicode_str *name,
                              unsigned int attr, const struct object_ops *ops );
212
extern struct object_type *get_object_type( const struct unicode_str *name );
213 214
extern void init_directories(void);

215 216 217 218 219
/* symbolic link functions */

extern struct symlink *create_symlink( struct directory *root, const struct unicode_str *name,
                                       unsigned int attr, const struct unicode_str *target );

220
/* devices */
221 222
extern void create_named_pipe_device( struct directory *root, const struct unicode_str *name );
extern void create_mailslot_device( struct directory *root, const struct unicode_str *name );
223

224
/* global variables */
225

226
  /* command-line options */
Alexandre Julliard's avatar
Alexandre Julliard committed
227
extern int debug_level;
228
extern int foreground;
229
extern timeout_t master_socket_timeout;
230
extern const char *server_argv0;
Alexandre Julliard's avatar
Alexandre Julliard committed
231

232
  /* server start time used for GetTickCount() */
233
extern timeout_t server_start_time;
234

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