From 074785cea106179cb3305637055ab0a009ca74f2 Mon Sep 17 00:00:00 2001 From: Peter Bengtsson Date: Tue, 8 Dec 2020 14:42:52 -0500 Subject: initial commit --- files/ru/webassembly/c_to_wasm/index.html | 185 +++++++ files/ru/webassembly/concepts/index.html | 147 ++++++ files/ru/webassembly/exported_functions/index.html | 74 +++ files/ru/webassembly/index.html | 113 +++++ .../ru/webassembly/loading_and_running/index.html | 114 +++++ files/ru/webassembly/rust_to_wasm/index.html | 314 ++++++++++++ .../understanding_the_text_format/index.html | 537 +++++++++++++++++++++ .../using_the_javascript_api/index.html | 302 ++++++++++++ 8 files changed, 1786 insertions(+) create mode 100644 files/ru/webassembly/c_to_wasm/index.html create mode 100644 files/ru/webassembly/concepts/index.html create mode 100644 files/ru/webassembly/exported_functions/index.html create mode 100644 files/ru/webassembly/index.html create mode 100644 files/ru/webassembly/loading_and_running/index.html create mode 100644 files/ru/webassembly/rust_to_wasm/index.html create mode 100644 files/ru/webassembly/understanding_the_text_format/index.html create mode 100644 files/ru/webassembly/using_the_javascript_api/index.html (limited to 'files/ru/webassembly') diff --git a/files/ru/webassembly/c_to_wasm/index.html b/files/ru/webassembly/c_to_wasm/index.html new file mode 100644 index 0000000000..81e1dc93a3 --- /dev/null +++ b/files/ru/webassembly/c_to_wasm/index.html @@ -0,0 +1,185 @@ +--- +title: Компиляция кода C/C++ в WebAssembly +slug: WebAssembly/C_to_wasm +translation_of: WebAssembly/C_to_wasm +--- +
{{WebAssemblySidebar}}
+ +

После того как вы написали код на C / C ++, вы можете скомпилировать его в WebAssembly, например, с помощью инструмента Emscripten. Давайте посмотрим, как это работает.

+ +

Подготовка рабочей среды для Emscripten

+ +

Первым делом установим компоненты для дальнейшей работы.

+ +

Необходимые компоненты

+ +

Установите Emscripten SDK и настройте рабочее окружение используя инструкции: https://kripken.github.io/emscripten-site/docs/getting_started/downloads.html

+ +

Компиляция примера

+ +

Когда рабочее окружение подготовлено, попробуем собрать пример кода на языке Си при помощи Emscripten. Вам доступно большое количество опций для настройки компиляции, но мы рассмотрим только два основных сценария компиляции с использованием Emscripten:

+ + + +

Мы рассмотрим оба способа ниже.

+ +

Создание HTML и JavaScript

+ +

Это самый простой способ, который мы рассмотрим. С его помощью вы сможете использовать Emscripten для создания всего что нужно, чтобы ваш код работал в браузере как модуль WebAssembly.

+ +
    +
  1. Нам понадобится простой пример для компиляции. Скопируйте следующий код программы на Си и сохраните его в файле  hello.c в новой папке на вашем локальном диске: + + 
    #include <stdio.h>
+
+int main(int argc, char ** argv) {
+  printf("Hello World\n");
+}
    +
    2. +
  2. Теперь, используя терминал, перейдите в каталог, в котором находится ваш файл hello.c, и выполните следующую команду: + 
    emcc hello.c -s WASM=1 -o hello.html
    +
    3. +
+ +

Рассмотрим параметры, которые мы передали компилятору:

+ + + +

На этом этапе в вашем каталоге должны находится:

+ + + +

Запуск вашего примера

+ +

Теперь, все что нужно чтобы запустить полученный  hello.html в браузере, это поддержка WebAssembly. Он включен по умолчанию в Firefox 52+, Chrome 57+ и последних версиях Opera. Также вы можете использовать модули WebAssembly в Firefox 47+, включив флаг javascript.options.wasm в about:config, или в Chrome 51+ и Opera 38+ перейдя в chrome://flags и включив флаг Experimental WebAssembly.

+ +

Если все работает как планировалось, вы должны увидеть надпись "Hello world" на открывшейся веб-странице и в JavaScript консоли вашего браузера. Поздравляем, вы только что скомпилировали программу на Си в WebAssembly и запустили ее в своем браузере!

+ +
+

Примечание: На самом деле, если просто открыть полученный hello.html, то ничего работать не будет. Подразумевается что все файлы находятся на веб-сервере и вы запускаете страницу через localhost/hello.html. Для этих целей можно использовать отладочный веб-сервер Emscripten. Чтобы его запустить, откройте терминал, перейдите в каталог, в котором находятся ваши файлы и выполните команду emrun hello.html

+
+ +

Использование собственного HTML шаблона

+ +

Вы можете использовать собственный шаблон HTML. Давайте посмотрим, как это сделать:

+ +
    +
  1. +

    Прежде всего, сохраните следующий код в файле hello2.c в новом каталоге:

    + + 
    #include <stdio.h>
+
+int main(int argc, char ** argv) {
+    printf("Hello World\n");
+
+}
    +
    2. +
  2. +

    Найдите файл  shell_minimal.html в вашем репозитории emsdk. Скопируйте его в подкаталог html_template внутри вашего нового каталога.

    +
    3. +
  3. +

    Теперь, используя терминал, перейдите в ваш новый каталог и выполните следующую команду:

    + + 
    emcc -o hello2.html hello2.c -O3 -s WASM=1 --shell-file html_template/shell_minimal.html
    + +

    В этот раз мы использовали немного другие параметры компиляции:

    + +
      +
    • Мы указали -o hello2.html, чтобы компилятор по прежнему генерировал необходимый JavaScript код и .html файл.
      • +
    • Также, мы указали  --shell-file html_template/shell_minimal.html чтобы компилятор использовал ваш шаблон для создания HTML страницы запускающей этот пример.
      • +
    +
    4. +
  4. +

    Теперь давайте запустим этот пример. Команда, указанная выше, сгенерирует файл hello2.html, который будет иметь тоже содержание что и шаблон, но с некоторым кодом, добавленным в процесс загрузки сгенерированного wasm, запускающим его и т.д. Откройте его в своем браузере, и вы увидите тот же результат, что и прошлом примере.

    +
    5. +
+ +
+

Примечание: Вы можете указать компилятору создавать только JavaScript кода, без HTML, используя внутри флага -o, .js вместо .html для формата выходного файла, например emcc -o hello2.js hello2.c -O3 -s WASM=1. После этого вы должны создать свой собственный HTML файл с нуля. Однако так делать не рекомендуется — Emscripten теребуется большое количество связывающего кода для обработки операций выделения памяти, утечек памяти и других проблем, которые уже включены в предоставляемый шаблон. Намного легче использовать уже готовое решение, чем создавать свои собственные версии самому.

+
+ +

Вызов пользовательской функции, определенной в Си

+ +

Если у вас есть функция определенная в коде на Си, которую вы хотите по необходимости вызывать из JavaScript, то вы можете использовать для этого функцию  ccall() из Emscripten, и объявление EMSCRIPTEN_KEEPALIVE которое добавит вашу функцию в список экспортируемых функций (см. Почему функции в моем коде исчезают после компиляции и/или я получаю сообщение «Нет функций для обработки»). Давайте посмотрим, как это работает.

+ +
    +
  1. +

    Для начала сохраните следующий код в файле  hello3.c в новом каталоге:

    + + 
    #include <stdio.h>
+#include <emscripten/emscripten.h>
+
+int main(int argc, char ** argv) {
+    printf("Hello World\n");
+}
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+void EMSCRIPTEN_KEEPALIVE myFunction(int argc, char ** argv) {
+  printf("MyFunction Called\n");
+}
+
+#ifdef __cplusplus
+}
+#endif
    + +

    По умолчанию, код созданный Emscripten, всегда просто вызывает функцию  main() , а остальные неиспользуемые функции удаляются. Добавьте определение EMSCRIPTEN_KEEPALIVE перед именем функции чтобы этого не происходило. Также вы должны подключить библиотеку emscripten.h для использования EMSCRIPTEN_KEEPALIVE.

    + +
    +

    Примечание: Мы используем блоки #ifdef чтобы, пример оставался рабочим если вы попытаетесь использовать C++ код. Из за различия в правилах преобразования имен между Си и Си++, этот код может сломаться, но мы написали его так, что функция будет рассматриваться как функция Си даже если вы будете использовать Си++.

    +
    +
    2. +
  2. +

    Теперь добавьте html_template/shell_minimal.html в ваш новый каталог, просто для удобства. В настоящем проекте стоит размещать его в специально отпределенный каталог.

    +
    3. +
  3. +

    Теперь снова займемся этапом компиляции. Внутри вашего последнего каталога, используя терминал, скомпилируйте ваш Си код следующей командой. (Обратите внимание что при компиляции обязательно нужно использовать опцию NO_EXIT_RUNTIME, иначе после выполнения функции main(), рабочий цикл будет завершен. Это приведет, например, к вызову функции atexits и дальше будет невозможно использовать наш скомпилированный код. Другими словами это необходимо для правильной эмуляции Си.)

    + + 
    emcc -o hello3.html hello3.c -O3 -s WASM=1 --shell-file html_template/shell_minimal.html -s NO_EXIT_RUNTIME=1  -s EXTRA_EXPORTED_RUNTIME_METHODS='["ccall"]'
    +
    4. +
  4. +

    Если вы снова запустите пример в своем браузере, вы увидите тоже самое что и до этого!

    +
    5. +
  5. +

    Теперь нам нужно вызвать нашу новую функцию myFunction() из JavaScript. Прежде всего, добавьте {{htmlelement("button")}} как показано ниже, чуть выше первого открывающего тега <script type='text/javascript'>.

    + + 
    <button class="mybutton">Run myFunction</button>
    +
    6. +
  6. +

    Теперь добавьте следующий код в конце первого элемента {{htmlelement("script")}} (чуть выше закрывающего тега </script>):

    + + 
    document.querySelector('.mybutton').addEventListener('click', function(){
+  alert('check console');
+  var result = Module.ccall('myFunction', // name of C function
+                             null, // return type
+                             null, // argument types
+                             null); // arguments
+});
    +
    7. +
+ +

Это показывает как использовать ccall() для вызова экспортируемой функции.

+ +

Смотрите также

+ + diff --git a/files/ru/webassembly/concepts/index.html b/files/ru/webassembly/concepts/index.html new file mode 100644 index 0000000000..064eb577b1 --- /dev/null +++ b/files/ru/webassembly/concepts/index.html @@ -0,0 +1,147 @@ +--- +title: Основы WebAssembly +slug: WebAssembly/Concepts +translation_of: WebAssembly/Concepts +--- +
{{WebAssemblySidebar}}
+ +

В этой статье объясняются концепции, лежащие в основе работы технологии WebAssembly, включая ее цели, проблемы, которые она решает, и то, как она работает в движке рендеринга веб-браузера.

+ +

Что такое WebAssembly?

+ +

WebAssembly - это технология, предоставляющая новый тип кода, который можно запускать в современных веб-браузерах, что обеспечивает новые функции и значительное повышение производительности. Код для WebAssembly не предназначен для написания вручную, скорее он спроектирован для эффективной компиляции из низкоуровневых исходных языков, таких как C, C++, Rust и.т.д.

+ +

WebAssembly ​​позволяет запускать код, написанный на различных языках в web-приложениях почти c естественной скоростью. Это имеет огромное значение для веб-платформы, так как ранее это нельзя было сделать.

+ +

Более того, вам даже не нужно знать, как создавать код WebAssembly, чтобы его использовать. Модули WebAssembly можно импортировать в веб-приложение (или Node.js), и экспортировать из них функции для использования через JavaScript. JavaScript-фреймворки могут использовать модули WebAssembly для получения огромных преимуществ в производительности и новых функций, в то же время делая их функциональность легко доступной для веб-разработчиков.

+ +

Цели WebAssembly

+ +

Технология WebAssembly создается как открытый стандарт внутри W3C WebAssembly Community Group со следующими целями:

+ + + +
+

Примечание: Технология WebAssembly также будет иметь возможность использования за пределами веб и JavaScript-сред (см. Встраивание вне Web).

+
+ +

Как WebAssembly встраивается в веб-платформу?

+ +

