opcservices/tests: Fix copy-pasted copyright line.
[wine.git] / server / file.h
blob8609db05c5654c154efa282f1906db1b9e27ed2d
1 /*
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>
26 #include "object.h"
28 struct fd;
29 struct mapping;
30 struct async_queue;
31 struct completion;
33 /* server-side representation of I/O status block */
34 struct iosb
36 struct object obj; /* object header */
37 unsigned int status; /* resulting status (or STATUS_PENDING) */
38 data_size_t result; /* size of result (input or output depending on the type) */
39 data_size_t in_size; /* size of input data */
40 void *in_data; /* input data */
41 data_size_t out_size; /* size of output data */
42 void *out_data; /* output data */
45 struct async_queue
47 struct list queue; /* queue of async objects */
50 /* operations valid on file descriptor objects */
51 struct fd_ops
53 /* get the events we want to poll() for on this object */
54 int (*get_poll_events)(struct fd *);
55 /* a poll() event occurred */
56 void (*poll_event)(struct fd *,int event);
57 /* get file information */
58 enum server_fd_type (*get_fd_type)(struct fd *fd);
59 /* perform a read on the file */
60 int (*read)(struct fd *, struct async *, file_pos_t );
61 /* perform a write on the file */
62 int (*write)(struct fd *, struct async *, file_pos_t );
63 /* flush the object buffers */
64 int (*flush)(struct fd *, struct async *);
65 /* query file info */
66 void (*get_file_info)( struct fd *, unsigned int );
67 /* query volume info */
68 void (*get_volume_info)( struct fd *, unsigned int );
69 /* perform an ioctl on the file */
70 int (*ioctl)(struct fd *fd, ioctl_code_t code, struct async *async );
71 /* queue an async operation */
72 void (*queue_async)(struct fd *, struct async *async, int type, int count);
73 /* selected events for async i/o need an update */
74 void (*reselect_async)( struct fd *, struct async_queue *queue );
77 /* file descriptor functions */
79 extern struct fd *alloc_pseudo_fd( const struct fd_ops *fd_user_ops, struct object *user,
80 unsigned int options );
81 extern struct fd *open_fd( struct fd *root, const char *name, int flags, mode_t *mode,
82 unsigned int access, unsigned int sharing, unsigned int options );
83 extern struct fd *create_anonymous_fd( const struct fd_ops *fd_user_ops,
84 int unix_fd, struct object *user, unsigned int options );
85 extern struct fd *dup_fd_object( struct fd *orig, unsigned int access, unsigned int sharing,
86 unsigned int options );
87 extern struct fd *get_fd_object_for_mapping( struct fd *fd, unsigned int access, unsigned int sharing );
88 extern void *get_fd_user( struct fd *fd );
89 extern void set_fd_user( struct fd *fd, const struct fd_ops *ops, struct object *user );
90 extern unsigned int get_fd_options( struct fd *fd );
91 extern int get_unix_fd( struct fd *fd );
92 extern int is_same_file_fd( struct fd *fd1, struct fd *fd2 );
93 extern int is_fd_removable( struct fd *fd );
94 extern int fd_close_handle( struct object *obj, struct process *process, obj_handle_t handle );
95 extern int check_fd_events( struct fd *fd, int events );
96 extern void set_fd_events( struct fd *fd, int events );
97 extern obj_handle_t lock_fd( struct fd *fd, file_pos_t offset, file_pos_t count, int shared, int wait );
98 extern void unlock_fd( struct fd *fd, file_pos_t offset, file_pos_t count );
99 extern void allow_fd_caching( struct fd *fd );
100 extern void set_fd_signaled( struct fd *fd, int signaled );
101 extern int is_fd_signaled( struct fd *fd );
102 extern char *dup_fd_name( struct fd *root, const char *name );
104 extern int default_fd_signaled( struct object *obj, struct wait_queue_entry *entry );
105 extern unsigned int default_fd_map_access( struct object *obj, unsigned int access );
106 extern int default_fd_get_poll_events( struct fd *fd );
107 extern void default_poll_event( struct fd *fd, int event );
108 extern void fd_queue_async( struct fd *fd, struct async *async, int type );
109 extern void fd_async_wake_up( struct fd *fd, int type, unsigned int status );
110 extern void fd_reselect_async( struct fd *fd, struct async_queue *queue );
111 extern int no_fd_read( struct fd *fd, struct async *async, file_pos_t pos );
112 extern int no_fd_write( struct fd *fd, struct async *async, file_pos_t pos );
113 extern int no_fd_flush( struct fd *fd, struct async *async );
114 extern void no_fd_get_file_info( struct fd *fd, unsigned int info_class );
115 extern void no_fd_get_volume_info( struct fd *fd, unsigned int info_class );
116 extern int no_fd_ioctl( struct fd *fd, ioctl_code_t code, struct async *async );
117 extern int default_fd_ioctl( struct fd *fd, ioctl_code_t code, struct async *async );
118 extern void no_fd_queue_async( struct fd *fd, struct async *async, int type, int count );
119 extern void default_fd_queue_async( struct fd *fd, struct async *async, int type, int count );
120 extern void default_fd_reselect_async( struct fd *fd, struct async_queue *queue );
121 extern void main_loop(void);
122 extern void remove_process_locks( struct process *process );
124 static inline struct fd *get_obj_fd( struct object *obj ) { return obj->ops->get_fd( obj ); }
126 /* timeout functions */
128 struct timeout_user;
129 extern timeout_t current_time;
131 #define TICKS_PER_SEC 10000000
133 typedef void (*timeout_callback)( void *private );
135 extern struct timeout_user *add_timeout_user( timeout_t when, timeout_callback func, void *private );
136 extern void remove_timeout_user( struct timeout_user *user );
137 extern const char *get_timeout_str( timeout_t timeout );
139 /* file functions */
141 extern struct file *get_file_obj( struct process *process, obj_handle_t handle,
142 unsigned int access );
143 extern int get_file_unix_fd( struct file *file );
144 extern struct file *create_file_for_fd( int fd, unsigned int access, unsigned int sharing );
145 extern struct file *create_file_for_fd_obj( struct fd *fd, unsigned int access, unsigned int sharing );
146 extern void file_set_error(void);
147 extern struct security_descriptor *mode_to_sd( mode_t mode, const SID *user, const SID *group );
148 extern mode_t sd_to_mode( const struct security_descriptor *sd, const SID *owner );
150 /* file mapping functions */
152 extern struct mapping *get_mapping_obj( struct process *process, obj_handle_t handle,
153 unsigned int access );
154 extern struct file *get_mapping_file( struct process *process, client_ptr_t base,
155 unsigned int access, unsigned int sharing );
156 extern void free_mapped_views( struct process *process );
157 extern int get_page_size(void);
159 /* device functions */
161 extern struct object *create_named_pipe_device( struct object *root, const struct unicode_str *name );
162 extern struct object *create_mailslot_device( struct object *root, const struct unicode_str *name );
163 extern struct object *create_unix_device( struct object *root, const struct unicode_str *name,
164 const char *unix_path );
166 /* change notification functions */
168 extern void do_change_notify( int unix_fd );
169 extern void sigio_callback(void);
170 extern struct object *create_dir_obj( struct fd *fd, unsigned int access, mode_t mode );
171 extern struct dir *get_dir_obj( struct process *process, obj_handle_t handle, unsigned int access );
173 /* completion */
175 extern struct completion *get_completion_obj( struct process *process, obj_handle_t handle, unsigned int access );
176 extern void add_completion( struct completion *completion, apc_param_t ckey, apc_param_t cvalue,
177 unsigned int status, apc_param_t information );
179 /* serial port functions */
181 extern int is_serial_fd( struct fd *fd );
182 extern struct object *create_serial( struct fd *fd );
184 /* async I/O functions */
185 extern void free_async_queue( struct async_queue *queue );
186 extern struct async *create_async( struct fd *fd, struct thread *thread, const async_data_t *data, struct iosb *iosb );
187 extern struct async *create_request_async( struct fd *fd, const async_data_t *data );
188 extern obj_handle_t async_handoff( struct async *async, int success, data_size_t *result );
189 extern void queue_async( struct async_queue *queue, struct async *async );
190 extern void async_set_timeout( struct async *async, timeout_t timeout, unsigned int status );
191 extern void async_set_result( struct object *obj, unsigned int status, apc_param_t total );
192 extern int async_waiting( struct async_queue *queue );
193 extern void async_terminate( struct async *async, unsigned int status );
194 extern void async_wake_up( struct async_queue *queue, unsigned int status );
195 extern struct completion *fd_get_completion( struct fd *fd, apc_param_t *p_key );
196 extern void fd_copy_completion( struct fd *src, struct fd *dst );
197 extern struct iosb *create_iosb( const void *in_data, data_size_t in_size, data_size_t out_size );
198 extern struct iosb *async_get_iosb( struct async *async );
199 extern int async_is_blocking( struct async *async );
200 extern struct async *find_pending_async( struct async_queue *queue );
201 extern void cancel_process_asyncs( struct process *process );
203 static inline void init_async_queue( struct async_queue *queue )
205 list_init( &queue->queue );
208 static inline int async_queued( struct async_queue *queue )
210 return !list_empty( &queue->queue );
214 /* access rights that require Unix read permission */
215 #define FILE_UNIX_READ_ACCESS (FILE_READ_DATA|FILE_READ_ATTRIBUTES|FILE_READ_EA)
217 /* access rights that require Unix write permission */
218 #define FILE_UNIX_WRITE_ACCESS (FILE_WRITE_DATA|FILE_APPEND_DATA|FILE_WRITE_ATTRIBUTES|FILE_WRITE_EA)
220 /* magic file access rights for mappings */
221 #define FILE_MAPPING_IMAGE 0x80000000 /* set for SEC_IMAGE mappings */
222 #define FILE_MAPPING_WRITE 0x40000000 /* set for writable shared mappings */
223 #define FILE_MAPPING_ACCESS 0x20000000 /* set for all mappings */
225 #endif /* __WINE_SERVER_FILE_H */