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
31 /* operations valid on file descriptor objects */
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 /* is this file's fd removable */
43 int (*removable
)(struct fd
*fd
);
44 /* perform an ioctl on the file */
45 obj_handle_t (*ioctl
)(struct fd
*fd
, ioctl_code_t code
, const async_data_t
*async
, int blocking
,
46 const void *data
, data_size_t size
);
47 /* queue an async operation */
48 void (*queue_async
)(struct fd
*, const async_data_t
*data
, int type
, int count
);
49 /* an async request changed state (or being destroyed) */
50 void (*async_event
)(struct fd
*, struct async_queue
*queue
, struct async
*async
, int status
, int finished
);
51 /* an async request was terminated, called before user apc */
52 int (*async_terminated
)(struct fd
*, struct async_queue
*queue
, struct async
*async
, int status
);
53 /* cancel an async operation */
54 void (*cancel_async
)(struct fd
*, struct process
*process
, struct thread
*thread
, client_ptr_t iosb
);
57 /* file descriptor functions */
59 extern struct fd
*alloc_pseudo_fd( const struct fd_ops
*fd_user_ops
, struct object
*user
,
60 unsigned int options
);
61 extern void set_no_fd_status( struct fd
*fd
, unsigned int status
);
62 extern struct fd
*open_fd( struct fd
*root
, const char *name
, int flags
, mode_t
*mode
,
63 unsigned int access
, unsigned int sharing
, unsigned int options
);
64 extern struct fd
*create_anonymous_fd( const struct fd_ops
*fd_user_ops
,
65 int unix_fd
, struct object
*user
, unsigned int options
);
66 extern struct fd
*dup_fd_object( struct fd
*orig
, unsigned int access
, unsigned int sharing
,
67 unsigned int options
);
68 extern void *get_fd_user( struct fd
*fd
);
69 extern void set_fd_user( struct fd
*fd
, const struct fd_ops
*ops
, struct object
*user
);
70 extern unsigned int get_fd_options( struct fd
*fd
);
71 extern int get_unix_fd( struct fd
*fd
);
72 extern int is_same_file_fd( struct fd
*fd1
, struct fd
*fd2
);
73 extern int is_fd_removable( struct fd
*fd
);
74 extern int fd_close_handle( struct object
*obj
, struct process
*process
, obj_handle_t handle
);
75 extern int check_fd_events( struct fd
*fd
, int events
);
76 extern void set_fd_events( struct fd
*fd
, int events
);
77 extern obj_handle_t
lock_fd( struct fd
*fd
, file_pos_t offset
, file_pos_t count
, int shared
, int wait
);
78 extern void unlock_fd( struct fd
*fd
, file_pos_t offset
, file_pos_t count
);
79 extern void set_fd_signaled( struct fd
*fd
, int signaled
);
80 extern int is_fd_signaled( struct fd
*fd
);
82 extern int default_fd_removable( struct fd
*fd
);
83 extern int default_fd_signaled( struct object
*obj
, struct thread
*thread
);
84 extern unsigned int default_fd_map_access( struct object
*obj
, unsigned int access
);
85 extern int default_fd_get_poll_events( struct fd
*fd
);
86 extern void default_poll_event( struct fd
*fd
, int event
);
87 extern struct async
*fd_queue_async( struct fd
*fd
, const async_data_t
*data
, int type
);
88 extern void fd_async_wake_up( struct fd
*fd
, int type
, unsigned int status
);
89 extern void fd_async_event( struct fd
*fd
, struct async_queue
*queue
, struct async
*async
, int status
, int finished
);
90 extern int fd_async_terminated( struct fd
*fd
, struct async_queue
*queue
, struct async
*async
, int status
);
91 extern obj_handle_t
no_fd_ioctl( struct fd
*fd
, ioctl_code_t code
, const async_data_t
*async
,
92 int blocking
, const void *data
, data_size_t size
);
93 extern obj_handle_t
default_fd_ioctl( struct fd
*fd
, ioctl_code_t code
, const async_data_t
*async
,
94 int blocking
, const void *data
, data_size_t size
);
95 extern void no_fd_queue_async( struct fd
*fd
, const async_data_t
*data
, int type
, int count
);
96 extern void default_fd_queue_async( struct fd
*fd
, const async_data_t
*data
, int type
, int count
);
97 extern void default_fd_async_event( struct fd
*fd
, struct async_queue
*queue
, struct async
*async
, int status
, int finished
);
98 extern int default_fd_async_terminated( struct fd
*fd
, struct async_queue
*queue
, struct async
*async
, int status
);
99 extern void default_fd_cancel_async( struct fd
*fd
, struct process
*process
, struct thread
*thread
, client_ptr_t iosb
);
100 extern void no_flush( struct fd
*fd
, struct event
**event
);
101 extern void main_loop(void);
102 extern void remove_process_locks( struct process
*process
);
104 static inline struct fd
*get_obj_fd( struct object
*obj
) { return obj
->ops
->get_fd( obj
); }
106 /* timeout functions */
109 extern timeout_t current_time
;
111 #define TICKS_PER_SEC 10000000
113 typedef void (*timeout_callback
)( void *private );
115 extern struct timeout_user
*add_timeout_user( timeout_t when
, timeout_callback func
, void *private );
116 extern void remove_timeout_user( struct timeout_user
*user
);
117 extern const char *get_timeout_str( timeout_t timeout
);
121 extern struct file
*get_file_obj( struct process
*process
, obj_handle_t handle
,
122 unsigned int access
);
123 extern int get_file_unix_fd( struct file
*file
);
124 extern int is_same_file( struct file
*file1
, struct file
*file2
);
125 extern struct file
*create_file_for_fd( int fd
, unsigned int access
, unsigned int sharing
);
126 extern struct file
*grab_file_unless_removable( struct file
*file
);
127 extern void file_set_error(void);
128 extern struct security_descriptor
*mode_to_sd( mode_t mode
, const SID
*user
, const SID
*group
);
129 extern mode_t
sd_to_mode( const struct security_descriptor
*sd
, const SID
*owner
);
131 /* change notification functions */
133 extern void do_change_notify( int unix_fd
);
134 extern void sigio_callback(void);
135 extern struct object
*create_dir_obj( struct fd
*fd
, unsigned int access
, mode_t mode
);
136 extern struct dir
*get_dir_obj( struct process
*process
, obj_handle_t handle
, unsigned int access
);
140 extern struct completion
*get_completion_obj( struct process
*process
, obj_handle_t handle
, unsigned int access
);
141 extern void add_completion( struct completion
*completion
, apc_param_t ckey
, apc_param_t cvalue
,
142 unsigned int status
, unsigned int information
);
144 /* serial port functions */
146 extern int is_serial_fd( struct fd
*fd
);
147 extern struct object
*create_serial( struct fd
*fd
);
149 /* async I/O functions */
150 extern struct async_queue
*create_async_queue( struct fd
*fd
);
151 extern void free_async_queue( struct async_queue
*queue
);
152 extern struct async
*create_async( struct thread
*thread
, struct async_queue
*queue
,
153 const async_data_t
*data
);
154 extern void async_set_timeout( struct async
*async
, timeout_t timeout
, unsigned int status
);
155 extern void async_set_result( struct object
*obj
, unsigned int status
,
156 unsigned int total
, client_ptr_t apc
);
157 extern int async_queued( struct async_queue
*queue
);
158 extern int async_waiting( struct async_queue
*queue
);
159 extern void async_terminate( struct async
*async
, unsigned int status
);
160 extern int async_wake_up_by( struct async_queue
*queue
, struct process
*process
,
161 struct thread
*thread
, client_ptr_t iosb
, unsigned int status
);
162 extern void async_wake_up( struct async_queue
*queue
, unsigned int status
);
163 extern struct completion
*fd_get_completion( struct fd
*fd
, apc_param_t
*p_key
);
164 extern void fd_copy_completion( struct fd
*src
, struct fd
*dst
);
166 /* access rights that require Unix read permission */
167 #define FILE_UNIX_READ_ACCESS (FILE_READ_DATA|FILE_READ_ATTRIBUTES|FILE_READ_EA)
169 /* access rights that require Unix write permission */
170 #define FILE_UNIX_WRITE_ACCESS (FILE_WRITE_DATA|FILE_WRITE_ATTRIBUTES|FILE_WRITE_EA)
172 /* magic file access rights for mappings */
173 #define FILE_MAPPING_IMAGE 0x80000000 /* set for SEC_IMAGE mappings */
174 #define FILE_MAPPING_WRITE 0x40000000 /* set for writable shared mappings */
175 #define FILE_MAPPING_ACCESS 0x20000000 /* set for all mappings */
177 #endif /* __WINE_SERVER_FILE_H */