- separate cleanly between async scheduling and file IO related issues.
[wine] / include / async.h
1 /*
2  * Structures and static functions for handling asynchronous I/O.
3  *
4  * Copyright (C) 2002 Mike McCormack,  Martin Wilck
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 /*
22  * This file declares static functions.
23  * It should only be included by those source files that implement async I/O requests.
24  */
25
26 #ifndef __WINE_ASYNC_H
27 #define __WINE_ASYNC_H
28
29 #include "wine/server.h"
30
31 struct async_private;
32
33 typedef void (*async_handler)(struct async_private *ovp);
34 typedef void CALLBACK (*async_call_completion_func)(ULONG_PTR data);
35 typedef DWORD (*async_get_status)(const struct async_private *ovp);
36 typedef DWORD (*async_get_count)(const struct async_private *ovp);
37 typedef void (*async_set_status)(struct async_private *ovp, const DWORD status);
38
39 typedef struct async_ops
40 {
41     async_get_status            get_status;
42     async_set_status            set_status;
43     async_get_count             get_count;
44     async_call_completion_func  call_completion;
45 } async_ops;
46
47 typedef struct async_private
48 {
49     struct async_ops     *ops;
50     HANDLE        handle;
51     HANDLE        event;
52     int           fd;
53     async_handler func;
54     int           type;
55     struct async_private *next;
56     struct async_private *prev;
57 } async_private;
58
59 /* All functions declared static for Dll separation purposes */
60
61 inline static void finish_async( async_private *ovp )
62 {
63     if(ovp->prev)
64         ovp->prev->next = ovp->next;
65     else
66         NtCurrentTeb()->pending_list = ovp->next;
67
68     if(ovp->next)
69         ovp->next->prev = ovp->prev;
70
71     ovp->next = ovp->prev = NULL;
72
73     close( ovp->fd );
74     if( ovp->event != INVALID_HANDLE_VALUE )
75         NtSetEvent( ovp->event, NULL );
76
77     QueueUserAPC( ovp->ops->call_completion, GetCurrentThread(), (ULONG_PTR)ovp );
78 }
79
80 inline static BOOL __register_async( async_private *ovp, const DWORD status )
81 {
82     BOOL ret;
83
84     SERVER_START_REQ( register_async )
85     {
86         req->handle = ovp->handle;
87         req->overlapped = ovp;
88         req->type = ovp->type;
89         req->count = ovp->ops->get_count( ovp );
90         req->status = status;
91         ret = wine_server_call( req );
92     }
93     SERVER_END_REQ;
94
95     if ( ret ) ovp->ops->set_status ( ovp, GetLastError() );
96     if ( ovp->ops->get_status (ovp) != STATUS_PENDING )
97         finish_async (ovp);
98
99     return ret;
100 }
101
102 #define register_old_async(ovp) \
103     __register_async (ovp, ovp->ops->get_status( ovp ));
104
105 inline static BOOL register_new_async( async_private *ovp )
106 {
107     ovp->ops->set_status ( ovp, STATUS_PENDING );
108
109     ovp->next = NtCurrentTeb()->pending_list;
110     ovp->prev = NULL;
111     if ( ovp->next ) ovp->next->prev = ovp;
112     NtCurrentTeb()->pending_list = ovp;
113
114     return __register_async( ovp, STATUS_PENDING );
115 }
116
117 inline static BOOL cancel_async ( async_private *ovp )
118 {
119      /* avoid multiple cancellations */
120      if ( ovp->ops->get_status( ovp ) != STATUS_PENDING )
121           return 0;
122      ovp->ops->set_status ( ovp, STATUS_CANCELLED );
123      return __register_async ( ovp, STATUS_CANCELLED );
124 }
125
126 #endif /* __WINE_ASYNC_H */