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