Reland r216808, underlying lldb bug has been fixed.
[WebKit-https.git] / Source / WTF / wtf / ThreadMessage.h
1 /*
2  * Copyright (C) 2017 Apple Inc. All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY APPLE INC. ``AS IS'' AND ANY
14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE INC. OR
17  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
18  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
19  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
20  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
21  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
23  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 #pragma once
27
28 #include <wtf/Ref.h>
29 #include <wtf/ScopedLambda.h>
30 #include <wtf/Threading.h>
31
32 #if USE(PTHREADS)
33
34 namespace WTF {
35
36 void initializeThreadMessages();
37
38 class ThreadMessageData;
39 using ThreadMessage = ScopedLambda<void(PlatformRegisters&)>;
40
41 enum class MessageStatus {
42     MessageRan,
43     ThreadExited,
44 };
45
46 // This method allows us to send a message which will be run in a signal handler on the desired thread.
47 // There are several caveates to this method however, This function uses signals so your message should
48 // be sync signal safe.
49 WTF_EXPORT_PRIVATE MessageStatus sendMessageScoped(Thread&, const ThreadMessage&);
50
51 template<typename Functor>
52 MessageStatus sendMessage(Thread& targetThread, const Functor& func)
53 {
54     auto lambda = scopedLambdaRef<void(PlatformRegisters&)>(func);
55     return sendMessageScoped(targetThread, lambda);
56 }
57
58 #if HAVE(MACH_EXCEPTIONS)
59 void deliverMessagesUsingMach();
60 #endif
61
62 } // namespace WTF
63
64 using WTF::sendMessage;
65
66 #endif // USE(PTHREADS)