Head

GCC Code Coverage Report

Directory:	./		Exec	Total	Coverage
File:	base_object-inl.h	Lines:	123	124	99.2 %
Date:	2022-12-31 04:22:30	Branches:	35	44	79.5 %


// Copyright Joyent, Inc. and other Node contributors.
//
// Permission is hereby granted, free of charge, to any person obtaining a
// copy of this software and associated documentation files (the
// "Software"), to deal in the Software without restriction, including
// without limitation the rights to use, copy, modify, merge, publish,
// distribute, sublicense, and/or sell copies of the Software, and to permit
// persons to whom the Software is furnished to do so, subject to the
// following conditions:
//
// The above copyright notice and this permission notice shall be included
// in all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
// OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
// MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN
// NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
// DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
// OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
// USE OR OTHER DEALINGS IN THE SOFTWARE.

#ifndef SRC_BASE_OBJECT_INL_H_
#define SRC_BASE_OBJECT_INL_H_

#if defined(NODE_WANT_INTERNALS) && NODE_WANT_INTERNALS

#include "base_object.h"
#include "env-inl.h"
#include "util.h"

#include "v8.h"

namespace node {

BaseObject::BaseObject(Environment* env, v8::Local<v8::Object> object)
    : BaseObject(env->principal_realm(), object) {}

// static
v8::Local<v8::FunctionTemplate> BaseObject::GetConstructorTemplate(
    Environment* env) {
  return BaseObject::GetConstructorTemplate(env->isolate_data());
}

void BaseObject::Detach() {
  CHECK_GT(pointer_data()->strong_ptr_count, 0);
  pointer_data()->is_detached = true;
}

v8::Global<v8::Object>& BaseObject::persistent() {
  return persistent_handle_;
}


v8::Local<v8::Object> BaseObject::object() const {
  return PersistentToLocal::Default(env()->isolate(), persistent_handle_);
}

v8::Local<v8::Object> BaseObject::object(v8::Isolate* isolate) const {
  v8::Local<v8::Object> handle = object();

  DCHECK_EQ(handle->GetCreationContext().ToLocalChecked()->GetIsolate(),
            isolate);
  DCHECK_EQ(env()->isolate(), isolate);

  return handle;
}

Environment* BaseObject::env() const {
  return realm_->env();
}

Realm* BaseObject::realm() const {
  return realm_;
}

void BaseObject::TagNodeObject(v8::Local<v8::Object> object) {
  DCHECK_GE(object->InternalFieldCount(), BaseObject::kInternalFieldCount);
  object->SetAlignedPointerInInternalField(BaseObject::kEmbedderType,
                                           &kNodeEmbedderId);
}

void BaseObject::SetInternalFields(v8::Local<v8::Object> object, void* slot) {
  TagNodeObject(object);
  object->SetAlignedPointerInInternalField(BaseObject::kSlot, slot);
}

BaseObject* BaseObject::FromJSObject(v8::Local<v8::Value> value) {
  v8::Local<v8::Object> obj = value.As<v8::Object>();
  DCHECK_GE(obj->InternalFieldCount(), BaseObject::kInternalFieldCount);
  return static_cast<BaseObject*>(
      obj->GetAlignedPointerFromInternalField(BaseObject::kSlot));
}

template <typename T>
T* BaseObject::FromJSObject(v8::Local<v8::Value> object) {
  return static_cast<T*>(FromJSObject(object));
}

void BaseObject::OnGCCollect() {
  delete this;
}

void BaseObject::ClearWeak() {
  if (has_pointer_data())
    pointer_data()->wants_weak_jsobj = false;

  persistent_handle_.ClearWeak();
}

bool BaseObject::IsWeakOrDetached() const {
  if (persistent_handle_.IsWeak()) return true;

  if (!has_pointer_data()) return false;
  const PointerData* pd = const_cast<BaseObject*>(this)->pointer_data();
  return pd->wants_weak_jsobj || pd->is_detached;
}

v8::EmbedderGraph::Node::Detachedness BaseObject::GetDetachedness() const {
  return IsWeakOrDetached() ? v8::EmbedderGraph::Node::Detachedness::kDetached
                            : v8::EmbedderGraph::Node::Detachedness::kUnknown;
}

template <int Field>
void BaseObject::InternalFieldGet(
    v8::Local<v8::String> property,
    const v8::PropertyCallbackInfo<v8::Value>& info) {
  info.GetReturnValue().Set(info.This()->GetInternalField(Field));
}

template <int Field, bool (v8::Value::* typecheck)() const>
void BaseObject::InternalFieldSet(v8::Local<v8::String> property,
                                  v8::Local<v8::Value> value,
                                  const v8::PropertyCallbackInfo<void>& info) {
  // This could be e.g. value->IsFunction().
  CHECK(((*value)->*typecheck)());
  info.This()->SetInternalField(Field, value);
}

bool BaseObject::has_pointer_data() const {
  return pointer_data_ != nullptr;
}

template <typename T, bool kIsWeak>
BaseObject::PointerData*
BaseObjectPtrImpl<T, kIsWeak>::pointer_data() const {
  if constexpr (kIsWeak) {
    return data_.pointer_data;
  }
  if (get_base_object() == nullptr) {
    return nullptr;
  }
  return get_base_object()->pointer_data();
}

template <typename T, bool kIsWeak>
BaseObject* BaseObjectPtrImpl<T, kIsWeak>::get_base_object() const {
  if constexpr (kIsWeak) {
    if (pointer_data() == nullptr) {
      return nullptr;
    }
    return pointer_data()->self;
  }
  return data_.target;
}

template <typename T, bool kIsWeak>
BaseObjectPtrImpl<T, kIsWeak>::~BaseObjectPtrImpl() {
  if constexpr (kIsWeak) {
    if (pointer_data() != nullptr &&
        --pointer_data()->weak_ptr_count == 0 &&
        pointer_data()->self == nullptr) {
      delete pointer_data();
    }
  } else if (get() != nullptr) {
    get()->decrease_refcount();
  }
}

template <typename T, bool kIsWeak>
BaseObjectPtrImpl<T, kIsWeak>::BaseObjectPtrImpl() {
  data_.target = nullptr;
}

template <typename T, bool kIsWeak>
BaseObjectPtrImpl<T, kIsWeak>::BaseObjectPtrImpl(T* target)
  : BaseObjectPtrImpl() {
  if (target == nullptr) return;
  if constexpr (kIsWeak) {
    data_.pointer_data = target->pointer_data();
    CHECK_NOT_NULL(pointer_data());
    pointer_data()->weak_ptr_count++;
  } else {
    data_.target = target;
    CHECK_NOT_NULL(pointer_data());
    get()->increase_refcount();
  }
}

template <typename T, bool kIsWeak>
template <typename U, bool kW>
BaseObjectPtrImpl<T, kIsWeak>::BaseObjectPtrImpl(
    const BaseObjectPtrImpl<U, kW>& other)
  : BaseObjectPtrImpl(other.get()) {}

template <typename T, bool kIsWeak>
BaseObjectPtrImpl<T, kIsWeak>::BaseObjectPtrImpl(const BaseObjectPtrImpl& other)
  : BaseObjectPtrImpl(other.get()) {}

template <typename T, bool kIsWeak>
template <typename U, bool kW>
BaseObjectPtrImpl<T, kIsWeak>& BaseObjectPtrImpl<T, kIsWeak>::operator=(
    const BaseObjectPtrImpl<U, kW>& other) {
  if (other.get() == get()) return *this;
  this->~BaseObjectPtrImpl();
  return *new (this) BaseObjectPtrImpl(other);
}

template <typename T, bool kIsWeak>
BaseObjectPtrImpl<T, kIsWeak>& BaseObjectPtrImpl<T, kIsWeak>::operator=(
    const BaseObjectPtrImpl& other) {
  if (other.get() == get()) return *this;
  this->~BaseObjectPtrImpl();
  return *new (this) BaseObjectPtrImpl(other);
}

template <typename T, bool kIsWeak>
BaseObjectPtrImpl<T, kIsWeak>::BaseObjectPtrImpl(BaseObjectPtrImpl&& other)
  : data_(other.data_) {
  if constexpr (kIsWeak)
    other.data_.target = nullptr;
  else
    other.data_.pointer_data = nullptr;
}

template <typename T, bool kIsWeak>
BaseObjectPtrImpl<T, kIsWeak>& BaseObjectPtrImpl<T, kIsWeak>::operator=(
    BaseObjectPtrImpl&& other) {
  if (&other == this) return *this;
  this->~BaseObjectPtrImpl();
  return *new (this) BaseObjectPtrImpl(std::move(other));
}

template <typename T, bool kIsWeak>
void BaseObjectPtrImpl<T, kIsWeak>::reset(T* ptr) {
  *this = BaseObjectPtrImpl(ptr);
}

template <typename T, bool kIsWeak>
T* BaseObjectPtrImpl<T, kIsWeak>::get() const {
  return static_cast<T*>(get_base_object());
}

template <typename T, bool kIsWeak>
T& BaseObjectPtrImpl<T, kIsWeak>::operator*() const {
  return *get();
}

template <typename T, bool kIsWeak>
T* BaseObjectPtrImpl<T, kIsWeak>::operator->() const {
  return get();
}

template <typename T, bool kIsWeak>
BaseObjectPtrImpl<T, kIsWeak>::operator bool() const {
  return get() != nullptr;
}

template <typename T, bool kIsWeak>
template <typename U, bool kW>
bool BaseObjectPtrImpl<T, kIsWeak>::operator ==(
    const BaseObjectPtrImpl<U, kW>& other) const {
  return get() == other.get();
}

template <typename T, bool kIsWeak>
template <typename U, bool kW>
bool BaseObjectPtrImpl<T, kIsWeak>::operator !=(
    const BaseObjectPtrImpl<U, kW>& other) const {
  return get() != other.get();
}

template <typename T, typename... Args>
BaseObjectPtr<T> MakeBaseObject(Args&&... args) {
  return BaseObjectPtr<T>(new T(std::forward<Args>(args)...));
}

template <typename T, typename... Args>
BaseObjectPtr<T> MakeDetachedBaseObject(Args&&... args) {
  BaseObjectPtr<T> target = MakeBaseObject<T>(std::forward<Args>(args)...);
  target->Detach();
  return target;
}

}  // namespace node