Веб-платформа может рассматриваться как состоящая из двух частей:

+ + + +

Исторически ВМ могла загружать только JavaScript. Раньше нас это вполне устраивало, поскольку JavaScript достаточно мощный, чтобы решать большинство проблем, с которыми мы сталкивались в интернете. Однако мы столкнулись с проблемами производительности, когда попытались использовать JavaScript для более нагруженных сценариев использования, таких как 3D-игры, виртуальная и дополненная реальность, компьютерное зрение, редактирование изображений / видео и в ряде других применений, которые требуют повышенной производительности (см. варианты использования WebAssembly где описано больше идей).

+ +

Кроме того, длительность загрузки, анализа и компиляции очень больших приложений JavaScript может быть непомерно высокой. Мобильные и другие ограниченные в ресурсах платформы могут еще более понизить  производительность.

+ +

Язык WebAssembly отличается от языка JavaScript, но он не предназначен для его замены. Он предназначен для дополнения и работы вместе с JavaScript, что позволяет веб-разработчикам использовать преимущества обоих языков:

+ + + +

С появлением WebAssembly в браузерах виртуальная машина, о которой мы говорили ранее, теперь будет загружать и запускать два типа кода - JavaScript и WebAssembly.

+ +

Различные типы кода могут вызывать друг друга по мере необходимости - WebAssembly JavaScript API оборачивает экспортированный код WebAssembly в функции JavaScript, которые можно вызывать обычным способом. А в код WebAssembly можно импортировать и синхронно вызывать обычные функции JavaScript. Фактически, базовая единица кода WebAssembly называется модулем, а модули WebAssembly во многом схожи с модулями ES2015.

+ +

Ключевые понятия WebAssembly

+ +

Есть несколько ключевых понятий, необходимых для понимания того, как WebAssembly работает в браузере. Все эти понятия отражены 1:1 в WebAssembly JavaScript API.

+ + + +

JavaScript API предоставляет разработчикам возможность создавать модули, объекты памяти, таблицы и экземпляры модулей. Получив экземпляр модуля WebAssembly, код JavaScript может синхронно вызывать его экспорты, которые представляются как обычные функции JavaScript. Любые функции JavaScript также могут синхронно вызываться кодом WebAssembly путем передачи этих функций в качестве импорта в экземпляр модуля WebAssembly.

+ +

Поскольку JavaScript полностью контролирует загрузку, компиляцию и запуск кода WebAssembly, разработчики JavaScript могут рассматривать технологию  WebAssembly как расширение JavaScript для эффективной генерации высокопроизводительных функций.

+ +

В будущем модули WebAssembly будут загружаться так же, как и модули ES2015 (с использованием <script type='module'>), что означает, что JavaScript сможет извлекать, компилировать и импортировать модуль WebAssembly так же легко, как модуль ES2015.

+ +

Как я могу использовать WebAssembly в своем приложении?

+ +

Выше мы говорили о низкоуровневых примитивах, которые WebAssembly добавляет к веб-платформе: двоичный формат для кода и API для его загрузки и запуска. Теперь давайте поговорим о том, как мы можем использовать эти примитивы на практике.

+ +

Экосистема WebAssembly находится на начальной стадии; больше инструментов, несомненно, появится в будущем. На данный момент есть три основные оптравные точки:

+ + + +

Давайте поговорим об этих вариантах:

+ +

Портирование из C/C++

+ +

Из множества вариантов создания кода WASM есть два наиболее популярных - это онлайн-сборщик wasm или Emscripten. Существует еще несколько вариантов сборки WASM, таких как:

+ + + +

Это отличные ресурсы для людей, которые хотят начать, но у них нет инструментов и возможностей Emscripten.

+ +

Инструмент Emscripten способен взять практически любой исходный код C/C++ и скомпилировать его в модуль .wasm, добавив необходимый "связующий" JavaScript-код для загрузки и запуска модуля в HTML-документе и отображения результатов работы.

+ +

+ +

В двух словах, процесс работает следующим образом:

+ +
    +
  1. Сначала Emscripten передает код C/C++ в clang + LLVM - набор инструментов компилятора C/C++ с открытым исходным кодом, который поставляется, например, как часть XCode для OSX.
    2. +
  2. Emscripten преобразует скомпилированный результат clang + LLVM в двоичный файл .wasm.   
    3. +
  3. Сам по себе код WebAssembly в настоящее время не может напрямую обращаться к DOM; он может вызывать только JavaScript, передавая целочисленные и числа с плавающей точкой примитивные типы данных. Таким образом, чтобы получить доступ к любому Web-API, WebAssembly модуль должен обращаться к JavaScript, который затем вызывает Web-API. Поэтому Emscripten создает необходимый для этого связующий код HTML и JavaScript.
    4. +
+ +
+

Примечание: В будущем планируется позволить WebAssembly напрямую вызывать Web API.

+
+ +

Связующий код JavaScript не так прост, как вы можете себе представить. Прежде всего Emscripten предоставляет популярные библиотеки C/C++, такие как SDL, OpenGL, OpenAL и части POSIX. Эти библиотеки реализованы с точки зрения Web-API, и поэтому каждой из них требуется некоторый код JavaScript для соединения WebAssembly модуля с базовым Web-API.

+ +

Таким образом, часть связующего кода предоставляет функциональность каждой библиотеки, используемой кодом C/C++. Связующий код также содержит логику для вызова вышеупомянутых WebAssembly JavaScript API для извлечения, загрузки и запуска файла .wasm.

+ +

Сгенерированный HTML-документ загружает связующий файл JavaScript и может записать stdout в {{htmlelement("textarea")}}. Если приложение использует OpenGL, HTML документ будет содержать элемент {{htmlelement("canvas")}}, который будет использоватся для  рендеринга. Очень легко изменить тип вывода комптляции Emscripten на любое веб-приложение, которое вам нужно.

+ +

Вы можете найти полную документацию по Emscripten на emscripten.org, а также руководство по созданию набора инструментов и компиляции вашего собственного приложения на C/C++ в wasm в разделе Компилирование из C/C++ в WebAssembly.

+ +

Написание WebAssembly напрямую

+ +

Хотите создать свой собственный компилятор, собственные инструменты или библиотеку JavaScript, которая генерирует WebAssembly во время выполнения?

+ +

Аналогично другим ассемблерным языкам, двоичный формат WebAssembly имеет текстовое представление с которым имеет соответствие 1:1. Вы можете написать или сгенерировать этот формат вручную, а затем преобразовать его в двоичный формат с помощью любого из инструментов преобразования текста в двоичные файлы WebAssembly.

+ +

Простое руководство о том, как это сделать, смотрите в нашей статье Перевод из текстового формата WebAssembly в wasm.

+ +

Написание приложения Rust с компиляцией в WebAssembly

+ +

Благодаря неустанной работе рабочей группы Rust WebAssembly, стало возможно писать Rust код и компилировать его в WebAssembly. В нашей статье Компиляция из Rust в WebAssembly описан процесс установки необходимого набора инструментов, компиляция примера программы Rust в пакет npm для WebAssembly с целью использования его в качестве примера веб-приложения.

+ +

Резюме

+ +

Эта статья дала вам объяснение того, что такое технология WebAssembly, чем  она полезная, как она вписывается в веб и как вы можете её использовать.

+ +

Смотрите также

+ + diff --git a/files/ru/webassembly/exported_functions/index.html b/files/ru/webassembly/exported_functions/index.html new file mode 100644 index 0000000000..bf29f3f76b --- /dev/null +++ b/files/ru/webassembly/exported_functions/index.html @@ -0,0 +1,74 @@ +--- +title: Экспортируемые функции WebAssembly +slug: WebAssembly/Exported_functions +tags: + - JavaScript + - WebAssembly + - wasm + - Экспортированные функции +translation_of: WebAssembly/Exported_functions +--- +
{{WebAssemblySidebar}}
+ +

Экспортированные функции WebAssembly - это функции вашего модуля доступные в JavaScript. В этой статье более подробно описывается, что они из себя представляют.

+ +

Экспортированные… что?

+ +

Экспортированные функции это просто JavaScript обертки, которые вызывают функции модуля WebAssembly. При их использовании происходит неявное преобразование типов аргументов функции в типы, с которыми может работать WebAssembly (например, преобразование number в int32). Дальше эти аргументы передаются функции вашего модуля и она вызывается. Результат также преобразовывается и возвращается в JavaScript.

+ +

Вы можете получить список экспортированных функций двумя способами:

+ + + +

В любом случае вы получаете одну и туже обертку функции вашего модуля. С точки зрения JavaScript, все экспортированные функции wasm являются функциями JavaScript, но они инкапсулированы экземпляром модуля wasm, и имеют только ограниченный способ доступа к ним.

+ +

Пример

+ +

Давайте посмотрим на пример, чтобы прояснить ситуацию (вы можете найти его на GitHub как table-set.html или запустить в своем браузере, и посмотерть текстовое представление модуля wasm):

+ +
var otherTable = new WebAssembly.Table({ element: "anyfunc", initial: 2 });
+
+WebAssembly.instantiateStreaming(fetch('table.wasm'))
+.then(obj => {
+  var tbl = obj.instance.exports.tbl;
+  console.log(tbl.get(0)());  // 13
+  console.log(tbl.get(1)());  // 42
+  otherTable.set(0,tbl.get(0));
+  otherTable.set(1,tbl.get(1));
+  console.log(otherTable.get(0)());
+  console.log(otherTable.get(1)());
+});
+ +

Здесь мы создаем таблицу otherTable из JavaScript используя конструктор {{jsxref("WebAssembly.Table")}}, после этого мы загружаем модуль table.wasm при помощи функции {{jsxref("WebAssembly.instantiateStreaming()")}}.

+ +

Затем мы получаем объект содержащий все функции, экспортированные из экземпляра модуля. Извлекаем ссылки на эти функции через  tbl.get(), вызываем их и выводим результат работы в консоль. Затем мы используем set() чтобы таблица  otherTable содержала ссылки на те же функции, что и таблица tbl.

+ +

Чтобы доказать это, мы получаем ссылки на функции из таблицы  otherTable и вызываем их. При выводе в консоль они дают такие же результаты.

+ +

Они являются настоящими функциями

+ +

В предыдущем примере возвращаемое значение каждого вызова Table.prototype.get() является экспортированной функцией WebAssembly — это именно то, о чем мы говорили.

+ +

Стоит заметить что помимо того что они являются обертками для функций WebAssembly, это обычные функции JavaScript. Если вы загрузите приведенный выше пример в браузере с поддержкой WebAssembly, и запустите следующие строки в консоли:

+ +
var testFunc = otherTable.get(0);
+typeof testFunc;
+ +

результатом выполнения будет function. Вы можете сделать с ней все тоже самое что и с другими функциями в JavaScript — call(), bind() и т.д. Вызов testFunc.toString() возвращает интересный результат:

+ +
function 0() {
+    [native code]
+}
+ +

Это наводит на мысль о том что эта функция является оберткой.

+ +

Дополнительные сведения которые нужно знать при работе с экспортированными функциями:

+ + diff --git a/files/ru/webassembly/index.html b/files/ru/webassembly/index.html new file mode 100644 index 0000000000..84e0c56b57 --- /dev/null +++ b/files/ru/webassembly/index.html @@ -0,0 +1,113 @@ +--- +title: WebAssembly +slug: WebAssembly +translation_of: WebAssembly +--- +
{{WebAssemblySidebar}}
+ +

WebAssembly – это новый открытый формат байт-кода, исполняемого современными браузерами. Он позволяет переносить код, написанный на таких языках как C, C++, C#, Rust, в низкоуровневые ассемблерные инструкции и использовать его в сети. Формат имеет компактные размеры, высокую производительность, близкую к нативной, и может одновременно работать с  JavaScript.

+ +

В двух словах

+ +

WebAssembly оказывает огромное влияние на веб-платформу — он предоставляет способ исполнения кода, написанного на различных языках, в сети, со скоростью близкой к нативной, чего ранее невозможно было достичь.

+ +

WebAssembly разработан для дополнения JavaScript – используя WebAssembly JavaScript API вы можете загружать модули WebAssembly в приложения JavaScript и обеспечивать взаимодействие между ними, используя общие функции. Такой подход позволяет вам получить производительность и мощность WebAssembly, а также выразительность и гибкость JavaScript в ваших приложениях, даже если вы не знаете как писать код WebAssembly, а используете готовые модули.

