1566057 - Use BytecodeLocation and BytecodeIterator in `Detecting` function

Status: RESOLVED FIXED

(Core :: JavaScript Engine, enhancement, P3)

Description

[Matthew Gaudet (he/him) [:mgaudet]]

+++ This bug was initially created as a clone of Bug #1538557 +++

Background

Historically access to bytecode in SpiderMonkey has been fairly freeform and common. This means that common idioms are repeated without encapsulation, and it's difficult to audit the codebase for patterns which makes changes around bytecode much more fragile than we'd like.

We'd like to encapsulate manipulation of bytecode within the engine to a set of accessor classes where possible.

This Bug

By using the BytecodeLocation and BytecodeIterator, we'd like to replace uses of jsbytecode* and pcOffset inside Detecting.

This bug is only for changing the implementation of this function: It's OK that when values escape this function the return to jsbytecode* and pcOffsets. We can't change everything at once!

Note: It is expected that you may have to expand the interface of BytecodeLocation or BytecodeIterator. The interfaces as they exist now are driven by clients, and are comparatively thin.

Prior Art

• In Bug 1499544, Part 2 used these interfaces to modify JSScript::assertValidJumpTargets. You can use that patch as inspiration for what we're looking for.

Prerequisites

Before getting started, you'll want to

• You Have a checkout of the Firefox source code
• Make sure you can build SpiderMonkey
• Read this walkthrough about how development works in Firefox

Getting Help

Feel free to leave comments on this bug for questions, or, if you have more synchronous questions about this bug, feel free to drop into #jsapi on irc.mozilla.org.

Tips:

• Not sure if the code you've been editing is getting run? Insert a call to MOZ_CRASH, a macro which will crash when executed, and run the entire test suite with an optimized build (for speed). If you see crashes, you can then use a debug build to make sure it's crashing in your code!

Comment 1

[chirag]

I have started to work in this bug.

Comment 2

[Will Hawkins]

Attachment: Bug 1566057: Convert Detecting function to use bytecode iterator.

Comment 3

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/717694871f97
Convert Detecting function to use bytecode iterator. r=tcampbell

Comment 4

[Stefan Hindli [:stefan_hindli]]

Backed out changeset 717694871f97 (Bug 1566057) for causing spidermonkey bustages CLOSED TREE

https://treeherder.mozilla.org/#/jobs?repo=autoland&resultStatus=testfailed%2Cbusted%2Cexception&classifiedState=unclassified&fromchange=8e400446aedc740c18aceab2ca6d59fa723bcea5&selectedJob=266181610

https://treeherder.mozilla.org/logviewer.html#/jobs?job_id=266181610&repo=autoland&lineNumber=5550

Comment 5

[Pulsebot]

Backout by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/499b56b9d670
Backed out changeset 717694871f97 for causing spidermonkey bustages CLOSED TREE

Comment 6

[Will Hawkins]

Updated patch to resolve this bustage is out for review.

Comment 7

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/3afa57585d5c
Convert Detecting function to use bytecode iterator. r=tcampbell

Comment 8

[Cosmin Sabou [:CosminS]]

https://hg.mozilla.org/mozilla-central/rev/3afa57585d5c