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

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

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