Implemented file locking functions (partly based on my old Corel
[wine] / 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., 59 Temple Place, Suite 330, Boston, MA  02111-1307  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 occured */
36     void (*poll_event)(struct fd *,int event);
37     /* flush the object buffers */
38     int  (*flush)(struct fd *);
39     /* get file information */
40     int  (*get_file_info)(struct fd *,struct get_file_info_reply *, int *flags);
41     /* queue an async operation - see register_async handler in async.c*/
42     void (*queue_async)(struct fd *, void* ptr, unsigned int status, int type, int count);
43 };
44
45 /* file descriptor functions */
46
47 extern struct fd *alloc_fd( const struct fd_ops *fd_user_ops, struct object *user );
48 extern struct fd *open_fd( struct fd *fd, const char *name, int flags, int *mode );
49 extern struct fd *create_anonymous_fd( const struct fd_ops *fd_user_ops,
50                                        int unix_fd, struct object *user );
51 extern void *get_fd_user( struct fd *fd );
52 extern int get_unix_fd( struct fd *fd );
53 extern void fd_poll_event( struct fd *fd, int event );
54 extern int check_fd_events( struct fd *fd, int events );
55 extern void set_fd_events( struct fd *fd, int events );
56 extern obj_handle_t lock_fd( struct fd *fd, file_pos_t offset, file_pos_t count, int shared, int wait );
57 extern void unlock_fd( struct fd *fd, file_pos_t offset, file_pos_t count );
58
59 extern int default_fd_add_queue( struct object *obj, struct wait_queue_entry *entry );
60 extern void default_fd_remove_queue( struct object *obj, struct wait_queue_entry *entry );
61 extern int default_fd_signaled( struct object *obj, struct thread *thread );
62 extern void default_poll_event( struct fd *fd, int event );
63 extern int no_flush( struct fd *fd );
64 extern int no_get_file_info( struct fd *fd, struct get_file_info_reply *info, int *flags );
65 extern void no_queue_async( struct fd *fd, void* ptr, unsigned int status, int type, int count );
66 extern void main_loop(void);
67
68 inline static struct fd *get_obj_fd( struct object *obj ) { return obj->ops->get_fd( obj ); }
69
70 /* timeout functions */
71
72 struct timeout_user;
73
74 typedef void (*timeout_callback)( void *private );
75
76 extern struct timeout_user *add_timeout_user( struct timeval *when,
77                                               timeout_callback func, void *private );
78 extern void remove_timeout_user( struct timeout_user *user );
79 extern void add_timeout( struct timeval *when, int timeout );
80 /* return 1 if t1 is before t2 */
81 static inline int time_before( struct timeval *t1, struct timeval *t2 )
82 {
83     return ((t1->tv_sec < t2->tv_sec) ||
84             ((t1->tv_sec == t2->tv_sec) && (t1->tv_usec < t2->tv_usec)));
85 }
86
87 /* file functions */
88
89 extern struct file *get_file_obj( struct process *process, obj_handle_t handle,
90                                   unsigned int access );
91 extern int get_file_unix_fd( struct file *file );
92 extern int is_same_file( struct file *file1, struct file *file2 );
93 extern int get_file_drive_type( struct file *file );
94 extern int grow_file( struct file *file, int size_high, int size_low );
95 extern struct file *create_temp_file( int access );
96 extern void file_set_error(void);
97
98 #endif  /* __WINE_SERVER_FILE_H */