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_fd_type
)(struct fd
*fd
);
42 /* perform an ioctl on the file */
43 void (*ioctl
)(struct fd
*fd
, ioctl_code_t code
, const async_data_t
*async
,
44 const void *data
, data_size_t size
);
45 /* queue an async operation */
46 void (*queue_async
)(struct fd
*, const async_data_t
*data
, int type
, int count
);
47 /* selected events for async i/o need an update */
48 void (*reselect_async
)( struct fd
*, struct async_queue
*queue
);
49 /* cancel an async operation */
50 void (*cancel_async
)(struct fd
*);
53 /* file descriptor functions */
55 extern struct fd
*alloc_pseudo_fd( const struct fd_ops
*fd_user_ops
, struct object
*user
);
56 extern void set_no_fd_status( struct fd
*fd
, unsigned int status
);
57 extern struct fd
*open_fd( const char *name
, int flags
, mode_t
*mode
, unsigned int access
,
58 unsigned int sharing
, unsigned int options
);
59 extern struct fd
*create_anonymous_fd( const struct fd_ops
*fd_user_ops
,
60 int unix_fd
, struct object
*user
, unsigned int options
);
61 extern void *get_fd_user( struct fd
*fd
);
62 extern void set_fd_user( struct fd
*fd
, const struct fd_ops
*ops
, struct object
*user
);
63 extern unsigned int get_fd_options( struct fd
*fd
);
64 extern int get_unix_fd( struct fd
*fd
);
65 extern int is_same_file_fd( struct fd
*fd1
, struct fd
*fd2
);
66 extern int is_fd_removable( struct fd
*fd
);
67 extern int fd_close_handle( struct object
*obj
, struct process
*process
, obj_handle_t handle
);
68 extern void fd_poll_event( struct fd
*fd
, int event
);
69 extern int check_fd_events( struct fd
*fd
, int events
);
70 extern void set_fd_events( struct fd
*fd
, int events
);
71 extern obj_handle_t
lock_fd( struct fd
*fd
, file_pos_t offset
, file_pos_t count
, int shared
, int wait
);
72 extern void unlock_fd( struct fd
*fd
, file_pos_t offset
, file_pos_t count
);
73 extern void set_fd_signaled( struct fd
*fd
, int signaled
);
75 extern int default_fd_signaled( struct object
*obj
, struct thread
*thread
);
76 extern int default_fd_get_poll_events( struct fd
*fd
);
77 extern void default_poll_event( struct fd
*fd
, int event
);
78 extern struct async
*fd_queue_async( struct fd
*fd
, const async_data_t
*data
, int type
, int count
);
79 extern void fd_async_wake_up( struct fd
*fd
, int type
, unsigned int status
);
80 extern void fd_reselect_async( struct fd
*fd
, struct async_queue
*queue
);
81 extern void default_fd_ioctl( struct fd
*fd
, ioctl_code_t code
, const async_data_t
*async
,
82 const void *data
, data_size_t size
);
83 extern void default_fd_queue_async( struct fd
*fd
, const async_data_t
*data
, int type
, int count
);
84 extern void default_fd_reselect_async( struct fd
*fd
, struct async_queue
*queue
);
85 extern void default_fd_cancel_async( struct fd
*fd
);
86 extern void no_flush( struct fd
*fd
, struct event
**event
);
87 extern void main_loop(void);
88 extern void remove_process_locks( struct process
*process
);
90 static inline struct fd
*get_obj_fd( struct object
*obj
) { return obj
->ops
->get_fd( obj
); }
92 /* timeout functions */
95 extern timeout_t current_time
;
97 #define TICKS_PER_SEC 10000000
99 typedef void (*timeout_callback
)( void *private );
101 extern struct timeout_user
*add_timeout_user( timeout_t when
, timeout_callback func
, void *private );
102 extern void remove_timeout_user( struct timeout_user
*user
);
103 extern const char *get_timeout_str( timeout_t timeout
);
107 extern struct file
*get_file_obj( struct process
*process
, obj_handle_t handle
,
108 unsigned int access
);
109 extern int get_file_unix_fd( struct file
*file
);
110 extern int is_same_file( struct file
*file1
, struct file
*file2
);
111 extern struct file
*grab_file_unless_removable( struct file
*file
);
112 extern int grow_file( struct file
*file
, file_pos_t size
);
113 extern struct file
*create_temp_file( int access
);
114 extern void file_set_error(void);
116 /* change notification functions */
118 extern void do_change_notify( int unix_fd
);
119 extern void sigio_callback(void);
120 extern struct object
*create_dir_obj( struct fd
*fd
);
122 /* serial port functions */
124 extern int is_serial_fd( struct fd
*fd
);
125 extern struct object
*create_serial( struct fd
*fd
);
127 /* async I/O functions */
128 extern struct async_queue
*create_async_queue( struct fd
*fd
);
129 extern void free_async_queue( struct async_queue
*queue
);
130 extern struct async
*create_async( struct thread
*thread
, struct async_queue
*queue
,
131 const async_data_t
*data
);
132 extern void async_set_timeout( struct async
*async
, timeout_t timeout
, unsigned int status
);
133 extern void async_set_result( struct object
*obj
, unsigned int status
);
134 extern int async_waiting( struct async_queue
*queue
);
135 extern void async_wake_up( struct async_queue
*queue
, unsigned int status
);
137 /* access rights that require Unix read permission */
138 #define FILE_UNIX_READ_ACCESS (FILE_READ_DATA|FILE_READ_ATTRIBUTES|FILE_READ_EA)
140 /* access rights that require Unix write permission */
141 #define FILE_UNIX_WRITE_ACCESS (FILE_WRITE_DATA|FILE_WRITE_ATTRIBUTES|FILE_WRITE_EA)
143 #endif /* __WINE_SERVER_FILE_H */