+ +

И что еще лучше, так это то, что WebAssembly разрабатывается как веб-стандарт W3C WebAssembly Working Group и Community Group при активном участии основных производителей браузеров.

+ +
+
+

Руководства

+ +
+
Основы WebAssembly
+
Прежде всего, начните с чтения общего описания WebAssembly - что это такое, чем это может быть полезно, почему он подходит для веб-платформы и как его использовать.
+
Компиляция кода C/C++ в WebAssembly
+
После того как вы написали код на C / C ++, вы можете скомпилировать его в .wasm, например, с помощью инструмента Emscripten. Давайте посмотрим, как это работает.
+
Компиляция существующего кода C в WebAssembly
+
Главное, что позволяет WebAssembly, это использование огромного множества разнообразных и проверенных временем библиотек, написанных на языке C, в сети.
+
Загрузка и запуск кода WebAssembly
+
После того, как у вас появился .wasm, эта статья расскажет, как из него получить, скомпилировать и создать экземпляр модуля, совмещая WebAssembly JavaScript API c Fetch или XHR API.
+
Кэширование скомпилированных модулей WebAssembly
+
Кэширование больших модулей WebAssembly на клиенте полезно для повышения скорости запуска приложений. В этой статье объясняется, как это сделать с помощью IndexedDB.
+
Использование WebAssembly JavaScript API
+
После того, как вы загрузили модуль .wasm, вы захотите его использовать. В этой статье мы покажем вам, как использовать WebAssembly через WebAssembly JavaScript API.
+
Экспортируемые функции WebAssembly
+
Экспортируемые функции WebAssembly — это функции нативного модуля, доступные в JavaScript, которые позволяют вызывать код WebAssembly из JavaScript. В этой статье описывается, что они из себя представляют.
+
Описание текстового формата WebAssembly
+
Эта статья описывает текстовый формат WebAssembly. Это низкоуровневое текстовое представления модулей .wasm используемое в инструментах разработчика во время отладки.
+
Перевод из текстового формата WebAssembly в wasm
+
Эта статья содержит руководство по переводу модулей WebAssembly, написанных в текстовом формате, в двоичный файл .wasm.
+
+
+ +
+

Ссылки на API

+ +
+
{{jsxref("Global_objects/WebAssembly", "WebAssembly")}}
+
Этот объект является пространством имен для всех функций, связанных с WebAssembly.
+
{{jsxref("Global_objects/WebAssembly/Module", "WebAssembly.Module()")}}
+
Объект WebAssembly.Module содержит не контролируемый WebAssembly код, который уже скомпилирован браузером и может эффективно использоваться совместно с Workers, кешироваться в IndexedDB, и иметь несколько экземпляров.
+
{{jsxref("Global_objects/WebAssembly/Instance", "WebAssembly.Instance()")}}
+
Объект WebAssembly.Instance это контролируемый, исполняемый экземпляр Module.  Instance содержит все  экспортированные функции WebAssembly, которые позволяют вызывать код WebAssembly из JavaScript.
+
{{jsxref("Global_objects/WebAssembly/instantiateStreaming", "WebAssembly.instantiateStreaming()")}}
+
Функция WebAssembly.instantiateStreaming() является основной для компиляции и создания экземпляра кода WebAssembly, возвращающая одновременно Module и Instance.
+
{{jsxref("Global_objects/WebAssembly/Memory", "WebAssembly.Memory()")}}
+
WebAssembly.Memory это изменяемый {{jsxref("Global_objects/ArrayBuffer", "ArrayBuffer")}} содержащий в себе данные не имеющие типа к которым обращается Instance.
+
{{jsxref("Global_objects/WebAssembly/Table", "WebAssembly.Table()")}}
+
WebAssembly.Table объект является изменяемым типизированным массивом значений, таких как ссылки на функции, которые доступны Instance.
+
{{jsxref("WebAssembly.CompileError()")}}
+
Создает новый WebAssembly CompileError объект.
+
{{jsxref("WebAssembly.LinkError()")}}
+
Создает новый WebAssembly LinkError объект.
+
{{jsxref("WebAssembly.RuntimeError()")}}
+
Создает новый WebAssembly RuntimeError объект.
+
+
+
+ +

Примеры

+ + + +

Спецификация

+ + + + + + + + + + + + + + + + +
SpecificationStatusComment
{{SpecName('WebAssembly JS')}}{{Spec2('WebAssembly JS')}}Initial draft definition of the JavaScript API.
+ +

Совместимость с браузерами

+ +
+ + +

{{Compat("javascript.builtins.WebAssembly")}}

+
+ +

Смотрите также

+ + diff --git a/files/ru/webassembly/loading_and_running/index.html b/files/ru/webassembly/loading_and_running/index.html new file mode 100644 index 0000000000..a796cc7a30 --- /dev/null +++ b/files/ru/webassembly/loading_and_running/index.html @@ -0,0 +1,114 @@ +--- +title: Загрузка и запуск кода WebAssembly +slug: WebAssembly/Loading_and_running +tags: + - Fetch + - JavaScript + - WebAssembly + - XMLHttpRequest + - bytecode +translation_of: WebAssembly/Loading_and_running +--- +
{{WebAssemblySidebar}}
+ +

Чтобы использовать WebAssembly в JavaScript, сначала нужно загрузить модуль в память перед компиляцией/созданием экземпляра. Эта статья содержит справочную информацию о различных механизмах, которые можно использовать для получения байт-кода WebAssembly, а также о том, как скомпилировать/создать экземпляр, а затем запустить его.

+ +

Какие есть варианты?

+ +

WebAssembly еще не интегрирована с <script type='module'> или ES2015 оператором import, поэтому не существует пути, позволяющего использовать модули загрузки браузера для использования импорта.

+ +

Старые методы {{jsxref("WebAssembly.compile")}}/{{jsxref("WebAssembly.instantiate")}} требуют создания {{domxref("ArrayBuffer")}}, содержащего двоичный файл модуля WebAssembly после загрузки необработанных байтов, а затем скомпилировать/создать его экземпляр. Это аналог new Function(string), за исключением того, что мы заменяем строку символов (исходный код JavaScript) буфером байтов массива (исходный код WebAssembly).

+ +

Более новые методы {{jsxref("WebAssembly.compileStreaming")}}/{{jsxref("WebAssembly.instantiateStreaming")}} намного эффективнее - они выполняют свои действия непосредственно с необработанным потоком байтов, поступающих из сети, избавление от необходимости шага {{domxref("ArrayBuffer")}}.

+ +

Итак, как мы можем получить эти байты в буфер массива и скомпилировать? Следующие разделы объясняют.

+ +

Используя Fetch

+ +

Fetch - это удобный современный API для извлечения сетевых ресурсов.

+ +

Самый быстрый и эффективный способ получить модуль wasm - использовать более новый метод {{jsxref("WebAssembly.instantiateStreaming()")}}, который может принять вызов fetch() в качестве первого аргумента и будет обрабатывать загрузку, компиляцию и создание экземпляра модуля за один шаг, получая доступ к необработанному байтовому коду при его потоковой передаче с сервера:

+ +
WebAssembly.instantiateStreaming(fetch('simple.wasm'), importObject)
+.then(results => {
+  // Do something with the results!
+});
+ +

Если бы мы использовали более старый метод {{jsxref("WebAssembly.instantiate()")}}, который не работает в прямом потоке, нам потребовался бы дополнительный шаг преобразования преобразованного байт-кода в {{domxref("ArrayBuffer")}}, вот так:

+ +
fetch('module.wasm').then(response =>
+  response.arrayBuffer()
+).then(bytes =>
+  WebAssembly.instantiate(bytes, importObject)
+).then(results => {
+  // Do something with the results!
+});
+ +

 

+ +

Помимо перегрузок instantiate()

+ +

Функция {{jsxref("WebAssembly.instantiate()")}} имеет две формы перегрузки - та, что показана выше, принимает байт-код для компиляции в качестве аргумента и возвращает Promise, которое разрешается для объекта, содержащего оба объекта скомпилированного модуля, и экземпляр этого. Объект выглядит так:

+ +
{
+  module : Module // The newly compiled WebAssembly.Module object,
+  instance : Instance // A new WebAssembly.Instance of the module object
+}
+ +
+

Примечание: Обычно мы заботимся только об экземпляре, но полезно иметь модуль на тот случай, если мы хотим его кешировать, поделиться им с другим работником или окном через postMessage(), или просто создать больше экземпляров.

+
+ +
+

Примечание: Вторая форма перегрузки принимает в качестве аргумента объект {{jsxref("WebAssembly.Module")}} и возвращает Promise, непосредственно содержащее объект экземпляра, в качестве результата. См. Второй пример перегрузки.

+
+ +

Выполнение вашего кода WebAssembly

+ +

Когда у вас есть экземпляр WebAssembly, доступный в вашем JavaScript, вы можете начать использовать его возможности, которые были экспортированы через свойство {{jsxref("WebAssembly.Instance/exports", "WebAssembly.Instance.exports")}}. Ваш код может выглядеть примерно так:

+ +
WebAssembly.instantiateStreaming(fetch('myModule.wasm'), importObject)
+.then(obj => {
+  // Call an exported function:
+  obj.instance.exports.exported_func();
+
+  // or access the buffer contents of an exported memory:
+  var i32 = new Uint32Array(obj.instance.exports.memory.buffer);
+
+  // or access the elements of an exported table:
+  var table = obj.instance.exports.table;
+  console.log(table.get(0)());
+})
+ +
+

Примечание: Для получения дополнительной информации о том, как работает экспорт из модуля WebAssembly, ознакомьтесь с разделами Использование JavaScript API WebAssembly, и Понимание текстового формата WebAssembly.

+
+ +

Используя XMLHttpRequest

+ +

XMLHttpRequest несколько старше, чем Fetch, но все же может успешно использоваться для получения типизированного массива. Опять же, если предположить, что наш модуль называется simple.wasm:

+ +
    +
  1. Создайте новый экземпляр {{domxref("XMLHttpRequest()")}} и используйте его метод {{domxref("XMLHttpRequest.open","open()")}} для открытия запроса, задав для метода запроса значение GET и указав путь к файлу, который мы хотим получить.
    2. +
  2. Ключевой частью этого является установка типа ответа 'arraybuffer' с помощью свойства {{domxref("XMLHttpRequest.responseType","responseType")}}.
    3. +
  3. Затем отправьте запрос с помощью {{domxref("XMLHttpRequest.send()")}}.
    4. +
  4. Затем мы используем обработчик событий {{domxref("XMLHttpRequest.onload", "onload")}} для вызова функции после завершения загрузки ответа - в этой функции мы получаем буфер массива из {{domxref("XMLHttpRequest.response", "response")}} и затем передайте это в наш метод {{jsxref("WebAssembly.instantiate()")}}, как мы это делали с Fetch.
    5. +
+ +

Финальный код выглядит так:

+ +
request = new XMLHttpRequest();
+request.open('GET', 'simple.wasm');
+request.responseType = 'arraybuffer';
+request.send();
+
+request.onload = function() {
+  var bytes = request.response;
+  WebAssembly.instantiate(bytes, importObject).then(results => {
+    results.instance.exports.exported_func();
+  });
+};
+ +
+

Примечание: Вы можете увидеть пример этого в действии в xhr-wasm.html.

+
diff --git a/files/ru/webassembly/rust_to_wasm/index.html b/files/ru/webassembly/rust_to_wasm/index.html new file mode 100644 index 0000000000..efc4bd52d0 --- /dev/null +++ b/files/ru/webassembly/rust_to_wasm/index.html @@ -0,0 +1,314 @@ +--- +title: Компиляция Rust в WebAssembly +slug: WebAssembly/Rust_to_wasm +translation_of: WebAssembly/Rust_to_wasm +--- +
{{WebAssemblySidebar}}
+ +

Если уже вы написали некоторый код на Rust, вы можете скомпилировать его в WebAssembly! Из этого руководства вы узнаете всё, что вам нужно знать, чтобы скомпилировать проект на Rust в wasm и использовать его в существующем веб-приложении.

+ +

Примеры использования Rust и WebAssembly

+ +

Существует два основных варианта использования Rust и WebAssembly:

+ + + +

На данный момент команда Rust фокусируется на последнем примере,  его мы рассмотрим здесь. Для первого примера, посмотрите проекты, такие как yew.

