object.h 8.75 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;
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 63
    /* dump the object (for debugging) */
    void (*dump)(struct object *,int);
    /* add a thread to the object wait queue */
64
    int  (*add_queue)(struct object *,struct wait_queue_entry *);
65 66 67 68 69 70
    /* 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 *);
71 72
    /* signal an object */
    int  (*signal)(struct object *, unsigned int);
73 74
    /* return an fd object that can be used to read/write from the object */
    struct fd *(*get_fd)(struct object *);
75 76
    /* map access rights to the specific rights for this object */
    unsigned int (*map_access)(struct object *, unsigned int);
77 78 79 80
    /* 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 );
81 82
    /* lookup a name if an object has a namespace */
    struct object *(*lookup_name)(struct object *, struct unicode_str *,unsigned int);
83 84 85
    /* open a file object to access this object */
    struct object *(*open_file)(struct object *, unsigned int access, unsigned int sharing,
                                unsigned int options);
86 87
    /* close a handle to this object */
    int (*close_handle)(struct object *,struct process *,obj_handle_t);
88 89
    /* destroy on refcount == 0 */
    void (*destroy)(struct object *);
Alexandre Julliard's avatar
Alexandre Julliard committed
90 91 92 93
};

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

104 105
struct wait_queue_entry
{
106 107 108
    struct list     entry;
    struct object  *obj;
    struct thread  *thread;
109 110
};

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

146 147 148 149
/* event functions */

struct event;

150
extern struct event *create_event( struct directory *root, const struct unicode_str *name,
151 152
                                   unsigned int attr, int manual_reset, int initial_state,
                                   const struct security_descriptor *sd );
153
extern struct event *get_event_obj( struct process *process, obj_handle_t handle, unsigned int access );
154 155 156 157
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
158 159 160 161
/* mutex functions */

extern void abandon_mutexes( struct thread *thread );

162 163
/* serial functions */

164
int get_serial_async_timeout(struct object *obj, int type, int count);
165

166 167 168 169
/* socket functions */

extern void sock_init(void);

170 171
/* debugger functions */

172
extern int set_process_debugger( struct process *process, struct thread *debugger );
173
extern void generate_debug_event( struct thread *thread, int code, void *arg );
174
extern void generate_startup_debug_events( struct process *process, void *entry );
175
extern void debug_exit_thread( struct thread *thread );
176

177 178 179 180
/* mapping functions */

extern int get_page_size(void);

181 182
/* registry functions */

183
extern void init_registry(void);
184
extern void flush_registry(void);
185

186 187
/* signal functions */

188 189 190
extern void start_watchdog(void);
extern void stop_watchdog(void);
extern int watchdog_triggered(void);
191 192
extern void init_signals(void);

193 194
/* atom functions */

195 196
extern atom_t add_global_atom( struct winstation *winstation, const WCHAR *str, data_size_t len );
extern atom_t find_global_atom( struct winstation *winstation, const WCHAR *str, data_size_t len );
197 198
extern int grab_global_atom( struct winstation *winstation, atom_t atom );
extern void release_global_atom( struct winstation *winstation, atom_t atom );
199

200 201 202 203 204 205 206
/* 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 );
207 208
extern void *open_object_dir( struct directory *root, const struct unicode_str *name,
                              unsigned int attr, const struct object_ops *ops );
209 210
extern void init_directories(void);

211 212 213 214 215
/* symbolic link functions */

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

216
/* devices */
217 218
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 );
219

220
/* global variables */
221

222
  /* command-line options */
Alexandre Julliard's avatar
Alexandre Julliard committed
223
extern int debug_level;
224
extern int foreground;
225
extern timeout_t master_socket_timeout;
226
extern const char *server_argv0;
Alexandre Julliard's avatar
Alexandre Julliard committed
227

228
  /* server start time used for GetTickCount() */
229
extern timeout_t server_start_time;
230

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