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 struct async_queue;
28 struct completion;
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 void (*flush)(struct fd *, struct event **);
39 /* get file information */
40 enum server_fd_type (*get_fd_type)(struct fd *fd);
41 /* perform an ioctl on the file */
42 obj_handle_t (*ioctl)(struct fd *fd, ioctl_code_t code, const async_data_t *async,
43 const void *data, data_size_t size);
44 /* queue an async operation */
45 void (*queue_async)(struct fd *, const async_data_t *data, int type, int count);
46 /* selected events for async i/o need an update */
47 void (*reselect_async)( struct fd *, struct async_queue *queue );
48 /* cancel an async operation */
49 void (*cancel_async)(struct fd *);
50 };
51
52 /* file descriptor functions */
53
54 extern struct fd *alloc_pseudo_fd( const struct fd_ops *fd_user_ops, struct object *user,
55 unsigned int options );
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 int check_fd_events( struct fd *fd, int events );
69 extern void set_fd_events( struct fd *fd, int events );
70 extern obj_handle_t lock_fd( struct fd *fd, file_pos_t offset, file_pos_t count, int shared, int wait );
71 extern void unlock_fd( struct fd *fd, file_pos_t offset, file_pos_t count );
72 extern void set_fd_signaled( struct fd *fd, int signaled );
73
74 extern int default_fd_signaled( struct object *obj, struct thread *thread );
75 extern unsigned int default_fd_map_access( struct object *obj, unsigned int access );
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 obj_handle_t 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 );
89
90 static inline struct fd *get_obj_fd( struct object *obj ) { return obj->ops->get_fd( obj ); }
91
92 /* timeout functions */
93
94 struct timeout_user;
95 extern timeout_t current_time;
96
97 #define TICKS_PER_SEC 10000000
98
99 typedef void (*timeout_callback)( void *private );
100
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 );
104
105 /* file functions */
106
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);
115 extern struct security_descriptor *mode_to_sd( mode_t mode, const SID *user, const SID *group );
116 extern mode_t sd_to_mode( const struct security_descriptor *sd, const SID *owner );
117
118 /* change notification functions */
119
120 extern void do_change_notify( int unix_fd );
121 extern void sigio_callback(void);
122 extern struct object *create_dir_obj( struct fd *fd );
123
124 /* completion */
125
126 extern struct completion *get_completion_obj( struct process *process, obj_handle_t handle, unsigned int access );
127 extern void add_completion( struct completion *completion, unsigned long ckey, unsigned long cvalue, unsigned int status, unsigned long information );
128
129 /* serial port functions */
130
131 extern int is_serial_fd( struct fd *fd );
132 extern struct object *create_serial( struct fd *fd );
133
134 /* async I/O functions */
135 extern struct async_queue *create_async_queue( struct fd *fd );
136 extern void free_async_queue( struct async_queue *queue );
137 extern struct async *create_async( struct thread *thread, struct async_queue *queue,
138 const async_data_t *data );
139 extern void async_set_timeout( struct async *async, timeout_t timeout, unsigned int status );
140 extern void async_set_result( struct object *obj, unsigned int status, unsigned long total );
141 extern int async_waiting( struct async_queue *queue );
142 extern void async_terminate( struct async *async, unsigned int status );
143 extern void async_wake_up( struct async_queue *queue, unsigned int status );
144 extern void fd_assign_completion( struct fd *fd, struct completion **p_port, unsigned long *p_key );
145
146 /* access rights that require Unix read permission */
147 #define FILE_UNIX_READ_ACCESS (FILE_READ_DATA|FILE_READ_ATTRIBUTES|FILE_READ_EA)
148
149 /* access rights that require Unix write permission */
150 #define FILE_UNIX_WRITE_ACCESS (FILE_WRITE_DATA|FILE_WRITE_ATTRIBUTES|FILE_WRITE_EA)
151
152 #endif /* __WINE_SERVER_FILE_H */
153
This page was automatically generated by the
LXR engine.
Visit the LXR main site for more
information.