1 /*
2 * Server-side file definitions
3 *
4 * Copyright (C) 2003 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_FILE_H
22 #define __WINE_SERVER_FILE_H
23
24 #include "object.h"
25
26 struct fd;
27 struct mapping;
28 struct async_queue;
29 struct completion;
30
31 /* operations valid on file descriptor objects */
32 struct fd_ops
33 {
34 /* get the events we want to poll() for on this object */
35 int (*get_poll_events)(struct fd *);
36 /* a poll() event occurred */
37 void (*poll_event)(struct fd *,int event);
38 /* flush the object buffers */
39 void (*flush)(struct fd *, struct event **);
40 /* get file information */
41 enum server_fd_type (*get_fd_type)(struct fd *fd);
42 /* perform an ioctl on the file */
43 obj_handle_t (*ioctl)(struct fd *fd, ioctl_code_t code, const async_data_t *async, int blocking,
44 const void *data, data_size_t size);
45 /* queue an async operation */
46 void (*queue_async)(struct fd *, const async_data_t *data, int type, int count);
47 /* selected events for async i/o need an update */
48 void (*reselect_async)( struct fd *, struct async_queue *queue );
49 /* cancel an async operation */
50 void (*cancel_async)(struct fd *, struct process *process, struct thread *thread, client_ptr_t iosb);
51 };
52
53 /* file descriptor functions */
54
55 extern struct fd *alloc_pseudo_fd( const struct fd_ops *fd_user_ops, struct object *user,
56 unsigned int options );
57 extern void set_no_fd_status( struct fd *fd, unsigned int status );
58 extern struct fd *open_fd( struct fd *root, const char *name, int flags, mode_t *mode,
59 unsigned int access, unsigned int sharing, unsigned int options );
60 extern struct fd *create_anonymous_fd( const struct fd_ops *fd_user_ops,
61 int unix_fd, struct object *user, unsigned int options );
62 extern struct fd *dup_fd_object( struct fd *orig, unsigned int access, unsigned int sharing,
63 unsigned int options );
64 extern struct fd *get_fd_object_for_mapping( struct fd *fd, unsigned int access, unsigned int sharing );
65 extern void *get_fd_user( struct fd *fd );
66 extern void set_fd_user( struct fd *fd, const struct fd_ops *ops, struct object *user );
67 extern unsigned int get_fd_options( struct fd *fd );
68 extern int get_unix_fd( struct fd *fd );
69 extern int is_same_file_fd( struct fd *fd1, struct fd *fd2 );
70 extern int is_fd_removable( struct fd *fd );
71 extern int fd_close_handle( struct object *obj, struct process *process, obj_handle_t handle );
72 extern int check_fd_events( struct fd *fd, int events );
73 extern void set_fd_events( struct fd *fd, int events );
74 extern obj_handle_t lock_fd( struct fd *fd, file_pos_t offset, file_pos_t count, int shared, int wait );
75 extern void unlock_fd( struct fd *fd, file_pos_t offset, file_pos_t count );
76 extern void allow_fd_caching( struct fd *fd );
77 extern void set_fd_signaled( struct fd *fd, int signaled );
78 extern int is_fd_signaled( struct fd *fd );
79
80 extern int default_fd_signaled( struct object *obj, struct thread *thread );
81 extern unsigned int default_fd_map_access( struct object *obj, unsigned int access );
82 extern int default_fd_get_poll_events( struct fd *fd );
83 extern void default_poll_event( struct fd *fd, int event );
84 extern struct async *fd_queue_async( struct fd *fd, const async_data_t *data, int type );
85 extern void fd_async_wake_up( struct fd *fd, int type, unsigned int status );
86 extern void fd_reselect_async( struct fd *fd, struct async_queue *queue );
87 extern obj_handle_t no_fd_ioctl( struct fd *fd, ioctl_code_t code, const async_data_t *async,
88 int blocking, const void *data, data_size_t size );
89 extern obj_handle_t default_fd_ioctl( struct fd *fd, ioctl_code_t code, const async_data_t *async,
90 int blocking, const void *data, data_size_t size );
91 extern void no_fd_queue_async( struct fd *fd, const async_data_t *data, int type, int count );
92 extern void default_fd_queue_async( struct fd *fd, const async_data_t *data, int type, int count );
93 extern void default_fd_reselect_async( struct fd *fd, struct async_queue *queue );
94 extern void default_fd_cancel_async( struct fd *fd, struct process *process, struct thread *thread, client_ptr_t iosb );
95 extern void no_flush( struct fd *fd, struct event **event );
96 extern void main_loop(void);
97 extern void remove_process_locks( struct process *process );
98
99 static inline struct fd *get_obj_fd( struct object *obj ) { return obj->ops->get_fd( obj ); }
100
101 /* timeout functions */
102
103 struct timeout_user;
104 extern timeout_t current_time;
105
106 #define TICKS_PER_SEC 10000000
107
108 typedef void (*timeout_callback)( void *private );
109
110 extern struct timeout_user *add_timeout_user( timeout_t when, timeout_callback func, void *private );
111 extern void remove_timeout_user( struct timeout_user *user );
112 extern const char *get_timeout_str( timeout_t timeout );
113
114 /* file functions */
115
116 extern struct file *get_file_obj( struct process *process, obj_handle_t handle,
117 unsigned int access );
118 extern int get_file_unix_fd( struct file *file );
119 extern int is_same_file( struct file *file1, struct file *file2 );
120 extern struct file *create_file_for_fd( int fd, unsigned int access, unsigned int sharing );
121 extern struct file *create_file_for_fd_obj( struct fd *fd, unsigned int access, unsigned int sharing );
122 extern void file_set_error(void);
123 extern struct security_descriptor *mode_to_sd( mode_t mode, const SID *user, const SID *group );
124 extern mode_t sd_to_mode( const struct security_descriptor *sd, const SID *owner );
125
126 /* file mapping functions */
127
128 extern struct mapping *get_mapping_obj( struct process *process, obj_handle_t handle,
129 unsigned int access );
130 extern obj_handle_t open_mapping_file( struct process *process, struct mapping *mapping,
131 unsigned int access, unsigned int sharing );
132 extern struct mapping *grab_mapping_unless_removable( struct mapping *mapping );
133 extern int get_page_size(void);
134
135 /* change notification functions */
136
137 extern void do_change_notify( int unix_fd );
138 extern void sigio_callback(void);
139 extern struct object *create_dir_obj( struct fd *fd, unsigned int access, mode_t mode );
140 extern struct dir *get_dir_obj( struct process *process, obj_handle_t handle, unsigned int access );
141
142 /* completion */
143
144 extern struct completion *get_completion_obj( struct process *process, obj_handle_t handle, unsigned int access );
145 extern void add_completion( struct completion *completion, apc_param_t ckey, apc_param_t cvalue,
146 unsigned int status, unsigned int information );
147
148 /* serial port functions */
149
150 extern int is_serial_fd( struct fd *fd );
151 extern struct object *create_serial( struct fd *fd );
152
153 /* async I/O functions */
154 extern struct async_queue *create_async_queue( struct fd *fd );
155 extern void free_async_queue( struct async_queue *queue );
156 extern struct async *create_async( struct thread *thread, struct async_queue *queue,
157 const async_data_t *data );
158 extern void async_set_timeout( struct async *async, timeout_t timeout, unsigned int status );
159 extern void async_set_result( struct object *obj, unsigned int status,
160 unsigned int total, client_ptr_t apc );
161 extern int async_queued( struct async_queue *queue );
162 extern int async_waiting( struct async_queue *queue );
163 extern void async_terminate( struct async *async, unsigned int status );
164 extern int async_wake_up_by( struct async_queue *queue, struct process *process,
165 struct thread *thread, client_ptr_t iosb, unsigned int status );
166 extern void async_wake_up( struct async_queue *queue, unsigned int status );
167 extern struct completion *fd_get_completion( struct fd *fd, apc_param_t *p_key );
168 extern void fd_copy_completion( struct fd *src, struct fd *dst );
169
170 /* access rights that require Unix read permission */
171 #define FILE_UNIX_READ_ACCESS (FILE_READ_DATA|FILE_READ_ATTRIBUTES|FILE_READ_EA)
172
173 /* access rights that require Unix write permission */
174 #define FILE_UNIX_WRITE_ACCESS (FILE_WRITE_DATA|FILE_WRITE_ATTRIBUTES|FILE_WRITE_EA)
175
176 /* magic file access rights for mappings */
177 #define FILE_MAPPING_IMAGE 0x80000000 /* set for SEC_IMAGE mappings */
178 #define FILE_MAPPING_WRITE 0x40000000 /* set for writable shared mappings */
179 #define FILE_MAPPING_ACCESS 0x20000000 /* set for all mappings */
180
181 #endif /* __WINE_SERVER_FILE_H */
182
This page was automatically generated by the
LXR engine.
Visit the LXR main site for more
information.