emscripten/tools/deps_info.py

218 строки
11 KiB
Python

# Copyright 2020 The Emscripten Authors. All rights reserved.
# Emscripten is available under two separate licenses, the MIT license and the
# University of Illinois/NCSA Open Source License. Both these licenses can be
# found in the LICENSE file.
# deps_info is a mechanism that lets JS code depend on C functions. This
# needs special help because of how linking works:
#
# 1. Receive some input files (.o, .c, etc.) from the user.
# 2. Link them with system libraries.
# 3. Whatever symbols are still unresolved, look in JS libraries for them.
#
# This makes C->JS calls work in a natural way: if compiled code depends on
# a function foo() that is implemented in a JS library, it will be unresolved
# after stage 2, and therefore linked in at stage 3. The problem is the other
# direction: if a JS library function decides it needs some function from say
# libc, then at stage 3 it is too late to link in more libc code. That's
# where deps_info comes in.
#
# Specifically, before stage 2 (linking with system libraries) we look at what
# symbols are required by the input files. Imagine that js_func in a JS
# library depends on libc_func in libc. Then if deps_info tells us
#
# "js_func": ["libc_func"]
#
# then if we see js_func is required (undefined) before stage 2, then we add
# a requirement to link in libc_func when linking in system libraries. All
# we do with deps_info is see if any of the keys are among the
# undefined symbols before stage 2, and if they are, add their values to the
# things we need to link in.
#
# This usually works the way you want, but note that it happens *before* stage
# 2 and not after it. That is, we look for js_func before linking in system
# libraries. If you have a situation where
#
# user_code => other_libc_func => js_func => libc_func
#
# then the deps_info entry must contain
#
# "other_libc_func": ["libc_func"]
#
# because that is what we see before stage 2: all we see is that
# other_libc_func is going to be linked in, and we don't know yet that it
# will end up calling js_func. But the presence of a call to other_libc_func
# indicates that we will need libc_func linked in as well, so that is what the
# deps_info entry should contain.
#
# TODO: Move all __deps from src/library*.js to deps_info, and use that single source of info
# both here and in the JS compiler.
from tools.settings import settings
_deps_info = {
'Mix_LoadWAV_RW': ['fileno'],
'SDL_CreateRGBSurface': ['malloc', 'free'],
'SDL_GL_GetProcAddress': ['malloc'],
'SDL_Init': ['malloc', 'free', 'memcpy'],
'SDL_LockSurface': ['malloc', 'free'],
'SDL_OpenAudio': ['malloc', 'free'],
'SDL_PushEvent': ['malloc', 'free'],
'SDL_free': ['free'],
'SDL_malloc': ['malloc', 'free'],
'__cxa_allocate_exception': ['malloc'],
'__cxa_end_catch': ['setThrew', 'free'],
'__cxa_free_exception': ['free'],
'_embind_register_class': ['free'],
'_embind_register_enum_value': ['free'],
'_embind_register_function': ['free'],
'_embind_register_std_string': ['free'],
'_embind_register_std_wstring': ['free'],
'alGetString': ['malloc'],
'alcGetString': ['malloc'],
'bind': ['ntohs'],
'connect': ['ntohs'],
'ctime': ['_get_tzname', '_get_daylight', '_get_timezone', 'malloc'],
'ctime_r': ['_get_tzname', '_get_daylight', '_get_timezone', 'malloc'],
'dladdr': ['malloc'],
'dlerror': ['malloc', 'free'],
'eglGetProcAddress': ['malloc'],
'eglQueryString': ['malloc'],
'emscripten_GetProcAddress': ['malloc'],
'emscripten_SDL_SetEventHandler': ['malloc', 'free'],
'emscripten_alcGetStringiSOFT': ['malloc'],
'emscripten_async_wget2_data': ['malloc', 'free'],
'emscripten_async_wget_data': ['malloc', 'free'],
'emscripten_create_worker': ['malloc', 'free'],
'emscripten_get_compiler_setting': ['malloc'],
'emscripten_get_preloaded_image_data': ['malloc'],
'emscripten_get_preloaded_image_data_from_FILE': ['fileno'],
'emscripten_get_window_title': ['malloc'],
'emscripten_idb_async_load': ['malloc', 'free'],
'emscripten_idb_load': ['malloc', 'free'],
'emscripten_init_websocket_to_posix_socket_bridge': ['malloc', 'free'],
'emscripten_log': ['strlen'],
# This list is the same as setjmp's dependencies. In non-LTO builds, setjmp
# does not exist in the object files; it is converted into a code sequence
# that includes several functions, one of which is emscripten_longjmp. This is
# a trick to include these dependencies for setjmp even when setjmp does not
# exist. Refer to setjmp's entry for more details.
'emscripten_longjmp': ['malloc', 'free', 'saveSetjmp', 'setThrew'],
'emscripten_pc_get_file': ['emscripten_builtin_malloc', 'emscripten_builtin_free', 'emscripten_builtin_memalign', 'malloc', 'free'],
'emscripten_pc_get_function': ['emscripten_builtin_malloc', 'emscripten_builtin_free', 'emscripten_builtin_memalign', 'malloc', 'free'],
'emscripten_run_preload_plugins_data': ['malloc'],
'emscripten_run_script_string': ['malloc', 'free'],
'emscripten_set_batterychargingchange_callback_on_thread': ['malloc', 'free'],
'emscripten_set_batterylevelchange_callback_on_thread': ['malloc', 'free'],
'emscripten_set_beforeunload_callback_on_thread': ['malloc', 'free'],
'emscripten_set_blur_callback_on_thread': ['malloc', 'free'],
'emscripten_set_click_callback_on_thread': ['malloc', 'free'],
'emscripten_set_dblclick_callback_on_thread': ['malloc', 'free'],
'emscripten_set_devicemotion_callback_on_thread': ['malloc', 'free'],
'emscripten_set_deviceorientation_callback_on_thread': ['malloc', 'free'],
'emscripten_set_focus_callback_on_thread': ['malloc', 'free'],
'emscripten_set_focusin_callback_on_thread': ['malloc', 'free'],
'emscripten_set_focusout_callback_on_thread': ['malloc', 'free'],
'emscripten_set_fullscreenchange_callback_on_thread': ['malloc', 'free'],
'emscripten_set_gamepadconnected_callback_on_thread': ['malloc', 'free'],
'emscripten_set_gamepaddisconnected_callback_on_thread': ['malloc', 'free'],
'emscripten_set_keydown_callback_on_thread': ['malloc', 'free'],
'emscripten_set_keypress_callback_on_thread': ['malloc', 'free'],
'emscripten_set_keyup_callback_on_thread': ['malloc', 'free'],
'emscripten_set_mousedown_callback_on_thread': ['malloc', 'free'],
'emscripten_set_mouseenter_callback_on_thread': ['malloc', 'free'],
'emscripten_set_mouseleave_callback_on_thread': ['malloc', 'free'],
'emscripten_set_mousemove_callback_on_thread': ['malloc', 'free'],
'emscripten_set_mouseout_callback_on_thread': ['malloc', 'free'],
'emscripten_set_mouseover_callback_on_thread': ['malloc', 'free'],
'emscripten_set_mouseup_callback_on_thread': ['malloc', 'free'],
'emscripten_set_offscreencanvas_size_on_target_thread_js': ['malloc', 'free'],
'emscripten_set_orientationchange_callback_on_thread': ['malloc', 'free'],
'emscripten_set_pointerlockchange_callback_on_thread': ['malloc', 'free'],
'emscripten_set_pointerlockerror_callback_on_thread': ['malloc', 'free'],
'emscripten_set_resize_callback_on_thread': ['malloc', 'free'],
'emscripten_set_scroll_callback_on_thread': ['malloc', 'free'],
'emscripten_set_touchcancel_callback_on_thread': ['malloc', 'free'],
'emscripten_set_touchend_callback_on_thread': ['malloc', 'free'],
'emscripten_set_touchmove_callback_on_thread': ['malloc', 'free'],
'emscripten_set_touchstart_callback_on_thread': ['malloc', 'free'],
'emscripten_set_visibilitychange_callback_on_thread': ['malloc', 'free'],
'emscripten_set_wheel_callback_on_thread': ['malloc', 'free'],
'emscripten_webgl_create_context': ['malloc'],
'emscripten_webgl_destroy_context': ['emscripten_webgl_make_context_current', 'emscripten_webgl_get_current_context'],
'emscripten_webgl_get_parameter_utf8': ['malloc'],
'emscripten_webgl_get_program_info_log_utf8': ['malloc'],
'emscripten_webgl_get_shader_info_log_utf8': ['malloc'],
'emscripten_webgl_get_shader_source_utf8': ['malloc'],
'emscripten_webgl_get_supported_extensions': ['malloc'],
'emscripten_websocket_set_onclose_callback_on_thread': ['malloc', 'free'],
'emscripten_websocket_set_onerror_callback_on_thread': ['malloc', 'free'],
'emscripten_websocket_set_onmessage_callback_on_thread': ['malloc', 'free'],
'emscripten_websocket_set_onopen_callback_on_thread': ['malloc', 'free'],
'emscripten_wget_data': ['malloc', 'free'],
'gai_strerror': ['malloc'],
'getaddrinfo': ['malloc', 'htonl', 'htons', 'ntohs'],
'gethostbyaddr': ['malloc', 'htons'],
'gethostbyname': ['malloc', 'htons'],
'gethostbyname_r': ['malloc', 'free', 'htons', 'memcpy'],
'getnameinfo': ['htons', 'ntohs'],
'getpeername': ['htons'],
'getsockname': ['htons'],
'glGetString': ['malloc'],
'glGetStringi': ['malloc'],
'glMapBufferRange': ['malloc'],
'glewInit': ['malloc'],
'glfwGetProcAddress': ['malloc'],
'glfwInit': ['malloc', 'free'],
'glfwSleep': ['sleep'],
'gmtime': ['malloc'],
'gmtime_r': ['malloc'],
'localtime': ['_get_tzname', '_get_daylight', '_get_timezone', 'malloc'],
'localtime_r': ['_get_tzname', '_get_daylight', '_get_timezone', 'malloc'],
'mktime': ['_get_tzname', '_get_daylight', '_get_timezone', 'malloc'],
'mmap': ['memalign'],
'munmap': ['free'],
'pthread_create': ['malloc', 'free', 'emscripten_main_thread_process_queued_calls'],
'recv': ['htons'],
'accept': ['htons'],
'recvfrom': ['htons'],
'send': ['ntohs'],
# In WebAssemblyLowerEmscriptenEHSjLj pass in the LLVM backend, function calls
# that exist in the same function with setjmp are converted to some code
# sequence that includes invokes, malloc, free, saveSetjmp, and
# emscripten_longjmp. setThrew is called from invokes, but there's no way to
# directly include invokes in deps_info.py, so we list it as a setjmp's
# dependency.
'setjmp': ['malloc', 'free', 'saveSetjmp', 'setThrew'],
'setprotoent': ['malloc'],
'setgroups': ['sysconf'],
'syslog': ['malloc', 'ntohs'],
'vsyslog': ['malloc', 'ntohs'],
'timegm': ['_get_tzname', '_get_daylight', '_get_timezone', 'malloc'],
'tzset': ['_get_tzname', '_get_daylight', '_get_timezone', 'malloc'],
'uuid_compare': ['memcmp'],
'uuid_copy': ['memcpy'],
'wgpuBufferGetMappedRange': ['malloc', 'free'],
'wgpuBufferGetConstMappedRange': ['malloc', 'free'],
'emscripten_glGetString': ['malloc'],
}
def get_deps_info():
if not settings.EXCEPTION_HANDLING and settings.LINK_AS_CXX:
_deps_info['__cxa_begin_catch'] = ['__cxa_is_pointer_type']
_deps_info['__cxa_find_matching_catch'] = ['__cxa_can_catch']
_deps_info['__cxa_find_matching_catch_1'] = ['__cxa_can_catch']
_deps_info['__cxa_find_matching_catch_2'] = ['__cxa_can_catch']
_deps_info['__cxa_find_matching_catch_3'] = ['__cxa_can_catch']
_deps_info['__cxa_find_matching_catch_4'] = ['__cxa_can_catch']
_deps_info['__cxa_find_matching_catch_5'] = ['__cxa_can_catch']
_deps_info['__cxa_find_matching_catch_6'] = ['__cxa_can_catch']
_deps_info['__cxa_find_matching_catch_7'] = ['__cxa_can_catch']
_deps_info['__cxa_find_matching_catch_8'] = ['__cxa_can_catch']
_deps_info['__cxa_find_matching_catch_9'] = ['__cxa_can_catch']
if settings.USE_PTHREADS:
_deps_info['emscripten_set_canvas_element_size_calling_thread'] = ['_emscripten_call_on_thread']
_deps_info['emscripten_set_offscreencanvas_size_on_target_thread'] = ['_emscripten_call_on_thread', 'malloc', 'free']
return _deps_info