977287 - Rename the operation callback

Status: RESOLVED FIXED

(Core :: JavaScript Engine, defect)

Description

[Jason Orendorff [:jorendorff]]

"operation callback" is meaningless. It should be called the interrupt callback.

Comment 1

[Jason Orendorff [:jorendorff]]

Attachment: bug-977287-part-1-renaming-v1.patch

Riskiest thing going on here is moving js_HandleExecutionInterrupt into a namespace and removing the `extern` keyword from its declaration.

Comment 2

[Jason Orendorff [:jorendorff]]

Attachment: bug-977287-part-2-minor-changes-v1.patch

Not-quite-as-trivial odds and ends found during renaming.

For example, it looks like JSShellContextData::startTime isn't used from the interrupt callback anymore, for years now.

Comment 3

[Jason Orendorff [:jorendorff]]

I'd love to delete the following paragraph from jsapi.h. It basically says, "Note: we might call this callback randomly. No reason. We just do sometimes." Maybe I'm the only person bothered by this.

> /*
>  * These functions allow setting an interrupt callback that will be called
>  * from the JS thread some time after any thread triggered the callback using
>  * JS_RequestInterruptCallback(rt).
>  *
>- * To schedule the GC and for other activities the engine internally triggers
>- * interrupt callbacks. The embedding should thus not rely on callbacks being
>- * triggered through the external API only.
>- *
>  * Important note: Additional callbacks can occur inside the callback handler
>  * if it re-enters the JS engine. The embedding must ensure that the callback
>  * is disconnected before attempting such re-entry.
>  */

It would be an easy fix, since all the interrupt state is already protected by a lock. We'd still need a comment to the effect that interrupts can be coalesced; you might request 2 and only get 1.

Comment 4

[Luke Wagner [:luke]]

Comment on attachment 8383355 [details] [diff] [review]
bug-977287-part-1-renaming-v1.patch

Lovely

Comment 5

[Jason Orendorff [:jorendorff]]

   https://hg.mozilla.org/integration/mozilla-inbound/rev/53139214dcf3
   https://hg.mozilla.org/integration/mozilla-inbound/rev/02400c717fa6

Comment 6

[Ryan VanderMeulen [:RyanVM]]

https://hg.mozilla.org/mozilla-central/rev/53139214dcf3
https://hg.mozilla.org/mozilla-central/rev/02400c717fa6