WebKit/Source/JavaScriptCore/API/JSContextRef.cpp at main · WebKit/WebKit · GitHub

History

524 lines (436 loc) · 14.7 KB

Raw

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

229

230

231

232

233

234

235

236

237

238

239

240

241

242

243

244

245

246

247

248

249

250

251

252

253

254

255

256

257

258

259

260

261

262

263

264

265

266

267

268

269

270

271

272

273

274

275

276

277

278

279

280

281

282

283

284

285

286

287

288

289

290

291

292

293

294

295

296

297

298

299

300

301

302

303

304

305

306

307

308

309

310

311

312

313

314

315

316

317

318

319

320

321

322

323

324

325

326

327

328

329

330

331

332

333

334

335

336

337

338

339

340

341

342

343

344

345

346

347

348

349

350

351

352

353

354

355

356

357

358

359

360

361

362

363

364

365

366

367

368

369

370

371

372

373

374

375

376

377

378

379

380

381

382

383

384

385

386

387

388

389

390

391

392

393

394

395

396

397

398

399

400

401

402

403

404

405

406

407

408

409

410

411

412

413

414

415

416

417

418

419

420

421

422

423

424

425

426

427

428

429

430

431

432

433

434

435

436

437

438

439

440

441

442

443

444

445

446

447

448

449

450

451

452

453

454

455

456

457

458

459

460

461

462

463

464

465

466

467

468

469

470

471

472

473

474

475

476

477

478

479

480

481

482

483

484

485

486

487

488

489

490

491

492

493

494

495

496

497

498

499

500

501

502

503

504

505

506

507

508

509

510

511

512

513

514

515

516

517

518

519

520

521

522

523

* Redistribution and use in source and binary forms, with or without

* modification, are permitted provided that the following conditions

* are met:

* 1. Redistributions of source code must retain the above copyright

* notice, this list of conditions and the following disclaimer.

* 2. Redistributions in binary form must reproduce the above copyright

* notice, this list of conditions and the following disclaimer in the

* documentation and/or other materials provided with the distribution.

* THIS SOFTWARE IS PROVIDED BY APPLE INC. ``AS IS'' AND ANY

* EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE

* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR

* PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR

* CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,

* EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,

* PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR

* PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY

* OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT

* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE

* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

#include "config.h"

#include "JSContextRef.h"

#include "JSContextRefInternal.h"

#include "APICast.h"

#include "CallFrame.h"

#include "InitializeThreading.h"

#include "IntegrityInlines.h"

#include "JSAPIGlobalObject.h"

#include "JSAPIWrapperObject.h"

#include "JSCJSValueInlines.h"

#include "JSCallbackObject.h"

#include "JSClassRef.h"

#include "JSObjectInlines.h"

#include "StackVisitor.h"

#include "StrongInlines.h"

#include "Watchdog.h"

#include <wtf/text/StringBuilder.h>

#if ENABLE(REMOTE_INSPECTOR)

#include "JSGlobalObjectDebuggable.h"

#include "JSGlobalObjectInspectorController.h"

#include "JSRemoteInspector.h"

#endif

#if ENABLE(INSPECTOR_ALTERNATE_DISPATCHERS)

#include "JSContextRefInspectorSupport.h"

#endif

#if OS(DARWIN)

#include <mach-o/dyld.h>

static constexpr int32_t webkitFirstVersionWithConcurrentGlobalContexts = 0x2100500; // 528.5.0

#endif

using namespace JSC;

// From the API's perspective, a context group remains alive iff

// (a) it has been JSContextGroupRetained

// OR

// (b) one of its contexts has been JSContextRetained

JSContextGroupRef JSContextGroupCreate()

{

JSC::initialize();

return toRef(&VM::createContextGroup().leakRef());

}

JSContextGroupRef JSContextGroupRetain(JSContextGroupRef group)

{

toJS(group)->refSuppressingSaferCPPChecking();

return group;

}

void JSContextGroupRelease(JSContextGroupRef group)

{

VM& vm = *toJS(group);

JSLockHolder locker(&vm);

vm.derefSuppressingSaferCPPChecking();

}

static bool internalScriptTimeoutCallback(JSGlobalObject* globalObject, void* callbackPtr, void* callbackData)

{

JSShouldTerminateCallback callback = reinterpret_cast<JSShouldTerminateCallback>(callbackPtr);

JSContextRef contextRef = toRef(globalObject);

ASSERT(callback);

return callback(contextRef, callbackData);

}

void JSContextGroupSetExecutionTimeLimit(JSContextGroupRef group, double limit, JSShouldTerminateCallback callback, void* callbackData)

