server: Add an intermediate file object for file handles opened on devices.
[wine.git] / server / object.h
blob00bef3859736d2b2ee3454ab1e1aee6a54213721
1 /*
2 * Wine server objects
4 * Copyright (C) 1998 Alexandre Julliard
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.
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.
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
21 #ifndef __WINE_SERVER_OBJECT_H
22 #define __WINE_SERVER_OBJECT_H
24 #ifdef HAVE_SYS_POLL_H
25 #include <sys/poll.h>
26 #endif
28 #include <sys/time.h>
29 #include "wine/server_protocol.h"
30 #include "wine/list.h"
32 #define DEBUG_OBJECTS
34 /* kernel objects */
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;
51 struct unicode_str
53 const WCHAR *str;
54 data_size_t len;
57 /* operations valid on all objects */
58 struct object_ops
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 wait_queue_entry *);
72 /* wait satisfied */
73 void (*satisfied)(struct object *,struct wait_queue_entry *);
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 *);
95 struct object
97 unsigned int refcount; /* reference count */
98 unsigned int handle_count;/* handle count */
99 const struct object_ops *ops;
100 struct list wait_queue;
101 struct object_name *name;
102 struct security_descriptor *sd;
103 #ifdef DEBUG_OBJECTS
104 struct list obj_list;
105 #endif
108 struct wait_queue_entry
110 struct list entry;
111 struct object *obj;
112 struct thread_wait *wait;
115 extern void *mem_alloc( size_t size ); /* malloc wrapper */
116 extern void *memdup( const void *data, size_t len );
117 extern void *alloc_object( const struct object_ops *ops );
118 extern const WCHAR *get_object_name( struct object *obj, data_size_t *len );
119 extern WCHAR *get_object_full_name( struct object *obj, data_size_t *ret_len );
120 extern void dump_object_name( struct object *obj );
121 extern void *create_object( struct namespace *namespace, const struct object_ops *ops,
122 const struct unicode_str *name, struct object *parent );
123 extern void *create_named_object( struct namespace *namespace, const struct object_ops *ops,
124 const struct unicode_str *name, unsigned int attributes );
125 extern void unlink_named_object( struct object *obj );
126 extern void make_object_static( struct object *obj );
127 extern struct namespace *create_namespace( unsigned int hash_size );
128 /* grab/release_object can take any pointer, but you better make sure */
129 /* that the thing pointed to starts with a struct object... */
130 extern struct object *grab_object( void *obj );
131 extern void release_object( void *obj );
132 extern struct object *find_object( const struct namespace *namespace, const struct unicode_str *name,
133 unsigned int attributes );
134 extern struct object *find_object_index( const struct namespace *namespace, unsigned int index );
135 extern struct object_type *no_get_type( struct object *obj );
136 extern int no_add_queue( struct object *obj, struct wait_queue_entry *entry );
137 extern void no_satisfied( struct object *obj, struct wait_queue_entry *entry );
138 extern int no_signal( struct object *obj, unsigned int access );
139 extern struct fd *no_get_fd( struct object *obj );
140 extern unsigned int no_map_access( struct object *obj, unsigned int access );
141 extern struct security_descriptor *default_get_sd( struct object *obj );
142 extern int default_set_sd( struct object *obj, const struct security_descriptor *sd, unsigned int set_info );
143 extern int set_sd_defaults_from_token( struct object *obj, const struct security_descriptor *sd,
144 unsigned int set_info, struct token *token );
145 extern struct object *no_lookup_name( struct object *obj, struct unicode_str *name, unsigned int attributes );
146 extern struct object *no_open_file( struct object *obj, unsigned int access, unsigned int sharing,
147 unsigned int options );
148 extern int no_close_handle( struct object *obj, struct process *process, obj_handle_t handle );
149 extern void no_destroy( struct object *obj );
150 #ifdef DEBUG_OBJECTS
151 extern void dump_objects(void);
152 extern void close_objects(void);
153 #endif
155 /* event functions */
157 struct event;
158 struct keyed_event;
160 extern struct event *create_event( struct directory *root, const struct unicode_str *name,
161 unsigned int attr, int manual_reset, int initial_state,
162 const struct security_descriptor *sd );
163 extern struct keyed_event *create_keyed_event( struct directory *root, const struct unicode_str *name,
164 unsigned int attr, const struct security_descriptor *sd );
165 extern struct event *get_event_obj( struct process *process, obj_handle_t handle, unsigned int access );
166 extern struct keyed_event *get_keyed_event_obj( struct process *process, obj_handle_t handle, unsigned int access );
167 extern void pulse_event( struct event *event );
168 extern void set_event( struct event *event );
169 extern void reset_event( struct event *event );
171 /* mutex functions */
173 extern void abandon_mutexes( struct thread *thread );
175 /* serial functions */
177 int get_serial_async_timeout(struct object *obj, int type, int count);
179 /* socket functions */
181 extern void sock_init(void);
183 /* debugger functions */
185 extern int set_process_debugger( struct process *process, struct thread *debugger );
186 extern void generate_debug_event( struct thread *thread, int code, const void *arg );
187 extern void generate_startup_debug_events( struct process *process, client_ptr_t entry );
188 extern void debug_exit_thread( struct thread *thread );
190 /* registry functions */
192 extern unsigned int get_prefix_cpu_mask(void);
193 extern void init_registry(void);
194 extern void flush_registry(void);
196 /* signal functions */
198 extern void start_watchdog(void);
199 extern void stop_watchdog(void);
200 extern int watchdog_triggered(void);
201 extern void init_signals(void);
203 /* atom functions */
205 extern atom_t add_global_atom( struct winstation *winstation, const struct unicode_str *str );
206 extern atom_t find_global_atom( struct winstation *winstation, const struct unicode_str *str );
207 extern int grab_global_atom( struct winstation *winstation, atom_t atom );
208 extern void release_global_atom( struct winstation *winstation, atom_t atom );
210 /* directory functions */
212 extern struct directory *get_directory_obj( struct process *process, obj_handle_t handle, unsigned int access );
213 extern struct object *find_object_dir( struct directory *root, const struct unicode_str *name,
214 unsigned int attr, struct unicode_str *name_left );
215 extern void *create_named_object_dir( struct directory *root, const struct unicode_str *name,
216 unsigned int attr, const struct object_ops *ops );
217 extern void *open_object_dir( struct directory *root, const struct unicode_str *name,
218 unsigned int attr, const struct object_ops *ops );
219 extern struct object_type *get_object_type( const struct unicode_str *name );
220 extern void init_directories(void);
222 /* symbolic link functions */
224 extern struct symlink *create_symlink( struct directory *root, const struct unicode_str *name,
225 unsigned int attr, const struct unicode_str *target );
227 /* devices */
228 extern void create_named_pipe_device( struct directory *root, const struct unicode_str *name );
229 extern void create_mailslot_device( struct directory *root, const struct unicode_str *name );
231 /* global variables */
233 /* command-line options */
234 extern int debug_level;
235 extern int foreground;
236 extern timeout_t master_socket_timeout;
237 extern const char *server_argv0;
239 /* server start time used for GetTickCount() */
240 extern timeout_t server_start_time;
242 #define KEYEDEVENT_WAIT 0x0001
243 #define KEYEDEVENT_WAKE 0x0002
244 #define KEYEDEVENT_ALL_ACCESS (STANDARD_RIGHTS_REQUIRED | 0x0003)
246 #endif /* __WINE_SERVER_OBJECT_H */