/* * Server-side file definitions * * Copyright (C) 2003 Alexandre Julliard * * This library is free software; you can redistribute it and/or * modify it under the terms of the GNU Lesser General Public * License as published by the Free Software Foundation; either * version 2.1 of the License, or (at your option) any later version. * * This library is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU * Lesser General Public License for more details. * * You should have received a copy of the GNU Lesser General Public * License along with this library; if not, write to the Free Software * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA */ #ifndef __WINE_SERVER_FILE_H #define __WINE_SERVER_FILE_H #include #include "object.h" struct fd; struct mapping; struct async_queue; struct completion; struct reserve; /* server-side representation of I/O status block */ struct iosb { struct object obj; /* object header */ unsigned int status; /* resulting status (or STATUS_PENDING) */ data_size_t result; /* size of result (input or output depending on the type) */ data_size_t in_size; /* size of input data */ void *in_data; /* input data */ data_size_t out_size; /* size of output data */ void *out_data; /* output data */ }; struct async_queue { struct list queue; /* queue of async objects */ }; /* operations valid on file descriptor objects */ struct fd_ops { /* get the events we want to poll() for on this object */ int (*get_poll_events)(struct fd *); /* a poll() event occurred */ void (*poll_event)(struct fd *,int event); /* get file information */ enum server_fd_type (*get_fd_type)(struct fd *fd); /* perform a read on the file */ void (*read)(struct fd *, struct async *, file_pos_t ); /* perform a write on the file */ void (*write)(struct fd *, struct async *, file_pos_t ); /* flush the object buffers */ void (*flush)(struct fd *, struct async *); /* query file info */ void (*get_file_info)( struct fd *, obj_handle_t, unsigned int ); /* query volume info */ void (*get_volume_info)( struct fd *, struct async *, unsigned int ); /* perform an ioctl on the file */ void (*ioctl)(struct fd *fd, ioctl_code_t code, struct async *async ); /* cancel an async operation */ void (*cancel_async)(struct fd *fd, struct async *async); /* queue an async operation */ void (*queue_async)(struct fd *, struct async *async, int type, int count); /* selected events for async i/o need an update */ void (*reselect_async)( struct fd *, struct async_queue *queue ); }; /* file descriptor functions */ extern struct fd *alloc_pseudo_fd( const struct fd_ops *fd_user_ops, struct object *user, unsigned int options ); extern struct fd *open_fd( struct fd *root, const char *name, struct unicode_str nt_name, int flags, mode_t *mode, unsigned int access, unsigned int sharing, unsigned int options ); extern struct fd *create_anonymous_fd( const struct fd_ops *fd_user_ops, int unix_fd, struct object *user, unsigned int options ); extern struct fd *dup_fd_object( struct fd *orig, unsigned int access, unsigned int sharing, unsigned int options ); extern struct fd *get_fd_object_for_mapping( struct fd *fd, unsigned int access, unsigned int sharing ); extern void *get_fd_user( struct fd *fd ); extern void set_fd_user( struct fd *fd, const struct fd_ops *ops, struct object *user ); extern unsigned int get_fd_options( struct fd *fd ); extern unsigned int get_fd_comp_flags( struct fd *fd ); extern int is_fd_overlapped( struct fd *fd ); extern int get_unix_fd( struct fd *fd ); extern client_ptr_t get_fd_map_address( struct fd *fd ); extern void set_fd_map_address( struct fd *fd, client_ptr_t addr, mem_size_t size ); extern int is_same_file_fd( struct fd *fd1, struct fd *fd2 ); extern int is_fd_removable( struct fd *fd ); extern int check_fd_events( struct fd *fd, int events ); extern void set_fd_events( struct fd *fd, int events ); extern obj_handle_t lock_fd( struct fd *fd, file_pos_t offset, file_pos_t count, int shared, int wait ); extern void unlock_fd( struct fd *fd, file_pos_t offset, file_pos_t count ); extern void allow_fd_caching( struct fd *fd ); extern void set_fd_signaled( struct fd *fd, int signaled ); extern char *dup_fd_name( struct fd *root, const char *name ) __WINE_DEALLOC(free) __WINE_MALLOC; extern void get_nt_name( struct fd *fd, struct unicode_str *name ); extern int default_fd_signaled( struct object *obj, struct wait_queue_entry *entry ); extern int default_fd_get_poll_events( struct fd *fd ); extern void default_poll_event( struct fd *fd, int event ); extern void fd_cancel_async( struct fd *fd, struct async *async ); extern void fd_queue_async( struct fd *fd, struct async *async, int type ); extern void fd_async_wake_up( struct fd *fd, int type, unsigned int status ); extern void fd_reselect_async( struct fd *fd, struct async_queue *queue ); extern void no_fd_read( struct fd *fd, struct async *async, file_pos_t pos ); extern void no_fd_write( struct fd *fd, struct async *async, file_pos_t pos ); extern void no_fd_flush( struct fd *fd, struct async *async ); extern void no_fd_get_file_info( struct fd *fd, obj_handle_t handle, unsigned int info_class ); extern void default_fd_get_file_info( struct fd *fd, obj_handle_t handle, unsigned int info_class ); extern void no_fd_get_volume_info( struct fd *fd, struct async *async, unsigned int info_class ); extern void no_fd_ioctl( struct fd *fd, ioctl_code_t code, struct async *async ); extern void default_fd_ioctl( struct fd *fd, ioctl_code_t code, struct async *async ); extern void default_fd_cancel_async( struct fd *fd, struct async *async ); extern void no_fd_queue_async( struct fd *fd, struct async *async, int type, int count ); extern void default_fd_queue_async( struct fd *fd, struct async *async, int type, int count ); extern void default_fd_reselect_async( struct fd *fd, struct async_queue *queue ); extern void main_loop(void); extern void remove_process_locks( struct process *process ); static inline struct fd *get_obj_fd( struct object *obj ) { return obj->ops->get_fd( obj ); } /* timeout functions */ struct timeout_user; extern timeout_t current_time; extern timeout_t monotonic_time; extern struct _KUSER_SHARED_DATA *user_shared_data; #define TICKS_PER_SEC 10000000 typedef void (*timeout_callback)( void *private ); static inline abstime_t timeout_to_abstime( timeout_t timeout ) { return timeout > 0 ? timeout : timeout - monotonic_time; } static inline timeout_t abstime_to_timeout( abstime_t abstime ) { if (abstime > 0) return abstime; return -abstime < monotonic_time ? 0 : abstime + monotonic_time; } extern void set_current_time( void ); extern struct timeout_user *add_timeout_user( timeout_t when, timeout_callback func, void *private ); extern void remove_timeout_user( struct timeout_user *user ); extern const char *get_timeout_str( timeout_t timeout ); /* file functions */ extern struct file *get_file_obj( struct process *process, obj_handle_t handle, unsigned int access ); extern int get_file_unix_fd( struct file *file ); extern struct file *create_file_for_fd( int fd, unsigned int access, unsigned int sharing ); extern struct file *create_file_for_fd_obj( struct fd *fd, unsigned int access, unsigned int sharing ); extern void file_set_error(void); extern struct security_descriptor *mode_to_sd( mode_t mode, const struct sid *user, const struct sid *group ); extern mode_t sd_to_mode( const struct security_descriptor *sd, const struct sid *owner ); extern int is_file_executable( const char *name ); /* file mapping functions */ struct memory_view; extern void init_memory(void); extern int grow_file( int unix_fd, file_pos_t new_size ); extern void free_map_addr( client_ptr_t base, mem_size_t size ); extern struct memory_view *find_mapped_view( struct process *process, client_ptr_t base ); extern struct memory_view *get_exe_view( struct process *process ); extern struct file *get_view_file( const struct memory_view *view, unsigned int access, unsigned int sharing ); extern const pe_image_info_t *get_view_image_info( const struct memory_view *view, client_ptr_t *base ); extern int get_view_nt_name( const struct memory_view *view, struct unicode_str *name ); extern void free_mapped_views( struct process *process ); extern int get_page_size(void); extern struct mapping *create_fd_mapping( struct object *root, const struct unicode_str *name, struct fd *fd, unsigned int attr, const struct security_descriptor *sd ); extern struct object *create_user_data_mapping( struct object *root, const struct unicode_str *name, unsigned int attr, const struct security_descriptor *sd ); extern struct mapping *create_session_mapping( struct object *root, const struct unicode_str *name, unsigned int attr, const struct security_descriptor *sd ); extern void set_session_mapping( struct mapping *mapping ); extern const volatile void *alloc_shared_object(void); extern void free_shared_object( const volatile void *object_shm ); extern void invalidate_shared_object( const volatile void *object_shm ); extern obj_locator_t get_shared_object_locator( const volatile void *object_shm ); #define SHARED_WRITE_BEGIN( object_shm, type ) \ do { \ const type *__shared = (object_shm); \ type *shared = (type *)__shared; \ shared_object_t *__obj = CONTAINING_RECORD( shared, shared_object_t, shm ); \ LONG64 __seq = __obj->seq + 1, __end = __seq + 1; \ assert( (__seq & 1) != 0 ); \ __WINE_ATOMIC_STORE_RELEASE( &__obj->seq, &__seq ); \ do #define SHARED_WRITE_END \ while(0); \ assert( __seq == __obj->seq ); \ __WINE_ATOMIC_STORE_RELEASE( &__obj->seq, &__end ); \ } while(0) /* device functions */ extern struct object *create_named_pipe_device( struct object *root, const struct unicode_str *name, unsigned int attr, const struct security_descriptor *sd ); extern struct object *create_mailslot_device( struct object *root, const struct unicode_str *name, unsigned int attr, const struct security_descriptor *sd ); extern struct object *create_console_device( struct object *root, const struct unicode_str *name, unsigned int attr, const struct security_descriptor *sd ); extern struct object *create_socket_device( struct object *root, const struct unicode_str *name, unsigned int attr, const struct security_descriptor *sd ); extern struct object *create_unix_device( struct object *root, const struct unicode_str *name, unsigned int attr, const struct security_descriptor *sd, const char *unix_path ); /* change notification functions */ extern void do_change_notify( int unix_fd ); extern void sigio_callback(void); extern struct object *create_dir_obj( struct fd *fd, unsigned int access, mode_t mode ); extern struct dir *get_dir_obj( struct process *process, obj_handle_t handle, unsigned int access ); /* completion */ extern struct completion *get_completion_obj( struct process *process, obj_handle_t handle, unsigned int access ); extern struct reserve *get_completion_reserve_obj( struct process *process, obj_handle_t handle, unsigned int access ); extern void add_completion( struct completion *completion, apc_param_t ckey, apc_param_t cvalue, unsigned int status, apc_param_t information ); extern void cleanup_thread_completion( struct thread *thread ); /* serial port functions */ extern int is_serial_fd( struct fd *fd ); extern struct object *create_serial( struct fd *fd ); /* async I/O functions */ typedef void (*async_completion_callback)( void *private ); extern void free_async_queue( struct async_queue *queue ); extern struct async *create_async( struct fd *fd, struct thread *thread, const struct async_data *data, struct iosb *iosb ); extern struct async *create_request_async( struct fd *fd, unsigned int comp_flags, const struct async_data *data, int is_system ); extern obj_handle_t async_handoff( struct async *async, data_size_t *result, int force_blocking ); extern void queue_async( struct async_queue *queue, struct async *async ); extern void async_set_timeout( struct async *async, timeout_t timeout, unsigned int status ); extern void async_set_result( struct object *obj, unsigned int status, apc_param_t total ); extern void async_set_completion_callback( struct async *async, async_completion_callback func, void *private ); extern void async_set_unknown_status( struct async *async ); extern void set_async_pending( struct async *async ); extern void async_set_initial_status( struct async *async, unsigned int status ); extern void async_wake_obj( struct async *async ); extern int async_waiting( struct async_queue *queue ); extern int async_queue_has_waiting_asyncs( struct async_queue *queue ); extern void async_terminate( struct async *async, unsigned int status ); extern void async_request_complete( struct async *async, unsigned int status, data_size_t result, data_size_t out_size, void *out_data ); extern void async_request_complete_alloc( struct async *async, unsigned int status, data_size_t result, data_size_t out_size, const void *out_data ); extern void async_wake_up( struct async_queue *queue, unsigned int status ); extern struct completion *fd_get_completion( struct fd *fd, apc_param_t *p_key ); extern void fd_copy_completion( struct fd *src, struct fd *dst ); extern struct iosb *async_get_iosb( struct async *async ); extern struct thread *async_get_thread( struct async *async ); extern struct async *find_pending_async( struct async_queue *queue ); extern void cancel_process_asyncs( struct process *process ); extern void cancel_terminating_thread_asyncs( struct thread *thread ); extern int async_close_obj_handle( struct object *obj, struct process *process, obj_handle_t handle ); static inline void init_async_queue( struct async_queue *queue ) { list_init( &queue->queue ); } static inline int async_queued( struct async_queue *queue ) { return !list_empty( &queue->queue ); } /* access rights that require Unix read permission */ #define FILE_UNIX_READ_ACCESS (FILE_READ_DATA|FILE_READ_ATTRIBUTES|FILE_READ_EA) /* access rights that require Unix write permission */ #define FILE_UNIX_WRITE_ACCESS (FILE_WRITE_DATA|FILE_APPEND_DATA|FILE_WRITE_ATTRIBUTES|FILE_WRITE_EA) /* magic file access rights for mappings */ #define FILE_MAPPING_IMAGE 0x80000000 /* set for SEC_IMAGE mappings */ #define FILE_MAPPING_WRITE 0x40000000 /* set for writable shared mappings */ #define FILE_MAPPING_ACCESS 0x20000000 /* set for all mappings */ #endif /* __WINE_SERVER_FILE_H */