GCC Code Coverage Report
Directory: ./ Exec Total Coverage
File: stream_base-inl.h Lines: 158 165 95.8 %
Date: 2022-05-08 04:15:02 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
19468
StreamReq::StreamReq(
15
    StreamBase* stream,
16
19468
    v8::Local<v8::Object> req_wrap_obj) : stream_(stream) {
17
19468
  AttachToObject(req_wrap_obj);
18
19468
}
19
20
19468
void StreamReq::AttachToObject(v8::Local<v8::Object> req_wrap_obj) {
21
38936
  CHECK_EQ(req_wrap_obj->GetAlignedPointerFromInternalField(
22
               StreamReq::kStreamReqField),
23
           nullptr);
24
19468
  req_wrap_obj->SetAlignedPointerInInternalField(
25
      StreamReq::kStreamReqField, this);
26
19468
}
27
28
8846
StreamReq* StreamReq::FromObject(v8::Local<v8::Object> req_wrap_obj) {
29
  return static_cast<StreamReq*>(
30
8846
      req_wrap_obj->GetAlignedPointerFromInternalField(
31
8846
          StreamReq::kStreamReqField));
32
}
33
34
19443
void StreamReq::Dispose() {
35
38886
  BaseObjectPtr<AsyncWrap> destroy_me{GetAsyncWrap()};
36
38886
  object()->SetAlignedPointerInInternalField(
37
      StreamReq::kStreamReqField, nullptr);
38
19443
  destroy_me->Detach();
39
19443
}
40
41
21342
v8::Local<v8::Object> StreamReq::object() {
42
21342
  return GetAsyncWrap()->object();
43
}
44
45
10016
ShutdownWrap::ShutdownWrap(
46
    StreamBase* stream,
47
10016
    v8::Local<v8::Object> req_wrap_obj)
48
10016
    : StreamReq(stream, req_wrap_obj) { }
49
50
9452
WriteWrap::WriteWrap(
51
    StreamBase* stream,
52
9452
    v8::Local<v8::Object> req_wrap_obj)
53
9452
    : StreamReq(stream, req_wrap_obj) { }
54
55
13020
void StreamListener::PassReadErrorToPreviousListener(ssize_t nread) {
56
13020
  CHECK_NOT_NULL(previous_listener_);
57
13020
  previous_listener_->OnStreamRead(nread, uv_buf_init(nullptr, 0));
58
13020
}
59
60
114408
void StreamResource::PushStreamListener(StreamListener* listener) {
61
114408
  CHECK_NOT_NULL(listener);
62
114408
  CHECK_NULL(listener->stream_);
63
64
114408
  listener->previous_listener_ = listener_;
65
114408
  listener->stream_ = this;
66
67
114408
  listener_ = listener;
68
114408
}
69
70
113835
void StreamResource::RemoveStreamListener(StreamListener* listener) {
71
113835
  CHECK_NOT_NULL(listener);
72
73
  StreamListener* previous;
74
  StreamListener* current;
75
76
  // Remove from the linked list.
77
113835
  for (current = listener_, previous = nullptr;
78
       /* No loop condition because we want a crash if listener is not found */
79
629
       ; previous = current, current = current->previous_listener_) {
80
114464
    CHECK_NOT_NULL(current);
81
114464
    if (current == listener) {
82
113835
      if (previous != nullptr)
83
629
        previous->previous_listener_ = current->previous_listener_;
84
      else
85
113206
        listener_ = listener->previous_listener_;
86
113835
      break;
87
    }
88
629
  }
89
90
113835
  listener->stream_ = nullptr;
91
113835
  listener->previous_listener_ = nullptr;
92
113835
}
93
94
95489
uv_buf_t StreamResource::EmitAlloc(size_t suggested_size) {
95
95489
  DebugSealHandleScope seal_handle_scope;
96
95489
  return listener_->OnStreamAlloc(suggested_size);
97
}
98
99
109838
void StreamResource::EmitRead(ssize_t nread, const uv_buf_t& buf) {
100
109838
  DebugSealHandleScope seal_handle_scope;
101
109838
  if (nread > 0)
102
88794
    bytes_read_ += static_cast<uint64_t>(nread);
103
109838
  listener_->OnStreamRead(nread, buf);
104
109722
}
105
106
9015
void StreamResource::EmitAfterWrite(WriteWrap* w, int status) {
107
9015
  DebugSealHandleScope seal_handle_scope;
108
9015
  listener_->OnStreamAfterWrite(w, status);
109
9014
}
110
111
10009
void StreamResource::EmitAfterShutdown(ShutdownWrap* w, int status) {
112
10009
  DebugSealHandleScope seal_handle_scope;
113
10009
  listener_->OnStreamAfterShutdown(w, status);
114
10009
}
115
116
3066
void StreamResource::EmitWantsWrite(size_t suggested_size) {
117
3066
  DebugSealHandleScope seal_handle_scope;
118
3066
  listener_->OnStreamWantsWrite(suggested_size);
119
3066
}
120
121
70442
StreamBase::StreamBase(Environment* env) : env_(env) {
122
70442
  PushStreamListener(&default_listener_);
123
70442
}
124
125
38034
int StreamBase::Shutdown(v8::Local<v8::Object> req_wrap_obj) {
126
38034
  Environment* env = stream_env();
127
128
76068
  v8::HandleScope handle_scope(env->isolate());
129
130
38034
  if (req_wrap_obj.IsEmpty()) {
131
2540
    if (!env->shutdown_wrap_template()
132
2540
             ->NewInstance(env->context())
133
2540
             .ToLocal(&req_wrap_obj)) {
134
      return UV_EBUSY;
135
    }
136
2540
    StreamReq::ResetObject(req_wrap_obj);
137
  }
138
139
76068
  BaseObjectPtr<AsyncWrap> req_wrap_ptr;
140
76068
  AsyncHooks::DefaultTriggerAsyncIdScope trigger_scope(GetAsyncWrap());
141
38034
  ShutdownWrap* req_wrap = CreateShutdownWrap(req_wrap_obj);
142
38034
  if (req_wrap != nullptr)
143
10016
    req_wrap_ptr.reset(req_wrap->GetAsyncWrap());
144
38034
  int err = DoShutdown(req_wrap);
145
146

38034
  if (err != 0 && req_wrap != nullptr) {
147
5
    req_wrap->Dispose();
148
  }
149
150
38034
  const char* msg = Error();
151
38034
  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
38034
  return err;
161
}
162
163
104177
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
104177
  Environment* env = stream_env();