{

VM& vm = *toJS(group);

JSLockHolder locker(&vm);

Ref watchdog = vm.ensureWatchdog();

if (callback) {

void* callbackPtr = reinterpret_cast<void*>(callback);

watchdog->setTimeLimit(Seconds { limit }, internalScriptTimeoutCallback, callbackPtr, callbackData);

} else

watchdog->setTimeLimit(Seconds { limit });

}

void JSContextGroupClearExecutionTimeLimit(JSContextGroupRef group)

{

VM& vm = *toJS(group);

JSLockHolder locker(&vm);

if (RefPtr watchdog = vm.watchdog())

watchdog->setTimeLimit(Watchdog::noTimeLimit);

}

// From the API's perspective, a global context remains alive iff it has been JSGlobalContextRetained.

JSGlobalContextRef JSGlobalContextCreate(JSClassRef globalObjectClass)

{

JSC::initialize();

#if OS(DARWIN)

// If the application was linked before JSGlobalContextCreate was changed to use a unique VM,

// we use a shared one for backwards compatibility.

static VM* s_sharedVM;

static std::once_flag once;

std::call_once(once, [] {

if (NSVersionOfLinkTimeLibrary("JavaScriptCore") <= webkitFirstVersionWithConcurrentGlobalContexts)

s_sharedVM = &VM::createContextGroup().leakRef();

});

if (s_sharedVM) [[unlikely]]

return JSGlobalContextCreateInGroup(toRef(s_sharedVM), globalObjectClass);

#endif // OS(DARWIN)

return JSGlobalContextCreateInGroup(nullptr, globalObjectClass);

}

JSGlobalContextRef JSGlobalContextCreateInGroup(JSContextGroupRef group, JSClassRef globalObjectClass)

{

JSC::initialize();

Ref<VM> vm = group ? Ref<VM>(*toJS(group)) : VM::createContextGroup();

JSLockHolder locker(vm.ptr());

if (!globalObjectClass) {

JSGlobalObject* globalObject = JSAPIGlobalObject::create(vm.get(), JSAPIGlobalObject::createStructure(vm.get(), jsNull()));

#if ENABLE(REMOTE_INSPECTOR)

globalObject->setInspectable(JSRemoteInspectorGetInspectionEnabledByDefault());

#endif

return JSGlobalContextRetain(toGlobalRef(globalObject));

}

JSGlobalObject* globalObject = JSCallbackObject<JSGlobalObject>::create(vm.get(), globalObjectClass, JSCallbackObject<JSGlobalObject>::createStructure(vm.get(), nullptr, jsNull()));

JSValue prototype = globalObjectClass->prototype(globalObject);

if (!prototype)

prototype = jsNull();

globalObject->resetPrototype(vm.get(), prototype);

#if ENABLE(REMOTE_INSPECTOR)

globalObject->setInspectable(JSRemoteInspectorGetInspectionEnabledByDefault());

#endif

return JSGlobalContextRetain(toGlobalRef(globalObject));

}

JSGlobalContextRef JSGlobalContextRetain(JSGlobalContextRef ctx)

{

JSGlobalObject* globalObject = toJS(ctx);

VM& vm = globalObject->vm();

JSLockHolder locker(vm);

gcProtect(globalObject);

vm.refSuppressingSaferCPPChecking();

return ctx;

}

void JSGlobalContextRelease(JSGlobalContextRef ctx)

{

JSGlobalObject* globalObject = toJS(ctx);

VM& vm = globalObject->vm();

JSLockHolder locker(vm);

bool protectCountIsZero = vm.heap.unprotect(globalObject);

if (protectCountIsZero)

vm.heap.reportAbandonedObjectGraph();

vm.derefSuppressingSaferCPPChecking();

}

JSObjectRef JSContextGetGlobalObject(JSContextRef ctx)

{

if (!ctx) {

ASSERT_NOT_REACHED();

return nullptr;

}

JSGlobalObject* globalObject = toJS(ctx);

VM& vm = globalObject->vm();

JSLockHolder locker(vm);

return toRef(uncheckedDowncast<JSObject>(JSValue(globalObject).toThis(globalObject, ECMAMode::sloppy())));

}

JSContextGroupRef JSContextGetGroup(JSContextRef ctx)

{

if (!ctx) {

ASSERT_NOT_REACHED();

return nullptr;

}

JSGlobalObject* globalObject = toJS(ctx);

return toRef(&globalObject->vm());

}

JSGlobalContextRef JSContextGetGlobalContext(JSContextRef ctx)