#endif  // defined(NODE_WANT_INTERNALS) && NODE_WANT_INTERNALS

#endif  // SRC_BASE_OBJECT_INL_H_


Generated by: GCOVR (Version 4.2)

Line	Branch	Exec	Source
1			// Copyright Joyent, Inc. and other Node contributors.
2			//
3			// Permission is hereby granted, free of charge, to any person obtaining a
4			// copy of this software and associated documentation files (the
5			// "Software"), to deal in the Software without restriction, including
6			// without limitation the rights to use, copy, modify, merge, publish,
7			// distribute, sublicense, and/or sell copies of the Software, and to permit
8			// persons to whom the Software is furnished to do so, subject to the
9			// following conditions:
10			//
11			// The above copyright notice and this permission notice shall be included
12			// in all copies or substantial portions of the Software.
13			//
14			// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
15			// OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
16			// MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN
17			// NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
18			// DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
19			// OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
20			// USE OR OTHER DEALINGS IN THE SOFTWARE.
21
22			#ifndef SRC_BASE_OBJECT_INL_H_
23			#define SRC_BASE_OBJECT_INL_H_
24
25			#if defined(NODE_WANT_INTERNALS) && NODE_WANT_INTERNALS
26
27			#include "base_object.h"
28			#include "env-inl.h"
29			#include "util.h"
30
31			#include "v8.h"
32
33			namespace node {
34
35		1409602	BaseObject::BaseObject(Environment* env, v8::Local<v8::Object> object)
36		1409602	: BaseObject(env->principal_realm(), object) {}
37
38			// static
39		63281	v8::Local<v8::FunctionTemplate> BaseObject::GetConstructorTemplate(
40			Environment* env) {
41		63281	return BaseObject::GetConstructorTemplate(env->isolate_data());
42			}
43
44		256524	void BaseObject::Detach() {
45	✗✓	256524	CHECK_GT(pointer_data()->strong_ptr_count, 0);
46		256524	pointer_data()->is_detached = true;
47		256524	}
48
49		393208	v8::Global<v8::Object>& BaseObject::persistent() {
50		393208	return persistent_handle_;
51			}
52
53
54		2521789	v8::Local<v8::Object> BaseObject::object() const {
55		2521789	return PersistentToLocal::Default(env()->isolate(), persistent_handle_);
56			}
57
58		141411	v8::Local<v8::Object> BaseObject::object(v8::Isolate* isolate) const {
59		141411	v8::Local<v8::Object> handle = object();
60
61			DCHECK_EQ(handle->GetCreationContext().ToLocalChecked()->GetIsolate(),
62			isolate);
63			DCHECK_EQ(env()->isolate(), isolate);
64
65		141411	return handle;
66			}
67
68		16156411	Environment* BaseObject::env() const {
69		16156411	return realm_->env();
70			}
71
72		3146265	Realm* BaseObject::realm() const {
73		3146265	return realm_;
74			}
75
76		1433418	void BaseObject::TagNodeObject(v8::Local<v8::Object> object) {
77			DCHECK_GE(object->InternalFieldCount(), BaseObject::kInternalFieldCount);
78		1433418	object->SetAlignedPointerInInternalField(BaseObject::kEmbedderType,
79			&kNodeEmbedderId);
80		1433418	}
81
82		1433418	void BaseObject::SetInternalFields(v8::Local<v8::Object> object, void* slot) {
83		1433418	TagNodeObject(object);
84		1433418	object->SetAlignedPointerInInternalField(BaseObject::kSlot, slot);
85		1433418	}
86
87		9690314	BaseObject* BaseObject::FromJSObject(v8::Local<v8::Value> value) {
88		9690314	v8::Local<v8::Object> obj = value.As<v8::Object>();
89			DCHECK_GE(obj->InternalFieldCount(), BaseObject::kInternalFieldCount);
90			return static_cast<BaseObject*>(
91		19380628	obj->GetAlignedPointerFromInternalField(BaseObject::kSlot));
92			}
93
94			template <typename T>
95		383691	T* BaseObject::FromJSObject(v8::Local<v8::Value> object) {
96		383691	return static_cast<T*>(FromJSObject(object));
97			}
98
99		1235646	void BaseObject::OnGCCollect() {
100	✓✗	1235646	delete this;
101		1235646	}
102
103		81970	void BaseObject::ClearWeak() {
104	✓✓	81970	if (has_pointer_data())
105		8206	pointer_data()->wants_weak_jsobj = false;
106
107		81970	persistent_handle_.ClearWeak();
108		81970	}
109
110		885	bool BaseObject::IsWeakOrDetached() const {
111	✓✓	1770	if (persistent_handle_.IsWeak()) return true;
112
113	✓✓	692	if (!has_pointer_data()) return false;
114		161	const PointerData* pd = const_cast<BaseObject*>(this)->pointer_data();
115	✓✓✓✓	161	return pd->wants_weak_jsobj \|\| pd->is_detached;
116			}
117
118		885	v8::EmbedderGraph::Node::Detachedness BaseObject::GetDetachedness() const {
119	✓✓	885	return IsWeakOrDetached() ? v8::EmbedderGraph::Node::Detachedness::kDetached
120		885	: v8::EmbedderGraph::Node::Detachedness::kUnknown;
121			}
122
123			template <int Field>
124		8	void BaseObject::InternalFieldGet(
125			v8::Local<v8::String> property,
126			const v8::PropertyCallbackInfo<v8::Value>& info) {
127		8	info.GetReturnValue().Set(info.This()->GetInternalField(Field));
128		8	}
129
130			template <int Field, bool (v8::Value::* typecheck)() const>
131		100576	void BaseObject::InternalFieldSet(v8::Local<v8::String> property,
132			v8::Local<v8::Value> value,
133			const v8::PropertyCallbackInfo<void>& info) {
134			// This could be e.g. value->IsFunction().
135	✗✓	100576	CHECK(((value)->typecheck)());
136		100576	info.This()->SetInternalField(Field, value);
137		100576	}
138
139		11549982	bool BaseObject::has_pointer_data() const {
140		11549982	return pointer_data_ != nullptr;
141			}
142
143			template <typename T, bool kIsWeak>
144			BaseObject::PointerData*
145		3933006	BaseObjectPtrImpl<T, kIsWeak>::pointer_data() const {
146			if constexpr (kIsWeak) {
147		2308804	return data_.pointer_data;
148			}
149	✗✓	1624202	if (get_base_object() == nullptr) {
150			return nullptr;
151			}
152		1624202	return get_base_object()->pointer_data();
153			}
154
155			template <typename T, bool kIsWeak>
156		18728352	BaseObject* BaseObjectPtrImpl<T, kIsWeak>::get_base_object() const {
157			if constexpr (kIsWeak) {
158	✓✓	1041946	if (pointer_data() == nullptr) {
159		8	return nullptr;
160			}
161		1041938	return pointer_data()->self;
162			}
163		17686406	return data_.target;
164			}
165
166			template <typename T, bool kIsWeak>
167		3776123	BaseObjectPtrImpl<T, kIsWeak>::~BaseObjectPtrImpl() {
168			if constexpr (kIsWeak) {
169		50246	if (pointer_data() != nullptr &&
170	✓✓✓✓ ✓✓	74174	--pointer_data()->weak_ptr_count == 0 &&
171	✓✓	23928	pointer_data()->self == nullptr) {
172		6	delete pointer_data();
173			}
174	✓✓	3725877	} else if (get() != nullptr) {
175		1545036	get()->decrease_refcount();
176			}
177		3776123	}
178
179			template <typename T, bool kIsWeak>
180		2978020	BaseObjectPtrImpl<T, kIsWeak>::BaseObjectPtrImpl() {
181		2978020	data_.target = nullptr;
182		2978020	}
183
184			template <typename T, bool kIsWeak>
185		2346030	BaseObjectPtrImpl<T, kIsWeak>::BaseObjectPtrImpl(T* target)
186		2346030	: BaseObjectPtrImpl() {
187	✓✓	2346030	if (target == nullptr) return;
188			if constexpr (kIsWeak) {
189		50252	data_.pointer_data = target->pointer_data();
190	✗✓	50252	CHECK_NOT_NULL(pointer_data());
191		50252	pointer_data()->weak_ptr_count++;
192			} else {
193		1624202	data_.target = target;
194	✗✓	1624202	CHECK_NOT_NULL(pointer_data());
195		1624202	get()->increase_refcount();
196			}
197			}
198
199			template <typename T, bool kIsWeak>
200			template <typename U, bool kW>
201		38940	BaseObjectPtrImpl<T, kIsWeak>::BaseObjectPtrImpl(
202			const BaseObjectPtrImpl<U, kW>& other)
203		38940	: BaseObjectPtrImpl(other.get()) {}
204
205			template <typename T, bool kIsWeak>
206		881865	BaseObjectPtrImpl<T, kIsWeak>::BaseObjectPtrImpl(const BaseObjectPtrImpl& other)
207		881865	: BaseObjectPtrImpl(other.get()) {}
208
209			template <typename T, bool kIsWeak>
210			template <typename U, bool kW>
211		8	BaseObjectPtrImpl<T, kIsWeak>& BaseObjectPtrImpl<T, kIsWeak>::operator=(
212			const BaseObjectPtrImpl<U, kW>& other) {
213	✗✓	8	if (other.get() == get()) return *this;
214		8	this->~BaseObjectPtrImpl();
215		8	return *new (this) BaseObjectPtrImpl(other);
216			}
217
218			template <typename T, bool kIsWeak>
219		2	BaseObjectPtrImpl<T, kIsWeak>& BaseObjectPtrImpl<T, kIsWeak>::operator=(
220			const BaseObjectPtrImpl& other) {
221	✗✓	2	if (other.get() == get()) return *this;
222		2	this->~BaseObjectPtrImpl();
223		2	return *new (this) BaseObjectPtrImpl(other);
224			}
225
226			template <typename T, bool kIsWeak>
227		888865	BaseObjectPtrImpl<T, kIsWeak>::BaseObjectPtrImpl(BaseObjectPtrImpl&& other)
228		888865	: data_(other.data_) {
229			if constexpr (kIsWeak)
230		4	other.data_.target = nullptr;
231			else
232		888861	other.data_.pointer_data = nullptr;
233		888865	}
234
235			template <typename T, bool kIsWeak>
236		430924	BaseObjectPtrImpl<T, kIsWeak>& BaseObjectPtrImpl<T, kIsWeak>::operator=(
237			BaseObjectPtrImpl&& other) {
238	✗✓	430924	if (&other == this) return *this;
239		430924	this->~BaseObjectPtrImpl();
240		430924	return *new (this) BaseObjectPtrImpl(std::move(other));
241			}
242
243			template <typename T, bool kIsWeak>
244		262067	void BaseObjectPtrImpl<T, kIsWeak>::reset(T* ptr) {
245		262067	*this = BaseObjectPtrImpl(ptr);
246		262067	}
247
248			template <typename T, bool kIsWeak>
249		15658166	T* BaseObjectPtrImpl<T, kIsWeak>::get() const {
250		15658166	return static_cast<T*>(get_base_object());
251			}
252
253			template <typename T, bool kIsWeak>
254			T& BaseObjectPtrImpl<T, kIsWeak>::operator*() const {
255			return *get();
256			}
257
258			template <typename T, bool kIsWeak>
259		4894759	T* BaseObjectPtrImpl<T, kIsWeak>::operator->() const {
260		4894759	return get();
261			}
262
263			template <typename T, bool kIsWeak>
264		1275674	BaseObjectPtrImpl<T, kIsWeak>::operator bool() const {
265		1275674	return get() != nullptr;
266			}
267
268			template <typename T, bool kIsWeak>
269			template <typename U, bool kW>
270		11200	bool BaseObjectPtrImpl<T, kIsWeak>::operator ==(
271			const BaseObjectPtrImpl<U, kW>& other) const {
272		11200	return get() == other.get();
273			}
274
275			template <typename T, bool kIsWeak>
276			template <typename U, bool kW>
277			bool BaseObjectPtrImpl<T, kIsWeak>::operator !=(
278			const BaseObjectPtrImpl<U, kW>& other) const {
279			return get() != other.get();
280			}
281
282			template <typename T, typename... Args>
283		37730	BaseObjectPtr<T> MakeBaseObject(Args&&... args) {
284		37730	return BaseObjectPtr<T>(new T(std::forward<Args>(args)...));
285			}
286
287			template <typename T, typename... Args>
288		22362	BaseObjectPtr<T> MakeDetachedBaseObject(Args&&... args) {
289		22362	BaseObjectPtr<T> target = MakeBaseObject<T>(std::forward<Args>(args)...);
290		22362	target->Detach();
291		22362	return target;
292			}
293
294			} // namespace node
295
296			#endif // defined(NODE_WANT_INTERNALS) && NODE_WANT_INTERNALS
297
298			#endif // SRC_BASE_OBJECT_INL_H_