c850b80ea78595185284d949746d111da30e1d7a
[WebKit-https.git] / Source / WTF / wtf / Poisoned.cpp
1 /*
2  * Copyright (C) 2017-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 #include "config.h"
27 #include <wtf/Poisoned.h>
28
29 #include <wtf/CryptographicallyRandomNumber.h>
30
31 namespace WTF {
32
33 uintptr_t makePoison()
34 {
35     uintptr_t poison = 0;
36 #if ENABLE(POISON)
37     do {
38         poison = cryptographicallyRandomNumber();
39         poison = (poison << 16) ^ (static_cast<uintptr_t>(cryptographicallyRandomNumber()) << 3);
40     } while (!(poison >> 32)); // Ensure that bits 32-47 are not completely 0.
41
42     // Ensure that the poisoned bits (pointer ^ poison) looks like a valid pointer.
43     RELEASE_ASSERT(poison && !(poison >> 48));
44
45     // Ensure that the poisoned bits (pointer ^ poison) cannot be 0. This is so that the poisoned
46     // bits can also be used for a normal zero check without needing to be decoded first.
47     poison |= (1 << 2);
48
49     // Ensure that the bottom 2 alignment bits are still 0 so that the poisoned bits will
50     // still preserve the properties of a pointer where these bits are expected to be 0.
51     // This allows the poisoned bits to be used in place of the pointer by clients that
52     // rely on this property of pointers and sets flags in the low bits.
53     // Note: a regular pointer has 3 alignment bits, but the poisoned bits need to use one
54     // (see above). Hence, clients can only use 2 bits for flags.
55     RELEASE_ASSERT(!(poison & 0x3));
56 #endif
57     return poison;
58 }
59
60 } // namespace WTF