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 "object.h"
  25
  26 struct fd;
  27
  28 typedef unsigned __int64 file_pos_t;
  29
  30 /* operations valid on file descriptor objects */
  31 struct fd_ops
  32 {
  33     /* get the events we want to poll() for on this object */
  34     int  (*get_poll_events)(struct fd *);
  35     /* a poll() event occurred */
  36     void (*poll_event)(struct fd *,int event);
  37     /* flush the object buffers */
  38     int  (*flush)(struct fd *, struct event **);
  39     /* get file information */
  40     enum server_fd_type (*get_file_info)(struct fd *fd, int *flags);
  41     /* queue an async operation */
  42     void (*queue_async)(struct fd *, void* apc, void* user, void* io_sb, int type, int count);
  43     /* cancel an async operation */
  44     void (*cancel_async)(struct fd *);
  45 };
  46
  47 /* file descriptor functions */
  48
  49 extern struct fd *alloc_pseudo_fd( const struct fd_ops *fd_user_ops, struct object *user );
  50 extern struct fd *open_fd( const char *name, int flags, mode_t *mode, unsigned int access,
  51                            unsigned int sharing, unsigned int options );
  52 extern struct fd *create_anonymous_fd( const struct fd_ops *fd_user_ops,
  53                                        int unix_fd, struct object *user );
  54 extern void *get_fd_user( struct fd *fd );
  55 extern void set_fd_user( struct fd *fd, const struct fd_ops *ops, struct object *user );
  56 extern int get_unix_fd( struct fd *fd );
  57 extern int is_same_file_fd( struct fd *fd1, struct fd *fd2 );
  58 extern int is_fd_removable( struct fd *fd );
  59 extern int fd_close_handle( struct object *obj, struct process *process, obj_handle_t handle );
  60 extern void fd_poll_event( struct fd *fd, int event );
  61 extern int check_fd_events( struct fd *fd, int events );
  62 extern void set_fd_events( struct fd *fd, int events );
  63 extern obj_handle_t lock_fd( struct fd *fd, file_pos_t offset, file_pos_t count, int shared, int wait );
  64 extern void unlock_fd( struct fd *fd, file_pos_t offset, file_pos_t count );
  65
  66 extern int default_fd_add_queue( struct object *obj, struct wait_queue_entry *entry );
  67 extern void default_fd_remove_queue( struct object *obj, struct wait_queue_entry *entry );
  68 extern int default_fd_signaled( struct object *obj, struct thread *thread );
  69 extern int default_fd_get_poll_events( struct fd *fd );
  70 extern void default_poll_event( struct fd *fd, int event );
  71 extern void fd_queue_async_timeout( struct fd *fd, void *apc, void *user, void *io_sb, int type,
  72                                     int count, const struct timeval *timeout );
  73 extern void default_fd_queue_async( struct fd *fd, void *apc, void *user, void *io_sb, int type, int count );
  74 extern void default_fd_cancel_async( struct fd *fd );
  75 extern int no_flush( struct fd *fd, struct event **event );
  76 extern enum server_fd_type no_get_file_info( struct fd *fd, int *flags );
  77 extern void no_queue_async( struct fd *fd, void* apc, void* user, void* io_sb, int type, int count);
  78 extern void no_cancel_async( struct fd *fd );
  79 extern void main_loop(void);
  80 extern void remove_process_locks( struct process *process );
  81
  82 inline static struct fd *get_obj_fd( struct object *obj ) { return obj->ops->get_fd( obj ); }
  83
  84 /* timeout functions */
  85
  86 struct timeout_user;
  87 extern struct timeval current_time;
  88
  89 typedef void (*timeout_callback)( void *private );
  90
  91 extern struct timeout_user *add_timeout_user( const struct timeval *when,
  92                                               timeout_callback func, void *private );
  93 extern void remove_timeout_user( struct timeout_user *user );
  94 extern void add_timeout( struct timeval *when, int timeout );
  95 /* return 1 if t1 is before t2 */
  96 static inline int time_before( const struct timeval *t1, const struct timeval *t2 )
  97 {
  98     return ((t1->tv_sec < t2->tv_sec) ||
  99             ((t1->tv_sec == t2->tv_sec) && (t1->tv_usec < t2->tv_usec)));
 100 }
 101
 102 /* file functions */
 103
 104 extern struct file *get_file_obj( struct process *process, obj_handle_t handle,
 105                                   unsigned int access );
 106 extern int get_file_unix_fd( struct file *file );
 107 extern int is_same_file( struct file *file1, struct file *file2 );
 108 extern struct file *grab_file_unless_removable( struct file *file );
 109 extern int grow_file( struct file *file, file_pos_t size );
 110 extern struct file *create_temp_file( int access );
 111 extern void file_set_error(void);
 112
 113 /* change notification functions */
 114
 115 extern void do_change_notify( int unix_fd );
 116 extern void sigio_callback(void);
 117 extern struct object *create_dir_obj( struct fd *fd );
 118
 119 /* serial port functions */
 120
 121 extern int is_serial_fd( struct fd *fd );
 122 extern struct object *create_serial( struct fd *fd, unsigned int options );
 123
 124 /* async I/O functions */
 125 extern struct async *create_async( struct thread *thread, const struct timeval *timeout,
 126                                    struct list *queue, void *, void *, void *);
 127 extern void async_terminate_head( struct list *queue, int status );
 128
 129 static inline void async_terminate_queue( struct list *queue, int status )
 130 {
 131     while (!list_empty( queue )) async_terminate_head( queue, status );
 132 }
 133
 134 /* access rights that require Unix read permission */
 135 #define FILE_UNIX_READ_ACCESS (FILE_READ_DATA|FILE_READ_ATTRIBUTES|FILE_READ_EA)
 136
 137 /* access rights that require Unix write permission */
 138 #define FILE_UNIX_WRITE_ACCESS (FILE_WRITE_DATA|FILE_WRITE_ATTRIBUTES|FILE_WRITE_EA)
 139
 140 #endif  /* __WINE_SERVER_FILE_H */