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 directory;
48 struct object_type;
49
50
51 struct unicode_str
52 {
53 const WCHAR *str;
54 data_size_t len;
55 };
56
57 /* operations valid on all objects */
58 struct object_ops
59 {
60 /* size of this object type */
61 size_t size;
62 /* dump the object (for debugging) */
63 void (*dump)(struct object *,int);
64 /* return the object type */
65 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 /* remove a thread from the object wait queue */
69 void (*remove_queue)(struct object *,struct wait_queue_entry *);
70 /* is object signaled? */
71 int (*signaled)(struct object *,struct thread *);
72 /* wait satisfied; return 1 if abandoned */
73 int (*satisfied)(struct object *,struct thread *);
74 /* signal an object */
75 int (*signal)(struct object *, unsigned int);
76 /* return an fd object that can be used to read/write from the object */
77 struct fd *(*get_fd)(struct object *);
78 /* map access rights to the specific rights for this object */
79 unsigned int (*map_access)(struct object *, unsigned int);
80 /* returns the security descriptor of the object */
81 struct security_descriptor *(*get_sd)( struct object * );
82 /* sets the security descriptor of the object */
83 int (*set_sd)( struct object *, const struct security_descriptor *, unsigned int );
84 /* lookup a name if an object has a namespace */
85 struct object *(*lookup_name)(struct object *, struct unicode_str *,unsigned int);
86 /* open a file object to access this object */
87 struct object *(*open_file)(struct object *, unsigned int access, unsigned int sharing,
88 unsigned int options);
89 /* close a handle to this object */
90 int (*close_handle)(struct object *,struct process *,obj_handle_t);
91 /* destroy on refcount == 0 */
92 void (*destroy)(struct object *);
93 };
94
95 struct object
96 {
97 unsigned int refcount; /* reference count */
98 const struct object_ops *ops;
99 struct list wait_queue;
100 struct object_name *name;
101 struct security_descriptor *sd;
102 #ifdef DEBUG_OBJECTS
103 struct list obj_list;
104 #endif
105 };
106
107 struct wait_queue_entry
108 {
109 struct list entry;
110 struct object *obj;
111 struct thread *thread;
112 };
113
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 extern void *create_object( struct namespace *namespace, const struct object_ops *ops,
121 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 );
127 /* grab/release_object can take any pointer, but you better make sure */
128 /* that the thing pointed to starts with a struct object... */
129 extern struct object *grab_object( void *obj );
130 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 extern struct security_descriptor *default_get_sd( struct object *obj );
141 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 extern struct object *no_open_file( struct object *obj, unsigned int access, unsigned int sharing,
144 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 #ifdef DEBUG_OBJECTS
148 extern void dump_objects(void);
149 extern void close_objects(void);
150 #endif
151
152 /* event functions */
153
154 struct event;
155
156 extern struct event *create_event( struct directory *root, const struct unicode_str *name,
157 unsigned int attr, int manual_reset, int initial_state,
158 const struct security_descriptor *sd );
159 extern struct event *get_event_obj( struct process *process, obj_handle_t handle, unsigned int access );
160 extern void pulse_event( struct event *event );
161 extern void set_event( struct event *event );
162 extern void reset_event( struct event *event );
163
164 /* mutex functions */
165
166 extern void abandon_mutexes( struct thread *thread );
167
168 /* serial functions */
169
170 int get_serial_async_timeout(struct object *obj, int type, int count);
171
172 /* socket functions */
173
174 extern void sock_init(void);
175
176 /* debugger functions */
177
178 extern int set_process_debugger( struct process *process, struct thread *debugger );
179 extern void generate_debug_event( struct thread *thread, int code, const void *arg );
180 extern void generate_startup_debug_events( struct process *process, client_ptr_t entry );
181 extern void debug_exit_thread( struct thread *thread );
182
183 /* registry functions */
184
185 extern unsigned int get_prefix_cpu_mask(void);
186 extern void init_registry(void);
187 extern void flush_registry(void);
188
189 /* signal functions */
190
191 extern void start_watchdog(void);
192 extern void stop_watchdog(void);
193 extern int watchdog_triggered(void);
194 extern void init_signals(void);
195
196 /* atom functions */
197
198 extern atom_t add_global_atom( struct winstation *winstation, const struct unicode_str *str );
199 extern atom_t find_global_atom( struct winstation *winstation, const struct unicode_str *str );
200 extern int grab_global_atom( struct winstation *winstation, atom_t atom );
201 extern void release_global_atom( struct winstation *winstation, atom_t atom );
202
203 /* directory functions */
204
205 extern struct directory *get_directory_obj( struct process *process, obj_handle_t handle, unsigned int access );
206 extern struct object *find_object_dir( struct directory *root, const struct unicode_str *name,
207 unsigned int attr, struct unicode_str *name_left );
208 extern void *create_named_object_dir( struct directory *root, const struct unicode_str *name,
209 unsigned int attr, const struct object_ops *ops );
210 extern void *open_object_dir( struct directory *root, const struct unicode_str *name,
211 unsigned int attr, const struct object_ops *ops );
212 extern struct object_type *get_object_type( const struct unicode_str *name );
213 extern void init_directories(void);
214
215 /* symbolic link functions */
216
217 extern struct symlink *create_symlink( struct directory *root, const struct unicode_str *name,
218 unsigned int attr, const struct unicode_str *target );
219
220 /* devices */
221 extern void create_named_pipe_device( struct directory *root, const struct unicode_str *name );
222 extern void create_mailslot_device( struct directory *root, const struct unicode_str *name );
223
224 /* global variables */
225
226 /* command-line options */
227 extern int debug_level;
228 extern int foreground;
229 extern timeout_t master_socket_timeout;
230 extern const char *server_argv0;
231
232 /* server start time used for GetTickCount() */
233 extern timeout_t server_start_time;
234
235 #endif /* __WINE_SERVER_OBJECT_H */
236
This page was automatically generated by the
LXR engine.
Visit the LXR main site for more
information.