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 /* operations valid on file descriptor objects */
  34 struct fd_ops
  35 {
  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 );
  54     /* cancel an async operation */
  55     int (*cancel_async)(struct fd *, struct process *process, struct thread *thread, client_ptr_t iosb);
  56 };
  57
  58 /* file descriptor functions */
  59
  60 extern struct fd *alloc_pseudo_fd( const struct fd_ops *fd_user_ops, struct object *user,
  61                                    unsigned int options );
  62 extern void set_no_fd_status( struct fd *fd, unsigned int status );
  63 extern struct fd *open_fd( struct fd *root, const char *name, int flags, mode_t *mode,
  64                            unsigned int access, unsigned int sharing, unsigned int options );
  65 extern struct fd *create_anonymous_fd( const struct fd_ops *fd_user_ops,
  66                                        int unix_fd, struct object *user, unsigned int options );
  67 extern struct fd *dup_fd_object( struct fd *orig, unsigned int access, unsigned int sharing,
  68                                  unsigned int options );
  69 extern struct fd *get_fd_object_for_mapping( struct fd *fd, unsigned int access, unsigned int sharing );
  70 extern void *get_fd_user( struct fd *fd );
  71 extern void set_fd_user( struct fd *fd, const struct fd_ops *ops, struct object *user );
  72 extern unsigned int get_fd_options( struct fd *fd );
  73 extern int get_unix_fd( struct fd *fd );
  74 extern int is_same_file_fd( struct fd *fd1, struct fd *fd2 );
  75 extern int is_fd_removable( struct fd *fd );
  76 extern int fd_close_handle( struct object *obj, struct process *process, obj_handle_t handle );
  77 extern int check_fd_events( struct fd *fd, int events );
  78 extern void set_fd_events( struct fd *fd, int events );
  79 extern obj_handle_t lock_fd( struct fd *fd, file_pos_t offset, file_pos_t count, int shared, int wait );
  80 extern void unlock_fd( struct fd *fd, file_pos_t offset, file_pos_t count );
  81 extern void allow_fd_caching( struct fd *fd );
  82 extern void set_fd_signaled( struct fd *fd, int signaled );
  83 extern int is_fd_signaled( struct fd *fd );
  84
  85 extern int default_fd_signaled( struct object *obj, struct wait_queue_entry *entry );
  86 extern unsigned int default_fd_map_access( struct object *obj, unsigned int access );
  87 extern int default_fd_get_poll_events( struct fd *fd );
  88 extern void default_poll_event( struct fd *fd, int event );
  89 extern struct async *fd_queue_async( struct fd *fd, const async_data_t *data, int type );
  90 extern void fd_async_wake_up( struct fd *fd, int type, unsigned int status );
  91 extern void fd_reselect_async( struct fd *fd, struct async_queue *queue );
  92 extern obj_handle_t no_fd_read( struct fd *fd, const async_data_t *async, int blocking, file_pos_t pos );
  93 extern obj_handle_t no_fd_write( struct fd *fd, const async_data_t *async, int blocking,
  94                                  file_pos_t pos, data_size_t *written );
  95 extern obj_handle_t no_fd_flush( struct fd *fd, const async_data_t *async, int blocking );
  96 extern obj_handle_t no_fd_ioctl( struct fd *fd, ioctl_code_t code, const async_data_t *async, int blocking );
  97 extern obj_handle_t default_fd_ioctl( struct fd *fd, ioctl_code_t code, const async_data_t *async, int blocking );
  98 extern void no_fd_queue_async( struct fd *fd, const async_data_t *data, int type, int count );
  99 extern void default_fd_queue_async( struct fd *fd, const async_data_t *data, int type, int count );
 100 extern void default_fd_reselect_async( struct fd *fd, struct async_queue *queue );
 101 extern int default_fd_cancel_async( struct fd *fd, struct process *process, struct thread *thread, client_ptr_t iosb );
 102 extern void main_loop(void);
 103 extern void remove_process_locks( struct process *process );
 104
 105 static inline struct fd *get_obj_fd( struct object *obj ) { return obj->ops->get_fd( obj ); }
 106
 107 /* timeout functions */
 108
 109 struct timeout_user;
 110 extern timeout_t current_time;
 111
 112 #define TICKS_PER_SEC 10000000
 113
 114 typedef void (*timeout_callback)( void *private );
 115
 116 extern struct timeout_user *add_timeout_user( timeout_t when, timeout_callback func, void *private );
 117 extern void remove_timeout_user( struct timeout_user *user );
 118 extern const char *get_timeout_str( timeout_t timeout );
 119
 120 /* file functions */
 121
 122 extern struct file *get_file_obj( struct process *process, obj_handle_t handle,
 123                                   unsigned int access );
 124 extern int get_file_unix_fd( struct file *file );
 125 extern int is_same_file( struct file *file1, struct file *file2 );
 126 extern struct file *create_file_for_fd( int fd, unsigned int access, unsigned int sharing );
 127 extern struct file *create_file_for_fd_obj( struct fd *fd, unsigned int access, unsigned int sharing );
 128 extern void file_set_error(void);
 129 extern struct security_descriptor *mode_to_sd( mode_t mode, const SID *user, const SID *group );
 130 extern mode_t sd_to_mode( const struct security_descriptor *sd, const SID *owner );
 131
 132 /* file mapping functions */
 133
 134 extern struct mapping *get_mapping_obj( struct process *process, obj_handle_t handle,
 135                                         unsigned int access );
 136 extern obj_handle_t open_mapping_file( struct process *process, struct mapping *mapping,
 137                                        unsigned int access, unsigned int sharing );
 138 extern struct mapping *grab_mapping_unless_removable( struct mapping *mapping );
 139 extern int get_page_size(void);
 140
 141 /* device functions */
 142
 143 extern void create_named_pipe_device( struct directory *root, const struct unicode_str *name );
 144 extern void create_mailslot_device( struct directory *root, const struct unicode_str *name );
 145 extern struct device *create_unix_device( struct directory *root, const struct unicode_str *name,
 146                                           const char *unix_path );
 147
 148 /* change notification functions */
 149
 150 extern void do_change_notify( int unix_fd );
 151 extern void sigio_callback(void);
 152 extern struct object *create_dir_obj( struct fd *fd, unsigned int access, mode_t mode );
 153 extern struct dir *get_dir_obj( struct process *process, obj_handle_t handle, unsigned int access );
 154
 155 /* completion */
 156
 157 extern struct completion *get_completion_obj( struct process *process, obj_handle_t handle, unsigned int access );
 158 extern void add_completion( struct completion *completion, apc_param_t ckey, apc_param_t cvalue,
 159                             unsigned int status, apc_param_t information );
 160
 161 /* serial port functions */
 162
 163 extern int is_serial_fd( struct fd *fd );
 164 extern struct object *create_serial( struct fd *fd );
 165
 166 /* async I/O functions */
 167 extern struct async_queue *create_async_queue( struct fd *fd );
 168 extern void free_async_queue( struct async_queue *queue );
 169 extern struct async *create_async( struct thread *thread, struct async_queue *queue,
 170                                    const async_data_t *data );
 171 extern void async_set_timeout( struct async *async, timeout_t timeout, unsigned int status );
 172 extern void async_set_result( struct object *obj, unsigned int status,
 173                               apc_param_t total, client_ptr_t apc, client_ptr_t apc_arg );
 174 extern int async_queued( struct async_queue *queue );
 175 extern int async_waiting( struct async_queue *queue );
 176 extern void async_terminate( struct async *async, unsigned int status );
 177 extern int async_wake_up_by( struct async_queue *queue, struct process *process,
 178                              struct thread *thread, client_ptr_t iosb, unsigned int status );
 179 extern void async_wake_up( struct async_queue *queue, unsigned int status );
 180 extern struct completion *fd_get_completion( struct fd *fd, apc_param_t *p_key );
 181 extern void fd_copy_completion( struct fd *src, struct fd *dst );
 182
 183 /* access rights that require Unix read permission */
 184 #define FILE_UNIX_READ_ACCESS (FILE_READ_DATA|FILE_READ_ATTRIBUTES|FILE_READ_EA)
 185
 186 /* access rights that require Unix write permission */
 187 #define FILE_UNIX_WRITE_ACCESS (FILE_WRITE_DATA|FILE_APPEND_DATA|FILE_WRITE_ATTRIBUTES|FILE_WRITE_EA)
 188
 189 /* magic file access rights for mappings */
 190 #define FILE_MAPPING_IMAGE  0x80000000  /* set for SEC_IMAGE mappings */
 191 #define FILE_MAPPING_WRITE  0x40000000  /* set for writable shared mappings */
 192 #define FILE_MAPPING_ACCESS 0x20000000  /* set for all mappings */
 193
 194 #endif  /* __WINE_SERVER_FILE_H */