GCC Code Coverage Report
Directory: ../ Exec Total Coverage
File: /home/iojs/build/workspace/node-test-commit-linux-coverage-daily/nodes/benchmark/out/../src/util.h Lines: 126 126 100.0 %
Date: 2020-05-27 22:15:15 Branches: 73 104 70.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_UTIL_H_
23
#define SRC_UTIL_H_
24
25
#if defined(NODE_WANT_INTERNALS) && NODE_WANT_INTERNALS
26
27
#if (__GNUC__ >= 8) && !defined(__clang__)
28
#pragma GCC diagnostic push
29
#pragma GCC diagnostic ignored "-Wcast-function-type"
30
#endif
31
#include "v8.h"
32
#if (__GNUC__ >= 8) && !defined(__clang__)
33
#pragma GCC diagnostic pop
34
#endif
35
36
#include <climits>
37
#include <cstddef>
38
#include <cstdio>
39
#include <cstdlib>
40
#include <cstring>
41
42
#include <functional>  // std::function
43
#include <limits>
44
#include <set>
45
#include <string>
46
#include <array>
47
#include <unordered_map>
48
#include <utility>
49
50
#ifdef __GNUC__
51
#define MUST_USE_RESULT __attribute__((warn_unused_result))
52
#else
53
#define MUST_USE_RESULT
54
#endif
55
56
namespace node {
57
58
// Maybe remove kPathSeparator when cpp17 is ready
59
#ifdef _WIN32
60
    constexpr char kPathSeparator = '\\';
61
/* MAX_PATH is in characters, not bytes. Make sure we have enough headroom. */
62
#define PATH_MAX_BYTES (MAX_PATH * 4)
63
#else
64
    constexpr char kPathSeparator = '/';
65
#define PATH_MAX_BYTES (PATH_MAX)
66
#endif
67
68
// These should be used in our code as opposed to the native
69
// versions as they abstract out some platform and or
70
// compiler version specific functionality
71
// malloc(0) and realloc(ptr, 0) have implementation-defined behavior in
72
// that the standard allows them to either return a unique pointer or a
73
// nullptr for zero-sized allocation requests.  Normalize by always using
74
// a nullptr.
75
template <typename T>
76
inline T* UncheckedRealloc(T* pointer, size_t n);
77
template <typename T>
78
inline T* UncheckedMalloc(size_t n);
79
template <typename T>
80
inline T* UncheckedCalloc(size_t n);
81
82
// Same things, but aborts immediately instead of returning nullptr when
83
// no memory is available.
84
template <typename T>
85
inline T* Realloc(T* pointer, size_t n);
86
template <typename T>
87
inline T* Malloc(size_t n);
88
template <typename T>
89
inline T* Calloc(size_t n);
90
91
inline char* Malloc(size_t n);
92
inline char* Calloc(size_t n);
93
inline char* UncheckedMalloc(size_t n);
94
inline char* UncheckedCalloc(size_t n);
95
96
template <typename T>
97
inline T MultiplyWithOverflowCheck(T a, T b);
98
99
namespace per_process {
100
// Tells whether the per-process V8::Initialize() is called and
101
// if it is safe to call v8::Isolate::GetCurrent().
102
extern bool v8_initialized;
103
}  // namespace per_process
104
105
// Used by the allocation functions when allocation fails.
106
// Thin wrapper around v8::Isolate::LowMemoryNotification() that checks
107
// whether V8 is initialized.
108
void LowMemoryNotification();
109
110
// The reason that Assert() takes a struct argument instead of individual
111
// const char*s is to ease instruction cache pressure in calls from CHECK.
112
struct AssertionInfo {
113
  const char* file_line;  // filename:line
114
  const char* message;
115
  const char* function;
116
};
117
[[noreturn]] void Assert(const AssertionInfo& info);
118
[[noreturn]] void Abort();
119
void DumpBacktrace(FILE* fp);
120
121
// Windows 8+ does not like abort() in Release mode
122
#ifdef _WIN32
123
#define ABORT_NO_BACKTRACE() _exit(134)
124
#else
125
#define ABORT_NO_BACKTRACE() abort()
126
#endif
127
128
#define ABORT() node::Abort()
129
130
#define ERROR_AND_ABORT(expr)                                                 \
131
  do {                                                                        \
132
    /* Make sure that this struct does not end up in inline code, but      */ \
133
    /* rather in a read-only data section when modifying this code.        */ \
134
    static const node::AssertionInfo args = {                                 \
135
      __FILE__ ":" STRINGIFY(__LINE__), #expr, PRETTY_FUNCTION_NAME           \
136
    };                                                                        \
137
    node::Assert(args);                                                       \
138
  } while (0)
139
140
#ifdef __GNUC__
141
#define LIKELY(expr) __builtin_expect(!!(expr), 1)
142
#define UNLIKELY(expr) __builtin_expect(!!(expr), 0)
143
#define PRETTY_FUNCTION_NAME __PRETTY_FUNCTION__
144
#else
145
#define LIKELY(expr) expr
146
#define UNLIKELY(expr) expr
147
#define PRETTY_FUNCTION_NAME ""
148
#endif
149
150
#define STRINGIFY_(x) #x
151
#define STRINGIFY(x) STRINGIFY_(x)
152
153
#define CHECK(expr)                                                           \
154
  do {                                                                        \
155
    if (UNLIKELY(!(expr))) {                                                  \
156
      ERROR_AND_ABORT(expr);                                                  \
157
    }                                                                         \
158
  } while (0)
159
160
#define CHECK_EQ(a, b) CHECK((a) == (b))
161
#define CHECK_GE(a, b) CHECK((a) >= (b))
162
#define CHECK_GT(a, b) CHECK((a) > (b))
163
#define CHECK_LE(a, b) CHECK((a) <= (b))
164
#define CHECK_LT(a, b) CHECK((a) < (b))
165
#define CHECK_NE(a, b) CHECK((a) != (b))
166
#define CHECK_NULL(val) CHECK((val) == nullptr)
167
#define CHECK_NOT_NULL(val) CHECK((val) != nullptr)
168
#define CHECK_IMPLIES(a, b) CHECK(!(a) || (b))
169
170
#ifdef DEBUG
171
  #define DCHECK(expr) CHECK(expr)
172
  #define DCHECK_EQ(a, b) CHECK((a) == (b))
173
  #define DCHECK_GE(a, b) CHECK((a) >= (b))
174
  #define DCHECK_GT(a, b) CHECK((a) > (b))
175
  #define DCHECK_LE(a, b) CHECK((a) <= (b))
176
  #define DCHECK_LT(a, b) CHECK((a) < (b))
177
  #define DCHECK_NE(a, b) CHECK((a) != (b))
178
  #define DCHECK_NULL(val) CHECK((val) == nullptr)
179
  #define DCHECK_NOT_NULL(val) CHECK((val) != nullptr)
180
  #define DCHECK_IMPLIES(a, b) CHECK(!(a) || (b))
181
#else
182
  #define DCHECK(expr)
183
  #define DCHECK_EQ(a, b)
184
  #define DCHECK_GE(a, b)
185
  #define DCHECK_GT(a, b)
186
  #define DCHECK_LE(a, b)
187
  #define DCHECK_LT(a, b)
188
  #define DCHECK_NE(a, b)
189
  #define DCHECK_NULL(val)
190
  #define DCHECK_NOT_NULL(val)
191
  #define DCHECK_IMPLIES(a, b)
192
#endif
193
194
195
#define UNREACHABLE(...)                                                      \
196
  ERROR_AND_ABORT("Unreachable code reached" __VA_OPT__(": ") __VA_ARGS__)
197
198
// ECMA262 20.1.2.6 Number.MAX_SAFE_INTEGER (2^53-1)
199
constexpr int64_t kMaxSafeJsInteger = 9007199254740991;
200
201
inline bool IsSafeJsInt(v8::Local<v8::Value> v);
202
203
// TAILQ-style intrusive list node.
204
template <typename T>
205
class ListNode;
206
207
// TAILQ-style intrusive list head.
208
template <typename T, ListNode<T> (T::*M)>
209
class ListHead;
210
211
template <typename T>
212
class ListNode {
213
 public:
214
  inline ListNode();
215
  inline ~ListNode();
216
  inline void Remove();
217
  inline bool IsEmpty() const;
218
219
  ListNode(const ListNode&) = delete;
220
  ListNode& operator=(const ListNode&) = delete;
221
222
 private:
223
  template <typename U, ListNode<U> (U::*M)> friend class ListHead;
224
  friend int GenDebugSymbols();
225
  ListNode* prev_;
226
  ListNode* next_;
227
};
228
229
template <typename T, ListNode<T> (T::*M)>
230
class ListHead {
231
 public:
232
  class Iterator {
233
   public:
234
    inline T* operator*() const;
235
    inline const Iterator& operator++();
236
    inline bool operator!=(const Iterator& that) const;
237
238
   private:
239
    friend class ListHead;
240
    inline explicit Iterator(ListNode<T>* node);
241
    ListNode<T>* node_;
242
  };
243
244
9189
  inline ListHead() = default;
245
  inline ~ListHead();
246
  inline void PushBack(T* element);
247
  inline void PushFront(T* element);
248
  inline bool IsEmpty() const;
249
  inline T* PopFront();
250
  inline Iterator begin() const;
251
  inline Iterator end() const;
252
253
  ListHead(const ListHead&) = delete;
254
  ListHead& operator=(const ListHead&) = delete;
255
256
 private:
257
  friend int GenDebugSymbols();
258
  ListNode<T> head_;
259
};
260
261
// The helper is for doing safe downcasts from base types to derived types.
262
template <typename Inner, typename Outer>
263
class ContainerOfHelper {
264
 public:
265
  inline ContainerOfHelper(Inner Outer::*field, Inner* pointer);
266
  template <typename TypeName>
267
  inline operator TypeName*() const;
268
 private:
269
  Outer* const pointer_;
270
};
271
272
// Calculate the address of the outer (i.e. embedding) struct from
273
// the interior pointer to a data member.
274
template <typename Inner, typename Outer>
275
constexpr ContainerOfHelper<Inner, Outer> ContainerOf(Inner Outer::*field,
276
                                                      Inner* pointer);
277
278
// Convenience wrapper around v8::String::NewFromOneByte().
279
inline v8::Local<v8::String> OneByteString(v8::Isolate* isolate,
280
                                           const char* data,
281
                                           int length = -1);
282
283
// For the people that compile with -funsigned-char.
284
inline v8::Local<v8::String> OneByteString(v8::Isolate* isolate,
285
                                           const signed char* data,
286
                                           int length = -1);
287
288
inline v8::Local<v8::String> OneByteString(v8::Isolate* isolate,
289
                                           const unsigned char* data,
290
                                           int length = -1);
291
292
// Used to be a macro, hence the uppercase name.
293
template <int N>
294
3797150
inline v8::Local<v8::String> FIXED_ONE_BYTE_STRING(
295
    v8::Isolate* isolate,
296
    const char(&data)[N]) {
297
3797150
  return OneByteString(isolate, data, N - 1);
298
}
299
300
template <std::size_t N>
301
570
inline v8::Local<v8::String> FIXED_ONE_BYTE_STRING(
302
    v8::Isolate* isolate,
303
    const std::array<char, N>& arr) {
304
570
  return OneByteString(isolate, arr.data(), N - 1);
305
}
306
307
308
309
// Swaps bytes in place. nbytes is the number of bytes to swap and must be a
310
// multiple of the word size (checked by function).
311
inline void SwapBytes16(char* data, size_t nbytes);
312
inline void SwapBytes32(char* data, size_t nbytes);
313
inline void SwapBytes64(char* data, size_t nbytes);
314
315
// tolower() is locale-sensitive.  Use ToLower() instead.
316
inline char ToLower(char c);
317
inline std::string ToLower(const std::string& in);
318
319
// toupper() is locale-sensitive.  Use ToUpper() instead.
320
inline char ToUpper(char c);
321
inline std::string ToUpper(const std::string& in);
322
323
// strcasecmp() is locale-sensitive.  Use StringEqualNoCase() instead.
324
inline bool StringEqualNoCase(const char* a, const char* b);
325
326
// strncasecmp() is locale-sensitive.  Use StringEqualNoCaseN() instead.
327
inline bool StringEqualNoCaseN(const char* a, const char* b, size_t length);
328
329
// Allocates an array of member type T. For up to kStackStorageSize items,
330
// the stack is used, otherwise malloc().
331
template <typename T, size_t kStackStorageSize = 1024>
332
class MaybeStackBuffer {
333
 public:
334
828
  const T* out() const {
335
828
    return buf_;
336
  }
337
338
4726451
  T* out() {
339
4726451
    return buf_;
340
  }
341
342
  // operator* for compatibility with `v8::String::(Utf8)Value`
343
4702891
  T* operator*() {
344
4702891
    return buf_;
345
  }
346
347
371106
  const T* operator*() const {
348
371106
    return buf_;
349
  }
350
351
3250325
  T& operator[](size_t index) {
352

3250325
    CHECK_LT(index, length());
353
3250325
    return buf_[index];
354
  }
355
356
10605
  const T& operator[](size_t index) const {
357
10605
    CHECK_LT(index, length());
358
10605
    return buf_[index];
359
  }
360
361
4604215
  size_t length() const {
362
4604215
    return length_;
363
  }
364
365
  // Current maximum capacity of the buffer with which SetLength() can be used
366
  // without first calling AllocateSufficientStorage().
367
12434646
  size_t capacity() const {
368

24517676
    return IsAllocated() ? capacity_ :
369

24517708
                           IsInvalidated() ? 0 : kStackStorageSize;
370
  }
371
372
  // Make sure enough space for `storage` entries is available.
373
  // This method can be called multiple times throughout the lifetime of the
374
  // buffer, but once this has been called Invalidate() cannot be used.
375
  // Content of the buffer in the range [0, length()) is preserved.
376
4426097
  void AllocateSufficientStorage(size_t storage) {
377

4426097
    CHECK(!IsInvalidated());
378

4426102
    if (storage > capacity()) {
379
344131
      bool was_allocated = IsAllocated();
380

344131
      T* allocated_ptr = was_allocated ? buf_ : nullptr;
381
344131
      buf_ = Realloc(allocated_ptr, storage);
382
344131
      capacity_ = storage;
383



344131
      if (!was_allocated && length_ > 0)
384
2
        memcpy(buf_, buf_st_, length_ * sizeof(buf_[0]));
385
    }
386
387
4426108
    length_ = storage;
388
4426108
  }
389
390
4309904
  void SetLength(size_t length) {
391
    // capacity() returns how much memory is actually available.
392

4309904
    CHECK_LE(length, capacity());
393
4309909
    length_ = length;
394
4309909
  }
395
396
3686042
  void SetLengthAndZeroTerminate(size_t length) {
397
    // capacity() returns how much memory is actually available.
398

3686042
    CHECK_LE(length + 1, capacity());
399
3686060
    SetLength(length);
400
401
    // T() is 0 for integer types, nullptr for pointers, etc.
402
3686059
    buf_[length] = T();
403
3686059
  }
404
405
  // Make derefencing this object return nullptr.
406
  // This method can be called multiple times throughout the lifetime of the
407
  // buffer, but once this has been called AllocateSufficientStorage() cannot
408
  // be used.
409
2
  void Invalidate() {
410
2
    CHECK(!IsAllocated());
411
2
    length_ = 0;
412
2
    buf_ = nullptr;
413
2
  }
414
415
  // If the buffer is stored in the heap rather than on the stack.
416
17812789
  bool IsAllocated() const {
417



17812789
    return !IsInvalidated() && buf_ != buf_st_;
418
  }
419
420
  // If Invalidate() has been called.
421
34329357
  bool IsInvalidated() const {
422
34329357
    return buf_ == nullptr;
423
  }
424
425
  // Release ownership of the malloc'd buffer.
426
  // Note: This does not free the buffer.
427
67
  void Release() {
428

67
    CHECK(IsAllocated());
429
67
    buf_ = buf_st_;
430
67
    length_ = 0;
431
67
    capacity_ = 0;
432
67
  }
433
434

82997222
  MaybeStackBuffer() : length_(0), capacity_(0), buf_(buf_st_) {
435
    // Default to a zero-length, null-terminated buffer.
436
5380437
    buf_[0] = T();
437
5018748
  }
438
439
291806
  explicit MaybeStackBuffer(size_t storage) : MaybeStackBuffer() {
440
291807
    AllocateSufficientStorage(storage);
441
291806
  }
442
443
5018767
  ~MaybeStackBuffer() {
444

5018767
    if (IsAllocated())
445
344061
      free(buf_);
446
5018770
  }
447
448
 private:
449
  size_t length_;
450
  // capacity of the malloc'ed buf_
451
  size_t capacity_;
452
  T* buf_;
453
  T buf_st_[kStackStorageSize];
454
};
455
456
// Provides access to an ArrayBufferView's storage, either the original,
457
// or for small data, a copy of it. This object's lifetime is bound to the
458
// original ArrayBufferView's lifetime.
459
template <typename T, size_t kStackStorageSize = 64>
460
class ArrayBufferViewContents {
461
 public:
462
1846
  ArrayBufferViewContents() = default;
463
464
  explicit inline ArrayBufferViewContents(v8::Local<v8::Value> value);
465
  explicit inline ArrayBufferViewContents(v8::Local<v8::Object> value);
466
  explicit inline ArrayBufferViewContents(v8::Local<v8::ArrayBufferView> abv);
467
  inline void Read(v8::Local<v8::ArrayBufferView> abv);
468
469
563341
  inline const T* data() const { return data_; }
470
2232412
  inline size_t length() const { return length_; }
471
472
 private:
473
  T stack_storage_[kStackStorageSize];
474
  T* data_ = nullptr;
475
  size_t length_ = 0;
476
};
477
478
3514392
class Utf8Value : public MaybeStackBuffer<char> {
479
 public:
480
  explicit Utf8Value(v8::Isolate* isolate, v8::Local<v8::Value> value);
481
482
828
  inline std::string ToString() const { return std::string(out(), length()); }
483
};
484
485
2222
class TwoByteValue : public MaybeStackBuffer<uint16_t> {
486
 public:
487
  explicit TwoByteValue(v8::Isolate* isolate, v8::Local<v8::Value> value);
488
};
489
490
169200
class BufferValue : public MaybeStackBuffer<char> {
491
 public:
492
  explicit BufferValue(v8::Isolate* isolate, v8::Local<v8::Value> value);
493
494
  inline std::string ToString() const { return std::string(out(), length()); }
495
};
496
497
#define SPREAD_BUFFER_ARG(val, name)                                          \
498
  CHECK((val)->IsArrayBufferView());                                          \
499
  v8::Local<v8::ArrayBufferView> name = (val).As<v8::ArrayBufferView>();      \
500
  std::shared_ptr<v8::BackingStore> name##_bs =                               \
501
      name->Buffer()->GetBackingStore();                                      \
502
  const size_t name##_offset = name->ByteOffset();                            \
503
  const size_t name##_length = name->ByteLength();                            \
504
  char* const name##_data =                                                   \
505
      static_cast<char*>(name##_bs->Data()) + name##_offset;                  \
506
  if (name##_length > 0)                                                      \
507
    CHECK_NE(name##_data, nullptr);
508
509
// Use this when a variable or parameter is unused in order to explicitly
510
// silence a compiler warning about that.
511
3952784
template <typename T> inline void USE(T&&) {}
512
513
template <typename Fn>
514
struct OnScopeLeaveImpl {
515
  Fn fn_;
516
  bool active_;
517
518
668994
  explicit OnScopeLeaveImpl(Fn&& fn) : fn_(std::move(fn)), active_(true) {}
519

668874
  ~OnScopeLeaveImpl() { if (active_) fn_(); }
520
521
  OnScopeLeaveImpl(const OnScopeLeaveImpl& other) = delete;
522
  OnScopeLeaveImpl& operator=(const OnScopeLeaveImpl& other) = delete;
523
  OnScopeLeaveImpl(OnScopeLeaveImpl&& other)
524
    : fn_(std::move(other.fn_)), active_(other.active_) {
525
    other.active_ = false;
526
  }
527
  OnScopeLeaveImpl& operator=(OnScopeLeaveImpl&& other) {
528
    if (this == &other) return *this;
529
    this->~OnScopeLeave();
530
    new (this)OnScopeLeaveImpl(std::move(other));
531
    return *this;
532
  }
533
};
534
535
// Run a function when exiting the current scope. Used like this:
536
// auto on_scope_leave = OnScopeLeave([&] {
537
//   // ... run some code ...
538
// });
539
template <typename Fn>
540
668998
inline MUST_USE_RESULT OnScopeLeaveImpl<Fn> OnScopeLeave(Fn&& fn) {
541
668998
  return OnScopeLeaveImpl<Fn>{std::move(fn)};
542
}
543
544
// Simple RAII wrapper for contiguous data that uses malloc()/free().
545
template <typename T>
546
struct MallocedBuffer {
547
  T* data;
548
  size_t size;
549
550
  T* release() {
551
    T* ret = data;
552
    data = nullptr;
553
    return ret;
554
  }
555
556
  void Truncate(size_t new_size) {
557
    CHECK(new_size <= size);
558
    size = new_size;
559
  }
560
561
42549
  inline bool is_empty() const { return data == nullptr; }
562
563
180701
  MallocedBuffer() : data(nullptr), size(0) {}
564
4
  explicit MallocedBuffer(size_t size) : data(Malloc<T>(size)), size(size) {}
565
42553
  MallocedBuffer(T* data, size_t size) : data(data), size(size) {}
566
384037
  MallocedBuffer(MallocedBuffer&& other) : data(other.data), size(other.size) {
567
384037
    other.data = nullptr;
568
384037
  }
569
95232
  MallocedBuffer& operator=(MallocedBuffer&& other) {
570
95232
    this->~MallocedBuffer();
571
95277
    return *new(this) MallocedBuffer(std::move(other));
572
  }
573
606836
  ~MallocedBuffer() {
574
606836
    free(data);
575
606836
  }
576
  MallocedBuffer(const MallocedBuffer&) = delete;
577
  MallocedBuffer& operator=(const MallocedBuffer&) = delete;
578
};
579
580
template <typename T>
581
1344
class NonCopyableMaybe {
582
 public:
583
1
  NonCopyableMaybe() : empty_(true) {}
584
1343
  explicit NonCopyableMaybe(T&& value)
585
      : empty_(false),
586
1343
        value_(std::move(value)) {}
587
588
1344
  bool IsEmpty() const {
589
1344
    return empty_;
590
  }
591
592
1343
  T&& Release() {
593
1343
    CHECK_EQ(empty_, false);
594
1343
    empty_ = true;
595
1343
    return std::move(value_);
596
  }
597
598
 private:
599
  bool empty_;
600
  T value_;
601
};
602
603
// Test whether some value can be called with ().
604
template <typename T, typename = void>
605
struct is_callable : std::is_function<T> { };
606
607
template <typename T>
608
struct is_callable<T, typename std::enable_if<
609
    std::is_same<decltype(void(&T::operator())), void>::value
610
    >::type> : std::true_type { };
611
612
template <typename T, void (*function)(T*)>
613
struct FunctionDeleter {
614
405914
  void operator()(T* pointer) const { function(pointer); }
615
  typedef std::unique_ptr<T, FunctionDeleter> Pointer;
616
};
617
618
template <typename T, void (*function)(T*)>
619
using DeleteFnPtr = typename FunctionDeleter<T, function>::Pointer;
620
621
std::vector<std::string> SplitString(const std::string& in, char delim);
622
623
inline v8::MaybeLocal<v8::Value> ToV8Value(v8::Local<v8::Context> context,
624
                                           const std::string& str,
625
                                           v8::Isolate* isolate = nullptr);
626
template <typename T, typename test_for_number =
627
    typename std::enable_if<std::numeric_limits<T>::is_specialized, bool>::type>
628
inline v8::MaybeLocal<v8::Value> ToV8Value(v8::Local<v8::Context> context,
629
                                           const T& number,
630
                                           v8::Isolate* isolate = nullptr);
631
template <typename T>
632
inline v8::MaybeLocal<v8::Value> ToV8Value(v8::Local<v8::Context> context,
633
                                           const std::vector<T>& vec,
634
                                           v8::Isolate* isolate = nullptr);
635
template <typename T, typename U>
636
inline v8::MaybeLocal<v8::Value> ToV8Value(v8::Local<v8::Context> context,
637
                                           const std::unordered_map<T, U>& map,
638
                                           v8::Isolate* isolate = nullptr);
639
640
// These macros expects a `Isolate* isolate` and a `Local<Context> context`
641
// to be in the scope.
642
#define READONLY_PROPERTY(obj, name, value)                                    \
643
  do {                                                                         \
644
    obj->DefineOwnProperty(                                                    \
645
           context, FIXED_ONE_BYTE_STRING(isolate, name), value, v8::ReadOnly) \
646
        .Check();                                                              \
647
  } while (0)
648
649
#define READONLY_DONT_ENUM_PROPERTY(obj, name, var)                            \
650
  do {                                                                         \
651
    obj->DefineOwnProperty(                                                    \
652
           context,                                                            \
653
           OneByteString(isolate, name),                                       \
654
           var,                                                                \
655
           static_cast<v8::PropertyAttribute>(v8::ReadOnly | v8::DontEnum))    \
656
        .Check();                                                              \
657
  } while (0)
658
659
#define READONLY_FALSE_PROPERTY(obj, name)                                     \
660
  READONLY_PROPERTY(obj, name, v8::False(isolate))
661
662
#define READONLY_TRUE_PROPERTY(obj, name)                                      \
663
  READONLY_PROPERTY(obj, name, v8::True(isolate))
664
665
#define READONLY_STRING_PROPERTY(obj, name, str)                               \
666
  READONLY_PROPERTY(obj, name, ToV8Value(context, str).ToLocalChecked())
667
668
// Variation on NODE_DEFINE_CONSTANT that sets a String value.
669
#define NODE_DEFINE_STRING_CONSTANT(target, name, constant)                    \
670
  do {                                                                         \
671
    v8::Isolate* isolate = target->GetIsolate();                               \
672
    v8::Local<v8::String> constant_name =                                      \
673
        v8::String::NewFromUtf8(isolate, name, v8::NewStringType::kNormal)     \
674
            .ToLocalChecked();                                                 \
675
    v8::Local<v8::String> constant_value =                                     \
676
        v8::String::NewFromUtf8(isolate, constant, v8::NewStringType::kNormal) \
677
            .ToLocalChecked();                                                 \
678
    v8::PropertyAttribute constant_attributes =                                \
679
        static_cast<v8::PropertyAttribute>(v8::ReadOnly | v8::DontDelete);     \
680
    target                                                                     \
681
        ->DefineOwnProperty(isolate->GetCurrentContext(),                      \
682
                            constant_name,                                     \
683
                            constant_value,                                    \
684
                            constant_attributes)                               \
685
        .Check();                                                              \
686
  } while (0)
687
688
enum Endianness {
689
  kLittleEndian,  // _Not_ LITTLE_ENDIAN, clashes with endian.h.
690
  kBigEndian
691
};
692
693
19322
inline enum Endianness GetEndianness() {
694
  // Constant-folded by the compiler.
695
  const union {
696
    uint8_t u8[2];
697
    uint16_t u16;
698
19322
  } u = {{1, 0}};
699
19322
  return u.u16 == 1 ? kLittleEndian : kBigEndian;
700
}
701
702
1
inline bool IsLittleEndian() {
703
1
  return GetEndianness() == kLittleEndian;
704
}
705
706
19321
inline bool IsBigEndian() {
707
19321
  return GetEndianness() == kBigEndian;
708
}
709
710
template <typename T, size_t N>
711
1757132
constexpr size_t arraysize(const T (&)[N]) {
712
1757132
  return N;
713
}
714
715
// Round up a to the next highest multiple of b.
716
template <typename T>
717
118883
constexpr T RoundUp(T a, T b) {
718
118883
  return a % b != 0 ? a + b - (a % b) : a;
719
}
720
721
40399
class SlicedArguments : public MaybeStackBuffer<v8::Local<v8::Value>> {
722
 public:
723
  inline explicit SlicedArguments(
724
      const v8::FunctionCallbackInfo<v8::Value>& args, size_t start = 0);
725
};
726
727
// Convert a v8::PersistentBase, e.g. v8::Global, to a Local, with an extra
728
// optimization for strong persistent handles.
729
class PersistentToLocal {
730
 public:
731
  // If persistent.IsWeak() == false, then do not call persistent.Reset()
732
  // while the returned Local<T> is still in scope, it will destroy the
733
  // reference to the object.
734
  template <class TypeName>
735
5438347
  static inline v8::Local<TypeName> Default(
736
      v8::Isolate* isolate,
737
      const v8::PersistentBase<TypeName>& persistent) {
738

5438347
    if (persistent.IsWeak()) {
739
3079458
      return PersistentToLocal::Weak(isolate, persistent);
740
    } else {
741
2358889
      return PersistentToLocal::Strong(persistent);
742
    }
743
  }
744
745
  // Unchecked conversion from a non-weak Persistent<T> to Local<T>,
746
  // use with care!
747
  //
748
  // Do not call persistent.Reset() while the returned Local<T> is still in
749
  // scope, it will destroy the reference to the object.
750
  template <class TypeName>
751
19048734
  static inline v8::Local<TypeName> Strong(
752
      const v8::PersistentBase<TypeName>& persistent) {
753
    return *reinterpret_cast<v8::Local<TypeName>*>(
754
19048734
        const_cast<v8::PersistentBase<TypeName>*>(&persistent));
755
  }
756
757
  template <class TypeName>
758
3079458
  static inline v8::Local<TypeName> Weak(
759
      v8::Isolate* isolate,
760
      const v8::PersistentBase<TypeName>& persistent) {
761
3079458
    return v8::Local<TypeName>::New(isolate, persistent);
762
  }
763
};
764
765
// Can be used as a key for std::unordered_map when lookup performance is more
766
// important than size and the keys are statically used to avoid redundant hash
767
// computations.
768
class FastStringKey {
769
 public:
770
  constexpr explicit FastStringKey(const char* name);
771
772
4594
  struct Hash {
773
    constexpr size_t operator()(const FastStringKey& key) const;
774
  };
775
  constexpr bool operator==(const FastStringKey& other) const;
776
777
  constexpr const char* c_str() const;
778
779
 private:
780
  static constexpr size_t HashImpl(const char* str);
781
782
  const char* name_;
783
  size_t cached_hash_;
784
};
785
786
}  // namespace node
787
788
#endif  // defined(NODE_WANT_INTERNALS) && NODE_WANT_INTERNALS
789
790
#endif  // SRC_UTIL_H_