+ +

В этом руководстве вы создадите npm-пакет, используя wasm-pack, инструмент построения npm-пакетов в Rust. Этот пакет будет содержать только код WebAssembly и JavaScript, так что его пользователям не нужен будет установщик Rust. Они могут даже не заметить, что он был написан на WebAssembly!

+ +

Настройка окружения Rust

+ +

Давайте пройдемся по всем пунктам, необходимым для настройки нашего окружения.

+ +

Установка Rust

+ +

Чтобы установить Rust, посетите Install Rust страницу и проследуйте всем инструкциям. Так вы установите тулзу, называемую "rustup", которая позволит вам управлять несколькими версиями Rust. По умолчанию, она устанавливает последний стабильный релиз Rust, который вы будете использовать для стандартной разработки на Rust. Rustup устанавливает rustc, компилятор Rust, вместе с cargo, Rust-овским пакетным менеджером, rust-std, стандартной  библиотекой Rust, и несколькими вспомогательными доками — rust-docs.

+ +
+

Заметка: Обратите внимание на пост-установочную заметку о необходимости добавить cargo bin директорию в список PATH. Она должна быть добавлена автоматически, но вам нужно будет перезапустить терминал, чтобы изменения втсупили в силу.

+
+ +

wasm-pack

+ +

Чтобы собрать наш пакет, вам понадобится дополнительный инструмент, wasm-pack. Он поможет нам скомпилировать наш код в WebAssembly и создаст правильный контейнер для нашего пакета для npm. Чтобы скачать и установить, введите в терминале следующую команду:

+ +
$ cargo install wasm-pack
+
+ +

Установка Node.js и получение npm-аккаунта

+ +

В этом руководстве мы будем собирать npm-пакет, поэтому вам понадобится установить Node.js и npm. Дополнительно, мы опубликуем наш пакет на npm, так что вам так же понадобится ваш npm-аккаунт. Они бесплатны! Технически, вы не обязаны ничего публиковать, но так будет проще, так что будем считать, что вы сделаете это в этом руководстве.

+ +

Чтобы получить Node.js и npm, посетите Get npm! страницу и проследуйте инструкциям. Когда настанет время выбрать версию, выберите любую, которая вам нравится; это руководство не зависит от версии.

+ +

Чтобы создать npm-аккаунт, посетите npm signup станицу и заполните форму.

+ +

Дальше запустите в командой строке npm adduser:

+ +
> npm adduser
+Username: yournpmusername
+Password:
+Email: (this IS public) you@example.com
+
+ +

Вам понадобится ввести свое пользовательское имя, пароль и email. Если все получится, вы увидите:

+ +
Logged in as yournpmusername on https://registry.npmjs.org/.
+
+ +

Если что-то пойдет не так, свяжитесь с командой npm, чтобы разобраться.

+ +

Создание WebAssembly npm-пакета

+ +

Хватит установок, давайте создадим новый пакет на Rust. Перейдите в любое место, где вы держите свои личные проекты, и сделайте следующее:

+ +
$ cargo new --lib hello-wasm
+     Создаст проектную библиотеку `hello-wasm`
+
+ +

Это создаст новую библиотеку в под-директории, называемой hello-wasm, со всем, что вам нужно:

+ +
+-- Cargo.toml
++-- src
+    +-- lib.rs
+
+ +

Для начала, у нас есть Cargo.toml; с его помощью мы можем сконфигурировать наш билд. Если вы пользуетесь Gemfile из Bundler или package.json из npm, то вы почувствуете себя, как дома; Cargo работает аналогично обоим.

+ +

Дальше, Cargo сгенерировал кое-какой код для нас на Rust в src/lib.rs:

+ +
#[cfg(test)]
+mod tests {
+    #[test]
+    fn it_works() {
+        assert_eq!(2 + 2, 4);
+    }
+}
+
+ +

Мы не будем использовать этот тестовый код вообще, так что можете просто удалить его.

+ +

Давайте попишем немного на Rust!

+ +

Вместо этого поместите этот код в src/lib.rs:

+ +
extern crate wasm_bindgen;
+
+use wasm_bindgen::prelude::*;
+
+#[wasm_bindgen]
+extern {
+    pub fn alert(s: &str);
+}
+
+#[wasm_bindgen]
+pub fn greet(name: &str) {
+    alert(&format!("Hello, {}!", name));
+}
+
+ +

Это содержимое нашего проекта на Rust. У него есть три основные части, давайте пройдемся по ним по очереди. Мы дадим здесь обощенное пояснение и поясним некоторые детали; чтобы узнать больше о Rust, пожалуйста, просмотрите бесплатную online-книгу The Rust Programming Language.

+ +

Использование wasm-bindgen для коммуникации между Rust и JavaScript

+ +

Первая часть выглядит вот так:

+ +
extern crate wasm_bindgen;
+
+use wasm_bindgen::prelude::*;
+
+ +

Первая строка гласит: "эй, Rust, мы используем библиотеку, называемую wasm_bindgen." Библиотеки в Rust называются "crates" (контейнеры), а так как мы используем внешнюю, то "extern".

+ +

Поняли? Cargo поставляет контейнеры.

+ +

Третья строка содержит команду use, которая импортирует код из библиотеки в наш код. В нашем случае, мы импортируем все из модуля wasm_bindgen::prelude. Мы будем использовать его функции в следующей секции.

+ +

Прежде чем перейти к следующей секции, давайте поговорим немного о wasm-bindgen.

+ +

wasm-pack использует wasm-bindgen, другую тулзу, чтобы предоставить соединение между типами в JavaScript и Rust. Это позволяет JavaScript вызывать Rust-API со строками или функциям Rust перехватывать исключения JavaScript.

+ +

Мы будем использовать функциональность wasm-bindgen в нашем пакете. По факту, это следующая секция!

+ +

Вызов внешних функций JavaScript из Rust

+ +

Следующая часть выглядит так:

+ +
#[wasm_bindgen]
+extern {
+    pub fn alert(s: &str);
+}
+
+ +

Частичка внутри #[] называется "атрибутом", и она кое-как модифицирует следующее за ней утверждение. В нашем случае, это утверждение extern, которое говорит Rust-у, что мы хотим вызвать некоторую функцию, определенную во внешнем пространстве. Атрибут говорит: "wasm-bindgen знает, как найти эти функции".

+ +

Третья строка это имя функции, написанной на Rust. Она говорит: "функция alert  принимает один аргумент, строку с именем s."

+ +

У вас, возможно, есть предположение, что это за функция, и, возможно, ваше предположение верное: это функция alert, предоставляемая JavaScript! Мы будем вызывать эту функцию в следующей секции.

+ +

Когда бы вы не захотели вызвать новую функцию JavaScript, вы можете написать ее здесь, и wasm-bindgen позаботится о том, чтобы настроить все для вас. Пока еще поддерживается не все, но мы работаем над этим! Пожалуйста, сообщайте о проблемах, если что-то было упущено.

+ +

Создание функций Rust, который может вызывать JavaScript

+ +

Финальная часть следующая:

+ +
#[wasm_bindgen]
+pub fn greet(name: &str) {
+    alert(&format!("Hello, {}!", name));
+}
+
+ +

Еще раз, мы видим #[wasm_bindgen] атрибут. В этом случае, он модифицирует не блок extern, а fn; это значит, что мы хотим, чтобы эта функция на Rust была доступна для JavaScript. Прямо противоположно extern: это не те функции, которые нам нужны, а те, что мы предоставляем миру!

+ +

Наша функция называется greet, и она принимает один аргумент, строку (пишется &str), name. Затем она вызывает функцию alert, которую мы запросили в блоке extern выше. Она передает вызов макросу format!, который позволяет нам соеденить строки.

+ +

format! принимает два аргумента в нашем случае: форматируемую строку и переменную, которую должен в нее поместить. Форматируемая строка это "Hello, {}!" часть. Она содержит {}, куда будет вставлена переменная. Переменная, которую мы передаем, это name, аргумент функции, так что если мы вызовем greet("Steve"), то увидим "Hello, Steve!".

+ +

Все это передается в alert(), так что когда мы вызовем функцию, мы увидим алерт с "Hello, Steve!" внутри него!

+ +

Теперь, когда наша библиотека написана, давайте соберем ее.

+ +

Компиляция кода в WebAssembly

+ +

Чтобы правильно скомпилить наш код, сначала нам надо сконфигурировать его с помощью Cargo.toml. Октройте этот файл и измените его так, чтобы он выглядел следующим образом:

+ +
[package]
+name = "hello-wasm"
+version = "0.1.0"
+authors = ["Your Name <you@example.com>"]
+description = "A sample project with wasm-pack"
+license = "MIT/Apache-2.0"
+repository = "https://github.com/yourgithubusername/hello-wasm"
+
+[lib]
+crate-type = ["cdylib"]
+
+[dependencies]
+wasm-bindgen = "0.2"
+
+ +

Вам нужно будет ввести свой личный репозиторий, а Cargo заполнит authors, основываясь на информации git.

+ +

Главная часть находится внизу. Первая — [lib] — говорит Rust собрать cdylib версию нашего пакета; мы не будем вдаваться в то, что это значит в этом руководстве. Чтобы узнать больше, просмотрите Cargo и Rust Linkage документацию.

+ +

Вторая часть это секция [dependencies] . Тут мы говорим Cargo, от какой версии wasm-bindgen мы хотим зависеть; в нашем случае, это любая версия 0.2.z (но не 0.3.0 или выше).

+ +

Сборка пакета

+ +

Теперь, когда мы все установили, давайте соберем проект! Введите это в терминале:

+ +
$ wasm-pack build --scope mynpmusername
+
+ +

Здесь мы сделали несколько вещей (и они займут много времени, особенно если вы запустили wasm-pack впервые). Чтобы изучить их детальней, прочитайте этот блог-пост на Mozilla Hacks. Вкратце, wasm-pack build:

+ +
    +
  1. Компилирует ваш Rust-код в WebAssembly.
    2. +
  2. Запускает wasm-bindgen с этим WebAssembly, генерируя JavaScript файл, который оборачивает WebAssembly файл в модуль. который может понять npm.
    3. +
  3. Создает папку pkg, куда перемещает этот JavaScript файл и ваш код WebAssembly.
    4. +
  4. Читает ваш Cargo.toml и создает эквивалентный package.json.
    5. +
  5. Копирует ваш README.md (если есть) в пакет.
    6. +
+ +

Конечный результат? У вас есть npm-пакет внутри папки pkg.

+ +

Отступление о размере кода

+ +

Если вы посмотрите на размер кода, сгенерированного для WebAssembly, это может быть около сотни килобайт. Мы вообще не инструктировали Rust оптимизировать размер, и он сильно его снизил. Это не является частью этого руководства, но если вам интересно, прочитайте документацию Rust WebAssembly Working Group на Shrinking .wasm Size.

+ +

Публикация нашего пакета на npm

+ +

Давайте опубликуем наш новый пакет на npm:

+ +
$ cd pkg
+$ npm publish --access=public
+
+ +

Теперь у нас есть npm-пакет, написанный на Rust, но скомпилированный в WebAssembly. Он готов к использованию из JavaScript, и его пользователь не нуждается в установке Rust; код внутри пакета написан на WebAssembly, не на Rust!

+ +

Использование пакета в web

+ +

Давайте создадим сайт, который будет использовать наш пакет! Многие пользуются пакетами npm с помощью разных сборщиков, и мы будем использовать один из них, webpack, в этом руководстве. Он только немного более усложненный, но описывает более реалистичный вариант использования.

+ +

Давайте выйдем из нашей папки pkg и создадим новую, site, чтобы попробовать в ней следующее:

+ +
$ cd ../..
+$ mkdir site
+$ cd site
+
+ +

Создайте новый файл, package.json, и поместите в него следующий код:

+ +
{
+  "scripts": {
+    "serve": "webpack-dev-server"
+  },
+  "dependencies": {
+    "@mynpmusername/hello-wasm": "^0.1.0"
+  },
+  "devDependencies": {
+    "webpack": "^4.25.1",
+    "webpack-cli": "^3.1.2",
+    "webpack-dev-server": "^3.1.10"
+  }
+}
+
+ +

Заметьте, что вам нужно ввести свое пользовательское имя после @ в секции зависемостей.

+ +

Дальше нам нужно сконфигурировать Webpack. Создайте webpack.config.js и введите следующее:

