1/*
2 * Copyright (C) 2016-2018 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 "ExceptionScope.h"
29
30namespace JSC {
31
32#if ENABLE(EXCEPTION_SCOPE_VERIFICATION)
33
34// If a function can clear JS exceptions, it should declare a CatchScope at the
35// top of the function (as early as possible) using the DECLARE_CATCH_SCOPE macro.
36// Declaring a CatchScope in a function means that the function intends to clear
37// pending exceptions before returning to its caller.
38
39class CatchScope : public ExceptionScope {
40public:
41 JS_EXPORT_PRIVATE CatchScope(VM&, ExceptionEventLocation);
42 CatchScope(const CatchScope&) = delete;
43 CatchScope(CatchScope&&) = default;
44
45 JS_EXPORT_PRIVATE ~CatchScope();
46
47 void clearException() { m_vm.clearException(); }
48};
49
50#define DECLARE_CATCH_SCOPE(vm__) \
51 JSC::CatchScope((vm__), JSC::ExceptionEventLocation(EXCEPTION_SCOPE_POSITION_FOR_ASAN(vm__), __FUNCTION__, __FILE__, __LINE__))
52
53#else // not ENABLE(EXCEPTION_SCOPE_VERIFICATION)
54
55class CatchScope : public ExceptionScope {
56public:
57 ALWAYS_INLINE CatchScope(VM& vm)
58 : ExceptionScope(vm)
59 { }
60 CatchScope(const CatchScope&) = delete;
61 CatchScope(CatchScope&&) = default;
62
63 ALWAYS_INLINE void clearException() { m_vm.clearException(); }
64};
65
66#define DECLARE_CATCH_SCOPE(vm__) \
67 JSC::CatchScope((vm__))
68
69#endif // ENABLE(EXCEPTION_SCOPE_VERIFICATION)
70
71#define CLEAR_AND_RETURN_IF_EXCEPTION(scope__, value__) do { \
72 if (UNLIKELY((scope__).exception())) { \
73 (scope__).clearException(); \
74 return value__; \
75 } \
76 } while (false)
77
78} // namespace JSC
79