169
  int err;
170
171
104177
  size_t total_bytes = 0;
172
362102
  for (size_t i = 0; i < count; ++i)
173
257925
    total_bytes += bufs[i].len;
174
104177
  bytes_written_ += total_bytes;
175
176
104177
  if (send_handle == nullptr) {
177
104071
    err = DoTryWrite(&bufs, &count);
178

104071
    if (err != 0 || count == 0) {
179
94720
      return StreamWriteResult { false, err, nullptr, total_bytes, {} };
180
    }
181
  }
182
183
18913
  v8::HandleScope handle_scope(env->isolate());
184
185
9457
  if (req_wrap_obj.IsEmpty()) {
186
3545
    if (!env->write_wrap_template()
187
3545
             ->NewInstance(env->context())
188
3545
             .ToLocal(&req_wrap_obj)) {
189
5
      return StreamWriteResult { false, UV_EBUSY, nullptr, 0, {} };
190
    }
191
3540
    StreamReq::ResetObject(req_wrap_obj);
192
  }
193
194
18903
  AsyncHooks::DefaultTriggerAsyncIdScope trigger_scope(GetAsyncWrap());
195
9452
  WriteWrap* req_wrap = CreateWriteWrap(req_wrap_obj);
196
18903
  BaseObjectPtr<AsyncWrap> req_wrap_ptr(req_wrap->GetAsyncWrap());
197
198
9452
  err = DoWrite(req_wrap, bufs, count, send_handle);
199
9451
  bool async = err == 0;
200
201
9451
  if (!async) {
202
415
    req_wrap->Dispose();
203
415
    req_wrap = nullptr;
204
  }
205
206
9451
  const char* msg = Error();
207
9451
  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
9451
      async, err, req_wrap, total_bytes, std::move(req_wrap_ptr) };
218
}
219
220
template <typename OtherBase>
221
10016
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
10016
              AsyncWrap::PROVIDER_SHUTDOWNWRAP) {
228
10016
}
229
230
template <typename OtherBase>
231
9452
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
9452
              AsyncWrap::PROVIDER_WRITEWRAP) {
238
9452
}
239
240
70442
void StreamBase::AttachToObject(v8::Local<v8::Object> obj) {
241
70442
  obj->SetAlignedPointerInInternalField(
242
      StreamBase::kStreamBaseField, this);
243
70442
}
244
245
283851
StreamBase* StreamBase::FromObject(v8::Local<v8::Object> obj) {
246
567702
  if (obj->GetAlignedPointerFromInternalField(StreamBase::kSlot) == nullptr)
247
1
    return nullptr;
248
249
  return static_cast<StreamBase*>(
250
283850
      obj->GetAlignedPointerFromInternalField(
251
283850
          StreamBase::kStreamBaseField));
252
}
253
254
7373
WriteWrap* WriteWrap::FromObject(v8::Local<v8::Object> req_wrap_obj) {
255
7373
  return static_cast<WriteWrap*>(StreamReq::FromObject(req_wrap_obj));
256
}
257
258
template <typename T, bool kIsWeak>
259
7373
WriteWrap* WriteWrap::FromObject(
260
    const BaseObjectPtrImpl<T, kIsWeak>& base_obj) {
261
7373
  if (!base_obj) return nullptr;
262
7373
  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
3982
void WriteWrap::SetBackingStore(std::unique_ptr<v8::BackingStore> bs) {
277
3982
  CHECK(!backing_store_);
278
3982
  backing_store_ = std::move(bs);
279
3982
}
280
281
19024
void StreamReq::Done(int status, const char* error_str) {
282
19024
  AsyncWrap* async_wrap = GetAsyncWrap();
283
19024
  Environment* env = async_wrap->env();
284
19024
  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
19024
  OnDone(status);
295
}
296
297
130747
void StreamReq::ResetObject(v8::Local<v8::Object> obj) {
298
  DCHECK_GT(obj->InternalFieldCount(), StreamReq::kStreamReqField);
299
300
130747
  obj->SetAlignedPointerInInternalField(StreamReq::kSlot, nullptr);
301
130747
  obj->SetAlignedPointerInInternalField(StreamReq::kStreamReqField, nullptr);
302
130747
}
303
304
}  // namespace node
305
306
#endif  // defined(NODE_WANT_INTERNALS) && NODE_WANT_INTERNALS
307
308
#endif  // SRC_STREAM_BASE_INL_H_