+ +
const path = require('path');
+module.exports = {
+  entry: "./index.js",
+  output: {
+    path: path.resolve(__dirname, "dist"),
+    filename: "index.js",
+  },
+  mode: "development"
+};
+
+ +

Теперь нам нужен HTML-файл; создайте index.html и поместите в него:

+ +
<!DOCTYPE html>
+<html>
+  <head>
+    <meta charset="utf-8">
+    <title>hello-wasm example</title>
+  </head>
+  <body>
+    <script src="./index.js"></script>
+  </body>
+</html>
+
+ +

Наконец, создайте index.js, на который мы сослались в HTML-файле, и вставьте:

+ +
const js = import("./node_modules/@yournpmusername/hello-wasm/hello_wasm.js");
+js.then(js => {
+  js.greet("WebAssembly");
+});
+
+ +

Заметьте, что вам нужно будет снова ввести ваше имя для npm.

+ +

Так мы импортируем наш модуль из папки node_modules. Это не считается лучшей практикой, но это пример, так что пока сойдет. Как только файл загрузится, он вызовет функцию greet из этого модуля, передав "WebAssembly", как строку. Обратите внимание, что здесь нет ничего особенного, и все же мы вызываем код на Rust! Насколько JavaScript код может судить, это просто обычный модуль.

+ +

Мы закончили! Давайте попробуем:

+ +
$ npm install
+$ npm run serve
+
+ +

Так мы запустим сервер. Откройте http://localhost:8080 и вы увидете алерт с надписью Hello, WebAssembly!  в нем! Мы успешно обратились из JavaScript в Rust и из Rust в JavaScript.

+ +

Заключение

+ +

На этом руководство заканчивается, мы надеемся, что вы сочли его для себя полезным.

+ +

В этом направлении кипит бурная и при этом очень интересная деятельность, так что если вы бы хотели помочь что-то улучшить, то загляните в the Rust Webassembly Working Group.

diff --git a/files/ru/webassembly/understanding_the_text_format/index.html b/files/ru/webassembly/understanding_the_text_format/index.html new file mode 100644 index 0000000000..9acdd0af80 --- /dev/null +++ b/files/ru/webassembly/understanding_the_text_format/index.html @@ -0,0 +1,537 @@ +--- +title: Описание текстового формата WebAssembly +slug: WebAssembly/Understanding_the_text_format +translation_of: WebAssembly/Understanding_the_text_format +--- +
{{WebAssemblySidebar}}
+ +

Чтобы люди могли читать и редактировать код WebAssembly, существует текстовое представление двоичного формата wasm. Это промежуточная форма, предназначенная для отображения в текстовых редакторах, средствах разработки браузеров и т. д. В этой статье объясняется, как работает этот текстовый формат с точки зрения синтаксиса, как он связан с байт-кодом, который он представляет и оболочками объектов wasm в JavaScript.

+ +
+

Примечание: Ознакомление с данной статьей может оказаться излишним, если вы веб-разработчик, который просто хочет загрузить модуль wasm на страницу и использовать его в своем коде (см. Использование WebAssembly JavaScript API). Эта статья будет наиболее полезной, если вы хотите написать несколько модулей wasm для оптимизации производительности вашей библиотеки JavaScript или создать свой собственный компилятор WebAssembly.

+
+ +

S-выражения

+ +

Как в двоичном, так и в текстовом форматах основным блоком кода в WebAssembly является модуль. В текстовом формате модуль представлен как одно большое S-выражение. S-выражения - это очень старый и очень простой текстовый формат для представления деревьев. И поэтому мы можем думать о модуле как о дереве узлов, которые описывают структуру модуля и его код. В отличие от абстрактного синтаксического дерева в языке программирования, дерево WebAssembly довольно плоское и состоит в основном из списков инструкций.

+ +

Во-первых, давайте посмотрим, как выглядит S-выражение. Каждый узел дерева входит в пару круглых скобок - ( ... ). Первая метка в скобках сообщает вам, какой это тип узла, за ним следует разделенный пробелами список атрибутов или дочерних узлов. Давайте рассмотрим, что  означает следующее S-выражение WebAssembly:

+ +
(module (memory 1) (func))
+ +

Это выражение представляет дерево с корневым узлом «module» и двумя дочерними узлами - узлом «memory» с атрибутом «1» и узлом «func». Мы вскоре увидим, что на самом деле означают эти узлы.

+ +

Самый простой модуль

+ +

Давайте начнем с самого простого модуля wasm.

+ +
(module)
+ +

Этот модуль полностью пуст, но является допустимым.

+ +

Если мы сейчас преобразуем наш модуль в двоичный формат (см. Перевод текстового формата WebAssembly в wasm), мы увидим только 8-байтовый заголовок модуля, описанный в двоичном формате:

+ +
0000000: 0061 736d              ; WASM_BINARY_MAGIC
+0000004: 0100 0000              ; WASM_BINARY_VERSION
+ +

Добавление функциональности в ваш модуль

+ +

Хорошо, это не очень интересно, давайте добавим немного исполняемого кода в этот модуль.

+ +

Весь код в модуле сгруппирован в функции, которые имеют следующую структуру псевдокода:

+ +
( func <signature> <locals> <body> )
+ + + +

Несмотря на то, что это S-выражение, оно очень напоминает функцию в других языках.

+ +

Сигнатуры и параметры

+ +

Сигнатура - это последовательность объявлений типов параметров, за которыми следует список объявлений возвращаемых типов. Здесь стоит отметить, что:

+ + + +

    Каждый параметр имеет явно объявленный тип; у wasm в настоящее время есть четыре доступных типа:

+ + + +

Один параметр можно записать как (param i32), а тип возвращаемого значения как (result i32). Двоичная функция, которая принимает два 32-разрядных целых числа и возвращает 64-разрядное число с плавающей запятой, будет записана следующим образом:

+ +
(func (param i32) (param i32) (result f64) ... )
+ +

После сигнатуры перечисляются локальные переменные с указанием типа, например (local i32). Параметры в сигнатуре приравниваются к локальным переменным, которые инициализируются значением соответствующего аргумента, переданного вызывающей стороной.

+ +

Получение и установка локальных переменных и параметров функции

+ +

И параметры и локальные переменные могут быть прочитаны и записаны в теле функции с помощью инструкций get_local и set_local.

+ +

Инструкции get_local и set_local ссылаются по индексу на параметр, который должен быть получен или  установлен: сначала считаются параметры, а затем локальные переменные в порядке их объявления. Объясним это на примере следующей функции:

+ +
(func (param i32) (param f32) (local f64)
+  get_local 0
+  get_local 1
+  get_local 2)
+ +

Инструкция get_local 0 получит параметр i32, get_local 1 получит параметр f32, а get_local 2 получит локальную переменную local f64.

+ +

Использование числовых индексов для ссылки на элементы может сбивать с толку и раздражать, поэтому текстовый формат позволяет присваивать имена параметрам, локальным переменным и большинству других элементов. Для этого нужно просто добавить имя с префиксом символа доллара ($) непосредственно перед объявлением типа.

+ +

Таким образом, можно переписать нашу сигнатуру так:

+ +
(func (param $p1 i32) (param $p2 f32) (local $loc f64) …)
+ +

После чего можно было бы написать инструкцию получения get_local $p1 вместо get_local 0 и т.д. (Обратите внимание, что, когда этот текст преобразуется в двоичный файл, двоичный файл будет содержать только индексы.)

+ +

Стековые машины

+ +

Прежде чем мы сможем написать тело функции, мы должны поговорить еще о стековых машинах. Хотя браузер компилирует wasm-код во что-то более эффективное, выполнение его определяется в терминах стековой машины, где основная идея заключается в том, что каждый тип инструкции получает или помещает определенное количество значений i32 / i64 / f32 / f64 в стек или из стека.

+ +

Например, инструкция get_local предназначена для помещения значения локальной переменной, которое она считала, в стек. А инструкция i32.add получает два значения i32 (неявно получает два предыдущих значения, помещенных в стек), вычисляет их сумму и помещает назад в стек результат вычисления i32.

+ +

Когда вызывается функция, для нее выделяется пустой стек, который постепенно заполняется и очищается при выполнении инструкций в теле функции. Так, например, после выполнения следующей функции:

+ +
(func (param $p i32)
+  get_local $p
+  get_local $p
+  i32.add)
+ +

Стек будет содержать ровно одно значение i32 - результат выполнения выражения ($p + $p), которое обработалось инструкцией i32.add. Возвращаемое значение функции - это  последнее значение, оставленное в стеке.

+ +

Правила валидации WebAssembly гарантируют, выполнение следующего: если вы объявляете тип возвращаемого значения функции как (result f32), то стек должен содержать ровно одно значение типа f32 в конце. Если тип результата отсутствует, стек должен быть пустым.

+ +

Тело функции

+ +

Как упоминалось ранее, тело функции - это просто список инструкций, которые выполняются при вызове функции. Объединяя это с тем, что мы уже изучили, мы можем наконец определить модуль, содержащий простую функцию:

+ +
(module
+  (func (param $lhs i32) (param $rhs i32) (result i32)
+    get_local $lhs
+    get_local $rhs
+    i32.add))
+ +

Эта функция получает два параметра, складывает их вместе и возвращает результат.

+ +

Есть еще много инструкций, которые можно поместить в тело функции. Сейчас мы начнем с простых, а далее вы увидите гораздо больше примеров по мере продвижения. Полный список доступных инструкций смотрите в справочнике по семантике webassembly.org.

+ +

Вызов функции

+ +

Определение нашей функции само по себе почти ничего не делает - теперь нам нужно её вызвать. Как мы это сделаем? Как и в модуле ES2015, функции wasm должны быть явно экспортированы инструкцией export внутри модуля.

+ +

Как и локальные переменные, функции идентифицируются индексом по умолчанию, но для удобства им можно присвоить имя. Давайте это сделаем: сначала добавим имя, которому предшествует знак доллара, сразу после ключевого слова func:

+ +
(func $add … )
+ +

Теперь нам нужно добавить объявление экспорта:

+ +
(export "add" (func $add))
+ +

Здесь add - это имя, по которому функция будет идентифицироваться в коде JavaScript, а $add определяет, какая функция внутри модуля WebAssembly будет экспортироваться.

+ +

Итак, наш последний вариант модуля (на данный момент) выглядит так:

+ +
(module
+  (func $add (param $lhs i32) (param $rhs i32) (result i32)
+    get_local $lhs
+    get_local $rhs
+    i32.add)
+  (export "add" (func $add))
+)
+ +

Если вы хотите собственноручно скомпилировать пример, сохраните ранее написанный модуль в файле с именем add.wat, а затем преобразуйте его в двоичный файл с именем add.wasm, используя wabt (подробности смотрите в разделе Перевод текстового формата WebAssembly в wasm).

+ +

Затем мы загрузим наш двоичный файл, скомпилируем, создадим его экземпляр и выполним нашу функцию add в коде JavaScript (теперь нам доступна функция add() в свойстве exports экземпляра модуля):

+ +
WebAssembly.instantiateStreaming(fetch('add.wasm'))
+.then(obj => {
+   console.log(obj.instance.exports.add(1, 2));  // "3"
+});
+ +
+

Примечание: Вы можете найти этот пример на GitHub в файле add.html (смотрите также это вживую). Также смотрите {{jsxref("WebAssembly.instantiateStreaming()")}} для получения более подробной информации о функции создания экземпляра модуля.

+
+ +

Изучение основ

+ +

Теперь, когда мы рассмотрели простейшие примеры, давайте перейдем к рассмотрению некоторых более сложных возможностей.

+ +

Вызов функций из других функций в том же модуле

+ +

Для вызова функци по индексу или имени используется инструкция call. Например, следующий модуль содержит две функции - первая просто возвращает значение 42, вторая возвращает сумму результата вызова первой функции и единицы:

+ +
(module
+  (func $getAnswer (result i32)
+    i32.const 42)
+  (func (export "getAnswerPlus1") (result i32)
+    call $getAnswer
+    i32.const 1
+    i32.add))
+ +
+

Примечание: Инструкция i32.const создает 32-разрядное целое число и помещает его в стек. Вы можете поменять i32 на любой другой доступный тип данных и изменить значение на любое другое (здесь мы установили значение 42).

+
+ +

