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