Skip to content

Commit 33e19a6

Browse files
sbc100sbc100
committed
Rename allocateUTF8OnStack -> stringToNewUTF8OnStack
The old name is still available as an alias in library_legacy.js. Followup to #19089
1 parent 2a13190 commit 33e19a6

18 files changed

+44
-42
lines changed

‎ChangeLog.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,8 +23,9 @@ See docs/process.md for more on how version tagging works.
2323
- `FS.loadFilesFromDB` and `FS.saveFilesToDB` were removed. We think it's
2424
unlikly there were any users of these functions since there is now a separate
2525
IDBFS filesystem for folks that want persistence. (#19049)
26-
- `allocateUTF8` library function moved to `library_legacy.js`. Prefer the
27-
more accurately named `stringToNewUTF8`.
26+
- `allocateUTF8` and `allocateUTF8OnStack` library function moved to
27+
`library_legacy.js`. Prefer the more accurately named `stringToNewUTF8` and
28+
`stringToUTF8OnStack`. (#19089)
2829
- `SDL_image` port was updated to version 2.6.0.
2930
- `-z` arguments are now passed directly to wasm-ld without the need for the
3031
`-Wl,` prefix. This matches the behaviour of both clang and gcc. (#18956)

‎emscripten.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -157,7 +157,7 @@ def update_settings_glue(wasm_file, metadata):
157157
settings.MAIN_READS_PARAMS = metadata.mainReadsParams or bool(settings.MAIN_MODULE)
158158
if settings.MAIN_READS_PARAMS and not settings.STANDALONE_WASM:
159159
# callMain depends on this library function
160-
settings.DEFAULT_LIBRARY_FUNCS_TO_INCLUDE += ['$allocateUTF8OnStack']
160+
settings.DEFAULT_LIBRARY_FUNCS_TO_INCLUDE += ['$stringToUTF8OnStack']
161161

162162
if settings.STACK_OVERFLOW_CHECK and not settings.SIDE_MODULE:
163163
# writeStackCookie and checkStackCookie both rely on emscripten_stack_get_end being

‎src/library.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3713,7 +3713,7 @@ DEFAULT_LIBRARY_FUNCS_TO_INCLUDE.push(
37133713
'$stringToUTF32',
37143714
'$lengthBytesUTF32',
37153715
'$stringToNewUTF8',
3716-
'$allocateUTF8OnStack',
3716+
'$stringToUTF8OnStack',
37173717
'$writeStringToMemory',
37183718
'$writeArrayToMemory',
37193719
'$writeAsciiToMemory',

‎src/library_ccall.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ mergeInto(LibraryManager.library, {
1515
},
1616

1717
// C calling interface.
18-
$ccall__deps: ['$getCFunc', '$writeArrayToMemory', '$allocateUTF8OnStack'],
18+
$ccall__deps: ['$getCFunc', '$writeArrayToMemory', '$stringToUTF8OnStack'],
1919
$ccall__docs: `
2020
/**
2121
* @param {string|null=} returnType
@@ -33,7 +33,7 @@ mergeInto(LibraryManager.library, {
3333
var ret = 0;
3434
if (str !== null && str !== undefined && str !== 0) { // null string
3535
// at most 4 bytes per UTF-8 code point, +1 for the trailing '\0'
36-
ret = allocateUTF8OnStack(str);
36+
ret = stringToUTF8OnStack(str);
3737
}
3838
return {{{ to64('ret') }}};
3939
},

‎src/library_dylink.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -296,13 +296,13 @@ var LibraryDylink = {
296296
},
297297

298298
$dlSetError__internal: true,
299-
$dlSetError__deps: ['__dl_seterr', '$allocateUTF8OnStack', '$withStackSave'],
299+
$dlSetError__deps: ['__dl_seterr', '$stringToUTF8OnStack', '$withStackSave'],
300300
$dlSetError: function(msg) {
301301
#if DYLINK_DEBUG
302302
dbg('dlSetError: ' + msg);
303303
#endif
304304
withStackSave(function() {
305-
var cmsg = allocateUTF8OnStack(msg);
305+
var cmsg = stringToUTF8OnStack(msg);
306306
___dl_seterr(cmsg, 0);
307307
});
308308
},

‎src/library_html5.js

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2459,7 +2459,7 @@ var LibraryHTML5 = {
24592459
},
24602460
#endif
24612461

2462-
$setCanvasElementSize__deps: ['emscripten_set_canvas_element_size', '$withStackSave', '$allocateUTF8OnStack'],
2462+
$setCanvasElementSize__deps: ['emscripten_set_canvas_element_size', '$withStackSave', '$stringToUTF8OnStack'],
24632463
$setCanvasElementSize: function(target, width, height) {
24642464
#if GL_DEBUG
24652465
dbg('setCanvasElementSize(target='+target+',width='+width+',height='+height);
@@ -2471,7 +2471,7 @@ var LibraryHTML5 = {
24712471
// This function is being called from high-level JavaScript code instead of asm.js/Wasm,
24722472
// and it needs to synchronously proxy over to another thread, so marshal the string onto the heap to do the call.
24732473
withStackSave(function() {
2474-
var targetInt = allocateUTF8OnStack(target.id);
2474+
var targetInt = stringToUTF8OnStack(target.id);
24752475
_emscripten_set_canvas_element_size(targetInt, width, height);
24762476
});
24772477
}
@@ -2533,13 +2533,13 @@ var LibraryHTML5 = {
25332533
#endif
25342534

25352535
// JavaScript-friendly API, returns pair [width, height]
2536-
$getCanvasElementSize__deps: ['emscripten_get_canvas_element_size', '$withStackSave', '$allocateUTF8OnStack'],
2536+
$getCanvasElementSize__deps: ['emscripten_get_canvas_element_size', '$withStackSave', '$stringToUTF8OnStack'],
25372537
$getCanvasElementSize: function(target) {
25382538
return withStackSave(function() {
25392539
var w = stackAlloc(8);
25402540
var h = w + 4;
25412541

2542-
var targetInt = allocateUTF8OnStack(target.id);
2542+
var targetInt = stringToUTF8OnStack(target.id);
25432543
var ret = _emscripten_get_canvas_element_size(targetInt, w, h);
25442544
var size = [{{{ makeGetValue('w', 0, 'i32')}}}, {{{ makeGetValue('h', 0, 'i32')}}}];
25452545
return size;

‎src/library_legacy.js

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,4 +39,5 @@ mergeInto(LibraryManager.library, {
3939
},
4040

4141
$allocateUTF8: '$stringToNewUTF8',
42+
$allocateUTF8OnStack: '$stringToUTF8OnStack',
4243
});

‎src/library_sockfs.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -727,13 +727,13 @@ mergeInto(LibraryManager.library, {
727727
* Passing a NULL callback function to a emscripten_set_socket_*_callback call
728728
* will deregister the callback registered for that Event.
729729
*/
730-
$_setNetworkCallback__deps: ['$withStackSave', '$allocateUTF8OnStack'],
730+
$_setNetworkCallback__deps: ['$withStackSave', '$stringToUTF8OnStack'],
731731
$_setNetworkCallback: function(event, userData, callback) {
732732
function _callback(data) {
733733
try {
734734
if (event === 'error') {
735735
withStackSave(function() {
736-
var msg = allocateUTF8OnStack(data[2]);
736+
var msg = stringToUTF8OnStack(data[2]);
737737
{{{ makeDynCall('viiii', 'callback') }}}(data[0], data[1], msg, userData);
738738
});
739739
} else {

‎src/library_stack_trace.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

77
var LibraryStackTrace = {
88
#if DEMANGLE_SUPPORT
9-
$demangle__deps: ['$withStackSave', '__cxa_demangle', 'free', '$allocateUTF8OnStack'],
9+
$demangle__deps: ['$withStackSave', '__cxa_demangle', 'free', '$stringToUTF8OnStack'],
1010
#endif
1111
$demangle: function(func) {
1212
#if DEMANGLE_SUPPORT
@@ -19,7 +19,7 @@ var LibraryStackTrace = {
1919
var s = func;
2020
if (s.startsWith('__Z'))
2121
s = s.substr(1);
22-
var buf = allocateUTF8OnStack(s);
22+
var buf = stringToUTF8OnStack(s);
2323
var status = stackAlloc(4);
2424
var ret = ___cxa_demangle(buf, 0, 0, status);
2525
if ({{{ makeGetValue('status', '0', 'i32') }}} === 0 && ret) {

‎src/library_strings.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -234,7 +234,7 @@ mergeInto(LibraryManager.library, {
234234
},
235235

236236
// Allocate stack space for a JS string, and write it there.
237-
$allocateUTF8OnStack: function(str) {
237+
$stringToUTF8OnStack: function(str) {
238238
var size = lengthBytesUTF8(str) + 1;
239239
var ret = stackAlloc(size);
240240
stringToUTF8Array(str, HEAP8, ret, size);

‎src/library_wasmfs.js

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ mergeInto(LibraryManager.library, {
1717
'$asyncLoad',
1818
'$PATH',
1919
'$stringToNewUTF8',
20-
'$allocateUTF8OnStack',
20+
'$stringToUTF8OnStack',
2121
'$withStackSave',
2222
'$readI53FromI64',
2323
],
@@ -134,7 +134,7 @@ mergeInto(LibraryManager.library, {
134134
mkdir: (path, mode) => {
135135
return withStackSave(() => {
136136
mode = mode !== undefined ? mode : 511 /* 0777 */;
137-
var buffer = allocateUTF8OnStack(path);
137+
var buffer = stringToUTF8OnStack(path);
138138
return __wasmfs_mkdir({{{ to64('buffer') }}}, mode);
139139
});
140140
},
@@ -145,21 +145,21 @@ mergeInto(LibraryManager.library, {
145145
flags = typeof flags == 'string' ? FS.modeStringToFlags(flags) : flags;
146146
mode = typeof mode == 'undefined' ? 438 /* 0666 */ : mode;
147147
return withStackSave(() => {
148-
var buffer = allocateUTF8OnStack(path);
148+
var buffer = stringToUTF8OnStack(path);
149149
return __wasmfs_open({{{ to64('buffer') }}}, flags, mode);
150150
})
151151
},
152152
// TODO: create
153153
// TODO: close
154154
unlink: (path) => {
155155
return withStackSave(() => {
156-
var buffer = allocateUTF8OnStack(path);
156+
var buffer = stringToUTF8OnStack(path);
157157
return __wasmfs_unlink(buffer);
158158
});
159159
},
160160
chdir: (path) => {
161161
return withStackSave(() => {
162-
var buffer = allocateUTF8OnStack(path);
162+
var buffer = stringToUTF8OnStack(path);
163163
return __wasmfs_chdir(buffer);
164164
});
165165
},
@@ -171,7 +171,7 @@ mergeInto(LibraryManager.library, {
171171
// TODO: munmap
172172
writeFile: (path, data) => {
173173
return withStackSave(() => {
174-
var pathBuffer = allocateUTF8OnStack(path);
174+
var pathBuffer = stringToUTF8OnStack(path);
175175
if (typeof data == 'string') {
176176
var buf = new Uint8Array(lengthBytesUTF8(data) + 1);
177177
var actualNumBytes = stringToUTF8Array(data, buf, 0, buf.length);
@@ -191,8 +191,8 @@ mergeInto(LibraryManager.library, {
191191
},
192192
symlink: (target, linkpath) => {
193193
return withStackSave(() => {
194-
var targetBuffer = allocateUTF8OnStack(target);
195-
var linkpathBuffer = allocateUTF8OnStack(linkpath);
194+
var targetBuffer = stringToUTF8OnStack(target);
195+
var linkpathBuffer = stringToUTF8OnStack(linkpath);
196196
return __wasmfs_symlink(targetBuffer, linkpathBuffer);
197197
});
198198
},
@@ -201,7 +201,7 @@ mergeInto(LibraryManager.library, {
201201
// TODO: lstat
202202
chmod: (path, mode) => {
203203
return withStackSave(() => {
204-
var buffer = allocateUTF8OnStack(path);
204+
var buffer = stringToUTF8OnStack(path);
205205
return __wasmfs_chmod(buffer, mode);
206206
});
207207
},
@@ -225,7 +225,7 @@ mergeInto(LibraryManager.library, {
225225
},
226226
readdir: (path) => {
227227
return withStackSave(() => {
228-
var pathBuffer = allocateUTF8OnStack(path);
228+
var pathBuffer = stringToUTF8OnStack(path);
229229
var entries = [];
230230
var state = __wasmfs_readdir_start(pathBuffer);
231231
if (!state) {

‎src/library_wasmfs_node.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ mergeInto(LibraryManager.library, {
6262
}
6363
entries.forEach((entry) => {
6464
withStackSave(() => {
65-
let name = allocateUTF8OnStack(entry.name);
65+
let name = stringToUTF8OnStack(entry.name);
6666
let type;
6767
// TODO: Figure out how to use `cDefine` here.
6868
if (entry.isFile()) {

‎src/library_wasmfs_opfs.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -100,7 +100,7 @@ mergeInto(LibraryManager.library, {
100100
for (let entry; entry = await iter.next(), !entry.done;) {
101101
let [name, child] = entry.value;
102102
withStackSave(() => {
103-
let namePtr = allocateUTF8OnStack(name);
103+
let namePtr = stringToUTF8OnStack(name);
104104
let type = child.kind == "file" ?
105105
{{{ cDefine('File::DataFileKind') }}} :
106106
{{{ cDefine('File::DirectoryKind') }}};

‎src/library_wget.js

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ var LibraryWget = {
1616
},
1717
},
1818

19-
emscripten_async_wget__deps: ['$PATH_FS', '$wget', '$callUserCallback', '$Browser', '$withStackSave', '$allocateUTF8OnStack'],
19+
emscripten_async_wget__deps: ['$PATH_FS', '$wget', '$callUserCallback', '$Browser', '$withStackSave', '$stringToUTF8OnStack'],
2020
emscripten_async_wget__proxy: 'sync',
2121
emscripten_async_wget: function(url, file, onload, onerror) {
2222
{{{ runtimeKeepalivePush() }}}
@@ -29,7 +29,7 @@ var LibraryWget = {
2929
{{{ runtimeKeepalivePop() }}}
3030
callUserCallback(function() {
3131
withStackSave(function() {
32-
{{{ makeDynCall('vi', 'callback') }}}(allocateUTF8OnStack(_file));
32+
{{{ makeDynCall('vi', 'callback') }}}(stringToUTF8OnStack(_file));
3333
});
3434
});
3535
}
@@ -80,7 +80,7 @@ var LibraryWget = {
8080
}, true /* no need for run dependency, this is async but will not do any prepare etc. step */ );
8181
},
8282

83-
emscripten_async_wget2__deps: ['$PATH_FS', '$wget', '$withStackSave', '$allocateUTF8OnStack'],
83+
emscripten_async_wget2__deps: ['$PATH_FS', '$wget', '$withStackSave', '$stringToUTF8OnStack'],
8484
emscripten_async_wget2__proxy: 'sync',
8585
emscripten_async_wget2: function(url, file, request, param, arg, onload, onerror, onprogress) {
8686
{{{ runtimeKeepalivePush() }}}
@@ -114,7 +114,7 @@ var LibraryWget = {
114114
FS.createDataFile( _file.substr(0, index), _file.substr(index + 1), new Uint8Array(/** @type{ArrayBuffer}*/(http.response)), true, true, false);
115115
if (onload) {
116116
withStackSave(function() {
117-
{{{ makeDynCall('viii', 'onload') }}}(handle, arg, allocateUTF8OnStack(_file));
117+
{{{ makeDynCall('viii', 'onload') }}}(handle, arg, stringToUTF8OnStack(_file));
118118
});
119119
}
120120
} else {
@@ -176,7 +176,7 @@ var LibraryWget = {
176176
withStackSave(() => {
177177
var statusText = 0;
178178
if (http.statusText) {
179-
statusText = allocateUTF8OnStack(http.statusText);
179+
statusText = stringToUTF8OnStack(http.statusText);
180180
}
181181
{{{ makeDynCall('viiii', 'onerror') }}}(handle, arg, http.status, statusText);
182182
});

‎src/postamble.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ function callMain() {
5454
var argv = stackAlloc((argc + 1) * {{{ POINTER_SIZE }}});
5555
var argv_ptr = argv >> {{{ POINTER_SHIFT }}};
5656
args.forEach((arg) => {
57-
{{{ POINTER_HEAP }}}[argv_ptr++] = {{{ to64('allocateUTF8OnStack(arg)') }}};
57+
{{{ POINTER_HEAP }}}[argv_ptr++] = {{{ to64('stringToUTF8OnStack(arg)') }}};
5858
});
5959
{{{ POINTER_HEAP }}}[argv_ptr] = {{{ to64('0') }}};
6060
#else

‎test/core/test_asan_js_stack_op.c

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,10 @@ EMSCRIPTEN_KEEPALIVE void c_func(char *str) {
55
printf("%s\n", str);
66
}
77

8-
EM_JS_DEPS(js_func, "$allocateUTF8OnStack");
8+
EM_JS_DEPS(js_func, "$stringToUTF8OnStack");
99

1010
EM_JS(void, js_func, (void), {
11-
_c_func(allocateUTF8OnStack('Hello, World!'));
11+
_c_func(stringToUTF8OnStack('Hello, World!'));
1212
});
1313

1414
int main(void) {

‎test/stack_overflow.cpp

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
#include <emscripten/em_asm.h>
1010
#include <emscripten/em_macros.h>
1111

12-
EM_JS_DEPS(main, "$allocateUTF8OnStack");
12+
EM_JS_DEPS(main, "$stringToUTF8OnStack");
1313

1414
void __attribute__((noinline)) InteropString(char *staticBuffer) {
1515
char *string = (char*)EM_ASM_PTR({
@@ -19,11 +19,11 @@ void __attribute__((noinline)) InteropString(char *staticBuffer) {
1919
for (var i = 0; i < 15; ++i) {
2020
str = str + str;
2121
}
22-
allocateUTF8OnStack(str);
22+
stringToUTF8OnStack(str);
2323
#else
2424
// allocate as many times as we need to overflow
2525
for (var i = 0; i < 1024 * 1024; i++) {
26-
allocateUTF8OnStack(str);
26+
stringToUTF8OnStack(str);
2727
}
2828
abort("we should never get here!");
2929
#endif

‎test/test_other.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13117,7 +13117,7 @@ def test_em_js_deps(self):
1311713117
create_file('f1.c', '''
1311813118
#include <emscripten.h>
1311913119

13120-
EM_JS_DEPS(other, "$allocateUTF8OnStack");
13120+
EM_JS_DEPS(other, "$stringToUTF8OnStack");
1312113121
''')
1312213122
create_file('f2.c', '''
1312313123
#include <emscripten.h>
@@ -13128,7 +13128,7 @@ def test_em_js_deps(self):
1312813128
EM_ASM({
1312913129
err(getHeapMax());
1313013130
var x = stackSave();
13131-
allocateUTF8OnStack("hello");
13131+
stringToUTF8OnStack("hello");
1313213132
stackRestore(x);
1313313133
});
1313413134
return 0;

0 commit comments

Comments
 (0)