[UNIX] Simplify the file descriptor handling in SharedMemory
[WebKit-https.git] / Source / WebKit2 / Platform / unix / SharedMemoryUnix.cpp
1 /*
2  * Copyright (C) 2010 Apple Inc. All rights reserved.
3  * Copyright (c) 2010 University of Szeged
4  * Copyright (C) 2010 Nokia Corporation and/or its subsidiary(-ies)
5  *
6  * Redistribution and use in source and binary forms, with or without
7  * modification, are permitted provided that the following conditions
8  * are met:
9  * 1. Redistributions of source code must retain the above copyright
10  *    notice, this list of conditions and the following disclaimer.
11  * 2. Redistributions in binary form must reproduce the above copyright
12  *    notice, this list of conditions and the following disclaimer in the
13  *    documentation and/or other materials provided with the distribution.
14  *
15  * THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
16  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
17  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
18  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
19  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
20  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
21  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
22  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
23  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
24  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
25  * THE POSSIBILITY OF SUCH DAMAGE.
26  */
27
28 #include "config.h"
29 #if USE(UNIX_DOMAIN_SOCKETS)
30 #include "SharedMemory.h"
31
32 #include "ArgumentDecoder.h"
33 #include "ArgumentEncoder.h"
34 #include <errno.h>
35 #include <fcntl.h>
36 #include <stdlib.h>
37 #include <sys/mman.h>
38 #include <sys/stat.h>
39 #include <sys/types.h>
40 #include <unistd.h>
41 #include <wtf/Assertions.h>
42 #include <wtf/CurrentTime.h>
43 #include <wtf/RandomNumber.h>
44 #include <wtf/UniStdExtras.h>
45 #include <wtf/text/CString.h>
46
47 namespace WebKit {
48
49 SharedMemory::Handle::Handle()
50 {
51 }
52
53 SharedMemory::Handle::~Handle()
54 {
55     clear();
56 }
57
58 void SharedMemory::Handle::clear()
59 {
60     m_attachment.dispose();
61 }
62
63 bool SharedMemory::Handle::isNull() const
64 {
65     return m_attachment.fileDescriptor() == -1;
66 }
67
68 void SharedMemory::Handle::encode(IPC::ArgumentEncoder& encoder) const
69 {
70     encoder << releaseAttachment();
71 }
72
73 bool SharedMemory::Handle::decode(IPC::ArgumentDecoder& decoder, Handle& handle)
74 {
75     ASSERT_ARG(handle, !handle.m_size);
76     ASSERT_ARG(handle, handle.isNull());
77
78     IPC::Attachment attachment;
79     if (!decoder.decode(attachment))
80         return false;
81
82     handle.adoptAttachment(WTF::move(attachment));
83     return true;
84 }
85
86 IPC::Attachment SharedMemory::Handle::releaseAttachment() const
87 {
88     ASSERT(!isNull());
89     return WTF::move(m_attachment);
90 }
91
92 void SharedMemory::Handle::adoptAttachment(IPC::Attachment&& attachment)
93 {
94     ASSERT(isNull());
95
96     m_attachment = WTF::move(attachment);
97 }
98
99 RefPtr<SharedMemory> SharedMemory::allocate(size_t size)
100 {
101     CString tempName;
102
103     int fileDescriptor = -1;
104     for (int tries = 0; fileDescriptor == -1 && tries < 10; ++tries) {
105         String name = String("/WK2SharedMemory.") + String::number(static_cast<unsigned>(WTF::randomNumber() * (std::numeric_limits<unsigned>::max() + 1.0)));
106         tempName = name.utf8();
107
108         do {
109             fileDescriptor = shm_open(tempName.data(), O_CREAT | O_RDWR, S_IRUSR | S_IWUSR);
110         } while (fileDescriptor == -1 && errno == EINTR);
111     }
112     if (fileDescriptor == -1) {
113         WTFLogAlways("Failed to create shared memory file %s: %s", tempName.data(), strerror(errno));
114         return 0;
115     }
116
117     while (ftruncate(fileDescriptor, size) == -1) {
118         if (errno != EINTR) {
119             closeWithRetry(fileDescriptor);
120             shm_unlink(tempName.data());
121             return 0;
122         }
123     }
124
125     void* data = mmap(0, size, PROT_READ | PROT_WRITE, MAP_SHARED, fileDescriptor, 0);
126     if (data == MAP_FAILED) {
127         closeWithRetry(fileDescriptor);
128         shm_unlink(tempName.data());
129         return 0;
130     }
131
132     shm_unlink(tempName.data());
133
134     RefPtr<SharedMemory> instance = adoptRef(new SharedMemory());
135     instance->m_data = data;
136     instance->m_fileDescriptor = fileDescriptor;
137     instance->m_size = size;
138     return instance.release();
139 }
140
141 static inline int accessModeMMap(SharedMemory::Protection protection)
142 {
143     switch (protection) {
144     case SharedMemory::Protection::ReadOnly:
145         return PROT_READ;
146     case SharedMemory::Protection::ReadWrite:
147         return PROT_READ | PROT_WRITE;
148     }
149
150     ASSERT_NOT_REACHED();
151     return PROT_READ | PROT_WRITE;
152 }
153
154 RefPtr<SharedMemory> SharedMemory::map(const Handle& handle, Protection protection)
155 {
156     ASSERT(!handle.isNull());
157
158     void* data = mmap(0, handle.m_attachment.size(), accessModeMMap(protection), MAP_SHARED, handle.m_attachment.fileDescriptor(), 0);
159     if (data == MAP_FAILED)
160         return nullptr;
161
162     RefPtr<SharedMemory> instance = adoptRef(new SharedMemory());
163     instance->m_data = data;
164     instance->m_fileDescriptor = handle.m_attachment.releaseFileDescriptor();
165     instance->m_size = handle.m_attachment.size();
166     return instance;
167 }
168
169 SharedMemory::~SharedMemory()
170 {
171     munmap(m_data, m_size);
172     closeWithRetry(m_fileDescriptor);
173 }
174
175 bool SharedMemory::createHandle(Handle& handle, Protection)
176 {
177     ASSERT_ARG(handle, !handle.m_size);
178     ASSERT_ARG(handle, handle.isNull());
179
180     // FIXME: Handle the case where the passed Protection is ReadOnly.
181     // See https://bugs.webkit.org/show_bug.cgi?id=131542.
182
183     int duplicatedHandle;
184     while ((duplicatedHandle = dup(m_fileDescriptor)) == -1) {
185         if (errno != EINTR) {
186             ASSERT_NOT_REACHED();
187             return false;
188         }
189     }
190
191     while (fcntl(duplicatedHandle, F_SETFD, FD_CLOEXEC) == -1) {
192         if (errno != EINTR) {
193             ASSERT_NOT_REACHED();
194             closeWithRetry(duplicatedHandle);
195             return false;
196         }
197     }
198     handle.m_attachment = IPC::Attachment(duplicatedHandle, m_size);
199     return true;
200 }
201
202 unsigned SharedMemory::systemPageSize()
203 {
204     static unsigned pageSize = 0;
205
206     if (!pageSize)
207         pageSize = getpagesize();
208
209     return pageSize;
210 }
211
212 } // namespace WebKit
213
214 #endif
215