В этом примере обратите внимание на секцию объявления экспорта (export “getAnswerPlus1”), которая находится сразу после объявления второй функции func. Это сокращенный способ объявления, совмещенный с именем функции, которую мы хотим экспортировать.

+ +

Функционально это эквивалентно включению отдельного объявления экспорта функции без функции, в любом месте модуля, например:

+ +
(export "getAnswerPlus1" (func $functionName))
+ +

Код JavaScript для вызова экспортируемой функции из нашего модуля выглядит так:

+ +
WebAssembly.instantiateStreaming(fetch('call.wasm'))
+.then(obj => {
+   console.log(obj.instance.exports.getAnswerPlus1());  // "43"
+});
+ +
+

Примечание: Вы можете найти этот пример на GitHub как call.html (смотрите также вживую). Еще посмотрите wasm-utils.js для метода fetchAndInstantiate().

+
+ +

Импорт функций из JavaScript

+ +

Мы уже видели JavaScript, вызывающий экспортируемые функции модуля WebAssembly, но как насчет WebAssembly модуля, вызывающего функции JavaScript? WebAssembly не имеет каких либо знаний о внешнем коде JavaScript, но у него есть  способ импорта, который может принимать функции из JavaScript или wasm. Давайте посмотрим на пример:

+ +
(module
+  (import "console" "log" (func $log (param i32)))
+  (func (export "logIt")
+    i32.const 13
+    call $log))
+ +

В инструкции импорта в модуль WebAssembly определено двухуровневое пространство имен, в котором мы указали импортировать функцию log из модуля console. Вы также можете видеть, что экспортируемая функция logIt вызывает импортированную функцию, используя инструкцию call, о которой мы говорили ранее.

+ +

Импортируемые функции аналогичны обычным функциям: они имеют сигнатуру, которую WebAssembly проверяет статически, им присваивается индекс (в место которого можно  присвоить имя) и их можно вызвать обычным способом.

+ +

Функции JavaScript не имеют понятия сигнатуры, поэтому любую функцию JavaScript можно передать независимо от объявленной сигнатуры импорта. Если модуль объявляет импорт, вызывающая сторона (например метод {{jsxref("WebAssembly.instantiate()")}}) должна передать объект импорта, который должен иметь соответствующее свойство.

+ +

Для иллюстрации вышесказанного нам нужен объект (назовем его importObject), в котором  конечное свойство importObject.console.log должно содержать функцию JavaScript.

+ +

Код будет выглядеть следующим образом:

+ +
var importObject = {
+  console: {
+    log: function(arg) {
+      console.log(arg);
+    }
+  }
+};
+
+WebAssembly.instantiateStreaming(fetch('logger.wasm'), importObject)
+.then(obj => {
+  obj.instance.exports.logIt();
+});
+ +
+

Примечание: Этот пример можно найти на GitHub в файле logger.html (смотрите также вживую).

+
+ +

Определение глобальных переменных WebAssembly

+ +

WebAssembly имеет возможность создавать экземпляры глобальных переменных. Они доступны как в коде JavaScript, так и через импорт / экспорт для одиного и более экземпляров {{jsxref("WebAssembly.Module")}}. Это очень полезная возможность в плане динамического связывания нескольких модулей.

+ +

В текстовом формате WebAssembly это выглядит примерно так (смотрите файл global.html в нашем репозитории на GitHub; смотрите также вживую):

+ +
(module
+   (global $g (import "js" "global") (mut i32))
+   (func (export "getGlobal") (result i32)
+        (get_global $g))
+   (func (export "incGlobal")
+        (set_global $g
+            (i32.add (get_global $g) (i32.const 1))))
+)
+ +

Это похоже на то, что мы делали раньше, за исключением того, что мы указываем глобальную переменную с помощью ключевого слова global. Также мы указываем ключевое слово mut вместе с типом данных значения (если хотим, чтобы глобальная переменная была изменяемой).

+ +

Чтобы создать эквивалентный код с помощью JavaScript, вы должны использовать конструктор {{jsxref("WebAssembly.Global()")}}:

+ +
const global = new WebAssembly.Global({value:'i32', mutable:true}, 0);
+ +

Память WebAssembly

+ +

Приведенный выше пример - довольно ужасная функция ведения журнала: она печатает только одно целое число! Что если мы хотим записать текстовую строку? Для работы со строками и другими более сложными типами данных WebAssembly предоставляет линейную память. Согласно технологии WebAssembly, линейная память - это просто большой массив байтов, который со временем может увеличиваться. WebAssembly код содержит ряд инструкций, наподобие i32.load и i32.store для чтения и записи значений из линейной памяти.

+ +

Со стороны JavaScript, линейная память как будто находится внутри одного большого (расширяющегося) объекта {{domxref("ArrayBuffer")}}.

+ +

Таким образом, строка - это просто последовательность байтов где-то внутри этой линейной памяти. Давайте предположим, что мы записали нужную строку байтов в память; как мы передадим эту строку в JavaScript?
+ Ключевым моментом является то, что JavaScript может создавать экземпляры(объекты) линейной памяти WebAssembly через конструктор {{jsxref("WebAssembly.Memory()")}} и получать доступ к существующему экземпляру памяти (в настоящее время вы можете иметь только один экземпляр памяти на экземпляр модуля), используя соответствующие методы экземпляра модуля. Экземпляр памяти имеет свойство buffer, которое возвращает объект ArrayBuffer, предоставляя всю линейную память модуля.

+ +

Объекты памяти могут расширятся с помощью метода Memory.grow() из JavaScript. Когда происходит расширение, текущий объект ArrayBuffer не может изменить размер и он отсоединяется. Вместо него создается новый объект ArrayBuffer, указывающий на новую, увеличенную память. Пользуясь этими возможностями можно передать строку в  JavaScript, её начальный индекс и её длину в линейной памяти.

+ +

Хотя есть много разных способов кодировать длину строки в самой строке (например, как в строках в C); для простоты здесь мы просто передаем смещение и длину в качестве параметров:

+ +
(import "console" "log" (func $log (param i32) (param i32)))
+ +

На стороне JavaScript, мы можем использовать TextDecoder API, чтобы легко декодировать наши байты в строку JavaScript. (Мы указываем кодировку utf8, хотя поддерживаются и другие кодировки.)

+ +
function consoleLogString(offset, length) {
+  var bytes = new Uint8Array(memory.buffer, offset, length);
+  var string = new TextDecoder('utf8').decode(bytes);
+  console.log(string);
+}
+ +

Последний недостающий фрагмент головоломки - это место, где функция consoleLogString получает доступ к памяти (memory) WebAssembly. WebAssembly дает нам здесь много гибкости: либо мы можем создать объект Memory в коде JavaScript и импортировать его в модуль WebAssembly, или мы можем создать его в модуле WebAssembly и затем экспортировать в  JavaScript.

+ +

Для простоты, давайте создадим объект памяти в JavaScript и импортируем его в  WebAssembly модуль. Напишем следующее объявление импорта (import):

+ +
(import "js" "mem" (memory 1))
+ +

Число 1 указывает, что импортируемая память должна иметь по крайней мере 1 страницу памяти (WebAssembly определяет страницу как фиксированный блок памяти в 64КБ.)

+ +

Давайте взглянем на наш последний вариант модуля, который выводит слово “Hi”. В обычной C программе, мы бы вызывали функцию для выделения памяти для строки. Но так как мы пишем собственную сборку и у нас есть собственная импортируемая память, то мы просто пишем содержание строки в линейную память, используя секцию data. Data-секция во время создания записывает строку байт, начиная с указанного отступа. И она действует также как и .data секция в “родных” форматах для исполнения.

+ +

Наш последний вариант модуля выглядит так:

+ +
(module
+  (import "console" "log" (func $log (param i32 i32)))
+  (import "js" "mem" (memory 1))
+  (data (i32.const 0) "Hi")
+  (func (export "writeHi")
+    i32.const 0  ;; pass offset 0 to log
+    i32.const 2  ;; pass length 2 to log
+    call $log))
+ +
+

Примечание: Обратите внимание, что двойная точка с запятой (;;) позволяет оставлять комментарии в файлах WebAssembly.

+
+ +

Теперь из JavaScript мы можем создать и передать объект памяти размером в 1 страницу. Результатом работы этого кода будет вывод “Hi” в консоль:

+ +
var memory = new WebAssembly.Memory({initial:1});
+
+var importObject = { console: { log: consoleLogString }, js: { mem: memory } };
+
+WebAssembly.instantiateStreaming(fetch('logger2.wasm'), importObject)
+.then(obj => {
+  obj.instance.exports.writeHi();
+});
+ +
+

Примечание: Вы можете найти полный исходный код на GitHub в файле logger2.html (также смотрите это вживую).

+
+ +

Таблицы WebAssembly

+ +

Чтобы завершить обзор текстового формата WebAssembly, давайте рассмотрим самую сложную и запутанную часть WebAssembly - таблицы. Таблицы - это массивы ссылок изменяемого размера, доступ к которым можно получить по индексу из кода WebAssembly.

+ +

Чтобы понять, зачем нужны таблицы, нам нужно сначала обратить внимание, что инструкция call, которую мы видели ранее (см. {{anch("Вызов функций из других функций в том же модуле")}}), принимает статический индекс функции и может вызывать только определенную функцию. Но что, если вызываемый элемент будет значением, установленным во время выполнения?

+ + + +

Для того чтобы сделать это в WebAssembly нужен был отдельный тип инструкции вызова.  Поэтому мы создали инструкцию call_indirect, которая принимает операнд динамической функции. Проблема в том, что типы данных, которые мы должны использовать в операндах в WebAssembly, в настоящее время такие: i32 / i64 / f32 / f64.

+ +

Для WebAssembly можно было бы создать тип инструкции вызова  anyfunc («любой», потому что эта инструкция смогла вызвать функции любой сигнатуры), но, к сожалению, операнд этого типа не может быть сохранен в линейной памяти по соображениям безопасности. Линейная память представляет содержимое хранимых значений в виде незащищенных байтов, и это позволяет содержимому wasm произвольно читать и изменять незащищенные адреса функций, что недопустимо для веб.

+ +

Решением стало следующее. Хранить ссылки на функции в таблице и передавать вместо них индексы таблицы, которые являются просто значениями i32. Поэтому операндом инструкции call_indirect может выступить простое значение индекса i32.

+ +

Определение таблицы в wasm

+ +

Так как же разместить функции wasm в нашей таблице? Подобно тому, как секции data могут использоваться для инициализации областей линейной памяти байтами, секции elem  могут использоваться для инициализации областей таблиц с функциями:

+ +
(module
+  (table 2 anyfunc)
+  (elem (i32.const 0) $f1 $f2)
+  (func $f1 (result i32)
+    i32.const 42)
+  (func $f2 (result i32)
+    i32.const 13)
+  ...
+)
+ + + +
+

Примечание: Неинициализированным элементам присваивается значение вызова по умолчанию.

+
+ +

В JavaScript эквивалентный код для создания такого экземпляра таблицы ссылок будет выглядеть примерно так:

+ +
function() {
+  // table section
+  var tbl = new WebAssembly.Table({initial:2, element:"anyfunc"});
+
+  // function sections:
+  var f1 = function() { … }
+  var f2 = function() { … }
+
+  // elem section
+  tbl.set(0, f1);
+  tbl.set(1, f2);
+};
+ +

Использование таблицы

+ +

Мы определили таблицу, которую нам нужно как-то использовать. Для этого добавим следующую секцию кода:

+ +
(type $return_i32 (func (result i32))) ;; if this was f32, type checking would fail
+(func (export "callByIndex") (param $i i32) (result i32)
+  get_local $i
+  call_indirect (type $return_i32))
+ + + +

Вы также можете объявить параметр call_indirect явно во время вызова инструкции, а не до него (неявным получением из стека), например так:

+ +
(call_indirect (type $return_i32) (get_local $i))
+ +

На языке высокого уровня, таком как JavaScript эти же действия вы можете представить в виде манипуляций с массивом (или, скорее, с объектом), содержащим функции. Псевдокод будет выглядеть примерно так: tbl[i]().

+ +

Итак, вернемся к проверке типов. Так как в коде WebAssembly проверяются типы, а атрибут anyfunc означает “сигнатура любой функции", мы должны предоставить предполагаемую сигнатуру в месте вызова, поэтому мы включаем тип с именем $return_i32, чтобы сообщить программе, что ожидается функция, возвращающая значение с типом i32. Если вызываемая функция не имеет соответствующей сигнатуры (скажем, вместо нее возвращается f32), выбросится исключение {{jsxref("WebAssembly.RuntimeError")}}.

