重学js —— 结构化数据之Atomics对象

[lizhongzhen11]

Atomics 对象

用来对 SharedArrayBuffer 对象进行原子操作。

• MDN
• 即固有对象 %Atomics%
• 全局对象 "Atomics" 属性的初始值
• 属于 普通对象
• 有 [[Prototype]] 内置插槽，值为 %Object.prototype%
• 没有 [[Construct]] 内置方法；不能做构造器
• 没有 [[Call]] 内置方法；不能被调用
• 和 Math 对象一样，所有的属性和方法都是静态的！

多个共享内存的线程能够同时读写同一位置上的数据。原子操作会确保正在读或写的数据的值是符合预期的，即下一个原子操作一定会在上一个原子操作结束后才会开始，其操作过程不会中断。（阻塞？）

共享内存通信的规则由 内存模型 提供

Atomics.add ( typedArray, index, value )

• MDN

1. 定义 type 为 类型化数组表 中对应 typedArray.[[TypedArrayName]] 的元素类型值
2. 定义 isLittleEndian 为 周围代理 的 代理记录 中 [[LittleEndian]] 字段值
3. 定义 add 为新的具有参数 (xBytes, yBytes) 的 读写修改函数，该函数捕获 type 和 isLittleEndian，调用时自动执行以下步骤：
   1. 定义 x 为 RawBytesToNumeric(type, xBytes, isLittleEndian)
   2. 定义 y 为 RawBytesToNumeric(type, yBytes, isLittleEndian)
   3. 定义 T 为 x 的类型
   4. 定义 sum 为 T::add(x, y) （可能是 Number::add ( x, y )，也可能是 BigInt::add( x, y )）
   5. 定义 sumBytes 为 NumericToRawBytes(type, sum, isLittleEndian)
   6. 断言：sumBytes, xBytes, 和 yBytes 有相同数量的元素
   7. 返回 sumBytes
4. 返回 ? AtomicReadModifyWrite(typedArray, index, value, add)

Atomics.and ( typedArray, index, value )

• MDN

1. 定义 and 为新的具有参数 (xBytes, yBytes) 的 读写修改函数，该函数不捕获任何东西，调用时自动执行以下步骤：
   1. 返回 ByteListBitwiseOp(&, xBytes, yBytes)
2. 返回 ? AtomicReadModifyWrite(typedArray, index, value, and)

Atomics.compareExchange ( typedArray, index, expectedValue, replacementValue )

• MDN

1. 定义 buffer 为 ? ValidateSharedIntegerTypedArray(typedArray)
2. 定义 i 为 ? ValidateAtomicAccess(typedArray, index)
3. 定义 arrayTypeName 为 typedArray.[[TypedArrayName]]
4. 如果 typedArray.[[ContentType]] 为 BigInt，
   1. 定义 expected 为 ? ToBigInt(expectedValue)
   2. 定义 replacement 为 ? ToBigInt(replacementValue)
5. 否则，
   1. 定义 expected 为 ? ToInteger(expectedValue)
   2. 定义 replacement 为 ? ToInteger(replacementValue)
6. 定义 elementType 为 类型化数组表 中对应 arrayTypeName 的元素类型值
7. 定义 isLittleEndian 为 周围代理 的 代理记录 中 [[LittleEndian]] 字段值
8. 定义 expectedBytes 为 NumericToRawBytes(elementType, expected, isLittleEndian)
9. 定义 elementSize 为 类型化数组表 中对应 arrayTypeName 的元素大小值
10. 定义 offset 为 typedArray.[[ByteOffset]]
11. 定义 indexedPosition 为 (i × elementSize) + offset
12. 定义 compareExchange 为新的具有参数 (oldBytes, newBytes) 的 读写修改函数，该函数捕获 expectedBytes，调用时自动执行以下步骤：
    1. 如果 ByteListEqual(oldBytes, expectedBytes) 为 true，返回 newBytes
    2. 返回 oldBytes
13. 返回 GetModifySetValueInBuffer(buffer, indexedPosition, elementType, replacement, compareExchange)

Atomics.exchange ( typedArray, index, value )

• MDN

1. 定义 second 为新的具有 参数 (oldBytes, newBytes) 的 读写修改函数，该函数不捕获任何东西，调用时自动执行以下步骤：
   1. 返回 newBytes
2. 返回 ? AtomicReadModifyWrite(typedArray, index, value, second)

Atomics.isLockFree ( size )

• MDN
• 校验 size 是不是可处理的TypedArray 标准字节长度

1. 定义 n 为 ? ToInteger(size)
2. 定义 AR 为 周围代理 的 代理记录
3. 如果 n = 1，返回 AR.[[IsLockFree1]]
4. 如果 n = 2，返回 AR.[[IsLockFree2]]
5. 如果 n = 4，返回 true
6. 如果 n = 8，返回 AR.[[IsLockFree8]]
7. 返回 false

Atomics.load ( typedArray, index )

• MDN

1. 返回 ? AtomicLoad(typedArray, index)

Atomics.or ( typedArray, index, value )

• MDN

1. 定义 or 为新的具有参数 (xBytes, yBytes) 的 读写修改函数，该函数不捕获任何东西，调用时自动执行以下步骤：
   1. 返回 ByteListBitwiseOp(|, xBytes, yBytes)