{

if (!ctx) {

ASSERT_NOT_REACHED();

return nullptr;

}

JSGlobalObject* globalObject = toJS(ctx);

JSLockHolder locker(globalObject);

return toGlobalRef(globalObject);

}

JSStringRef JSGlobalContextCopyName(JSGlobalContextRef ctx)

{

if (!ctx) {

ASSERT_NOT_REACHED();

return nullptr;

}

JSGlobalObject* globalObject = toJS(ctx);

VM& vm = globalObject->vm();

JSLockHolder locker(vm);

String name = globalObject->name();

if (name.isNull())

return nullptr;

return OpaqueJSString::tryCreate(name).leakRef();

}

void JSGlobalContextSetName(JSGlobalContextRef ctx, JSStringRef name)

{

if (!ctx) {

ASSERT_NOT_REACHED();

return;

}

JSGlobalObject* globalObject = toJS(ctx);

VM& vm = globalObject->vm();

JSLockHolder locker(vm);

globalObject->setName(name ? name->string() : String());

}

bool JSGlobalContextIsInspectable(JSGlobalContextRef ctx)

{

if (!ctx) {

ASSERT_NOT_REACHED();

return false;

}

JSGlobalObject* globalObject = toJS(ctx);

VM& vm = globalObject->vm();

JSLockHolder lock(vm);

return globalObject->inspectable();

}

void JSGlobalContextSetInspectable(JSGlobalContextRef ctx, bool inspectable)

{

if (!ctx) {

ASSERT_NOT_REACHED();

return;

}

JSGlobalObject* globalObject = toJS(ctx);

VM& vm = globalObject->vm();

JSLockHolder lock(vm);

globalObject->setInspectable(inspectable);

}

void JSGlobalContextSetUnhandledRejectionCallback(JSGlobalContextRef ctx, JSObjectRef function, JSValueRef* exception)

{

if (!ctx) {

ASSERT_NOT_REACHED();

return;

}

JSGlobalObject* globalObject = toJS(ctx);

VM& vm = globalObject->vm();

JSLockHolder locker(vm);

JSObject* object = toJS(function);

if (!object->isCallable()) {

*exception = toRef(createTypeError(globalObject));

return;

}

globalObject->setUnhandledRejectionCallback(vm, object);

}

void JSGlobalContextSetEvalEnabled(JSGlobalContextRef ctx, bool enabled, JSStringRef message)

{

if (!ctx) {

ASSERT_NOT_REACHED();

return;

}

JSGlobalObject* globalObject = toJS(ctx);

VM& vm = globalObject->vm();

JSLockHolder locker(vm);

globalObject->setEvalEnabled(enabled, message ? message->string() : String());

}

class BacktraceFunctor {

public:

BacktraceFunctor(StringBuilder& builder, unsigned remainingCapacityForFrameCapture)

: m_builder(builder)

, m_remainingCapacityForFrameCapture(remainingCapacityForFrameCapture)

{

}

IterationStatus operator()(StackVisitor& visitor) const

{

if (m_remainingCapacityForFrameCapture) {

// If callee is unknown, but we've not added any frame yet, we should

// still add the frame, because something called us, and gave us arguments.

if (visitor->callee().isCell()) {

JSCell* callee = visitor->callee().asCell();

if (!callee && visitor->index())

return IterationStatus::Done;

}

StringBuilder& builder = m_builder;

if (!builder.isEmpty())

builder.append('\n');

builder.append('#', visitor->index(), ' ', visitor->functionName(), "() at "_s, visitor->sourceURL());

if (visitor->hasLineAndColumnInfo()) {

auto lineColumn = visitor->computeLineAndColumn();

builder.append(':', lineColumn.line);

}

if (!visitor->callee().rawPtr())

return IterationStatus::Done;

m_remainingCapacityForFrameCapture--;

return IterationStatus::Continue;

}

return IterationStatus::Done;

}

private:

StringBuilder& m_builder;

mutable unsigned m_remainingCapacityForFrameCapture;

};

JSStringRef JSContextCreateBacktrace(JSContextRef ctx, unsigned maxStackSize)

{

if (!ctx) {

ASSERT_NOT_REACHED();

return nullptr;

}

JSGlobalObject* globalObject = toJS(ctx);

VM& vm = globalObject->vm();

JSLockHolder lock(vm);

StringBuilder builder;

CallFrame* frame = vm.topCallFrame;

ASSERT(maxStackSize);

BacktraceFunctor functor(builder, maxStackSize);

StackVisitor::visit(frame, vm, functor);

return OpaqueJSString::tryCreate(builder.toString()).leakRef();

}

bool JSGlobalContextGetRemoteInspectionEnabled(JSGlobalContextRef ctx)