+ +

Так как инструкция call_indirect связывается с таблицей, с которой мы вызываем функцию? Ответ заключается в том, что на данный момент для каждого экземпляра модуля разрешена только одна таблица. Поэтому инструкция call_indirect выполняет неявный вызов именно из этой таблицы. В будущем, когда будет разрешено использование нескольких таблиц, нам нужно будет указать идентификатор таблицы, например так:

+ +
call_indirect $my_spicy_table (type $i32_to_void)
+ +

Весь модуль в целом выглядит следующим образом и может быть найден в нашем примере файла wasm-table.wat:

+ +
(module
+  (table 2 anyfunc)
+  (func $f1 (result i32)
+    i32.const 42)
+  (func $f2 (result i32)
+    i32.const 13)
+  (elem (i32.const 0) $f1 $f2)
+  (type $return_i32 (func (result i32)))
+  (func (export "callByIndex") (param $i i32) (result i32)
+    get_local $i
+    call_indirect (type $return_i32))
+)
+ +

Загрузка модуля и использование экспортируемой функции в коде JavaScript будет выглядеть так:

+ +
WebAssembly.instantiateStreaming(fetch('wasm-table.wasm'))
+.then(obj => {
+  console.log(obj.instance.exports.callByIndex(0)); // returns 42
+  console.log(obj.instance.exports.callByIndex(1)); // returns 13
+  console.log(obj.instance.exports.callByIndex(2)); // returns an error, because there is no index position 2 in the table
+});
+ +
+

Примечание: Этот пример можно найти на GitHub в файле wasm-table.html (смотрите это также вживую)

+
+ +
+

Примечание: Как и в случае с памятью, таблицы также можно создавать из кода JavaScript (см. WebAssembly.Table()).

+
+ +

Изменяющиеся таблицы и динамическое связывание

+ +

Поскольку JavaScript имеет полный доступ к ссылкам на функции, объект таблицы может быть изменен из кода JavaScript с помощью методов grow(), get() и set(). Когда WebAssembly получит ссылочные типы, код WebAssembly сможет изменять таблицы самостоятельно с помощью инструкций get_elem / set_elem.

+ +

Поскольку таблицы являются изменяемыми, их можно использовать для реализации сложных схем динамического связывания во время загрузки и во время выполнения. Когда программа динамически связана, несколько экземпляров могут совместно использовать линейную память и таблицу ссылок. Это похоже на поведение в обычном приложении где несколько скомпилированных .dll совместно используют адресное пространство одного процесса.

+ +

Чтобы увидеть это в действии, мы создадим один объект импорта, содержащий объект памяти и объект таблицы. Далее мы передадим этот объект импорта при создании нескольких модулей с помощью метода instantiate().

+ +

Наши примеры файлов .wat выглядят так:

+ +

shared0.wat:

+ +
(module
+  (import "js" "memory" (memory 1))
+  (import "js" "table" (table 1 anyfunc))
+  (elem (i32.const 0) $shared0func)
+  (func $shared0func (result i32)
+   i32.const 0
+   i32.load)
+)
+ +

shared1.wat:

+ +
(module
+  (import "js" "memory" (memory 1))
+  (import "js" "table" (table 1 anyfunc))
+  (type $void_to_i32 (func (result i32)))
+  (func (export "doIt") (result i32)
+   i32.const 0
+   i32.const 42
+   i32.store  ;; store 42 at address 0
+   i32.const 0
+   call_indirect (type $void_to_i32))
+)
+ +

Они работают следующим образом:

+ +
    +
  1. Функция shared0func определена в shared0.wat и сохраняется в нашей импортированной таблице.
    2. +
  2. Эта функция создает константу, содержащую значение 0, затем инструкция i32.load получает значение из импортированной памяти по предоставленному константой индексу. Предоставленный  индекс равен 0. Как и другие подобные инструкции, i32.load неявно получает предоставленное значение из стека. Итак, shared0func загружает и возвращает значение, хранящееся в индексе памяти 0.
    3. +
  3. В shared1.wat мы экспортируем функцию с именем doIt - эта функция размещает в стеке  две константы, содержащие значения 0 и 42. Затем она вызывает инструкцию i32.store для сохранения предоставленного значения по предоставленному индексу в импортированной памяти. Опять же, инструкция неявно получает эти значения из стека. Поэтому в результате doIt сохраняет значение 42 в индексе памяти 0.
    4. +
  4. В последней части функции создается константа со значением 0, затем вызывается  функция с этим индексом (0) из таблицы. Это будет функция shared0func модуля shared0.wat, которая ранее была размещена там с помощью секции elem.
    5. +
  5. При вызове shared0func загружает число 42, которые мы сохранили в памяти, с помощью ранее указанной инструкции i32.store в модуле shared1.wat.
    6. +
+ +
+

Примечание: Вышеприведенные выражения неявно извлекают значения из стека, но вместо этого вы можете объявить их явно в вызовах инструкций, например:

+ +
(i32.store (i32.const 0) (i32.const 42))
+(call_indirect (type $void_to_i32) (i32.const 0))
+
+ +

После преобразования текста в модули мы используем файлы shared0.wasm и shared1.wasm в JavaScript с помощью следующего кода:

+ +
var importObj = {
+  js: {
+    memory : new WebAssembly.Memory({ initial: 1 }),
+    table : new WebAssembly.Table({ initial: 1, element: "anyfunc" })
+  }
+};
+
+Promise.all([
+  WebAssembly.instantiateStreaming(fetch('shared0.wasm'), importObj),
+  WebAssembly.instantiateStreaming(fetch('shared1.wasm'), importObj)
+]).then(function(results) {
+  console.log(results[1].instance.exports.doIt());  // prints 42
+});
+ +

Каждый из компилируемых модулей может импортировать общие объекты памяти и таблицы. Таким образом, они могут совместно использовать одну и ту же линейную память и таблицу ссылок.

+ +
+

Примечание: Этот пример можно найти на GitHub в файле shared-address-space.html (смотрите это также вживую).

+
+ +

Резюме

+ +

На этом мы завершаем обзор основных компонентов текстового формата WebAssembly и того, как они отображены в WebAssembly JS API.

+ +

Смотрите также

+ + diff --git a/files/ru/webassembly/using_the_javascript_api/index.html b/files/ru/webassembly/using_the_javascript_api/index.html new file mode 100644 index 0000000000..d480825a10 --- /dev/null +++ b/files/ru/webassembly/using_the_javascript_api/index.html @@ -0,0 +1,302 @@ +--- +title: Использование WebAssembly JavaScript API +slug: WebAssembly/Using_the_JavaScript_API +tags: + - API + - JavaScript + - WebAssembly +translation_of: WebAssembly/Using_the_JavaScript_API +--- +
{{WebAssemblySidebar}}
+ +

Если вы уже компилировали модуль из другого языка, используя такие инструменты как Emscripten, или загружали и запускали код, то следующим шагом будет углубленное изучение возможностей WebAssembly JavaScript API. Эта статья даст необходимые знания по этому вопросу.

+ +
+

Примечание: Если вы незнакомы с фундаментальными понятиями, упомянутыми в этой статье, и вам нужны дополнительные объяснения, то вам нужно сначала прочитать про Основы WebAssembly.

+
+ +

Несколько простых примеров

+ +

Давайте запустим несколько примеров, которые объяснят как использовать WebAssembly JavaScript API, и как использовать его для загрузки wasm-модуля в web-странице.

+ +
+

Примечание: Вы можете найти примеры кода в нашем репозитории webassembly-examples на GitHub.

+
+ +

Подготовка примера

+ +
    +
  1. Для начала нам нужен wasm-модуль! Возьмите наш файл simple.wasm и сохраните копию в новой директории на своем локальном компьютере.
    2. +
  2. Далее, давайте создадим в той же директории что и wasm-модуль простой HTML-файл и назовем его index.html (можно использовать HTML шаблон если вы этого еще не сделали).
    3. +
  3. Теперь, для того чтобы понять что происходит в коде модуля, давайте взглянем на его текстовое представление (которое мы также встречали в Перевод из текстового формата WebAssembly в wasm): + 
    (module
+  (func $i (import "imports" "imported_func") (param i32))
+  (func (export "exported_func")
+    i32.const 42
+    call $i))
    +
    4. +
  4. Во второй строчке вы видите что import имеет двухуровневое пространство имен - внутренняя функция $i импортирована из imports.imported_func. Нам нужно создать это двухуровневое пространство имен в JavaScript-объекте, который будет импортирован в wasm-модуль. Создайте <script></script> элемент в своем HTML-файле, и добавьте следующий код: + 
    var importObject = {
+  imports: { imported_func: arg => console.log(arg) }
+};
    +
    5. +
+ +

Загрузка wasm-модуля в потоке

+ +

Новшество в Firefox 58 - это возможность компилировать и создавать экземпляры (объекты) модулей WebAssembly непосредственно из исходников. Это достигается использованием методов {{jsxref("WebAssembly.compileStreaming()")}} и {{jsxref("WebAssembly.instantiateStreaming()")}}. Эти методы занимают меньше места чем их непотоковые аналоги, потому что они могут преобразовывать байт-код прямо в модуль или экземпляр модуля, исключая необходимость отдельного размещения ответа ({{domxref("Response")}}) в объекте {{domxref("ArrayBuffer")}} после загрузки файла.

+ +

Следующий пример (см. наш демонстрационный файл instantiate-streaming.html на GitHub и его работу вживую) показывает как использовать instantiateStreaming() чтобы загрузить wasm-модуль, импортировать JavaScript функцию в него, компилировать, создать его экземпляр и получить доступ к его экспортируемой функции. Все это в одном шаге.

+ +

Добавьте этот скрипт ниже первого блока кода:

+ +
WebAssembly.instantiateStreaming(fetch('simple.wasm'), importObject)
+.then(obj => obj.instance.exports.exported_func());
+ +

В конце этого действия мы вызываем нашу экспортированную из WebAssembly-функцию exported_func, которая в свою очередь вызывает нашу импортированную JavaScript-функцию imported_func, которая выводит в консоль значение (42), что хранится внутри экземпляра модуля WebAssembly. Если вы сейчас сохраните пример кода и загрузите его в браузер, который поддерживает WebAssembly, вы увидите это в действии!

+ +
+

Примечание: Этот замысловатый и запутанный пример почти ничего не делает, но он служит иллюстрацией того, что можно одновременно использовать WebAssembly-код и JavaScript-код в ваших приложениях. Как мы утверждали ранее, технология WebAssembly не призвана заменить JavaScript. Вместо этого две технологии могут работать вместе, усиливая преимущества каждой стороны.

+
+ +

Загрузка wasm-модуля без потока

+ +

Если вы не можете или не хотите использовать методы описанные выше, то вы можете использовать вместо этого непотоковые методы {{jsxref("WebAssembly.compile")}} / {{jsxref("WebAssembly.instantiate")}}.

+ +

Эти методы не получают непосредственно доступ к байт-коду, так что требуется дополнительный шаг помещения ответа загрузки файла в объект {{domxref("ArrayBuffer")}} перед компилированием и созданием экземпляра wasm-модуля.

+ +

Эквивалентный код будет выглядить так:

+ +
fetch('simple.wasm').then(response =>
+  response.arrayBuffer()
+).then(bytes =>
+  WebAssembly.instantiate(bytes, importObject)
+).then(results => {
+  results.instance.exports.exported_func();
+});
+ +

Просмотр wasm в инструментах разработчика

+ +

В Firefox 54+, в отладочной панели инструментов разработчика имеется возможность отображения текстового представления любого wasm-кода, включенного в веб-страницу. Для того чтобы просмотреть его, вы можете перейти на отладочную панель и нажать на пункт "wasm://".

+ +

+ +

В ближайших версиях в Firefox, в дополнении к просмотру wasm-кода как текста, разработчики будут иметь возможность отлаживать wasm используя текстовый формат (устанавливать точки останова, изучать стек вызовов, построчно переходить, и.т.д). См. WebAssembly debugging with Firefox DevTools в видео-анонсе.

+ +

Память

+ +

