1586441 - Use BytecodeLocation and BytecodeIterator in DebugScript::clearBreakpointsIn

Status: RESOLVED FIXED

(Core :: JavaScript Engine, enhancement, P3)

Description

[Adam Holm]

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 DebugScript::clearBreakpointsIn.

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.

• Dependencies of Bug 1478034 that have been marked RESOLVED FIXED can also be used 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
• Understand the basics of using Mercurial
• Understand how to submit a patch
• Read this walkthrough about how development works in Firefox

This patch is done when

• Direct access to the bytecode in DebugScript::clearBreakpointsIn is abstracted through the use of the classes BytecodeLocation and BytecodeIterator. In other words, jsbytecode* and offsetToPC uses in DebugScript::clearBreakpointsIn are replaced with methods and members of the classes BytecodeLocation and BytecodeIterator.

• Your patch passes the test suites described here.

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

[yozaam]

Attachment: Bug 1586441 Using iterator and BytecodeIterable in for loop instead of jsbytecode* pc r?mgaudet

Comment 2

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/820fa7359a58
Using iterator and BytecodeIterable in for loop instead of jsbytecode* pc r=mgaudet

Comment 3

[Razvan Maries]

https://hg.mozilla.org/mozilla-central/rev/820fa7359a58