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