В низкоуровневой модели памяти WebAssembly, память представлена как диапазон смежных байт, называемых линейной памятью (Linear Memory), которая внутри модуля читается и записывается инструкциями загрузки и размещения значений. В этой модели памяти, любая инструкция загрузки или размещения может получить доступ к любому байту всей линейной памяти. Это необходимо для полноценного представления таких концепций языков C/C++ как указатели.

+ +

В отличии от C/C++ программы, где доступный диапазон памяти ограничен процессом, память доступная отдельному экземпляру WebAssembly ограничена до одного специфического (потенциально очень маленького) диапазона, который содержится в объекте памяти WebAssembly. Это позволяет единственному web-приложению использовать множество независимых библиотек (использующих WebAssembly) которые могут иметь отдельные и полностью изолированные друг от друга диапазоны памяти.

+ +

В JavaScript-коде, объект памяти WebAssembly можно считать объектом ArrayBuffer c изменяемыми размерами. Одно веб-приложение может создавать много таких независимых объектов памяти. Вы можете создать новый объект, используя конструктор WebAssembly.Memory(), который принимает аргументы начального и максимального размера буфера (опционально).

+ +

Давайте исследуем эту возможность рассмотрев небольшой пример.

+ +

Создайте еще одну простую HTML страницу (скопируйте HTML шаблон) и назовите её memory.html. Добавьте <script></script> элемент на страницу.

+ +
    +
  1. +

    Добавьте следующую строку в начало нашего скрипта, для создания экземпляра объекта памяти:

    + + 
    var memory = new WebAssembly.Memory({initial:10, maximum:100});
    + +

    Единицы измерения начальной (initial) и максимальной (maximum) памяти имеют фиксированый размер в 64KB. Это означает, что в нашем случае объект памяти при создании имеет 640KB, а его максимальный возможный размер будет 6.4MB.

    + +

    Объект памяти WebAssembly предоставляет свой хранимый диапазон байт через getter/setter свойства buffer, которое возвращает объект ArrayBuffer. Для примера, чтобы записать число 42 в первое слово линейной памяти, вы можете сделать это:

    + + 
    new Uint32Array(memory.buffer)[0] = 42;
    + +

    вы можете возвратить значение используя этот код:

    + + 
    new Uint32Array(memory.buffer)[0]
    +
    2. +
  2. +

    Попробуйте сделать это в вашем примере - сохраните то, что вы сделали, загрузите его в браузере, после чего попробуйте ввести вышеупомянутые строчки в JavaScript-консоль.

    +
    3. +
+ +

Расширение памяти

+ +

Объект памяти может быть расширен с помощью вызова метода {{jsxref("Memory.prototype.grow()")}}, где аргументом будет количество единиц (размером в 64KB) памяти WebAssembly:

+ +
memory.grow(1);
+ +

При превышении максимального значения, указанного при создании объекта памяти, будет выброшено исключение {{jsxref("WebAssembly.RangeError")}}. Движок использует предоставленные верхние границы для резервирования памяти заранее, что делает расширение памяти более эффективным.

+ +
+

Примечание: Так как размер объекта {{domxref("ArrayBuffer")}} неизменен, после успешного вызова метода {{jsxref("Memory.prototype.grow()")}} свойство buffer объекта памяти будет возвращать уже новый объект {{domxref("ArrayBuffer")}} (с новым размером в свойстве byteLength) и любые предыдущие объекты ArrayBuffer станут в некотором роде “отсоединенными”, или отключенными от низкоуровневой памяти, к которой они ранее относились.

+
+ +

Подобно функциям, диапазоны линейной памяти могут быть импортированы или определены внутри модуля. Также, модуль имеет возможность экспортировать свою память. Это означает, что JavaScript-код может получить доступ к объекту памяти WebAssembly либо c помощью создания нового объекта через конструктор WebAssembly.Memory и передачи его в импортируемый объект, либо с помощью получения объекта памяти через экспортируемый объект (через Instance.prototype.exports).

+ +

Более сложный пример

+ +

Давайте сделаем вышеупомянутые утверждения понятнее, рассмотрев более сложный пример работы с памятью, где WebAssembly-модуль импортирует объект памяти, который мы определили ранее, после чего JavaScript-код наполняет его с помощью массива целых чисел, а экспортируемая wasm-функция суммирует их.

+ +
    +
  1. +

    Сопируйте файл memory.wasm в локальную директорию в которой вы работаете.

    + +
    +

    Примечание: Вы можете увидеть текстовое представление модуля в файле memory.wat.

    +
    +
    2. +
  2. +

    Откройте ваш файл memory.html и добавьте следующий код снизу вашего основного скрипта для загрузки, компилирования и создания экземпляра wasm-модуля:

    + + 
    WebAssembly.instantiateStreaming(fetch('memory.wasm'), { js: { mem: memory } })
+.then(results => {
+  // add code here
+});
    +
    3. +
  3. +

    Так как модуль экспортирует свою память, которая была передана экземпляру этого модуля при его создании, мы можем наполнить ранее импортированный массив прямо в линейной памяти экземпляра модуля (mem), и вызвать экспортированную функцию accumulate() для расчета суммы значений. Добавьте следующий код, в обозначенном месте: 

    + + 
    var i32 = new Uint32Array(memory.buffer);
+
+for (var i = 0; i < 10; i++) {
+  i32[i] = i;
+}
+
+var sum = results.instance.exports.accumulate(0, 10);
+console.log(sum);
    +
    4. +
+ +

Обратите внимание на то, что мы создаем представление данных {{domxref("Uint32Array")}} с помощью свойства buffer объекта памяти (Memory.prototype.buffer), а не самого объекта памяти.

+ +

Импорт памяти почти такой же как импорт функций, только вместо JavaScript функций передаются объекты памяти. Импорт памяти полезен по двум причинам:

+ + + +
+

Примечание: Вы можете найти полную демонстрацию в файле memory.html (см. ее также вживую) — эта версия использует функцию fetchAndInstantiate().

+
+ +

Таблицы

+ +

Таблица WebAssembly - это расширяемый типизированный массив ссылок, доступ к которому может быть получен из JavaScript и WebAssembly кода. Так как линейная память предоставляет расширяемый массив незащищенных байт, слишком небезопасно размещать там ссылки, так как для движка ссылка является доверенным значением, чьи байты не должны быть прочитаны или записаны кодом напрямую по причинам безопасности, переносимости и стабильности.

+ +

У таблиц есть тип элемента, который ограничивает тип возможной ссылки, который может быть размещен в таблице. В текущей версии WebAssembly, только один тип ссылки используется в WebAssembly коде - функции - и поэтому существует только один возможный тип элемента. В следующих версиях их количество будет увеличено.

+ +

Ссылки на функции необходимы для компиляции в таких языках как C/C++, которые имеют указатели на функции. В родной реализации C/C++, указатель на функцию представлен прямым адресом на код функции в виртуальном адресном пространстве процесса, и потому для ранее упомянутой безопасности, они не могут быть размещены прямо в линейной памяти. Вместо этого ссылки на функции размещаются в таблице, а её индексы, которые являются целыми числами могут быть размещены в линейной памяти и переданы куда угодно.

+ +

Когда приходит время для вызова указателя на функцию, вызывающая сторона WebAssembly предоставляет индекс, который затем может быть проверен на безопасность по таблице перед индексацией и вызовом ссылки на индексированную функцию. Таким образом, таблицы в настоящее время являются лучшим низкоуровневым примитивом, используемым для безопасной и удобной компиляции низкоуровневых возможностей языка программирования.

+ +

Таблицы могут изменятся с помощью метода Table.prototype.set(), который обновляет одно из значений в таблице, и метода Table.prototype.grow(), который увеличивает количество значений, которое может быть размещено в таблице. Это позволяет этому "непрямо-вызываемому набору функций" изменяться со временем, что необходимо для техник динамического связывания. Изменения немедленно становятся доступными с помощью метода Table.prototype.get() в JavaScript коде и wasm-модулях.

+ +

Пример таблицы

+ +

Давайте взглянем на простой пример таблицы - модуль WebAssembly, который создает и экспортирует таблицу с двумя элементами: элемент под индексом 0 возвращает 13, а элемент под индексом 1 возвращает 42.

+ +
    +
  1. +

    Сделайте локальную копию файла table.wasm в новой директории.

    + +
    +

    Примечание: Вы можете посмотреть текстовое представление модуля в файле table.wat.

    +
    +
    2. +
  2. +

    Создайте новую копию нашего HTML шаблона в той же директории и назовите его table.html.

    +
    3. +
  3. +

    Как и раньше загрузите, компилируйте, и создайте экземпляр вашего wasm-модуля, добавив следующий код в {{htmlelement("script")}} элемент в тело документа:

    + + 
    WebAssembly.instantiateStreaming(fetch('table.wasm'))
+.then(function(results) {
+  // add code here
+});
    +
    4. +
  4. +

    Теперь давайте получим доступ к данным в таблицах - добавим следующие строки в ваш код, в обозначенном месте:

    + + 
    var tbl = results.instance.exports.tbl;
+console.log(tbl.get(0)());  // 13
+console.log(tbl.get(1)());  // 42
    +
    5. +
+ +

Этот код получает доступ к каждой ссылке на функцию, которая размещена в таблице, после чего вызывает её и выводит хранимое значение в консоль. Обратите внимание, что каждая ссылка на функцию получена с помощью вызова метода Table.prototype.get(), после чего мы добавили пару круглых скобок для вызова самой функции.

+ +
+

Примечание: Вы можете найти нашу полную демонстрацию в файле table.html (см. ее также вживую) — эта версия использует функцию fetchAndInstantiate().

+
+ +

Глобальные переменные

+ +

WebAssembly имеет возможность создавать экземпляры глобальных переменных, доступных как в JavaScript так и в экземплярах модулей WebAssembly ({{jsxref("WebAssembly.Module")}}) посредством импорта или экспорта. Это очень полезная возможность, которая позволяет динамически связывать несколько модулей. Для создания глобальной переменной WebAssembly внутри вашего JavaScript-кода, используйте конструктор {{jsxref("WebAssembly.Global()")}}, который выглядит так:

+ +
const global = new WebAssembly.Global({value:'i32', mutable:true}, 0);
+ +

Вы можете видеть, что он принимает 2 параметра:

+ + + +

Что мы будем с этим делать? В следующем примере мы определим глобальную, изменяемую переменную с типом i32 и значением 0.

+ +

Значение глобальной переменной будет изменено на число 42 используя свойство Global.value, а после на 43 используя экспортированную функцию incGlobal() из модуля global.wasm (это добавит 1 к установленному значению и возвратит новое).

+ +
const output = document.getElementById('output');
+
+function assertEq(msg, got, expected) {
+    output.innerHTML += `Testing ${msg}: `;
+    if (got !== expected)
+        output.innerHTML += `FAIL!<br>Got: ${got}<br>Expected: ${expected}<br>`;
+    else
+        output.innerHTML += `SUCCESS! Got: ${got}<br>`;
+}
+
+assertEq("WebAssembly.Global exists", typeof WebAssembly.Global, "function");
+
+const global = new WebAssembly.Global({value:'i32', mutable:true}, 0);
+
+WebAssembly.instantiateStreaming(fetch('global.wasm'), { js: { global } })
+.then(({instance}) => {
+    assertEq("getting initial value from wasm", instance.exports.getGlobal(), 0);
+    global.value = 42;
+    assertEq("getting JS-updated value from wasm", instance.exports.getGlobal(), 42);
+    instance.exports.incGlobal();
+    assertEq("getting wasm-updated value from JS", global.value, 43);
+});
+ +
+

Примечание: Вы можете увидеть этот пример вживую на  GitHub; смотрите также исходники.

+
+ +

Множественность

+ +

К этому моменту мы продемонстрировали использование всех ключевых составных элементов WebAssembly, и сейчас самое время рассказать о концепции множественности. Она позволяет WebAssembly иметь множество преимуществ с точки зрения архитектурной эффективности:

+ + + +

Чтобы ознакомится с множественностью в действии, смотрите нашу объясняющую статью Изменяющиеся таблицы и динамическое связывание.

+ +

Резюме

+ +

В этой статье-путеводителе по основам WebAssembly JavaScript API вы включали модули WebAssembly в среду JavaScript, использовали их функции, объекты памяти, таблицы и глобальные переменные. Мы также затронули концепцию множественности.

+ +

Смотрите также

+ + -- cgit v1.2.3-54-g00ecf