{

return JSGlobalContextIsInspectable(ctx);

}

void JSGlobalContextSetRemoteInspectionEnabled(JSGlobalContextRef ctx, bool enabled)

{

JSGlobalContextSetInspectable(ctx, enabled);

}

bool JSGlobalContextGetIncludesNativeCallStackWhenReportingExceptions(JSGlobalContextRef ctx)

{

#if ENABLE(REMOTE_INSPECTOR)

if (!ctx) {

ASSERT_NOT_REACHED();

return false;

}

JSGlobalObject* globalObject = toJS(ctx);

VM& vm = globalObject->vm();

JSLockHolder lock(vm);

return globalObject->inspectorController().includesNativeCallStackWhenReportingExceptions();

#else

UNUSED_PARAM(ctx);

return false;

#endif

}

void JSGlobalContextSetIncludesNativeCallStackWhenReportingExceptions(JSGlobalContextRef ctx, bool includesNativeCallStack)

{

#if ENABLE(REMOTE_INSPECTOR)

if (!ctx) {

ASSERT_NOT_REACHED();

return;

}

JSGlobalObject* globalObject = toJS(ctx);

VM& vm = globalObject->vm();

JSLockHolder lock(vm);

globalObject->inspectorController().setIncludesNativeCallStackWhenReportingExceptions(includesNativeCallStack);

#else

UNUSED_PARAM(ctx);

UNUSED_PARAM(includesNativeCallStack);

#endif

}

#if USE(CF)

CFRunLoopRef JSGlobalContextGetDebuggerRunLoop(JSGlobalContextRef ctx)

{

#if ENABLE(REMOTE_INSPECTOR)

if (!ctx) {

ASSERT_NOT_REACHED();

return nullptr;

}

JSGlobalObject* globalObject = toJS(ctx);

VM& vm = globalObject->vm();

JSLockHolder lock(vm);

return globalObject->inspectorDebuggable().targetRunLoop();

#else

UNUSED_PARAM(ctx);

return nullptr;

#endif

}

void JSGlobalContextSetDebuggerRunLoop(JSGlobalContextRef ctx, CFRunLoopRef runLoop)

{

#if ENABLE(REMOTE_INSPECTOR)

if (!ctx) {

ASSERT_NOT_REACHED();

return;

}

JSGlobalObject* globalObject = toJS(ctx);

VM& vm = globalObject->vm();

JSLockHolder lock(vm);

protect(globalObject->inspectorDebuggable())->setTargetRunLoop(runLoop);

#else

UNUSED_PARAM(ctx);

UNUSED_PARAM(runLoop);

#endif

}

#endif // USE(CF)

#if ENABLE(INSPECTOR_ALTERNATE_DISPATCHERS)

Inspector::AugmentableInspectorController* JSGlobalContextGetAugmentableInspectorController(JSGlobalContextRef ctx)

{

if (!ctx) {

ASSERT_NOT_REACHED();

return nullptr;

}

JSGlobalObject* globalObject = toJS(ctx);

VM& vm = globalObject->vm();

JSLockHolder lock(vm);

return &globalObject->inspectorController();

}

#endif

bool JSContextGroupEnableSamplingProfiler(JSContextGroupRef group)

{

VM& vm = *toJS(group);

JSLockHolder locker(&vm);

#if ENABLE(SAMPLING_PROFILER)

vm.enableSamplingProfiler();

return true;

#else

return false;

#endif

}

void JSContextGroupDisableSamplingProfiler(JSContextGroupRef group)

{

VM& vm = *toJS(group);

JSLockHolder locker(&vm);

#if ENABLE(SAMPLING_PROFILER)

vm.disableSamplingProfiler();

#endif

}

JSStringRef JSContextGroupTakeSamplesFromSamplingProfiler(JSContextGroupRef group)

{

VM& vm = *toJS(group);

JSLockHolder locker(&vm);

#if ENABLE(SAMPLING_PROFILER)

auto json = vm.takeSamplingProfilerSamplesAsJSON();

if (!json) [[unlikely]]

return nullptr;

auto jsonData = json->toJSONString();

if (jsonData.isNull()) [[unlikely]]

return nullptr;

return OpaqueJSString::tryCreate(WTF::move(jsonData)).leakRef();

#else

return nullptr;

#endif

}

WebKit/Source/JavaScriptCore/API/JSContextRef.cpp at main · WebKit/WebKit · GitHub

Uh oh!

Expand file tree

Breadcrumbs

JSContextRef.cpp

Latest commit

History

Breadcrumbs

JSContextRef.cpp

File metadata and controls