Trong bài viết WebAssembly là gì và bắt nguồn từ đâu?, Tôi đã giải thích cách chúng ta kết thúc với WebAssembly của ngày hôm nay. Trong bài viết này, tôi sẽ hướng dẫn bạn phương pháp biên dịch một chương trình C hiện có, mkbitmap, sang WebAssembly. Mã này phức tạp hơn ví dụ hello world vì bao gồm việc xử lý tệp, giao tiếp giữa WebAssembly và JavaScript và vẽ lên canvas, nhưng vẫn đủ dễ quản lý để không làm bạn choáng ngợp.
Bài viết này dành cho các nhà phát triển web muốn tìm hiểu về WebAssembly và hướng dẫn từng bước cách bạn có thể tiến hành nếu muốn biên dịch một nội dung như mkbitmap sang WebAssembly. Tôi muốn cảnh báo rằng việc không biên dịch được ứng dụng hoặc thư viện trong lần chạy đầu tiên là điều hoàn toàn bình thường. Đó là lý do một số bước được mô tả bên dưới không hoạt động. Vì vậy, tôi cần quay lại và thử lại theo cách khác. Bài viết này không cho thấy lệnh biên dịch cuối cùng kỳ diệu như thể nó rơi từ trên trời xuống, mà thay vào đó mô tả tiến trình thực tế của tôi, bao gồm cả một số sự thất vọng.
Khoảng mkbitmap
Chương trình C mkbitmap đọc một hình ảnh và áp dụng một hoặc nhiều thao tác sau cho hình ảnh đó theo thứ tự: đảo ngược, lọc cao, điều chỉnh theo tỷ lệ và đặt ngưỡng. Bạn có thể kiểm soát và bật/tắt từng thao tác riêng lẻ. Mục đích chính của mkbitmap là chuyển đổi hình ảnh màu hoặc thang màu xám thành một định dạng phù hợp làm dữ liệu đầu vào cho các chương trình khác, đặc biệt là chương trình theo dõi potrace tạo nên nền tảng của SVGcode. Là một công cụ xử lý trước, mkbitmap đặc biệt hữu ích để chuyển đổi hình minh hoạ đường vẽ được quét, chẳng hạn như phim hoạt hình hoặc văn bản viết tay, thành hình ảnh hai cấp độ có độ phân giải cao.
Bạn sử dụng mkbitmap bằng cách truyền cho hàm này một số tuỳ chọn và một hoặc nhiều tên tệp. Để biết tất cả thông tin chi tiết, hãy xem trang man của công cụ:
$ mkbitmap [options] [filename...]
mkbitmap -f 2 -s 2 -t 0.48 (Nguồn).Lấy mã
Bước đầu tiên là lấy mã nguồn của mkbitmap. Bạn có thể tìm thấy thông tin này trên trang web của dự án. Tại thời điểm viết bài này, potrace-1.16.tar.gz là phiên bản mới nhất.
Biên dịch và cài đặt trên máy
Bước tiếp theo là biên dịch và cài đặt công cụ trên máy để hiểu rõ cách hoạt động của công cụ. Tệp INSTALL chứa các hướng dẫn sau:
cdvào thư mục chứa mã nguồn của gói và nhập./configuređể định cấu hình gói cho hệ thống của bạn.Quá trình chạy
configurecó thể mất chút thời gian. Trong khi chạy, ứng dụng này sẽ in một số thông báo cho biết tính năng nào đang được kiểm tra.Nhập
makeđể biên dịch gói.Bạn có thể nhập
make checkđể chạy mọi chương trình tự kiểm thử đi kèm với gói, thường là sử dụng các tệp nhị phân chưa cài đặt vừa tạo.Nhập
make installđể cài đặt các chương trình và mọi tệp dữ liệu cũng như tài liệu. Khi cài đặt vào một tiền tố do thư mục gốc sở hữu, bạn nên định cấu hình và tạo gói dưới dạng người dùng thông thường và chỉ thực thi giai đoạnmake installbằng các đặc quyền thư mục gốc.
Bằng cách làm theo các bước này, bạn sẽ có hai tệp thực thi là potrace và mkbitmap. Tệp sau là trọng tâm của bài viết này. Bạn có thể xác minh rằng ứng dụng hoạt động đúng cách bằng cách chạy mkbitmap --version. Dưới đây là kết quả của cả 4 bước trên máy của tôi, được cắt bớt để ngắn gọn:
Bước 1, ./configure:
$ ./configure
checking for a BSD-compatible install... /usr/bin/install -c
checking whether build environment is sane... yes
checking for a thread-safe mkdir -p... ./install-sh -c -d
checking for gawk... no
checking for mawk... no
checking for nawk... no
checking for awk... awk
checking whether make sets $(MAKE)... yes
[…]
config.status: executing libtool commands
Bước 2, make:
$ make
/Applications/Xcode.app/Contents/Developer/usr/bin/make all-recursive
Making all in src
clang -DHAVE_CONFIG_H -I. -I.. -g -O2 -MT main.o -MD -MP -MF .deps/main.Tpo -c -o main.o main.c
mv -f .deps/main.Tpo .deps/main.Po
[…]
make[2]: Nothing to be done for `all-am'.
Bước 3, make check:
$ make check
Making check in src
make[1]: Nothing to be done for `check'.
Making check in doc
make[1]: Nothing to be done for `check'.
[…]
============================================================================
Testsuite summary for potrace 1.16
============================================================================
# TOTAL: 8
# PASS: 8
# SKIP: 0
# XFAIL: 0
# FAIL: 0
# XPASS: 0
# ERROR: 0
============================================================================
make[1]: Nothing to be done for `check-am'.
Bước 4, sudo make install:
$ sudo make install
Password:
Making install in src
.././install-sh -c -d '/usr/local/bin'
/bin/sh ../libtool --mode=install /usr/bin/install -c potrace mkbitmap '/usr/local/bin'
[…]
make[2]: Nothing to be done for `install-data-am'.
Để kiểm tra xem cách này có hiệu quả hay không, hãy chạy mkbitmap --version:
$ mkbitmap --version
mkbitmap 1.16. Copyright (C) 2001-2019 Peter Selinger.
Nếu nhận được thông tin chi tiết về phiên bản, tức là bạn đã biên dịch và cài đặt thành công mkbitmap. Tiếp theo, hãy làm cho các bước tương đương này hoạt động với WebAssembly.
Biên dịch mkbitmap thành WebAssembly
Emscripten là một công cụ biên dịch các chương trình C/C++ sang WebAssembly. Tài liệu Tạo dự án của Emscripten nêu rõ những điều sau:
Việc xây dựng các dự án lớn bằng Emscripten rất dễ dàng. Emscripten cung cấp hai tập lệnh đơn giản giúp định cấu hình tệp make để sử dụng
emccthay thế chogcc. Trong hầu hết các trường hợp, phần còn lại của hệ thống xây dựng hiện tại của dự án sẽ không thay đổi.
Sau đó, tài liệu sẽ tiếp tục (được chỉnh sửa một chút để ngắn gọn):
Hãy xem xét trường hợp mà bạn thường tạo bằng các lệnh sau:
./configure
make
Để tạo bằng Emscripten, bạn sẽ sử dụng các lệnh sau:
emconfigure ./configure
emmake make
Vì vậy, về cơ bản, ./configure trở thành emconfigure ./configure và make trở thành emmake make. Phần sau đây minh hoạ cách thực hiện việc này với mkbitmap.
Bước 0, make clean:
$ make clean
Making clean in src
rm -f potrace mkbitmap
test -z "" || rm -f
rm -rf .libs _libs
[…]
rm -f *.lo
Bước 1, emconfigure ./configure:
$ emconfigure ./configure
configure: ./configure
checking for a BSD-compatible install... /usr/bin/install -c
checking whether build environment is sane... yes
checking for a thread-safe mkdir -p... ./install-sh -c -d
checking for gawk... no
checking for mawk... no
checking for nawk... no
checking for awk... awk
[…]
config.status: executing libtool commands
Bước 2, emmake make:
$ emmake make
make: make
/Applications/Xcode.app/Contents/Developer/usr/bin/make all-recursive
Making all in src
/opt/homebrew/Cellar/emscripten/3.1.36/libexec/emcc -DHAVE_CONFIG_H -I. -I.. -g -O2 -MT main.o -MD -MP -MF .deps/main.Tpo -c -o main.o main.c
mv -f .deps/main.Tpo .deps/main.Po
[…]
make[2]: Nothing to be done for `all'.
Nếu mọi thứ diễn ra suôn sẻ, thì giờ đây, bạn sẽ thấy các tệp .wasm ở đâu đó trong thư mục. Bạn có thể tìm thấy các tệp này bằng cách chạy find . -name "*.wasm":
$ find . -name "*.wasm"
./a.wasm
./src/mkbitmap.wasm
./src/potrace.wasm
Hai cái cuối cùng có vẻ hứa hẹn, vì vậy, hãy cd vào thư mục src/. Hiện cũng có hai tệp tương ứng mới là mkbitmap và potrace. Đối với bài viết này, chỉ mkbitmap là có liên quan. Việc các tệp này không có đuôi .js có thể gây nhầm lẫn một chút, nhưng thực tế chúng là các tệp JavaScript, có thể xác minh bằng lệnh gọi head nhanh:
$ cd src/
$ head -n 20 mkbitmap
// include: shell.js
// The Module object: Our interface to the outside world. We import
// and export values on it. There are various ways Module can be used:
// 1. Not defined. We create it here
// 2. A function parameter, function(Module) { ..generated code.. }
// 3. pre-run appended it, var Module = {}; ..generated code..
// 4. External script tag defines var Module.
// We need to check if Module already exists (e.g. case 3 above).
// Substitution will be replaced with actual code on later stage of the build,
// this way Closure Compiler will not mangle it (e.g. case 4. above).
// Note that if you want to run closure, and also to use Module
// after the generated code, you will need to define var Module = {};
// before the code. Then that object will be used in the code, and you
// can continue to use Module afterwards as well.
var Module = typeof Module != 'undefined' ? Module : {};
// --pre-jses are emitted after the Module integration code, so that they can
// refer to Module (if they choose; they can also define Module)
Đổi tên tệp JavaScript thành mkbitmap.js bằng cách gọi mv mkbitmap mkbitmap.js (và mv potrace potrace.js tương ứng nếu bạn muốn).
Bây giờ, đã đến lúc kiểm thử lần đầu để xem liệu mã có hoạt động hay không bằng cách thực thi tệp bằng Node.js trên dòng lệnh bằng cách chạy node mkbitmap.js --version:
$ node mkbitmap.js --version
mkbitmap 1.16. Copyright (C) 2001-2019 Peter Selinger.
Bạn đã biên dịch thành công mkbitmap sang WebAssembly. Bước tiếp theo là làm cho tính năng này hoạt động trong trình duyệt.
mkbitmap với WebAssembly trong trình duyệt
Sao chép các tệp mkbitmap.js và mkbitmap.wasm vào một thư mục mới có tên mkbitmap và tạo một tệp nguyên mẫu HTML index.html để tải tệp JavaScript mkbitmap.js.
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8" />
<title>mkbitmap</title>
</head>
<body>
<script src="mkbitmap.js"></script>
</body>
</html>
Khởi động một máy chủ cục bộ phân phát thư mục mkbitmap và mở thư mục đó trong trình duyệt. Bạn sẽ thấy một lời nhắc yêu cầu bạn nhập dữ liệu. Điều này đúng như dự kiến, vì theo trang man của công cụ, "[i]f no filename arguments are given, then mkbitmap acts as a filter, reading from standard input" (nếu không có đối số tên tệp nào được cung cấp, thì mkbitmap sẽ hoạt động như một bộ lọc, đọc từ dữ liệu đầu vào chuẩn), theo mặc định, đối với Emscripten là prompt().
Ngăn thực thi tự động
Để ngăn mkbitmap thực thi ngay lập tức và thay vào đó là chờ dữ liệu đầu vào của người dùng, bạn cần hiểu đối tượng Module của Emscripten. Module là một đối tượng JavaScript toàn cục có các thuộc tính mà mã do Emscripten tạo ra gọi tại nhiều điểm trong quá trình thực thi.
Bạn có thể cung cấp cách triển khai Module để kiểm soát quá trình thực thi mã.
Khi khởi động, ứng dụng Emscripten sẽ xem xét các giá trị trên đối tượng Module và áp dụng các giá trị đó.
Trong trường hợp mkbitmap, hãy đặt Module.noInitialRun thành true để ngăn quá trình chạy ban đầu khiến lời nhắc xuất hiện. Tạo một tập lệnh có tên là script.js, đưa tập lệnh đó vào trước <script src="mkbitmap.js"></script> trong index.html và thêm mã sau vào script.js. Giờ đây, khi bạn tải lại ứng dụng, lời nhắc sẽ biến mất.
var Module = {
// Don't run main() at page load
noInitialRun: true,
};
Tạo bản dựng mô-đun bằng một số cờ bản dựng khác
Để cung cấp dữ liệu đầu vào cho ứng dụng, bạn có thể sử dụng tính năng hỗ trợ hệ thống tệp của Emscripten trong Module.FS. Phần Thêm tính năng hỗ trợ hệ thống tệp trong tài liệu nêu rõ:
Emscripten quyết định xem có tự động đưa tính năng hỗ trợ hệ thống tệp vào hay không. Nhiều chương trình không cần tệp và tính năng hỗ trợ hệ thống tệp có kích thước không nhỏ, vì vậy, Emscripten tránh đưa tính năng này vào khi không có lý do. Điều đó có nghĩa là nếu mã C/C++ của bạn không truy cập vào tệp, thì đối tượng
FSvà các API hệ thống tệp khác sẽ không có trong kết quả. Mặt khác, nếu mã C/C++ của bạn sử dụng tệp, thì tính năng hỗ trợ hệ thống tệp sẽ tự động được đưa vào.
Rất tiếc, mkbitmap là một trong những trường hợp mà Emscripten không tự động hỗ trợ hệ thống tệp, vì vậy, bạn cần phải yêu cầu rõ ràng việc này. Điều này có nghĩa là bạn cần làm theo các bước emconfigure và emmake được mô tả trước đó, với một vài cờ khác được đặt thông qua đối số CFLAGS. Các cờ sau đây cũng có thể hữu ích cho các dự án khác.
- Đặt
-sFILESYSTEM=1để hỗ trợ hệ thống tệp. - Đặt
-sEXPORTED_RUNTIME_METHODS=FS,callMainđể xuấtModule.FSvàModule.callMain. - Đặt
-sMODULARIZE=1và-sEXPORT_ES6để tạo một mô-đun ES6 hiện đại. - Đặt
-sINVOKE_RUN=0để ngăn lần chạy đầu tiên khiến lời nhắc xuất hiện.
Ngoài ra, trong trường hợp cụ thể này, bạn cần đặt cờ --host thành wasm32 để cho tập lệnh configure biết rằng bạn đang biên dịch cho WebAssembly.
Lệnh emconfigure cuối cùng sẽ có dạng như sau:
$ emconfigure ./configure --host=wasm32 CFLAGS='-sFILESYSTEM=1 -sEXPORTED_RUNTIME_METHODS=FS,callMain -sMODULARIZE=1 -sEXPORT_ES6 -sINVOKE_RUN=0'
Đừng quên chạy lại emmake make và sao chép các tệp mới tạo vào thư mục mkbitmap.
Sửa đổi index.html để chỉ tải mô-đun ES script.js, sau đó bạn nhập mô-đun mkbitmap.js.
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8" />
<title>mkbitmap</title>
</head>
<body>
<!-- No longer load `mkbitmap.js` here -->
<script src="script.js" type="module"></script>
</body>
</html>
// This is `script.js`.
import loadWASM from './mkbitmap.js';
const run = async () => {
const Module = await loadWASM();
console.log(Module);
};
run();
Khi mở ứng dụng trong trình duyệt, bạn sẽ thấy đối tượng Module được ghi vào bảng điều khiển DevTools và lời nhắc sẽ biến mất, vì hàm main() của mkbitmap không còn được gọi khi bắt đầu nữa.
Thực thi hàm chính theo cách thủ công
Bước tiếp theo là gọi hàm main() của mkbitmap theo cách thủ công bằng cách chạy Module.callMain(). Hàm callMain() nhận một mảng đối số, khớp từng cái với những gì bạn sẽ truyền trên dòng lệnh. Nếu chạy mkbitmap -v trên dòng lệnh, bạn sẽ gọi Module.callMain(['-v']) trong trình duyệt. Thao tác này sẽ ghi lại số phiên bản mkbitmap vào bảng điều khiển DevTools.
// This is `script.js`.
import loadWASM from './mkbitmap.js';
const run = async () => {
const Module = await loadWASM();
Module.callMain(['-v']);
};
run();
Chuyển hướng đầu ra chuẩn
Theo mặc định, đầu ra chuẩn (stdout) là bảng điều khiển. Tuy nhiên, bạn có thể chuyển hướng kết quả này đến một nơi khác, chẳng hạn như một hàm lưu trữ kết quả vào một biến. Điều này có nghĩa là bạn có thể thêm kết quả vào HTML bằng cách đặt thuộc tính Module.print.
// This is `script.js`.
import loadWASM from './mkbitmap.js';
const run = async () => {
let consoleOutput = 'Powered by ';
const Module = await loadWASM({
print: (text) => (consoleOutput += text),
});
Module.callMain(['-v']);
document.body.textContent = consoleOutput;
};
run();
Nhận tệp đầu vào vào hệ thống tệp bộ nhớ
Để đưa tệp đầu vào vào hệ thống tệp bộ nhớ, bạn cần có mkbitmap filename tương đương trên dòng lệnh. Để hiểu cách tôi tiếp cận vấn đề này, trước tiên, hãy tìm hiểu một số thông tin cơ bản về cách mkbitmap dự kiến dữ liệu đầu vào và tạo dữ liệu đầu ra.
Các định dạng đầu vào được hỗ trợ của mkbitmap là PNM (PBM, PGM, PPM) và BMP. Định dạng đầu ra là PBM cho bitmap và PGM cho bản đồ xám. Nếu bạn cung cấp đối số filename, theo mặc định, mkbitmap sẽ tạo một tệp đầu ra có tên lấy từ tên tệp đầu vào bằng cách thay đổi hậu tố của tệp đó thành .pbm. Ví dụ: đối với tên tệp đầu vào example.bmp, tên tệp đầu ra sẽ là example.pbm.
Emscripten cung cấp một hệ thống tệp ảo mô phỏng hệ thống tệp cục bộ, nhờ đó, mã gốc sử dụng API tệp đồng bộ có thể được biên dịch và chạy mà không cần thay đổi nhiều hoặc không thay đổi gì.
Để mkbitmap đọc tệp đầu vào như thể tệp đó được truyền dưới dạng đối số dòng lệnh filename, bạn cần sử dụng đối tượng FS mà Emscripten cung cấp.
Đối tượng FS được hỗ trợ bởi một hệ thống tệp trong bộ nhớ (thường gọi là MEMFS) và có hàm writeFile() mà bạn dùng để ghi tệp vào hệ thống tệp ảo. Bạn sử dụng writeFile() như trong mã mẫu sau.
Để xác minh thao tác ghi tệp đã hoạt động, hãy chạy hàm readdir() của đối tượng FS bằng tham số '/'. Bạn sẽ thấy example.bmp và một số tệp mặc định luôn được tạo tự động.
Xin lưu ý rằng lệnh gọi trước đó đến Module.callMain(['-v']) để in số phiên bản đã bị xoá. Điều này là do Module.callMain() là một hàm thường chỉ chạy một lần.
// This is `script.js`.
import loadWASM from './mkbitmap.js';
const run = async () => {
const Module = await loadWASM();
const buffer = await fetch('https://example.com/example.bmp').then((res) => res.arrayBuffer());
Module.FS.writeFile('example.bmp', new Uint8Array(buffer));
console.log(Module.FS.readdir('/'));
};
run();
Lần thực thi thực tế đầu tiên
Khi mọi thứ đã sẵn sàng, hãy thực thi mkbitmap bằng cách chạy Module.callMain(['example.bmp']). Ghi lại nội dung của thư mục '/' của MEMFS và bạn sẽ thấy tệp đầu ra example.pbm mới tạo bên cạnh tệp đầu vào example.bmp.
// This is `script.js`.
import loadWASM from './mkbitmap.js';
const run = async () => {
const Module = await loadWASM();
const buffer = await fetch('https://example.com/example.bmp').then((res) => res.arrayBuffer());
Module.FS.writeFile('example.bmp', new Uint8Array(buffer));
Module.callMain(['example.bmp']);
console.log(Module.FS.readdir('/'));
};
run();
Lấy tệp đầu ra ra khỏi hệ thống tệp bộ nhớ
Hàm readFile() của đối tượng FS cho phép lấy example.pbm được tạo ở bước cuối cùng ra khỏi hệ thống tệp bộ nhớ. Hàm này trả về một Uint8Array mà bạn chuyển đổi thành đối tượng File và lưu vào ổ đĩa, vì các trình duyệt thường không hỗ trợ tệp PBM để xem trực tiếp trong trình duyệt.
(Có nhiều cách lưu tệp tinh tế hơn, nhưng việc sử dụng <a download> được tạo động là cách được hỗ trợ rộng rãi nhất.) Sau khi lưu tệp, bạn có thể mở tệp đó trong trình xem hình ảnh mà bạn yêu thích.
// This is `script.js`.
import loadWASM from './mkbitmap.js';
const run = async () => {
const Module = await loadWASM();
const buffer = await fetch('https://example.com/example.bmp').then((res) => res.arrayBuffer());
Module.FS.writeFile('example.bmp', new Uint8Array(buffer));
Module.callMain(['example.bmp']);
const output = Module.FS.readFile('example.pbm', { encoding: 'binary' });
const file = new File([output], 'example.pbm', {
type: 'image/x-portable-bitmap',
});
const a = document.createElement('a');
a.href = URL.createObjectURL(file);
a.download = file.name;
a.click();
};
run();
Thêm giao diện người dùng tương tác
Đến thời điểm này, tệp đầu vào được mã hoá cứng và mkbitmap chạy bằng các tham số mặc định. Bước cuối cùng là cho phép người dùng linh động chọn một tệp đầu vào, điều chỉnh các tham số mkbitmap, sau đó chạy công cụ bằng các tuỳ chọn đã chọn.
// Corresponds to `mkbitmap -o output.pbm input.bmp -s 8 -3 -f 4 -t 0.45`.
Module.callMain(['-o', 'output.pbm', 'input.bmp', '-s', '8', '-3', '-f', '4', '-t', '0.45']);
Định dạng hình ảnh PBM không khó phân tích cú pháp, vì vậy, với một số mã JavaScript, bạn thậm chí có thể hiển thị bản xem trước của hình ảnh đầu ra. Hãy xem mã nguồn của mã minh hoạ được nhúng bên dưới để biết một cách thực hiện việc này.
Kết luận
Xin chúc mừng! Bạn đã biên dịch thành công mkbitmap thành WebAssembly và làm cho mã này hoạt động trong trình duyệt! Có một số trường hợp không thành công và bạn phải biên dịch công cụ nhiều lần cho đến khi công cụ hoạt động. Tuy nhiên, như tôi đã viết ở trên, đó là một phần của trải nghiệm. Ngoài ra, hãy nhớ thẻ webassembly của StackOverflow nếu bạn gặp khó khăn. Chúc bạn biên dịch thành công!
Lời cảm ơn
Bài viết này đã được Sam Clegg và Rachel Andrew xem xét.