[WebIDL] Support callbacks with arbitrary return types
[WebKit-https.git] / Source / WebCore / fileapi / AsyncFileStream.cpp
1 /*
2  * Copyright (C) 2010 Google Inc.  All rights reserved.
3  * Copyright (C) 2012, 2014 Apple Inc. All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions are
7  * met:
8  *
9  *     * Redistributions of source code must retain the above copyright
10  * notice, this list of conditions and the following disclaimer.
11  *     * Redistributions in binary form must reproduce the above
12  * copyright notice, this list of conditions and the following disclaimer
13  * in the documentation and/or other materials provided with the
14  * distribution.
15  *     * Neither the name of Google Inc. nor the names of its
16  * contributors may be used to endorse or promote products derived from
17  * this software without specific prior written permission.
18  *
19  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
20  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
21  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
22  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
23  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
24  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
25  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
26  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
27  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
28  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
29  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30  */
31
32 #include "config.h"
33 #include "AsyncFileStream.h"
34
35 #include "FileStream.h"
36 #include "FileStreamClient.h"
37 #include "URL.h"
38 #include <mutex>
39 #include <wtf/AutodrainedPool.h>
40 #include <wtf/Function.h>
41 #include <wtf/MainThread.h>
42 #include <wtf/MessageQueue.h>
43 #include <wtf/NeverDestroyed.h>
44
45 namespace WebCore {
46
47 struct AsyncFileStream::Internals {
48     explicit Internals(FileStreamClient&);
49
50     FileStream stream;
51     FileStreamClient& client;
52 #if !COMPILER(MSVC)
53     std::atomic_bool destroyed { false };
54 #else
55     std::atomic_bool destroyed;
56 #endif
57 };
58
59 inline AsyncFileStream::Internals::Internals(FileStreamClient& client)
60     : client(client)
61 {
62 #if COMPILER(MSVC)
63     // Work around a bug that prevents the default value above from compiling.
64     atomic_init(&destroyed, false);
65 #endif
66 }
67
68 static void callOnFileThread(Function<void ()>&& function)
69 {
70     ASSERT(isMainThread());
71     ASSERT(function);
72
73     static NeverDestroyed<MessageQueue<Function<void ()>>> queue;
74
75     static std::once_flag createFileThreadOnce;
76     std::call_once(createFileThreadOnce, [] {
77         Thread::create("WebCore: AsyncFileStream", [] {
78             for (;;) {
79                 AutodrainedPool pool;
80
81                 auto function = queue.get().waitForMessage();
82
83                 // This can never be null because we never kill the MessageQueue.
84                 ASSERT(function);
85
86                 // This can bever be null because we never queue a function that is null.
87                 ASSERT(*function);
88
89                 (*function)();
90             }
91         });
92     });
93
94     queue.get().append(std::make_unique<Function<void ()>>(WTFMove(function)));
95 }
96
97 AsyncFileStream::AsyncFileStream(FileStreamClient& client)
98     : m_internals(std::make_unique<Internals>(client))
99 {
100     ASSERT(isMainThread());
101 }
102
103 AsyncFileStream::~AsyncFileStream()
104 {
105     ASSERT(isMainThread());
106
107     // Set flag to prevent client callbacks and also prevent queued operations from starting.
108     m_internals->destroyed = true;
109
110     // Call through file thread and back to main thread to make sure deletion happens
111     // after all file thread functions and all main thread functions called from them.
112     callOnFileThread([internals = WTFMove(m_internals)]() mutable {
113         callOnMainThread([internals = WTFMove(internals)] {
114         });
115     });
116 }
117
118 void AsyncFileStream::perform(Function<std::function<void(FileStreamClient&)>(FileStream&)>&& operation)
119 {
120     auto& internals = *m_internals;
121     callOnFileThread([&internals, operation = WTFMove(operation)] {
122         // Don't do the operation if stop was already called on the main thread. Note that there is
123         // a race here, but since skipping the operation is an optimization it's OK that we can't
124         // guarantee exactly which operations are skipped. Note that this is also the only reason
125         // we use an atomic_bool rather than just a bool for destroyed.
126         if (internals.destroyed)
127             return;
128         callOnMainThread([&internals, mainThreadWork = operation(internals.stream)] {
129             if (internals.destroyed)
130                 return;
131             mainThreadWork(internals.client);
132         });
133     });
134 }
135
136 void AsyncFileStream::getSize(const String& path, double expectedModificationTime)
137 {
138     // FIXME: Explicit return type here and in all the other cases like this below is a workaround for a deficiency
139     // in the Windows compiler at the time of this writing. Could remove it if that is resolved.
140     perform([path = path.isolatedCopy(), expectedModificationTime](FileStream& stream) -> std::function<void(FileStreamClient&)> {
141         long long size = stream.getSize(path, expectedModificationTime);
142         return [size](FileStreamClient& client) {
143             client.didGetSize(size);
144         };
145     });
146 }
147
148 void AsyncFileStream::openForRead(const String& path, long long offset, long long length)
149 {
150     // FIXME: Explicit return type here is a workaround for a deficiency in the Windows compiler at the time of this writing.
151     perform([path = path.isolatedCopy(), offset, length](FileStream& stream) -> std::function<void(FileStreamClient&)> {
152         bool success = stream.openForRead(path, offset, length);
153         return [success](FileStreamClient& client) {
154             client.didOpen(success);
155         };
156     });
157 }
158
159 void AsyncFileStream::close()
160 {
161     auto& internals = *m_internals;
162     callOnFileThread([&internals] {
163         internals.stream.close();
164     });
165 }
166
167 void AsyncFileStream::read(char* buffer, int length)
168 {
169     perform([buffer, length](FileStream& stream) -> std::function<void(FileStreamClient&)> {
170         int bytesRead = stream.read(buffer, length);
171         return [bytesRead](FileStreamClient& client) {
172             client.didRead(bytesRead);
173         };
174     });
175 }
176
177 } // namespace WebCore