2. 返回 ? AtomicReadModifyWrite(typedArray, index, value, or)

Atomics.store ( typedArray, index, value )

• MDN

1. 定义 buffer 为 ?ValidateSharedIntegerTypedArray(typedArray)
2. 定义 i 为 ?ValidateAtomicAccess(typedArray, index)
3. 定义 arrayTypeName 为 typedArray.[[TypedArrayName]]
4. 如果 arrayTypeName 为 "BigUint64Array" 或 "BigInt64Array"，定义 v 为 ?ToBigInt(value)
5. 否则，定义 v 为 ?ToInteger(value)
6. 定义 elementSize 为 类型化数组表 中对应 arrayTypeName 的元素大小值
7. 定义 elementType 为 类型化数组表 中对应 arrayTypeName 的元素类型值
8. 定义 offset 为 typedArray.[[ByteOffset]]
9. 定义 indexedPosition 为 (i × elementSize) + offset
10. 执行 SetValueInBuffer(buffer, indexedPosition, elementType, v, true, SeqCst)
11. 返回 v

Atomics.sub ( typedArray, index, value )

• MDN

1. 定义 type 为 类型化数组表 中对应 typedArray.[[TypedArrayName]] 的元素类型值
2. 定义 isLittleEndian 为 周围代理 的 代理记录 中 [[LittleEndian]] 字段值
3. 定义 subtract 为具有参数 (xBytes, yBytes) 的 读写修改函数，该函数捕获 type 和 isLittleEndian，调用时自动执行以下步骤：
   1. 定义 x 为 RawBytesToNumeric(type, xBytes, isLittleEndian)
   2. 定义 y 为 RawBytesToNumeric(type, yBytes, isLittleEndian)
   3. 定义 T 为 x 的类型
   4. 定义 difference 为 T::subtract(x, y) （可能是 Number::subtract ( x, y )，也可能是 BigInt::subtract( x, y )）
   5. 定义 differenceBytes 为 NumericToRawBytes(type, difference, isLittleEndian)
   6. 断言：differenceBytes，xBytes 和 yBytes 有相同数量的元素
   7. 返回 differenceBytes
4. 返回 ? AtomicReadModifyWrite(typedArray, index, value, subtract)

Atomics.wait ( typedArray, index, value, timeout )

• MDN

1. 定义 buffer 为 ? ValidateSharedIntegerTypedArray(typedArray, true)
2. 定义 i 为 ? ValidateAtomicAccess(typedArray, index)
3. 定义 arrayTypeName 为 typedArray.[[TypedArrayName]]
4. 如果 arrayTypeName 为 "BigInt64Array"，定义 v 为 ? ToBigInt64(value)
5. 否则，定义 v 为 ? ToInt32(value)
6. 定义 q 为 ? ToNumber(timeout)
7. 如果 q 为 NaN，定义 t 为 +∞，否则定义 t 为 max(q, 0)
8. 定义 B 为 AgentCanSuspend
9. 如果 B 为 false，抛 TypeError 异常
10. 定义 block 为 buffer.[[ArrayBufferData]]
11. 定义 offset 为 typedArray.[[ByteOffset]]
12. 定义 elementSize 为 类型化数组表 中对应 arrayTypeName 的元素大小值
13. 定义 indexedPosition 为 (i × elementSize) + offset
14. 定义 WL 为 GetWaiterList(block, indexedPosition)
15. 执行 EnterCriticalSection(WL)
16. 定义 w 为 ! AtomicLoad(typedArray, i)
17. 如果 v != w，
    1. 执行 LeaveCriticalSection(WL)
    2. 返回字符串 "not-equal"
18. 定义 W 为 AgentSignifier
19. 执行 AddWaiter(WL, W)
20. 定义 notified 为 Suspend(WL, W, t)
21. 如果 notified 为 true，
    1. 断言：W 不在 WL 服务列表中
22. 否则，
    1. 执行 RemoveWaiter(WL, W)
23. 执行 LeaveCriticalSection(WL)
24. 如果 notified 为 true，返回字符串 "ok"
25. 返回字符串 "timed-out"

Atomics.notify ( typedArray, index, count )

• MDN

Atomics.xor ( typedArray, index, value )

• MDN

1. 定义 xor 为新的具有参数 (xBytes, yBytes) 的 读写修改函数，该函数不捕获任何东西，调用时自动执行以下步骤：
   1. 返回 ByteListBitwiseOp(^, xBytes, yBytes)
2. 返回 ? AtomicReadModifyWrite(typedArray, index, value, xor)

注意

Atomics.wait 中示例代码不能直接在主线程执行（我做了修改），规范中也在调用 AgentCanSuspend 时明确提到了：

在某些环境中，挂起代理程序可能不合理。例如，在浏览器环境中，禁止挂起文档的主事件处理线程，但是同时仍然允许 workers 的事件处理线程挂起。

如果直接在浏览器控制台输入 MDN 给的代码会报错！需要用 Worker 开辟新的线程，在新的线程中使用 Atomics.wait 睡眠该线程。

永远不应该尝试睡眠主线程！

我在 codepen 上写了个例子，可以看看：https://codepen.io/lizhongzhen11/project/editor/AmzyaY# （记得打开f12看浏览器控制台输出，用谷歌，同事用的火狐打开报 SharedArrayBuffer 未定义）

[dino-zhao]

从mdn过来的,,,