mirror of
https://github.com/dart-lang/sdk
synced 2024-09-05 00:13:50 +00:00
![Vyacheslav Egorov](/assets/img/avatar_default.png)
FinalizeHash(hash) was trying to avoid UB in expression 1 << 32 by casting 1 to uintptr_t. This type however is not wide enough on 32-bit platforms. Instead just use explicit comparison hashbits < kBitsPerInt32 to avoid overflow in left shift. This bug went unnoticed for a while because it the only place where we call FinalizeHash(hash) is in the snapshot profile writer code and it only triggers when gen_snapshot is a 32-bit binary - which is only true on Windows, as Mac and Linux seem to use simarm_x64 configuration instead. This UB was explicitly affecting the code behavior because C++ compiler would either optimize out or change behavior of any code that consumed value produced by FinalizeHash(hash). Fixes https://github.com/flutter/flutter/issues/97764 TEST=vm/cc/DirectChainedHashMap Change-Id: I39f2b09e7516c875b765e5a065d1c1331f89fa33 Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/250741 Commit-Queue: Slava Egorov <vegorov@google.com> Reviewed-by: Daco Harkes <dacoharkes@google.com>
393 lines
11 KiB
C++
393 lines
11 KiB
C++
// Copyright (c) 2012, the Dart project authors. Please see the AUTHORS file
|
|
// for details. All rights reserved. Use of this source code is governed by a
|
|
// BSD-style license that can be found in the LICENSE file.
|
|
|
|
#include "vm/hash_map.h"
|
|
#include "platform/assert.h"
|
|
#include "vm/unit_test.h"
|
|
|
|
namespace dart {
|
|
|
|
class TestValue {
|
|
public:
|
|
explicit TestValue(intptr_t x) : x_(x) {}
|
|
// FinalizeHash is used here to provide coverage for FinalizeHash(...)
|
|
// function.
|
|
uword Hash() const { return FinalizeHash(static_cast<uint32_t>(x_) & 1); }
|
|
bool Equals(const TestValue& other) { return x_ == other.x_; }
|
|
|
|
private:
|
|
intptr_t x_;
|
|
};
|
|
|
|
TEST_CASE(DirectChainedHashMap) {
|
|
DirectChainedHashMap<PointerSetKeyValueTrait<TestValue>> map;
|
|
EXPECT(map.IsEmpty());
|
|
TestValue v1(0);
|
|
TestValue v2(1);
|
|
TestValue v3(0);
|
|
map.Insert(&v1);
|
|
EXPECT(map.LookupValue(&v1) == &v1);
|
|
map.Insert(&v2);
|
|
EXPECT(map.LookupValue(&v1) == &v1);
|
|
EXPECT(map.LookupValue(&v2) == &v2);
|
|
EXPECT(map.LookupValue(&v3) == &v1);
|
|
EXPECT(map.Remove(&v1));
|
|
EXPECT(map.Lookup(&v1) == NULL);
|
|
map.Insert(&v1);
|
|
DirectChainedHashMap<PointerSetKeyValueTrait<TestValue>> map2(map);
|
|
EXPECT(map2.LookupValue(&v1) == &v1);
|
|
EXPECT(map2.LookupValue(&v2) == &v2);
|
|
EXPECT(map2.LookupValue(&v3) == &v1);
|
|
}
|
|
|
|
TEST_CASE(DirectChainedHashMapInsertRemove) {
|
|
DirectChainedHashMap<PointerSetKeyValueTrait<TestValue>> map;
|
|
EXPECT(map.IsEmpty());
|
|
TestValue v1(1);
|
|
TestValue v2(3); // Note: v1, v2, v3 should have the same hash.
|
|
TestValue v3(5);
|
|
|
|
// Start with adding and removing the same element.
|
|
map.Insert(&v1);
|
|
EXPECT(map.LookupValue(&v1) == &v1);
|
|
EXPECT(map.Remove(&v1));
|
|
EXPECT(map.Lookup(&v1) == NULL);
|
|
|
|
// Inserting v2 first should put it at the head of the list.
|
|
map.Insert(&v2);
|
|
map.Insert(&v1);
|
|
EXPECT(map.LookupValue(&v2) == &v2);
|
|
EXPECT(map.LookupValue(&v1) == &v1);
|
|
|
|
// Check to see if removing the head of the list causes issues.
|
|
EXPECT(map.Remove(&v2));
|
|
EXPECT(map.Lookup(&v2) == NULL);
|
|
EXPECT(map.LookupValue(&v1) == &v1);
|
|
|
|
// Reinsert v2, which will place it at the back of the hash map list.
|
|
map.Insert(&v2);
|
|
EXPECT(map.LookupValue(&v2) == &v2);
|
|
|
|
// Remove from the back of the hash map list.
|
|
EXPECT(map.Remove(&v2));
|
|
EXPECT(map.Lookup(&v2) == NULL);
|
|
EXPECT(map.Remove(&v1));
|
|
EXPECT(map.Lookup(&v1) == NULL);
|
|
|
|
// Check to see that removing an invalid element returns false.
|
|
EXPECT(!map.Remove(&v1));
|
|
|
|
// One last case: remove from the middle of a hash map list.
|
|
map.Insert(&v1);
|
|
map.Insert(&v2);
|
|
map.Insert(&v3);
|
|
|
|
EXPECT(map.LookupValue(&v1) == &v1);
|
|
EXPECT(map.LookupValue(&v2) == &v2);
|
|
EXPECT(map.LookupValue(&v3) == &v3);
|
|
|
|
EXPECT(map.Remove(&v2));
|
|
EXPECT(map.LookupValue(&v1) == &v1);
|
|
EXPECT(map.Lookup(&v2) == NULL);
|
|
EXPECT(map.LookupValue(&v3) == &v3);
|
|
|
|
EXPECT(map.Remove(&v1));
|
|
EXPECT(map.Remove(&v3));
|
|
|
|
EXPECT(map.IsEmpty());
|
|
}
|
|
|
|
TEST_CASE(MallocDirectChainedHashMap) {
|
|
MallocDirectChainedHashMap<PointerSetKeyValueTrait<TestValue>> map;
|
|
EXPECT(map.IsEmpty());
|
|
TestValue v1(0);
|
|
TestValue v2(1);
|
|
TestValue v3(0);
|
|
map.Insert(&v1);
|
|
EXPECT(map.LookupValue(&v1) == &v1);
|
|
map.Insert(&v2);
|
|
EXPECT(map.LookupValue(&v1) == &v1);
|
|
EXPECT(map.LookupValue(&v2) == &v2);
|
|
EXPECT(map.LookupValue(&v3) == &v1);
|
|
MallocDirectChainedHashMap<PointerSetKeyValueTrait<TestValue>> map2(map);
|
|
EXPECT(map2.LookupValue(&v1) == &v1);
|
|
EXPECT(map2.LookupValue(&v2) == &v2);
|
|
EXPECT(map2.LookupValue(&v3) == &v1);
|
|
}
|
|
|
|
TEST_CASE(ZoneDirectChainedHashMap) {
|
|
auto zone = thread->zone();
|
|
auto const map = new (zone)
|
|
ZoneDirectChainedHashMap<PointerSetKeyValueTrait<TestValue>>(zone);
|
|
EXPECT(map->IsEmpty());
|
|
TestValue v1(0);
|
|
TestValue v2(1);
|
|
TestValue v3(0);
|
|
map->Insert(&v1);
|
|
EXPECT(map->LookupValue(&v1) == &v1);
|
|
map->Insert(&v2);
|
|
EXPECT(map->LookupValue(&v1) == &v1);
|
|
EXPECT(map->LookupValue(&v2) == &v2);
|
|
EXPECT(map->LookupValue(&v3) == &v1);
|
|
}
|
|
|
|
class IntptrPair {
|
|
public:
|
|
IntptrPair() : first_(-1), second_(-1) {}
|
|
IntptrPair(intptr_t first, intptr_t second)
|
|
: first_(first), second_(second) {}
|
|
|
|
intptr_t first() const { return first_; }
|
|
intptr_t second() const { return second_; }
|
|
|
|
bool operator==(const IntptrPair& other) {
|
|
return (first_ == other.first_) && (second_ == other.second_);
|
|
}
|
|
|
|
bool operator!=(const IntptrPair& other) {
|
|
return (first_ != other.first_) || (second_ != other.second_);
|
|
}
|
|
|
|
private:
|
|
intptr_t first_;
|
|
intptr_t second_;
|
|
};
|
|
|
|
TEST_CASE(DirectChainedHashMapIterator) {
|
|
IntptrPair p1(1, 1);
|
|
IntptrPair p2(2, 2);
|
|
IntptrPair p3(3, 3);
|
|
IntptrPair p4(4, 4);
|
|
IntptrPair p5(5, 5);
|
|
DirectChainedHashMap<NumbersKeyValueTrait<IntptrPair> > map;
|
|
EXPECT(map.IsEmpty());
|
|
DirectChainedHashMap<NumbersKeyValueTrait<IntptrPair> >::Iterator it =
|
|
map.GetIterator();
|
|
EXPECT(it.Next() == NULL);
|
|
it.Reset();
|
|
|
|
map.Insert(p1);
|
|
EXPECT(*it.Next() == p1);
|
|
it.Reset();
|
|
|
|
map.Insert(p2);
|
|
map.Insert(p3);
|
|
map.Insert(p4);
|
|
map.Insert(p5);
|
|
intptr_t count = 0;
|
|
intptr_t sum = 0;
|
|
while (true) {
|
|
IntptrPair* p = it.Next();
|
|
if (p == NULL) {
|
|
break;
|
|
}
|
|
count++;
|
|
sum += p->second();
|
|
}
|
|
|
|
EXPECT(count == 5);
|
|
EXPECT(sum == 15);
|
|
}
|
|
|
|
TEST_CASE(DirectChainedHashMapIteratorWithCollisionInLastBucket) {
|
|
intptr_t values[] = {65, 325, 329, 73, 396, 207, 215, 93, 227, 39,
|
|
431, 112, 176, 313, 188, 317, 61, 127, 447};
|
|
IntMap<intptr_t> map;
|
|
|
|
for (intptr_t value : values) {
|
|
map.Insert(value, value);
|
|
}
|
|
|
|
bool visited[ARRAY_SIZE(values)] = {};
|
|
intptr_t count = 0;
|
|
auto it = map.GetIterator();
|
|
for (auto* p = it.Next(); p != nullptr; p = it.Next()) {
|
|
++count;
|
|
bool found = false;
|
|
intptr_t i = 0;
|
|
for (intptr_t v : values) {
|
|
if (v == p->key) {
|
|
EXPECT(v == p->value);
|
|
EXPECT(!visited[i]);
|
|
visited[i] = true;
|
|
found = true;
|
|
break;
|
|
}
|
|
++i;
|
|
}
|
|
EXPECT(found);
|
|
}
|
|
EXPECT(count == ARRAY_SIZE(values));
|
|
for (bool is_visited : visited) {
|
|
EXPECT(is_visited);
|
|
}
|
|
}
|
|
|
|
TEST_CASE(ZoneCStringSet) {
|
|
auto zone = thread->zone();
|
|
|
|
const char* const kConst1 = "test";
|
|
const char* const kConst2 = "test 2";
|
|
|
|
char* const str1 = OS::SCreate(zone, "%s", kConst1);
|
|
char* const str2 = OS::SCreate(zone, "%s", kConst2);
|
|
char* const str3 = OS::SCreate(zone, "%s", kConst1);
|
|
|
|
// Make sure these strings are pointer-distinct, but C-string-equal.
|
|
EXPECT_NE(str1, str3);
|
|
EXPECT_STREQ(str1, str3);
|
|
|
|
auto const set = new (zone) ZoneCStringSet(zone);
|
|
EXPECT(set->IsEmpty());
|
|
|
|
set->Insert(str1);
|
|
EXPECT_NOTNULL(set->Lookup(str1));
|
|
EXPECT_NULLPTR(set->Lookup(str2));
|
|
EXPECT_NOTNULL(set->Lookup(str3));
|
|
|
|
set->Insert(str2);
|
|
EXPECT_NOTNULL(set->Lookup(str1));
|
|
EXPECT_NOTNULL(set->Lookup(str2));
|
|
EXPECT_NOTNULL(set->Lookup(str3));
|
|
|
|
EXPECT(set->Remove(str3));
|
|
EXPECT_NULLPTR(set->Lookup(str1));
|
|
EXPECT_NOTNULL(set->Lookup(str2));
|
|
EXPECT_NULLPTR(set->Lookup(str3));
|
|
|
|
EXPECT(!set->Remove(str3));
|
|
EXPECT(set->Remove(str2));
|
|
EXPECT(set->IsEmpty());
|
|
}
|
|
|
|
TEST_CASE(CStringIntMap) {
|
|
const char* const kConst1 = "test";
|
|
const char* const kConst2 = "test 2";
|
|
|
|
char* const str1 = OS::SCreate(nullptr, "%s", kConst1);
|
|
char* const str2 = OS::SCreate(nullptr, "%s", kConst2);
|
|
char* const str3 = OS::SCreate(nullptr, "%s", kConst1);
|
|
|
|
// Make sure these strings are pointer-distinct, but C-string-equal.
|
|
EXPECT_NE(str1, str3);
|
|
EXPECT_STREQ(str1, str3);
|
|
|
|
const intptr_t i1 = 1;
|
|
const intptr_t i2 = 2;
|
|
|
|
CStringIntMap map;
|
|
EXPECT(map.IsEmpty());
|
|
|
|
map.Insert({str1, i1});
|
|
EXPECT_NOTNULL(map.Lookup(str1));
|
|
EXPECT_EQ(i1, map.LookupValue(str1));
|
|
EXPECT_NULLPTR(map.Lookup(str2));
|
|
EXPECT_NOTNULL(map.Lookup(str3));
|
|
EXPECT_EQ(i1, map.LookupValue(str3));
|
|
|
|
map.Insert({str2, i2});
|
|
EXPECT_NOTNULL(map.Lookup(str1));
|
|
EXPECT_EQ(i1, map.LookupValue(str1));
|
|
EXPECT_NOTNULL(map.Lookup(str2));
|
|
EXPECT_EQ(i2, map.LookupValue(str2));
|
|
EXPECT_NOTNULL(map.Lookup(str3));
|
|
EXPECT_EQ(i1, map.LookupValue(str3));
|
|
|
|
EXPECT(map.Remove(str3));
|
|
EXPECT_NULLPTR(map.Lookup(str1));
|
|
EXPECT_NOTNULL(map.Lookup(str2));
|
|
EXPECT_EQ(i2, map.LookupValue(str2));
|
|
EXPECT_NULLPTR(map.Lookup(str3));
|
|
|
|
EXPECT(!map.Remove(str3));
|
|
EXPECT(map.Remove(str2));
|
|
EXPECT(map.IsEmpty());
|
|
|
|
free(str3);
|
|
free(str2);
|
|
free(str1);
|
|
}
|
|
|
|
TEST_CASE(CStringIntMapUpdate) {
|
|
const char* const kConst1 = "test";
|
|
const char* const kConst2 = "test 2";
|
|
|
|
char* str1 = OS::SCreate(nullptr, "%s", kConst1);
|
|
char* str2 = OS::SCreate(nullptr, "%s", kConst2);
|
|
char* str3 = OS::SCreate(nullptr, "%s", kConst1);
|
|
char* str4 = OS::SCreate(nullptr, "%s", kConst1); // Only used for lookup.
|
|
|
|
// Make sure these strings are pointer-distinct, but C-string-equal.
|
|
EXPECT_NE(str1, str3);
|
|
EXPECT_NE(str1, str4);
|
|
EXPECT_NE(str3, str4);
|
|
EXPECT_STREQ(str1, str3);
|
|
EXPECT_STREQ(str1, str4);
|
|
|
|
CStringIntMapKeyValueTrait::Pair p1{str1, 1};
|
|
CStringIntMapKeyValueTrait::Pair p2{str2, 2};
|
|
CStringIntMapKeyValueTrait::Pair p3{str3, 3};
|
|
|
|
CStringIntMap map;
|
|
EXPECT(map.IsEmpty());
|
|
|
|
map.Update(p1);
|
|
EXPECT_NOTNULL(map.Lookup(str1));
|
|
EXPECT_EQ(p1.value, map.LookupValue(str1));
|
|
EXPECT_NULLPTR(map.Lookup(str2));
|
|
EXPECT_NOTNULL(map.Lookup(str3));
|
|
EXPECT_EQ(p1.value, map.LookupValue(str3));
|
|
EXPECT_NOTNULL(map.Lookup(str4));
|
|
EXPECT_EQ(p1.value, map.LookupValue(str4));
|
|
|
|
map.Update(p2);
|
|
EXPECT_NOTNULL(map.Lookup(str1));
|
|
EXPECT_EQ(p1.value, map.LookupValue(str1));
|
|
EXPECT_NOTNULL(map.Lookup(str2));
|
|
EXPECT_EQ(p2.value, map.LookupValue(str2));
|
|
EXPECT_NOTNULL(map.Lookup(str3));
|
|
EXPECT_EQ(p1.value, map.LookupValue(str3));
|
|
EXPECT_NOTNULL(map.Lookup(str4));
|
|
EXPECT_EQ(p1.value, map.LookupValue(str4));
|
|
|
|
// Check Lookup after Update.
|
|
map.Update(p3);
|
|
EXPECT_NOTNULL(map.Lookup(str1));
|
|
EXPECT_EQ(p3.value, map.LookupValue(str1));
|
|
EXPECT_NOTNULL(map.Lookup(str2));
|
|
EXPECT_EQ(p2.value, map.LookupValue(str2));
|
|
EXPECT_NOTNULL(map.Lookup(str3));
|
|
EXPECT_EQ(p3.value, map.LookupValue(str3));
|
|
EXPECT_NOTNULL(map.Lookup(str4));
|
|
EXPECT_EQ(p3.value, map.LookupValue(str4));
|
|
|
|
// Check that single Remove after only Updates ensures Lookup fails after.
|
|
EXPECT(map.Remove(str3));
|
|
EXPECT_NULLPTR(map.Lookup(str1));
|
|
EXPECT_NOTNULL(map.Lookup(str2));
|
|
EXPECT_EQ(p2.value, map.LookupValue(str2));
|
|
EXPECT_NULLPTR(map.Lookup(str3));
|
|
EXPECT_NULLPTR(map.Lookup(str4));
|
|
|
|
EXPECT(!map.Remove(str3));
|
|
EXPECT(map.Remove(str2));
|
|
EXPECT(map.IsEmpty());
|
|
|
|
// Quick double-check that these weren't side-effected by the implementation
|
|
// of hash maps (p1 especially).
|
|
EXPECT_EQ(str1, p1.key);
|
|
EXPECT_EQ(1, p1.value);
|
|
EXPECT_EQ(str2, p2.key);
|
|
EXPECT_EQ(2, p2.value);
|
|
EXPECT_EQ(str3, p3.key);
|
|
EXPECT_EQ(3, p3.value);
|
|
|
|
free(str4);
|
|
free(str3);
|
|
free(str2);
|
|
free(str1);
|
|
}
|
|
|
|
} // namespace dart
|