server/file.h

   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 <sys/types.h>
  25
  26 #include "object.h"
  27
  28 struct fd;
  29 struct mapping;
  30 struct async_queue;
  31 struct completion;
  32
  33 /* server-side representation of I/O status block */
  34 struct iosb
  35 {
  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 */
  43 };
  44
  45 struct async_queue
  46 {
  47     struct list queue;          /* queue of async objects */
  48 };
  49
  50 /* operations valid on file descriptor objects */
  51 struct fd_ops
  52 {
  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     void (*read)(struct fd *, struct async *, file_pos_t );
  61     /* perform a write on the file */
  62     void (*write)(struct fd *, struct async *, file_pos_t );
  63     /* flush the object buffers */
  64     void (*flush)(struct fd *, struct async *);
  65     /* query file info */
  66     void (*get_file_info)( struct fd *, obj_handle_t, unsigned int );
  67     /* query volume info */
  68     void (*get_volume_info)( struct fd *, struct async *, unsigned int );
  69     /* perform an ioctl on the file */
  70     void (*ioctl)(struct fd *fd, ioctl_code_t code, struct async *async );
  71     /* cancel an async operation */
  72     void (*cancel_async)(struct fd *fd, struct async *async);
  73     /* queue an async operation */
  74     void (*queue_async)(struct fd *, struct async *async, int type, int count);
  75     /* selected events for async i/o need an update */
  76     void (*reselect_async)( struct fd *, struct async_queue *queue );
  77 };
  78
  79 /* file descriptor functions */
  80
  81 extern struct fd *alloc_pseudo_fd( const struct fd_ops *fd_user_ops, struct object *user,
  82                                    unsigned int options );
  83 extern struct fd *open_fd( struct fd *root, const char *name, struct unicode_str nt_name,
  84                            int flags, mode_t *mode, unsigned int access,
  85                            unsigned int sharing, unsigned int options );
  86 extern struct fd *create_anonymous_fd( const struct fd_ops *fd_user_ops,
  87                                        int unix_fd, struct object *user, unsigned int options );
  88 extern struct fd *dup_fd_object( struct fd *orig, unsigned int access, unsigned int sharing,
  89                                  unsigned int options );
  90 extern struct fd *get_fd_object_for_mapping( struct fd *fd, unsigned int access, unsigned int sharing );
  91 extern void *get_fd_user( struct fd *fd );
  92 extern void set_fd_user( struct fd *fd, const struct fd_ops *ops, struct object *user );
  93 extern unsigned int get_fd_options( struct fd *fd );
  94 extern unsigned int get_fd_comp_flags( struct fd *fd );
  95 extern int is_fd_overlapped( struct fd *fd );
  96 extern int get_unix_fd( struct fd *fd );
  97 extern int is_same_file_fd( struct fd *fd1, struct fd *fd2 );
  98 extern int is_fd_removable( struct fd *fd );
  99 extern int check_fd_events( struct fd *fd, int events );
 100 extern void set_fd_events( struct fd *fd, int events );
 101 extern obj_handle_t lock_fd( struct fd *fd, file_pos_t offset, file_pos_t count, int shared, int wait );
 102 extern void unlock_fd( struct fd *fd, file_pos_t offset, file_pos_t count );
 103 extern void allow_fd_caching( struct fd *fd );
 104 extern void set_fd_signaled( struct fd *fd, int signaled );
 105 extern char *dup_fd_name( struct fd *root, const char *name );
 106 extern void get_nt_name( struct fd *fd, struct unicode_str *name );
 107
 108 extern int default_fd_signaled( struct object *obj, struct wait_queue_entry *entry );
 109 extern int default_fd_get_poll_events( struct fd *fd );
 110 extern void default_poll_event( struct fd *fd, int event );
 111 extern void fd_cancel_async( struct fd *fd, struct async *async );
 112 extern void fd_queue_async( struct fd *fd, struct async *async, int type );
 113 extern void fd_async_wake_up( struct fd *fd, int type, unsigned int status );
 114 extern void fd_reselect_async( struct fd *fd, struct async_queue *queue );
 115 extern void no_fd_read( struct fd *fd, struct async *async, file_pos_t pos );
 116 extern void no_fd_write( struct fd *fd, struct async *async, file_pos_t pos );
 117 extern void no_fd_flush( struct fd *fd, struct async *async );
 118 extern void no_fd_get_file_info( struct fd *fd, obj_handle_t handle, unsigned int info_class );
 119 extern void default_fd_get_file_info( struct fd *fd, obj_handle_t handle, unsigned int info_class );
 120 extern void no_fd_get_volume_info( struct fd *fd, struct async *async, unsigned int info_class );
 121 extern void no_fd_ioctl( struct fd *fd, ioctl_code_t code, struct async *async );
 122 extern void default_fd_ioctl( struct fd *fd, ioctl_code_t code, struct async *async );
 123 extern void default_fd_cancel_async( struct fd *fd, struct async *async );
 124 extern void no_fd_queue_async( struct fd *fd, struct async *async, int type, int count );
 125 extern void default_fd_queue_async( struct fd *fd, struct async *async, int type, int count );
 126 extern void default_fd_reselect_async( struct fd *fd, struct async_queue *queue );
 127 extern void main_loop(void);
 128 extern void remove_process_locks( struct process *process );
 129
 130 static inline struct fd *get_obj_fd( struct object *obj ) { return obj->ops->get_fd( obj ); }
 131
 132 /* timeout functions */
 133
 134 struct timeout_user;
 135 extern timeout_t current_time;
 136 extern timeout_t monotonic_time;
 137 extern struct _KUSER_SHARED_DATA *user_shared_data;
 138
 139 #define TICKS_PER_SEC 10000000
 140
 141 typedef void (*timeout_callback)( void *private );
 142
 143 static inline abstime_t timeout_to_abstime( timeout_t timeout )
 144 {
 145     return timeout > 0 ? timeout : timeout - monotonic_time;
 146 }
 147
 148 static inline timeout_t abstime_to_timeout( abstime_t abstime )
 149 {
 150     if (abstime > 0) return abstime;
 151     return -abstime < monotonic_time ? 0 : abstime + monotonic_time;
 152 }
 153
 154 extern void set_current_time( void );
 155 extern struct timeout_user *add_timeout_user( timeout_t when, timeout_callback func, void *private );
 156 extern void remove_timeout_user( struct timeout_user *user );
 157 extern const char *get_timeout_str( timeout_t timeout );
 158
 159 /* file functions */
 160
 161 extern struct file *get_file_obj( struct process *process, obj_handle_t handle,
 162                                   unsigned int access );
 163 extern int get_file_unix_fd( struct file *file );
 164 extern struct file *create_file_for_fd( int fd, unsigned int access, unsigned int sharing );
 165 extern struct file *create_file_for_fd_obj( struct fd *fd, unsigned int access, unsigned int sharing );
 166 extern void file_set_error(void);
 167 extern struct security_descriptor *mode_to_sd( mode_t mode, const SID *user, const SID *group );
 168 extern mode_t sd_to_mode( const struct security_descriptor *sd, const SID *owner );
 169 extern int is_file_executable( const char *name );
 170
 171 /* file mapping functions */
 172
 173 struct memory_view;
 174
 175 extern int grow_file( int unix_fd, file_pos_t new_size );
 176 extern struct memory_view *find_mapped_view( struct process *process, client_ptr_t base );
 177 extern struct memory_view *get_exe_view( struct process *process );
 178 extern struct file *get_view_file( const struct memory_view *view, unsigned int access, unsigned int sharing );
 179 extern const pe_image_info_t *get_view_image_info( const struct memory_view *view, client_ptr_t *base );
 180 extern int get_view_nt_name( const struct memory_view *view, struct unicode_str *name );
 181 extern void free_mapped_views( struct process *process );
 182 extern int get_page_size(void);
 183 extern struct mapping *create_fd_mapping( struct object *root, const struct unicode_str *name, struct fd *fd,
 184                                           unsigned int attr, const struct security_descriptor *sd );
 185 extern struct object *create_user_data_mapping( struct object *root, const struct unicode_str *name,
 186                                                 unsigned int attr, const struct security_descriptor *sd );
 187
 188 /* device functions */
 189
 190 extern struct object *create_named_pipe_device( struct object *root, const struct unicode_str *name,
 191                                                 unsigned int attr, const struct security_descriptor *sd );
 192 extern struct object *create_mailslot_device( struct object *root, const struct unicode_str *name,
 193                                               unsigned int attr, const struct security_descriptor *sd );
 194 extern struct object *create_console_device( struct object *root, const struct unicode_str *name,
 195                                               unsigned int attr, const struct security_descriptor *sd );
 196 extern struct object *create_socket_device( struct object *root, const struct unicode_str *name,
 197                                               unsigned int attr, const struct security_descriptor *sd );
 198 extern struct object *create_unix_device( struct object *root, const struct unicode_str *name,
 199                                           unsigned int attr, const struct security_descriptor *sd, const char *unix_path );
 200
 201 /* change notification functions */
 202
 203 extern void do_change_notify( int unix_fd );
 204 extern void sigio_callback(void);
 205 extern struct object *create_dir_obj( struct fd *fd, unsigned int access, mode_t mode );
 206 extern struct dir *get_dir_obj( struct process *process, obj_handle_t handle, unsigned int access );
 207
 208 /* completion */
 209
 210 extern struct completion *get_completion_obj( struct process *process, obj_handle_t handle, unsigned int access );
 211 extern void add_completion( struct completion *completion, apc_param_t ckey, apc_param_t cvalue,
 212                             unsigned int status, apc_param_t information );
 213
 214 /* serial port functions */
 215
 216 extern int is_serial_fd( struct fd *fd );
 217 extern struct object *create_serial( struct fd *fd );
 218
 219 /* async I/O functions */
 220
 221 typedef void (*async_completion_callback)( void *private );
 222
 223 extern void free_async_queue( struct async_queue *queue );
 224 extern struct async *create_async( struct fd *fd, struct thread *thread, const async_data_t *data, struct iosb *iosb );
 225 extern struct async *create_request_async( struct fd *fd, unsigned int comp_flags, const async_data_t *data );
 226 extern obj_handle_t async_handoff( struct async *async, data_size_t *result, int force_blocking );
 227 extern void queue_async( struct async_queue *queue, struct async *async );
 228 extern void async_set_timeout( struct async *async, timeout_t timeout, unsigned int status );
 229 extern void async_set_result( struct object *obj, unsigned int status, apc_param_t total );
 230 extern void async_set_completion_callback( struct async *async, async_completion_callback func, void *private );
 231 extern void async_set_unknown_status( struct async *async );
 232 extern void set_async_pending( struct async *async );
 233 extern void async_set_initial_status( struct async *async, unsigned int status );
 234 extern void async_wake_obj( struct async *async );
 235 extern int async_waiting( struct async_queue *queue );
 236 extern void async_terminate( struct async *async, unsigned int status );
 237 extern void async_request_complete( struct async *async, unsigned int status, data_size_t result,
 238                                     data_size_t out_size, void *out_data );
 239 extern void async_request_complete_alloc( struct async *async, unsigned int status, data_size_t result,
 240                                           data_size_t out_size, const void *out_data );
 241 extern void async_wake_up( struct async_queue *queue, unsigned int status );
 242 extern struct completion *fd_get_completion( struct fd *fd, apc_param_t *p_key );
 243 extern void fd_copy_completion( struct fd *src, struct fd *dst );
 244 extern struct iosb *async_get_iosb( struct async *async );
 245 extern struct thread *async_get_thread( struct async *async );
 246 extern struct async *find_pending_async( struct async_queue *queue );
 247 extern void cancel_process_asyncs( struct process *process );
 248
 249 static inline void init_async_queue( struct async_queue *queue )
 250 {
 251     list_init( &queue->queue );
 252 }
 253
 254 static inline int async_queued( struct async_queue *queue )
 255 {
 256     return !list_empty( &queue->queue );
 257 }
 258
 259
 260 /* access rights that require Unix read permission */
 261 #define FILE_UNIX_READ_ACCESS (FILE_READ_DATA|FILE_READ_ATTRIBUTES|FILE_READ_EA)
 262
 263 /* access rights that require Unix write permission */
 264 #define FILE_UNIX_WRITE_ACCESS (FILE_WRITE_DATA|FILE_APPEND_DATA|FILE_WRITE_ATTRIBUTES|FILE_WRITE_EA)
 265
 266 /* magic file access rights for mappings */
 267 #define FILE_MAPPING_IMAGE  0x80000000  /* set for SEC_IMAGE mappings */
 268 #define FILE_MAPPING_WRITE  0x40000000  /* set for writable shared mappings */
 269 #define FILE_MAPPING_ACCESS 0x20000000  /* set for all mappings */
 270
 271 #endif  /* __WINE_SERVER_FILE_H */