GCC Code Coverage Report
Directory: ./ Exec Total Coverage
File: stream_base-inl.h Lines: 158 165 95.8 %
Date: 2022-08-06 04:16:36 Branches: 46 60 76.7 %

Line Branch Exec Source
1
#ifndef SRC_STREAM_BASE_INL_H_
2
#define SRC_STREAM_BASE_INL_H_
3
4
#if defined(NODE_WANT_INTERNALS) && NODE_WANT_INTERNALS
5
6
#include "async_wrap-inl.h"
7
#include "base_object-inl.h"
8
#include "node.h"
9
#include "stream_base.h"
10
#include "v8.h"
11
12
namespace node {
13
14
15554
StreamReq::StreamReq(
15
    StreamBase* stream,
16
15554
    v8::Local<v8::Object> req_wrap_obj) : stream_(stream) {
17
15554
  AttachToObject(req_wrap_obj);
18
15554
}
19
20
15554
void StreamReq::AttachToObject(v8::Local<v8::Object> req_wrap_obj) {
21
31108
  CHECK_EQ(req_wrap_obj->GetAlignedPointerFromInternalField(
22
               StreamReq::kStreamReqField),
23
           nullptr);
24
15554
  req_wrap_obj->SetAlignedPointerInInternalField(
25
      StreamReq::kStreamReqField, this);
26
15554
}
27
28
7824
StreamReq* StreamReq::FromObject(v8::Local<v8::Object> req_wrap_obj) {
29
  return static_cast<StreamReq*>(
30
7824
      req_wrap_obj->GetAlignedPointerFromInternalField(
31
7824
          StreamReq::kStreamReqField));
32
}
33
34
15531
void StreamReq::Dispose() {
35
31062
  BaseObjectPtr<AsyncWrap> destroy_me{GetAsyncWrap()};
36
31062
  object()->SetAlignedPointerInInternalField(
37
      StreamReq::kStreamReqField, nullptr);
38
15531
  destroy_me->Detach();
39
15531
}
40
41
16381
v8::Local<v8::Object> StreamReq::object() {
42
16381
  return GetAsyncWrap()->object();
43
}
44
45
7484
ShutdownWrap::ShutdownWrap(
46
    StreamBase* stream,
47
7484
    v8::Local<v8::Object> req_wrap_obj)
48
7484
    : StreamReq(stream, req_wrap_obj) { }
49
50
8070
WriteWrap::WriteWrap(
51
    StreamBase* stream,
52
8070
    v8::Local<v8::Object> req_wrap_obj)
53
8070
    : StreamReq(stream, req_wrap_obj) { }
54
55
13233
void StreamListener::PassReadErrorToPreviousListener(ssize_t nread) {
56
13233
  CHECK_NOT_NULL(previous_listener_);
57
13233
  previous_listener_->OnStreamRead(nread, uv_buf_init(nullptr, 0));
58
13233
}
59
60
108449
void StreamResource::PushStreamListener(StreamListener* listener) {
61
108449
  CHECK_NOT_NULL(listener);
62
108449
  CHECK_NULL(listener->stream_);
63
64
108449
  listener->previous_listener_ = listener_;
65
108449
  listener->stream_ = this;
66
67
108449
  listener_ = listener;
68
108449
}
69
70
107812
void StreamResource::RemoveStreamListener(StreamListener* listener) {
71
107812
  CHECK_NOT_NULL(listener);
72
73
  StreamListener* previous;
74
  StreamListener* current;
75
76
  // Remove from the linked list.
77
107812
  for (current = listener_, previous = nullptr;
78
       /* No loop condition because we want a crash if listener is not found */
79
631
       ; previous = current, current = current->previous_listener_) {
80
108443
    CHECK_NOT_NULL(current);
81
108443
    if (current == listener) {
82
107812
      if (previous != nullptr)
83
631
        previous->previous_listener_ = current->previous_listener_;
84
      else
85
107181
        listener_ = listener->previous_listener_;
86
107812
      break;
87
    }
88
631
  }
89
90
107812
  listener->stream_ = nullptr;
91
107812
  listener->previous_listener_ = nullptr;
92
107812
}
93
94
93343
uv_buf_t StreamResource::EmitAlloc(size_t suggested_size) {
95
93343
  DebugSealHandleScope seal_handle_scope;
96
93343
  return listener_->OnStreamAlloc(suggested_size);
97
}
98
99
107705
void StreamResource::EmitRead(ssize_t nread, const uv_buf_t& buf) {
100
107705
  DebugSealHandleScope seal_handle_scope;
101
107705
  if (nread > 0)
102
87576
    bytes_read_ += static_cast<uint64_t>(nread);
103
107705
  listener_->OnStreamRead(nread, buf);
104
107583
}
105
106
7978
void StreamResource::EmitAfterWrite(WriteWrap* w, int status) {
107
7978
  DebugSealHandleScope seal_handle_scope;
108
7978
  listener_->OnStreamAfterWrite(w, status);
109
7977
}
110
111
7478
void StreamResource::EmitAfterShutdown(ShutdownWrap* w, int status) {
112
7478
  DebugSealHandleScope seal_handle_scope;
113
7478
  listener_->OnStreamAfterShutdown(w, status);
114
7478
}
115
116
2727
void StreamResource::EmitWantsWrite(size_t suggested_size) {
117
2727
  DebugSealHandleScope seal_handle_scope;
118
2727
  listener_->OnStreamWantsWrite(suggested_size);
119
2727
}
120
121
67639
StreamBase::StreamBase(Environment* env) : env_(env) {
122
67639
  PushStreamListener(&default_listener_);
123
67639
}
124
125
32331
int StreamBase::Shutdown(v8::Local<v8::Object> req_wrap_obj) {
126
32331
  Environment* env = stream_env();
127
128
64662
  v8::HandleScope handle_scope(env->isolate());
129
130
32331
  if (req_wrap_obj.IsEmpty()) {
131
969
    if (!env->shutdown_wrap_template()
132
969
             ->NewInstance(env->context())
133
969
             .ToLocal(&req_wrap_obj)) {
134
      return UV_EBUSY;
135
    }
136
969
    StreamReq::ResetObject(req_wrap_obj);
137
  }
138
139
64662
  BaseObjectPtr<AsyncWrap> req_wrap_ptr;
140
64662
  AsyncHooks::DefaultTriggerAsyncIdScope trigger_scope(GetAsyncWrap());
141
32331
  ShutdownWrap* req_wrap = CreateShutdownWrap(req_wrap_obj);
142
32331
  if (req_wrap != nullptr)
143
7484
    req_wrap_ptr.reset(req_wrap->GetAsyncWrap());
144
32331
  int err = DoShutdown(req_wrap);
145
146

32331
  if (err != 0 && req_wrap != nullptr) {
147
5
    req_wrap->Dispose();
148
  }
149
150
32331
  const char* msg = Error();
151
32331
  if (msg != nullptr) {
152
    if (req_wrap_obj->Set(env->context(),
153
                          env->error_string(),
154
                          OneByteString(env->isolate(), msg)).IsNothing()) {
155
      return UV_EBUSY;
156
    }
157
    ClearError();
158
  }
159
160
32331
  return err;
161
}
162
163
101610
StreamWriteResult StreamBase::Write(
164
    uv_buf_t* bufs,
165
    size_t count,
166
    uv_stream_t* send_handle,
167
    v8::Local<v8::Object> req_wrap_obj) {
168
101610
  Environment* env = stream_env();
169
  int err;
170
171
101610
  size_t total_bytes = 0;
172
354831
  for (size_t i = 0; i < count; ++i)
173
253221
    total_bytes += bufs[i].len;
174
101610
  bytes_written_ += total_bytes;
175
176
101610
  if (send_handle == nullptr) {
177
101491
    err = DoTryWrite(&bufs, &count);
178

101491
    if (err != 0 || count == 0) {
179
93537
      return StreamWriteResult { false, err, nullptr, total_bytes, {} };
180
    }
181
  }
182
183
16145
  v8::HandleScope handle_scope(env->isolate());
184
185
8073
  if (req_wrap_obj.IsEmpty()) {
186
2510
    if (!env->write_wrap_template()
187
2510
             ->NewInstance(env->context())
188
2510
             .ToLocal(&req_wrap_obj)) {
189
3
      return StreamWriteResult { false, UV_EBUSY, nullptr, 0, {} };
190
    }
191
2507
    StreamReq::ResetObject(req_wrap_obj);
192
  }
193
194
16139
  AsyncHooks::DefaultTriggerAsyncIdScope trigger_scope(GetAsyncWrap());
195
8070
  WriteWrap* req_wrap = CreateWriteWrap(req_wrap_obj);
196
16139
  BaseObjectPtr<AsyncWrap> req_wrap_ptr(req_wrap->GetAsyncWrap());
197
198
8070
  err = DoWrite(req_wrap, bufs, count, send_handle);
199
8069
  bool async = err == 0;
200
201
8069
  if (!async) {
202
71
    req_wrap->Dispose();
203
71
    req_wrap = nullptr;
204
  }
205
206
8069
  const char* msg = Error();
207
8069
  if (msg != nullptr) {
208
8
    if (req_wrap_obj->Set(env->context(),
209
                          env->error_string(),
210
16
                          OneByteString(env->isolate(), msg)).IsNothing()) {
211
      return StreamWriteResult { false, UV_EBUSY, nullptr, 0, {} };
212
    }
213
4
    ClearError();
214
  }
215
216
  return StreamWriteResult {
217
8069
      async, err, req_wrap, total_bytes, std::move(req_wrap_ptr) };
218
}
219
220
template <typename OtherBase>
221
7484
SimpleShutdownWrap<OtherBase>::SimpleShutdownWrap(
222
    StreamBase* stream,
223
    v8::Local<v8::Object> req_wrap_obj)
224
  : ShutdownWrap(stream, req_wrap_obj),
225
    OtherBase(stream->stream_env(),
226
              req_wrap_obj,
227
7484
              AsyncWrap::PROVIDER_SHUTDOWNWRAP) {
228
7484
}
229
230
template <typename OtherBase>
231
8070
SimpleWriteWrap<OtherBase>::SimpleWriteWrap(
232
    StreamBase* stream,
233
    v8::Local<v8::Object> req_wrap_obj)
234
  : WriteWrap(stream, req_wrap_obj),
235
    OtherBase(stream->stream_env(),
236
              req_wrap_obj,
237
8070
              AsyncWrap::PROVIDER_WRITEWRAP) {
238
8070
}
239
240
67639
void StreamBase::AttachToObject(v8::Local<v8::Object> obj) {
241
67639
  obj->SetAlignedPointerInInternalField(
242
      StreamBase::kStreamBaseField, this);
243
67639
}
244
245
275970
StreamBase* StreamBase::FromObject(v8::Local<v8::Object> obj) {
246
551940
  if (obj->GetAlignedPointerFromInternalField(StreamBase::kSlot) == nullptr)
247
1
    return nullptr;
248
249
  return static_cast<StreamBase*>(
250
275969
      obj->GetAlignedPointerFromInternalField(
251
275969
          StreamBase::kStreamBaseField));
252
}
253
254
7054
WriteWrap* WriteWrap::FromObject(v8::Local<v8::Object> req_wrap_obj) {
255
7054
  return static_cast<WriteWrap*>(StreamReq::FromObject(req_wrap_obj));
256
}
257
258
template <typename T, bool kIsWeak>
259
7054
WriteWrap* WriteWrap::FromObject(
260
    const BaseObjectPtrImpl<T, kIsWeak>& base_obj) {
261
7054
  if (!base_obj) return nullptr;
262
7054
  return FromObject(base_obj->object());
263
}
264
265
ShutdownWrap* ShutdownWrap::FromObject(v8::Local<v8::Object> req_wrap_obj) {
266
  return static_cast<ShutdownWrap*>(StreamReq::FromObject(req_wrap_obj));
267
}
268
269
template <typename T, bool kIsWeak>
270
ShutdownWrap* ShutdownWrap::FromObject(
271
    const BaseObjectPtrImpl<T, kIsWeak>& base_obj) {
272
  if (!base_obj) return nullptr;
273
  return FromObject(base_obj->object());
274
}
275
276
3649
void WriteWrap::SetBackingStore(std::unique_ptr<v8::BackingStore> bs) {
277
3649
  CHECK(!backing_store_);
278
3649
  backing_store_ = std::move(bs);
279
3649
}
280
281
15456
void StreamReq::Done(int status, const char* error_str) {
282
15456
  AsyncWrap* async_wrap = GetAsyncWrap();
283
15456
  Environment* env = async_wrap->env();
284
15456
  if (error_str != nullptr) {
285
4
    v8::HandleScope handle_scope(env->isolate());
286
4
    if (async_wrap->object()->Set(
287
            env->context(),
288
            env->error_string(),
289
16
            OneByteString(env->isolate(), error_str)).IsNothing()) {
290
      return;
291
    }
292
  }
293
294
15456
  OnDone(status);
295
}
296
297
123058
void StreamReq::ResetObject(v8::Local<v8::Object> obj) {
298
  DCHECK_GT(obj->InternalFieldCount(), StreamReq::kStreamReqField);
299
300
123058
  obj->SetAlignedPointerInInternalField(StreamReq::kSlot, nullptr);
301
123058
  obj->SetAlignedPointerInInternalField(StreamReq::kStreamReqField, nullptr);
302
123058
}
303
304
}  // namespace node
305
306
#endif  // defined(NODE_WANT_INTERNALS) && NODE_WANT_INTERNALS
307
308
#endif  // SRC_STREAM_BASE_INL_H_