2 * Server-side file definitions
4 * Copyright (C) 2003 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_FILE_H
22 #define __WINE_SERVER_FILE_H
24 #include <sys/types.h>
33 /* operations valid on file descriptor objects */
36 /* get the events we want to poll() for on this object */
37 int (*get_poll_events
)(struct fd
*);
38 /* a poll() event occurred */
39 void (*poll_event
)(struct fd
*,int event
);
40 /* get file information */
41 enum server_fd_type (*get_fd_type
)(struct fd
*fd
);
42 /* perform a read on the file */
43 obj_handle_t (*read
)(struct fd
*, const async_data_t
*, int, file_pos_t
);
44 /* perform a write on the file */
45 obj_handle_t (*write
)(struct fd
*, const async_data_t
*, int, file_pos_t
, data_size_t
* );
46 /* flush the object buffers */
47 obj_handle_t (*flush
)(struct fd
*, const async_data_t
*, int);
48 /* perform an ioctl on the file */
49 obj_handle_t (*ioctl
)(struct fd
*fd
, ioctl_code_t code
, const async_data_t
*async
, int blocking
);
50 /* queue an async operation */
51 void (*queue_async
)(struct fd
*, const async_data_t
*data
, int type
, int count
);
52 /* selected events for async i/o need an update */
53 void (*reselect_async
)( struct fd
*, struct async_queue
*queue
);
56 /* server-side representation of I/O status block */
59 struct object obj
; /* object header */
60 unsigned int status
; /* resulting status (or STATUS_PENDING) */
61 data_size_t result
; /* size of result (input or output depending on the type) */
62 data_size_t in_size
; /* size of input data */
63 void *in_data
; /* input data */
64 data_size_t out_size
; /* size of output data */
65 void *out_data
; /* output data */
68 /* file descriptor functions */
70 extern struct fd
*alloc_pseudo_fd( const struct fd_ops
*fd_user_ops
, struct object
*user
,
71 unsigned int options
);
72 extern void set_no_fd_status( struct fd
*fd
, unsigned int status
);
73 extern struct fd
*open_fd( struct fd
*root
, const char *name
, int flags
, mode_t
*mode
,
74 unsigned int access
, unsigned int sharing
, unsigned int options
);
75 extern struct fd
*create_anonymous_fd( const struct fd_ops
*fd_user_ops
,
76 int unix_fd
, struct object
*user
, unsigned int options
);
77 extern struct fd
*dup_fd_object( struct fd
*orig
, unsigned int access
, unsigned int sharing
,
78 unsigned int options
);
79 extern struct fd
*get_fd_object_for_mapping( struct fd
*fd
, unsigned int access
, unsigned int sharing
);
80 extern void *get_fd_user( struct fd
*fd
);
81 extern void set_fd_user( struct fd
*fd
, const struct fd_ops
*ops
, struct object
*user
);
82 extern unsigned int get_fd_options( struct fd
*fd
);
83 extern int get_unix_fd( struct fd
*fd
);
84 extern int is_same_file_fd( struct fd
*fd1
, struct fd
*fd2
);
85 extern int is_fd_removable( struct fd
*fd
);
86 extern int fd_close_handle( struct object
*obj
, struct process
*process
, obj_handle_t handle
);
87 extern int check_fd_events( struct fd
*fd
, int events
);
88 extern void set_fd_events( struct fd
*fd
, int events
);
89 extern obj_handle_t
lock_fd( struct fd
*fd
, file_pos_t offset
, file_pos_t count
, int shared
, int wait
);
90 extern void unlock_fd( struct fd
*fd
, file_pos_t offset
, file_pos_t count
);
91 extern void allow_fd_caching( struct fd
*fd
);
92 extern void set_fd_signaled( struct fd
*fd
, int signaled
);
93 extern int is_fd_signaled( struct fd
*fd
);
94 extern char *dup_fd_name( struct fd
*root
, const char *name
);
96 extern int default_fd_signaled( struct object
*obj
, struct wait_queue_entry
*entry
);
97 extern unsigned int default_fd_map_access( struct object
*obj
, unsigned int access
);
98 extern int default_fd_get_poll_events( struct fd
*fd
);
99 extern void default_poll_event( struct fd
*fd
, int event
);
100 extern struct async
*fd_queue_async( struct fd
*fd
, const async_data_t
*data
, struct iosb
*iosb
, int type
);
101 extern void fd_async_wake_up( struct fd
*fd
, int type
, unsigned int status
);
102 extern void fd_reselect_async( struct fd
*fd
, struct async_queue
*queue
);
103 extern obj_handle_t
no_fd_read( struct fd
*fd
, const async_data_t
*async
, int blocking
, file_pos_t pos
);
104 extern obj_handle_t
no_fd_write( struct fd
*fd
, const async_data_t
*async
, int blocking
,
105 file_pos_t pos
, data_size_t
*written
);
106 extern obj_handle_t
no_fd_flush( struct fd
*fd
, const async_data_t
*async
, int blocking
);
107 extern obj_handle_t
no_fd_ioctl( struct fd
*fd
, ioctl_code_t code
, const async_data_t
*async
, int blocking
);
108 extern obj_handle_t
default_fd_ioctl( struct fd
*fd
, ioctl_code_t code
, const async_data_t
*async
, int blocking
);
109 extern void no_fd_queue_async( struct fd
*fd
, const async_data_t
*data
, int type
, int count
);
110 extern void default_fd_queue_async( struct fd
*fd
, const async_data_t
*data
, int type
, int count
);
111 extern void default_fd_reselect_async( struct fd
*fd
, struct async_queue
*queue
);
112 extern void main_loop(void);
113 extern void remove_process_locks( struct process
*process
);
115 static inline struct fd
*get_obj_fd( struct object
*obj
) { return obj
->ops
->get_fd( obj
); }
117 /* timeout functions */
120 extern timeout_t current_time
;
122 #define TICKS_PER_SEC 10000000
124 typedef void (*timeout_callback
)( void *private );
126 extern struct timeout_user
*add_timeout_user( timeout_t when
, timeout_callback func
, void *private );
127 extern void remove_timeout_user( struct timeout_user
*user
);
128 extern const char *get_timeout_str( timeout_t timeout
);
132 extern struct file
*get_file_obj( struct process
*process
, obj_handle_t handle
,
133 unsigned int access
);
134 extern int get_file_unix_fd( struct file
*file
);
135 extern int is_same_file( struct file
*file1
, struct file
*file2
);
136 extern struct file
*create_file_for_fd( int fd
, unsigned int access
, unsigned int sharing
);
137 extern struct file
*create_file_for_fd_obj( struct fd
*fd
, unsigned int access
, unsigned int sharing
);
138 extern void file_set_error(void);
139 extern struct security_descriptor
*mode_to_sd( mode_t mode
, const SID
*user
, const SID
*group
);
140 extern mode_t
sd_to_mode( const struct security_descriptor
*sd
, const SID
*owner
);
142 /* file mapping functions */
144 extern struct mapping
*get_mapping_obj( struct process
*process
, obj_handle_t handle
,
145 unsigned int access
);
146 extern obj_handle_t
open_mapping_file( struct process
*process
, struct mapping
*mapping
,
147 unsigned int access
, unsigned int sharing
);
148 extern struct mapping
*grab_mapping_unless_removable( struct mapping
*mapping
);
149 extern int get_page_size(void);
151 /* device functions */
153 extern struct object
*create_named_pipe_device( struct object
*root
, const struct unicode_str
*name
);
154 extern struct object
*create_mailslot_device( struct object
*root
, const struct unicode_str
*name
);
155 extern struct object
*create_unix_device( struct object
*root
, const struct unicode_str
*name
,
156 const char *unix_path
);
158 /* change notification functions */
160 extern void do_change_notify( int unix_fd
);
161 extern void sigio_callback(void);
162 extern struct object
*create_dir_obj( struct fd
*fd
, unsigned int access
, mode_t mode
);
163 extern struct dir
*get_dir_obj( struct process
*process
, obj_handle_t handle
, unsigned int access
);
167 extern struct completion
*get_completion_obj( struct process
*process
, obj_handle_t handle
, unsigned int access
);
168 extern void add_completion( struct completion
*completion
, apc_param_t ckey
, apc_param_t cvalue
,
169 unsigned int status
, apc_param_t information
);
171 /* serial port functions */
173 extern int is_serial_fd( struct fd
*fd
);
174 extern struct object
*create_serial( struct fd
*fd
);
176 /* async I/O functions */
177 extern struct async_queue
*create_async_queue( struct fd
*fd
);
178 extern void free_async_queue( struct async_queue
*queue
);
179 extern struct async
*create_async( struct thread
*thread
, struct async_queue
*queue
,
180 const async_data_t
*data
, struct iosb
*iosb
);
181 extern void async_set_timeout( struct async
*async
, timeout_t timeout
, unsigned int status
);
182 extern void async_set_result( struct object
*obj
, unsigned int status
,
183 apc_param_t total
, client_ptr_t apc
, client_ptr_t apc_arg
);
184 extern int async_queued( struct async_queue
*queue
);
185 extern int async_waiting( struct async_queue
*queue
);
186 extern void async_terminate( struct async
*async
, unsigned int status
);
187 extern void async_wake_up( struct async_queue
*queue
, unsigned int status
);
188 extern struct completion
*fd_get_completion( struct fd
*fd
, apc_param_t
*p_key
);
189 extern void fd_copy_completion( struct fd
*src
, struct fd
*dst
);
190 extern struct iosb
*create_iosb( const void *in_data
, data_size_t in_size
, data_size_t out_size
);
191 extern void cancel_process_asyncs( struct process
*process
);
193 /* access rights that require Unix read permission */
194 #define FILE_UNIX_READ_ACCESS (FILE_READ_DATA|FILE_READ_ATTRIBUTES|FILE_READ_EA)
196 /* access rights that require Unix write permission */
197 #define FILE_UNIX_WRITE_ACCESS (FILE_WRITE_DATA|FILE_APPEND_DATA|FILE_WRITE_ATTRIBUTES|FILE_WRITE_EA)
199 /* magic file access rights for mappings */
200 #define FILE_MAPPING_IMAGE 0x80000000 /* set for SEC_IMAGE mappings */
201 #define FILE_MAPPING_WRITE 0x40000000 /* set for writable shared mappings */
202 #define FILE_MAPPING_ACCESS 0x20000000 /* set for all mappings */
204 #endif /* __WINE_SERVER_FILE_H */