[ { "path": ".clang-format", "content": "# Copyright 2014 The Crashpad Authors\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n\n{\n BasedOnStyle: Chromium,\n AlignTrailingComments: false,\n BinPackArguments: false,\n}\n" }, { "path": ".gitattributes", "content": "# Copyright 2019 The Crashpad Authors\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n\n*.S text eol=lf\n*.asm text eol=lf\n*.c text eol=lf\n*.cc text eol=lf\n*.cmx text eol=lf\n*.css text eol=lf\n*.defs text eol=lf\n*.doxy text eol=lf\n*.gn text eol=lf\n*.gni text eol=lf\n*.go text eol=lf\n*.h text eol=lf\n*.m text eol=lf\n*.md text eol=lf\n*.mm text eol=lf\n*.pem text eol=lf\n*.plist text eol=lf\n*.proctype text eol=lf\n*.py text eol=lf\n*.sh text eol=lf\n*.sym text eol=lf\n*.txt text eol=lf\n*.yaml text eol=lf\n.clang-format text eol=lf\n.gitattributes text eol=lf\n.gitignore text eol=lf\n.vpython text eol=lf\n/AUTHORS text eol=lf\n/CONTRIBUTORS text eol=lf\n/LICENSE text eol=lf\n/codereview.settings text eol=lf\nAPPLE_LICENSE text eol=lf\nCOPYING.LIB text eol=lf\nDEPS text eol=lf\nREADME text eol=lf\nREADME.crashpad text eol=lf\n\n*.dat binary\n*.dll binary\n*.ico binary\n*.obj binary\n*.png binary\n*.so binary\n" }, { "path": ".gitignore", "content": "# Copyright 2014 The Crashpad Authors\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n\n# Keep sorted\n\n*.Makefile\n*.ninja\n*.pyc\n*.target.mk\n*.xcodeproj\n*~\n.*.sw?\n.DS_Store\n.cache\n.gdb_history\n.gdbinit\n/.vscode/\n/Makefile\n/build/fuchsia\n/out\n/third_party/edo/edo\n/third_party/fuchsia-gn-sdk\n/third_party/fuchsia/.cipd\n/third_party/fuchsia/clang\n/third_party/fuchsia/qemu\n/third_party/fuchsia/sdk\n/third_party/googletest/googletest\n/third_party/libfuzzer\n/third_party/linux/.cipd\n/third_party/linux/clang\n/third_party/linux/sysroot\n/third_party/lss/lss\n/third_party/mini_chromium/mini_chromium\n/third_party/ninja/linux\n/third_party/ninja/mac*\n/third_party/ninja/ninja.exe\n/third_party/windows/clang/win-amd64\n/third_party/zlib/zlib\n/xcodebuild\ntags\n" }, { "path": ".gn", "content": "# Copyright 2017 The Crashpad Authors\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n\nbuildconfig = \"//build/BUILDCONFIG.gn\"\nscript_executable = \"python3\"\n" }, { "path": ".style.yapf", "content": "# Copyright 2020 The Crashpad Authors\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n\n[style]\nbased_on_style = google\n" }, { "path": ".vpython3", "content": "# Copyright 2022 The Crashpad Authors\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n\n# This is a vpython \"spec\" file.\n#\n# It describes patterns for python wheel dependencies of the python scripts.\n#\n# Read more about `vpython` and how to modify this file here:\n# https://chromium.googlesource.com/infra/infra/+/master/doc/users/vpython.md\n\n# This is needed for snapshot/win/end_to_end_test.py.\nwheel: <\n name: \"infra/python/wheels/pywin32/${vpython_platform}\"\n version: \"version:300\"\n match_tag: <\n platform: \"win32\"\n >\n match_tag: <\n platform: \"win_amd64\"\n >\n>\n" }, { "path": "AUTHORS", "content": "# This is the official list of Crashpad authors for copyright purposes.\n# This file is distinct from the CONTRIBUTORS files.\n# See the latter for an explanation.\n\n# Names should be added to this file as:\n# Name or Organization \n# The email address is not required for organizations.\n\nGoogle Inc.\nIntel Corporation\nOpera Software ASA\nVewd Software AS\nLG Electronics, Inc.\nMIPS Technologies, Inc.\nDarshan Sen \nHo Cheung \n" }, { "path": "BUILD.gn", "content": "# Copyright 2017 The Crashpad Authors\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n\nimport(\"build/crashpad_buildconfig.gni\")\nimport(\"build/test.gni\")\nimport(\"util/net/tls.gni\")\n\nconfig(\"crashpad_config\") {\n include_dirs = [\n \".\",\n root_gen_dir,\n ]\n}\n\nif (crashpad_is_in_chromium || crashpad_is_in_fuchsia) {\n test(\"crashpad_tests\") {\n deps = [\n \"client:client_test\",\n \"minidump:minidump_test\",\n \"snapshot:snapshot_test\",\n \"test:googlemock_main\",\n \"test:test_test\",\n \"util:util_test\",\n ]\n\n data_deps = []\n\n if (crashpad_is_in_chromium) {\n data_deps += [ \"//testing/buildbot/filters:crashpad_tests_filters\" ]\n }\n\n if (!crashpad_is_ios && !crashpad_is_fuchsia) {\n deps += [ \"handler:handler_test\" ]\n }\n if (crashpad_is_in_fuchsia) {\n # TODO(fuchsia:46559): Fix the leaks and remove this.\n deps += [ \"//build/config/sanitizers:suppress-lsan.DO-NOT-USE-THIS\" ]\n\n # TODO(fxbug.dev/42059784): Remove this once the underlying issue is\n # addressed.\n exclude_toolchain_tags = [ \"hwasan\" ]\n }\n if (crashpad_is_android) {\n use_raw_android_executable = true\n\n # crbug.com/418874703 - This is a workaround to propagate the data deps to\n # //:crashpad_tests__dist for Android build.\n data_deps += [\n \"snapshot:crashpad_snapshot_test_both_dt_hash_styles\",\n \"snapshot:crashpad_snapshot_test_module\",\n \"snapshot:crashpad_snapshot_test_module_large\",\n \"snapshot:crashpad_snapshot_test_module_small\",\n \"test:crashpad_test_test_multiprocess_exec_test_child\",\n ]\n\n copy(\"crashpad_test_data\") {\n testonly = true\n sources = [\n \"test/test_paths_test_data_root.txt\",\n \"util/net/testdata/ascii_http_body.txt\",\n \"util/net/testdata/binary_http_body.dat\",\n ]\n\n outputs = [ \"$root_out_dir/crashpad_test_data/{{source}}\" ]\n }\n\n deps += [ \":crashpad_test_data\" ]\n\n extra_dist_files = [\n \"$root_out_dir/crashpad_handler\",\n \"$root_out_dir/crashpad_test_test_multiprocess_exec_test_child\",\n \"$root_out_dir/crashpad_test_data\",\n ]\n }\n }\n\n if (crashpad_is_in_fuchsia) {\n import(\"//build/components.gni\")\n fuchsia_test_component(\"crashpad-test-component\") {\n manifest = \"test/fuchsia_crashpad_tests.cml\"\n deps = [\n \":crashpad-test-resources\",\n \":crashpad_tests\",\n \"snapshot:crashpad_snapshot_test_both_dt_hash_styles\",\n \"snapshot:crashpad_snapshot_test_module\",\n \"snapshot:crashpad_snapshot_test_module_large\",\n \"snapshot:crashpad_snapshot_test_module_small\",\n \"test:crashpad_test_test_multiprocess_exec_test_child\",\n ]\n }\n\n fuchsia_test_package(\"crashpad-test\") {\n test_components = [ \":crashpad-test-component\" ]\n\n deps = [\n \"//src/connectivity/network/dns:component\",\n \"//src/connectivity/network/netstack:component\",\n ]\n\n test_specs = {\n log_settings = {\n max_severity = \"FATAL\"\n }\n }\n }\n\n _resource_files = [\n \"test/test_paths_test_data_root.txt\",\n \"util/net/testdata/ascii_http_body.txt\",\n \"util/net/testdata/binary_http_body.dat\",\n ]\n if (crashpad_use_boringssl_for_http_transport_socket) {\n _resource_files += [\n \"util/net/testdata/crashpad_util_test_cert.pem\",\n \"util/net/testdata/crashpad_util_test_key.pem\",\n ]\n }\n\n _resources = []\n foreach(resource_file, _resource_files) {\n _resource_file_target = string_replace(resource_file, \"/\", \"_\")\n resource(\"${_resource_file_target}\") {\n sources = [ \"${resource_file}\" ]\n outputs = [ \"data/${resource_file}\" ]\n }\n _resources += [ \":${_resource_file_target}\" ]\n }\n\n group(\"crashpad-test-resources\") {\n deps = _resources\n }\n\n group(\"tests\") {\n testonly = true\n\n deps = [ \":crashpad-test\" ]\n }\n }\n} else if (crashpad_is_standalone || crashpad_is_external) {\n test(\"crashpad_client_test\") {\n deps = [\n \"client:client_test\",\n \"test:googlemock_main\",\n ]\n }\n\n test(\"crashpad_handler_test\") {\n deps = [\n \"handler:handler_test\",\n \"test:googletest_main\",\n ]\n if (crashpad_is_ios || crashpad_is_fuchsia) {\n deps -= [ \"handler:handler_test\" ]\n }\n }\n\n test(\"crashpad_minidump_test\") {\n deps = [\n \"minidump:minidump_test\",\n \"test:googletest_main\",\n ]\n }\n\n test(\"crashpad_snapshot_test\") {\n deps = [\n \"snapshot:snapshot_test\",\n \"test:googlemock_main\",\n ]\n }\n\n test(\"crashpad_test_test\") {\n deps = [\n \"test:googlemock_main\",\n \"test:test_test\",\n ]\n }\n\n test(\"crashpad_util_test\") {\n deps = [\n \"test:googlemock_main\",\n \"util:util_test\",\n ]\n }\n}\n\nif (crashpad_is_ios) {\n group(\"ios_xcuitests\") {\n testonly = true\n deps = [ \"test/ios:all_tests\" ]\n }\n}\n" }, { "path": "CONTRIBUTORS", "content": "# People who have agreed to one of the CLAs and can contribute patches.\n# The AUTHORS file lists the copyright holders; this file\n# lists people. For example, Google employees are listed here\n# but not in AUTHORS, because Google holds the copyright.\n#\n# https://developers.google.com/open-source/cla/individual\n# https://developers.google.com/open-source/cla/corporate\n#\n# Names should be added to this file as:\n# Name \n\nMark Mentovai \nRobert Sesek \nScott Graham \nJoshua Peraza \n" }, { "path": "DEPS", "content": "# Copyright 2014 The Crashpad Authors\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n\nvars = {\n 'chromium_git': 'https://chromium.googlesource.com',\n 'gn_version': 'git_revision:5e19d2fb166fbd4f6f32147fbb2f497091a54ad8',\n # ninja CIPD package version.\n # https://chrome-infra-packages.appspot.com/p/infra/3pp/tools/ninja\n 'ninja_version': 'version:2@1.8.2.chromium.3',\n 'pull_linux_clang': False,\n 'pull_win_toolchain': False,\n # Controls whether crashpad/build/ios/setup-ios-gn.py is run as part of\n # gclient hooks. It is enabled by default for developer's convenience. It can\n # be disabled with custom_vars (done automatically on the bots).\n 'run_setup_ios_gn': True,\n}\n\ndeps = {\n 'buildtools':\n Var('chromium_git') + '/chromium/src/buildtools.git@' +\n 'efa920ce144e4dc1c1841e73179cd7e23b9f0d5e',\n 'buildtools/clang_format/script':\n Var('chromium_git') +\n '/external/github.com/llvm/llvm-project/clang/tools/clang-format.git@' +\n 'c912837e0d82b5ca4b6e790b573b3956d3744c1c',\n 'crashpad/third_party/edo/edo': {\n 'url': Var('chromium_git') + '/external/github.com/google/eDistantObject.git@' +\n '38e71ff183d76f702db6966fa7236c98831acd80',\n 'condition': 'checkout_ios',\n },\n 'crashpad/third_party/googletest/googletest':\n Var('chromium_git') + '/external/github.com/google/googletest@' +\n '3983f67e32fb3e9294487b9d4f9586efa6e5d088',\n 'crashpad/third_party/lss/lss':\n Var('chromium_git') + '/linux-syscall-support.git@' +\n '9719c1e1e676814c456b55f5f070eabad6709d31',\n 'crashpad/third_party/mini_chromium/mini_chromium':\n Var('chromium_git') + '/chromium/mini_chromium@' +\n '706fce5b1a280a6f2eea69040f67847f9acb65ff',\n 'crashpad/third_party/libfuzzer/src':\n Var('chromium_git') + '/chromium/llvm-project/compiler-rt/lib/fuzzer.git@' +\n 'fda403cf93ecb8792cb1d061564d89a6553ca020',\n 'crashpad/third_party/zlib/zlib':\n Var('chromium_git') + '/chromium/src/third_party/zlib@' +\n 'fef58692c1d7bec94c4ed3d030a45a1832a9615d',\n\n # CIPD packages.\n 'buildtools/linux64': {\n 'packages': [\n {\n 'package': 'gn/gn/linux-${{arch}}',\n 'version': Var('gn_version'),\n }\n ],\n 'dep_type': 'cipd',\n 'condition': 'host_os == \"linux\"',\n },\n 'buildtools/mac': {\n 'packages': [\n {\n 'package': 'gn/gn/mac-${{arch}}',\n 'version': Var('gn_version'),\n }\n ],\n 'dep_type': 'cipd',\n 'condition': 'host_os == \"mac\"',\n },\n 'buildtools/win': {\n 'packages': [\n {\n 'package': 'gn/gn/windows-amd64',\n 'version': Var('gn_version'),\n }\n ],\n 'dep_type': 'cipd',\n 'condition': 'host_os == \"win\"',\n },\n 'crashpad/build/fuchsia': {\n 'packages': [\n {\n 'package': 'chromium/fuchsia/test-scripts',\n 'version': 'latest',\n }\n ],\n 'condition': 'checkout_fuchsia',\n 'dep_type': 'cipd',\n },\n 'crashpad/third_party/linux/clang/linux-amd64': {\n 'packages': [\n {\n 'package': 'fuchsia/third_party/clang/linux-amd64',\n 'version': 'Tpc85d1ZwSlZ6UKl2d96GRUBGNA5JKholOKe24sRDr0C',\n },\n ],\n 'condition': 'checkout_linux and pull_linux_clang',\n 'dep_type': 'cipd'\n },\n 'crashpad/third_party/fuchsia/clang/mac-amd64': {\n 'packages': [\n {\n 'package': 'fuchsia/third_party/clang/mac-amd64',\n 'version': 'integration',\n },\n ],\n 'condition': 'checkout_fuchsia and host_os == \"mac\"',\n 'dep_type': 'cipd'\n },\n 'crashpad/third_party/fuchsia/clang/linux-amd64': {\n 'packages': [\n {\n 'package': 'fuchsia/third_party/clang/linux-amd64',\n 'version': 'integration',\n },\n ],\n 'condition': 'checkout_fuchsia and host_os == \"linux\"',\n 'dep_type': 'cipd'\n },\n 'crashpad/third_party/windows/clang/win-amd64': {\n 'bucket': 'chromium-browser-clang',\n 'objects': [\n {\n 'object_name': 'Win/clang-llvmorg-20-init-17108-g29ed6000-2.tar.xz',\n 'sha256sum': '1c71efd923a91480480d4f31c2fd5f1369e01e14f15776a9454abbce0bc13548',\n 'size_bytes': 46357580,\n 'generation': 1737590897363452,\n },\n ],\n 'condition': 'checkout_win and host_os == \"win\"',\n 'dep_type': 'gcs',\n },\n 'crashpad/third_party/fuchsia-gn-sdk': {\n 'packages': [\n {\n 'package': 'chromium/fuchsia/gn-sdk',\n 'version': 'latest'\n },\n ],\n 'condition': 'checkout_fuchsia',\n 'dep_type': 'cipd'\n },\n 'crashpad/third_party/fuchsia/sdk/linux-amd64': {\n 'packages': [\n {\n 'package': 'fuchsia/sdk/core/linux-amd64',\n 'version': 'latest'\n },\n ],\n 'condition': 'checkout_fuchsia and host_os == \"linux\"',\n 'dep_type': 'cipd'\n },\n # depot_tools/ninja wrapper calls third_party/ninja/{ninja, ninja.exe}.\n # crashpad/third_party/ninja/ninja is another wrapper to call linux ninja\n # or mac ninja.\n # This allows crashpad developers to work for multiple platforms on the same\n # machine.\n 'crashpad/third_party/ninja': {\n 'packages': [\n {\n 'package': 'infra/3pp/tools/ninja/${{platform}}',\n 'version': Var('ninja_version'),\n }\n ],\n 'condition': 'host_os == \"win\"',\n 'dep_type': 'cipd',\n },\n 'crashpad/third_party/ninja/linux': {\n 'packages': [\n {\n 'package': 'infra/3pp/tools/ninja/${{platform}}',\n 'version': Var('ninja_version'),\n }\n ],\n 'condition': 'host_os == \"linux\"',\n 'dep_type': 'cipd',\n },\n 'crashpad/third_party/ninja/mac-amd64': {\n 'packages': [\n {\n 'package': 'infra/3pp/tools/ninja/mac-amd64',\n 'version': Var('ninja_version'),\n }\n ],\n 'condition': 'host_os == \"mac\" and host_cpu == \"x64\"',\n 'dep_type': 'cipd',\n },\n 'crashpad/third_party/ninja/mac-arm64': {\n 'packages': [\n {\n 'package': 'infra/3pp/tools/ninja/mac-arm64',\n 'version': Var('ninja_version'),\n }\n ],\n 'condition': 'host_os == \"mac\" and host_cpu == \"arm64\"',\n 'dep_type': 'cipd',\n },\n 'crashpad/third_party/win/toolchain': {\n # This package is only updated when the solution in .gclient includes an\n # entry like:\n # \"custom_vars\": { \"pull_win_toolchain\": True }\n # This is because the contained bits are not redistributable.\n 'packages': [\n {\n 'package': 'chrome_internal/third_party/sdk/windows',\n 'version': 'uploaded:2021-04-28'\n },\n ],\n 'condition': 'checkout_win and pull_win_toolchain',\n 'dep_type': 'cipd'\n },\n}\n\nhooks = [\n {\n # If using a local clang (\"pull_linux_clang\" above), also pull down a\n # sysroot.\n 'name': 'sysroot_linux',\n 'pattern': '.',\n 'condition': 'checkout_linux and pull_linux_clang',\n 'action': [\n 'crashpad/build/install_linux_sysroot.py',\n ],\n },\n {\n # Avoid introducing unnecessary PRESUBMIT.py file from build/fuchsia.\n # Never fail and ignore the error if the file does not exist.\n 'name': 'Remove the PRESUBMIT.py from build/fuchsia',\n 'pattern': '.',\n 'condition': 'checkout_fuchsia',\n 'action': [\n 'rm',\n '-f',\n 'crashpad/build/fuchsia/PRESUBMIT.py',\n ],\n },\n {\n 'name': 'Generate Fuchsia Build Definitions',\n 'pattern': '.',\n 'condition': 'checkout_fuchsia',\n 'action': [\n 'python3',\n 'crashpad/build/fuchsia_envs.py',\n 'crashpad/build/fuchsia/gen_build_defs.py'\n ],\n },\n {\n 'name': 'setup_gn_ios',\n 'pattern': '.',\n 'condition': 'run_setup_ios_gn and checkout_ios',\n 'action': [\n 'python3',\n 'crashpad/build/ios/setup_ios_gn.py'\n ],\n },\n]\n\nrecursedeps = [\n 'buildtools',\n]\n" }, { "path": "LICENSE", "content": "\n Apache License\n Version 2.0, January 2004\n http://www.apache.org/licenses/\n\n TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION\n\n 1. Definitions.\n\n \"License\" shall mean the terms and conditions for use, reproduction,\n and distribution as defined by Sections 1 through 9 of this document.\n\n \"Licensor\" shall mean the copyright owner or entity authorized by\n the copyright owner that is granting the License.\n\n \"Legal Entity\" shall mean the union of the acting entity and all\n other entities that control, are controlled by, or are under common\n control with that entity. For the purposes of this definition,\n \"control\" means (i) the power, direct or indirect, to cause the\n direction or management of such entity, whether by contract or\n otherwise, or (ii) ownership of fifty percent (50%) or more of the\n outstanding shares, or (iii) beneficial ownership of such entity.\n\n \"You\" (or \"Your\") shall mean an individual or Legal Entity\n exercising permissions granted by this License.\n\n \"Source\" form shall mean the preferred form for making modifications,\n including but not limited to software source code, documentation\n source, and configuration files.\n\n \"Object\" form shall mean any form resulting from mechanical\n transformation or translation of a Source form, including but\n not limited to compiled object code, generated documentation,\n and conversions to other media types.\n\n \"Work\" shall mean the work of authorship, whether in Source or\n Object form, made available under the License, as indicated by a\n copyright notice that is included in or attached to the work\n (an example is provided in the Appendix below).\n\n \"Derivative Works\" shall mean any work, whether in Source or Object\n form, that is based on (or derived from) the Work and for which the\n editorial revisions, annotations, elaborations, or other modifications\n represent, as a whole, an original work of authorship. For the purposes\n of this License, Derivative Works shall not include works that remain\n separable from, or merely link (or bind by name) to the interfaces of,\n the Work and Derivative Works thereof.\n\n \"Contribution\" shall mean any work of authorship, including\n the original version of the Work and any modifications or additions\n to that Work or Derivative Works thereof, that is intentionally\n submitted to Licensor for inclusion in the Work by the copyright owner\n or by an individual or Legal Entity authorized to submit on behalf of\n the copyright owner. For the purposes of this definition, \"submitted\"\n means any form of electronic, verbal, or written communication sent\n to the Licensor or its representatives, including but not limited to\n communication on electronic mailing lists, source code control systems,\n and issue tracking systems that are managed by, or on behalf of, the\n Licensor for the purpose of discussing and improving the Work, but\n excluding communication that is conspicuously marked or otherwise\n designated in writing by the copyright owner as \"Not a Contribution.\"\n\n \"Contributor\" shall mean Licensor and any individual or Legal Entity\n on behalf of whom a Contribution has been received by Licensor and\n subsequently incorporated within the Work.\n\n 2. Grant of Copyright License. Subject to the terms and conditions of\n this License, each Contributor hereby grants to You a perpetual,\n worldwide, non-exclusive, no-charge, royalty-free, irrevocable\n copyright license to reproduce, prepare Derivative Works of,\n publicly display, publicly perform, sublicense, and distribute the\n Work and such Derivative Works in Source or Object form.\n\n 3. Grant of Patent License. Subject to the terms and conditions of\n this License, each Contributor hereby grants to You a perpetual,\n worldwide, non-exclusive, no-charge, royalty-free, irrevocable\n (except as stated in this section) patent license to make, have made,\n use, offer to sell, sell, import, and otherwise transfer the Work,\n where such license applies only to those patent claims licensable\n by such Contributor that are necessarily infringed by their\n Contribution(s) alone or by combination of their Contribution(s)\n with the Work to which such Contribution(s) was submitted. If You\n institute patent litigation against any entity (including a\n cross-claim or counterclaim in a lawsuit) alleging that the Work\n or a Contribution incorporated within the Work constitutes direct\n or contributory patent infringement, then any patent licenses\n granted to You under this License for that Work shall terminate\n as of the date such litigation is filed.\n\n 4. Redistribution. You may reproduce and distribute copies of the\n Work or Derivative Works thereof in any medium, with or without\n modifications, and in Source or Object form, provided that You\n meet the following conditions:\n\n (a) You must give any other recipients of the Work or\n Derivative Works a copy of this License; and\n\n (b) You must cause any modified files to carry prominent notices\n stating that You changed the files; and\n\n (c) You must retain, in the Source form of any Derivative Works\n that You distribute, all copyright, patent, trademark, and\n attribution notices from the Source form of the Work,\n excluding those notices that do not pertain to any part of\n the Derivative Works; and\n\n (d) If the Work includes a \"NOTICE\" text file as part of its\n distribution, then any Derivative Works that You distribute must\n include a readable copy of the attribution notices contained\n within such NOTICE file, excluding those notices that do not\n pertain to any part of the Derivative Works, in at least one\n of the following places: within a NOTICE text file distributed\n as part of the Derivative Works; within the Source form or\n documentation, if provided along with the Derivative Works; or,\n within a display generated by the Derivative Works, if and\n wherever such third-party notices normally appear. The contents\n of the NOTICE file are for informational purposes only and\n do not modify the License. You may add Your own attribution\n notices within Derivative Works that You distribute, alongside\n or as an addendum to the NOTICE text from the Work, provided\n that such additional attribution notices cannot be construed\n as modifying the License.\n\n You may add Your own copyright statement to Your modifications and\n may provide additional or different license terms and conditions\n for use, reproduction, or distribution of Your modifications, or\n for any such Derivative Works as a whole, provided Your use,\n reproduction, and distribution of the Work otherwise complies with\n the conditions stated in this License.\n\n 5. Submission of Contributions. Unless You explicitly state otherwise,\n any Contribution intentionally submitted for inclusion in the Work\n by You to the Licensor shall be under the terms and conditions of\n this License, without any additional terms or conditions.\n Notwithstanding the above, nothing herein shall supersede or modify\n the terms of any separate license agreement you may have executed\n with Licensor regarding such Contributions.\n\n 6. Trademarks. This License does not grant permission to use the trade\n names, trademarks, service marks, or product names of the Licensor,\n except as required for reasonable and customary use in describing the\n origin of the Work and reproducing the content of the NOTICE file.\n\n 7. Disclaimer of Warranty. Unless required by applicable law or\n agreed to in writing, Licensor provides the Work (and each\n Contributor provides its Contributions) on an \"AS IS\" BASIS,\n WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or\n implied, including, without limitation, any warranties or conditions\n of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A\n PARTICULAR PURPOSE. You are solely responsible for determining the\n appropriateness of using or redistributing the Work and assume any\n risks associated with Your exercise of permissions under this License.\n\n 8. Limitation of Liability. In no event and under no legal theory,\n whether in tort (including negligence), contract, or otherwise,\n unless required by applicable law (such as deliberate and grossly\n negligent acts) or agreed to in writing, shall any Contributor be\n liable to You for damages, including any direct, indirect, special,\n incidental, or consequential damages of any character arising as a\n result of this License or out of the use or inability to use the\n Work (including but not limited to damages for loss of goodwill,\n work stoppage, computer failure or malfunction, or any and all\n other commercial damages or losses), even if such Contributor\n has been advised of the possibility of such damages.\n\n 9. Accepting Warranty or Additional Liability. While redistributing\n the Work or Derivative Works thereof, You may choose to offer,\n and charge a fee for, acceptance of support, warranty, indemnity,\n or other liability obligations and/or rights consistent with this\n License. However, in accepting such obligations, You may act only\n on Your own behalf and on Your sole responsibility, not on behalf\n of any other Contributor, and only if You agree to indemnify,\n defend, and hold each Contributor harmless for any liability\n incurred by, or claims asserted against, such Contributor by reason\n of your accepting any such warranty or additional liability.\n\n END OF TERMS AND CONDITIONS\n\n APPENDIX: How to apply the Apache License to your work.\n\n To apply the Apache License to your work, attach the following\n boilerplate notice, with the fields enclosed by brackets \"[]\"\n replaced with your own identifying information. (Don't include\n the brackets!) The text should be enclosed in the appropriate\n comment syntax for the file format. We also recommend that a\n file or class name and description of purpose be included on the\n same \"printed page\" as the copyright notice for easier\n identification within third-party archives.\n\n Copyright [yyyy] [name of copyright owner]\n\n Licensed under the Apache License, Version 2.0 (the \"License\");\n you may not use this file except in compliance with the License.\n You may obtain a copy of the License at\n\n http://www.apache.org/licenses/LICENSE-2.0\n\n Unless required by applicable law or agreed to in writing, software\n distributed under the License is distributed on an \"AS IS\" BASIS,\n WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n See the License for the specific language governing permissions and\n limitations under the License.\n" }, { "path": "OWNERS", "content": "# Copyright 2025 The Crashpad Authors\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n\njperaza@chromium.org\njustincohen@chromium.org\nlgrey@chromium.org\nmark@chromium.org\npbos@chromium.org\nwfh@chromium.org\n" }, { "path": "README.md", "content": "\n\n# Crashpad\n\n[Crashpad](https://crashpad.chromium.org/) is a crash-reporting system.\n\n## Documentation\n\n * [Project status](doc/status.md)\n * [Developing Crashpad](doc/developing.md): instructions for getting the source\n code, building, testing, and contributing to the project.\n * [Crashpad interface documentation](https://crashpad.chromium.org/doxygen/)\n * [Crashpad tool man pages](doc/man.md)\n * [Crashpad overview design](doc/overview_design.md)\n\n## Source Code\n\nCrashpad’s source code is hosted in a Git repository at\nhttps://chromium.googlesource.com/crashpad/crashpad.\n\n## Other Links\n\n * Bugs can be reported at the [Crashpad issue\n tracker](https://crashpad.chromium.org/bug/).\n * The [Crashpad bots](https://ci.chromium.org/p/crashpad/g/main/console)\n perform automated builds and tests.\n * [crashpad-dev](https://groups.google.com/a/chromium.org/group/crashpad-dev)\n is the Crashpad developers’ mailing list.\n" }, { "path": "build/BUILD.gn", "content": "# Copyright 2017 The Crashpad Authors\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n\n# When building in Chromium, these configs is used to set #defines that indicate\n# whether code is being built standalone, or in Chromium, or potentially in some\n# other configutation.\n\nimport(\"crashpad_buildconfig.gni\")\n\nconfig(\"crashpad_is_in_chromium\") {\n if (crashpad_is_in_chromium) {\n defines = [ \"CRASHPAD_IS_IN_CHROMIUM\" ]\n }\n}\n\nconfig(\"crashpad_is_in_fuchsia\") {\n if (crashpad_is_in_fuchsia) {\n defines = [ \"CRASHPAD_IS_IN_FUCHSIA\" ]\n }\n}\n\nconfig(\"flock_always_supported_defines\") {\n defines =\n [ \"CRASHPAD_FLOCK_ALWAYS_SUPPORTED=$crashpad_flock_always_supported\" ]\n}\n\ngroup(\"default_exe_manifest_win\") {\n if (crashpad_is_in_chromium) {\n deps = [ \"//build/win:default_exe_manifest\" ]\n }\n}\n\nconfig(\"crashpad_fuzzer_flags\") {\n cflags = [\n \"-fsanitize=address\",\n \"-fsanitize-address-use-after-scope\",\n \"-fsanitize=fuzzer\",\n ]\n\n ldflags = [ \"-fsanitize=address\" ]\n}\n\nif (crashpad_is_apple) {\n group(\"apple_enable_arc\") {\n # If `crashpad_is_in_chromium`, then because Chromium enables ARC\n # compilation by default, no special configuration is needed.\n\n if (crashpad_is_standalone) {\n public_configs = [ \"//third_party/mini_chromium/mini_chromium/build/config:apple_enable_arc\" ]\n }\n }\n}\n\nif (crashpad_is_ios) {\n group(\"ios_xctest\") {\n if (crashpad_is_in_chromium) {\n public_configs = [ \"//build/config/ios:xctest_config\" ]\n } else if (crashpad_is_standalone) {\n public_configs = [\n \"//third_party/mini_chromium/mini_chromium/build/ios:xctest_config\",\n ]\n }\n }\n\n if (crashpad_is_in_chromium) {\n import(\"//build/config/ios/ios_sdk.gni\")\n crashpad_is_ios_app_extension = ios_is_app_extension\n } else {\n crashpad_is_ios_app_extension = false\n }\n\n config(\"crashpad_is_ios_app_extension\") {\n if (crashpad_is_ios_app_extension) {\n defines = [ \"CRASHPAD_IS_IOS_APP_EXTENSION\" ]\n }\n }\n}\n" }, { "path": "build/BUILDCONFIG.gn", "content": "# Copyright 2017 The Crashpad Authors\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n\n# Intentionally very minimal, so that Crashpad can build in-tree in a variety of\n# other projects, unrelated to the variables that are set in those projects'\n# BUILDCONFIG.gn. Do not add more variables here. Instead, make them available\n# in build/crashpad_buildconfig.gni if they must be globally available.\n\nif (target_os == \"\") {\n target_os = host_os\n}\n\nif (current_os == \"\") {\n current_os = target_os\n}\n\nif (target_cpu == \"\") {\n target_cpu = host_cpu\n}\n\nif (current_cpu == \"\") {\n current_cpu = target_cpu\n}\n\nimport(\"//build/crashpad_buildconfig.gni\")\n\nif (crashpad_is_standalone) {\n _mini_chromium_dir = \"//third_party/mini_chromium/mini_chromium\"\n} else if (crashpad_is_external) {\n _mini_chromium_dir = \"//../../mini_chromium/mini_chromium\"\n}\n\nif (current_os == \"win\") {\n set_default_toolchain(\n \"$_mini_chromium_dir/build/config:msvc_toolchain_$current_cpu\")\n} else {\n set_default_toolchain(\"$_mini_chromium_dir/build/config:gcc_like_toolchain\")\n}\n\ndeclare_args() {\n # When true, enables the debug configuration, with additional run-time checks\n # and logging. When false, enables the release configuration, with additional\n # optimizations.\n is_debug = false\n\n # When true, build all code with -fsanitize=fuzzer, and enable various\n # *_fuzzer targets.\n crashpad_use_libfuzzer = false\n}\n\n_default_configs = [\n \"$_mini_chromium_dir/build/config:default\",\n \"$_mini_chromium_dir/build/config:Wexit_time_destructors\",\n \"$_mini_chromium_dir/build/config:Wimplicit_fallthrough\",\n]\n\nif (crashpad_use_libfuzzer) {\n _default_configs += [ \"//build/config:crashpad_fuzzer_flags\" ]\n}\n\nif (current_os == \"fuchsia\") {\n _default_configs += [\n \"//third_party/fuchsia-gn-sdk/src/config:compiler\",\n \"//third_party/fuchsia-gn-sdk/src/config:runtime_library\",\n ]\n import(\"//third_party/fuchsia-gn-sdk/src/gn_configs.gni\")\n}\n\n_default_executable_configs = _default_configs + [\n \"$_mini_chromium_dir/build/config:executable\",\n \"$_mini_chromium_dir/build/config:win_console\",\n ]\n\nset_defaults(\"source_set\") {\n configs = _default_configs\n}\n\nset_defaults(\"static_library\") {\n configs = _default_configs\n}\n\nset_defaults(\"executable\") {\n configs = _default_executable_configs\n}\n\nset_defaults(\"loadable_module\") {\n configs = _default_configs\n}\n\nset_defaults(\"shared_library\") {\n configs = _default_configs\n}\n\nset_defaults(\"test\") {\n configs = _default_executable_configs\n}\n" }, { "path": "build/config/fuchsia/gn_configs.gni", "content": "# Copyright 2024 The Crashpad Authors\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n\n# This file is copied from\n# https://crsrc.org/c/build/config/fuchsia/gn_configs.gni?q=gn_configs.gni\n# with some local modifications to match the crashpad setup.\n\n# Path to the fuchsia SDK. This is intended for use in other templates &\n# rules to reference the contents of the fuchsia SDK.\nfuchsia_sdk = \"//third_party/fuchsia/sdk/linux-amd64\"\n\ndeclare_args() {\n # Specify a readelf_exec path to use. If not specified, the host's system\n # executable will be used. Passed to populate_build_id_dir.py and\n # prepare_package_inputs.py via the --readelf-exec flag.\n # Must be a GN path (not an absolute path) since it is adjusted with\n # rebase_path().\n if (!defined(fuchsia_sdk_readelf_exec)) {\n fuchsia_sdk_readelf_exec = \"\"\n }\n}\n" }, { "path": "build/crashpad_buildconfig.gni", "content": "# Copyright 2017 The Crashpad Authors\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n\ndeclare_args() {\n # Determines various flavors of build configuration, and which concrete\n # targets to use for dependencies. Valid values are \"standalone\", \"chromium\",\n # \"fuchsia\", \"dart\" or \"external\".\n crashpad_dependencies = \"standalone\"\n\n if (defined(is_fuchsia_tree) && is_fuchsia_tree) {\n crashpad_dependencies = \"fuchsia\"\n }\n}\n\nassert(\n crashpad_dependencies == \"chromium\" || crashpad_dependencies == \"fuchsia\" ||\n crashpad_dependencies == \"standalone\" ||\n crashpad_dependencies == \"external\" || crashpad_dependencies == \"dart\")\n\ncrashpad_is_in_chromium = crashpad_dependencies == \"chromium\"\ncrashpad_is_in_fuchsia = crashpad_dependencies == \"fuchsia\"\ncrashpad_is_in_dart = crashpad_dependencies == \"dart\"\ncrashpad_is_external = crashpad_dependencies == \"external\"\ncrashpad_is_standalone = crashpad_dependencies == \"standalone\"\n\n# This is the parent directory that contains the mini_chromium source dir.\n# This variable is not used when crashpad_is_in_chromium.\nif (crashpad_is_in_fuchsia) {\n import(\"//third_party/crashpad/fuchsia_buildconfig.gni\")\n mini_chromium_source_parent =\n fuchsia_crashpad_root + \"/third_party/mini_chromium\"\n} else {\n mini_chromium_source_parent = \"../third_party/mini_chromium\"\n}\n\n# This is the source directory of mini_chromium (what is checked out).\n_mini_chromium_source_root = \"$mini_chromium_source_parent/mini_chromium\"\n\n# This references the mini_chromium location for importing GN files.\nif (crashpad_is_external || crashpad_is_in_dart) {\n mini_chromium_import_root = \"../../../$_mini_chromium_source_root\"\n} else if (crashpad_is_in_fuchsia) {\n mini_chromium_import_root = fuchsia_mini_chromium_root\n} else {\n mini_chromium_import_root = _mini_chromium_source_root\n}\n\nif (crashpad_is_in_chromium) {\n if (is_ios) {\n # For `target_platform`.\n import(\"//build/config/apple/mobile_config.gni\")\n }\n\n crashpad_is_mac = is_mac\n crashpad_is_ios = is_ios\n crashpad_is_tvos = is_ios && target_platform == \"tvos\"\n crashpad_is_apple = is_apple\n crashpad_is_win = is_win\n crashpad_is_linux = is_linux || is_chromeos\n crashpad_is_android = is_android\n crashpad_is_fuchsia = is_fuchsia\n\n crashpad_is_posix = is_posix\n\n crashpad_is_clang = is_clang\n} else {\n import(\"$mini_chromium_import_root/build/compiler.gni\")\n import(\"$mini_chromium_import_root/build/platform.gni\")\n\n if (mini_chromium_is_ios) {\n # For `target_platform`.\n import(\"$mini_chromium_import_root/build/ios/ios_sdk.gni\")\n }\n\n crashpad_is_mac = mini_chromium_is_mac\n crashpad_is_ios = mini_chromium_is_ios\n crashpad_is_tvos = crashpad_is_ios && target_platform == \"tvos\"\n crashpad_is_apple = mini_chromium_is_apple\n crashpad_is_win = mini_chromium_is_win\n crashpad_is_linux = mini_chromium_is_linux\n crashpad_is_android = mini_chromium_is_android\n crashpad_is_fuchsia = mini_chromium_is_fuchsia\n\n crashpad_is_posix = mini_chromium_is_posix\n\n crashpad_is_clang = mini_chromium_is_clang\n\n # fuchsia-gn-sdk from chromium uses \"is_fuchsia\" condition.\n is_fuchsia = crashpad_is_fuchsia\n}\n\ncrashpad_flock_always_supported = !(crashpad_is_android || crashpad_is_fuchsia)\n\ntemplate(\"crashpad_executable\") {\n executable(target_name) {\n forward_variables_from(invoker,\n \"*\",\n [\n \"configs\",\n \"remove_configs\",\n ])\n if (defined(invoker.remove_configs)) {\n configs -= invoker.remove_configs\n }\n\n if (defined(invoker.configs)) {\n configs += invoker.configs\n }\n\n if (crashpad_is_in_fuchsia) {\n conversion_config = [ \"//build/config:Wno-conversion\" ]\n if (configs + conversion_config - conversion_config == configs) {\n # TODO(https://fxbug.dev/42136089): Decide if these are worth enabling.\n configs += conversion_config\n }\n }\n }\n}\n\ntemplate(\"crashpad_loadable_module\") {\n loadable_module(target_name) {\n forward_variables_from(invoker,\n \"*\",\n [\n \"configs\",\n \"remove_configs\",\n ])\n if (defined(invoker.remove_configs)) {\n configs -= invoker.remove_configs\n }\n\n if (defined(invoker.configs)) {\n configs += invoker.configs\n }\n\n if (crashpad_is_in_fuchsia) {\n conversion_config = [ \"//build/config:Wno-conversion\" ]\n if (configs + conversion_config - conversion_config == configs) {\n # TODO(https://fxbug.dev/42136089): Decide if these are worth enabling.\n configs += conversion_config\n }\n }\n }\n}\n\ntemplate(\"crashpad_static_library\") {\n static_library(target_name) {\n forward_variables_from(invoker,\n \"*\",\n [\n \"configs\",\n \"remove_configs\",\n ])\n if (defined(invoker.remove_configs)) {\n configs -= invoker.remove_configs\n }\n\n if (defined(invoker.configs)) {\n configs += invoker.configs\n }\n\n if (crashpad_is_in_fuchsia) {\n conversion_config = [ \"//build/config:Wno-conversion\" ]\n if (configs + conversion_config - conversion_config == configs) {\n # TODO(https://fxbug.dev/42136089): Decide if these are worth enabling.\n configs += conversion_config\n }\n }\n }\n}\n" }, { "path": "build/crashpad_fuzzer_test.gni", "content": "# Copyright 2018 The Crashpad Authors\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n\nimport(\"crashpad_buildconfig.gni\")\nimport(\"test.gni\")\nif (crashpad_is_in_chromium) {\n import(\"//testing/libfuzzer/fuzzer_test.gni\")\n}\n\ntemplate(\"crashpad_fuzzer_test\") {\n if (crashpad_is_standalone && crashpad_use_libfuzzer) {\n test(target_name) {\n forward_variables_from(invoker,\n [\n \"cflags\",\n \"cflags_cc\",\n \"check_includes\",\n \"defines\",\n \"include_dirs\",\n \"sources\",\n ])\n configs += [ \"..:crashpad_config\" ]\n if (defined(invoker.deps)) {\n deps = invoker.deps\n }\n deps += [ \"../third_party/libfuzzer\" ]\n\n if (!defined(invoker.cflags)) {\n cflags = []\n }\n cflags += [ \"-fsanitize=fuzzer\" ]\n }\n if (defined(invoker.seed_corpus)) {\n not_needed(invoker, [ \"seed_corpus\" ])\n }\n } else if (crashpad_is_in_chromium && use_fuzzing_engine) {\n # Append \"crashpad_\" to the beginning of the fuzzer's name to make it easier\n # in Chromium to recognize where fuzzer came from.\n forward_variables_from(invoker, \"*\")\n fuzzer_test(\"crashpad_\" + target_name) {\n }\n } else {\n not_needed(invoker, \"*\")\n group(target_name) {\n }\n }\n}\n" }, { "path": "build/fuchsia_envs.py", "content": "#!/usr/bin/env python3\n\n# Copyright 2024 The Crashpad Authors\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n\nimport os\nimport platform\nimport subprocess\nimport sys\n\n\ndef main(args):\n \"\"\"\n Executes the test-scripts with required environment variables. It acts like\n /usr/bin/env, but provides some extra functionality to dynamically set up\n the environment variables.\n\n Args:\n args: the command line arguments without the script name itself.\n \"\"\"\n os.environ['SRC_ROOT'] = os.path.abspath(\n os.path.join(os.path.dirname(__file__), '..'))\n\n assert platform.system() == 'Linux', 'Unsupported OS ' + platform.system()\n os.environ['FUCHSIA_SDK_ROOT'] = os.path.join(\n os.environ['SRC_ROOT'], 'third_party/fuchsia/sdk/linux-amd64/')\n os.environ['FUCHSIA_GN_SDK_ROOT'] = os.path.join(\n os.environ['SRC_ROOT'], 'third_party/fuchsia-gn-sdk/src')\n os.environ['FUCHSIA_READELF'] = os.path.join(os.environ['SRC_ROOT'],\n 'third_party/fuchsia/clang/linux-amd64/bin/llvm-readelf')\n\n return subprocess.run(args).returncode\n\n\nif __name__ == '__main__':\n sys.exit(main(sys.argv[1:]))\n" }, { "path": "build/install_linux_sysroot.py", "content": "#!/usr/bin/env python3\n\n# Copyright 2018 The Crashpad Authors\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n\n# Various code adapted from:\n# https://cs.chromium.org/chromium/src/build/linux/sysroot_scripts/install-sysroot.py\n\nimport os\nimport shutil\nimport subprocess\nimport sys\nimport urllib.request\n\nSCRIPT_DIR = os.path.dirname(os.path.abspath(__file__))\n\n# Sysroot revision from:\n# https://cs.chromium.org/chromium/src/build/linux/sysroot_scripts/sysroots.json\nSERVER = 'https://commondatastorage.googleapis.com'\nPATH = 'chrome-linux-sysroot/toolchain'\nREVISION = '43a87bbebccad99325fdcf34166295b121ee15c7'\nFILENAME = 'debian_sid_amd64_sysroot.tar.xz'\n\n\ndef main():\n url = '%s/%s/%s/%s' % (SERVER, PATH, REVISION, FILENAME)\n\n sysroot = os.path.join(SCRIPT_DIR, os.pardir, 'third_party', 'linux',\n 'sysroot')\n\n stamp = os.path.join(sysroot, '.stamp')\n if os.path.exists(stamp):\n with open(stamp) as s:\n if s.read() == url:\n return\n\n print('Installing Debian root image from %s' % url)\n\n if os.path.isdir(sysroot):\n shutil.rmtree(sysroot)\n os.mkdir(sysroot)\n tarball = os.path.join(sysroot, FILENAME)\n print('Downloading %s' % url)\n\n for _ in range(3):\n response = urllib.request.urlopen(url)\n with open(tarball, 'wb') as f:\n f.write(response.read())\n break\n else:\n raise Exception('Failed to download %s' % url)\n\n subprocess.check_call(['tar', 'xf', tarball, '-C', sysroot])\n\n os.remove(tarball)\n\n with open(stamp, 'w') as s:\n s.write(url)\n\n\nif __name__ == '__main__':\n main()\n sys.exit(0)\n" }, { "path": "build/ios/Unittest-Info.plist", "content": "\n\n\n\n\tCFBundleIdentifier\n\t${IOS_BUNDLE_ID_PREFIX}.${GTEST_BUNDLE_ID_SUFFIX:rfc1034identifier}\n\tUIApplicationDelegate\n\tCrashpadUnitTestDelegate\n\n\n" }, { "path": "build/ios/convert_gn_xcodeproj.py", "content": "#!/usr/bin/env python3\n\n# Copyright 2020 The Crashpad Authors\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n\"\"\"Convert GN Xcode projects to platform and configuration independent targets.\n\nGN generates Xcode projects that build one configuration only. However, typical\niOS development involves using the Xcode IDE to toggle the platform and\nconfiguration. This script replaces the 'gn' configuration with 'Debug',\n'Release' and 'Profile', and changes the ninja invocation to honor these\nconfigurations.\n\"\"\"\n\nimport argparse\nimport collections\nimport copy\nimport filecmp\nimport functools\nimport hashlib\nimport io\nimport json\nimport os\nimport re\nimport shutil\nimport string\nimport subprocess\nimport sys\nimport tempfile\nimport xml.etree.ElementTree\n\n\nLLDBINIT_PATH = '$(PROJECT_DIR)/.lldbinit'\n\nPYTHON_RE = re.compile('[ /]python[23]?$')\n\nXCTEST_PRODUCT_TYPES = frozenset((\n 'com.apple.product-type.bundle.unit-test',\n 'com.apple.product-type.bundle.ui-testing',\n))\n\nSCHEME_PRODUCT_TYPES = frozenset((\n 'com.apple.product-type.app-extension',\n 'com.apple.product-type.application',\n 'com.apple.product-type.framework'\n))\n\n\nclass Template(string.Template):\n\n \"\"\"A subclass of string.Template that changes delimiter.\"\"\"\n\n delimiter = '@'\n\n\n@functools.lru_cache\ndef LoadSchemeTemplate(root, name):\n \"\"\"Return a string.Template object for scheme file loaded relative to root.\"\"\"\n path = os.path.join(root, 'build', 'ios', name + '.template')\n with open(path) as file:\n return Template(file.read())\n\n\ndef CreateIdentifier(str_id):\n \"\"\"Return a 24 characters string that can be used as an identifier.\"\"\"\n return hashlib.sha1(str_id.encode(\"utf-8\")).hexdigest()[:24].upper()\n\n\ndef GenerateSchemeForTarget(root, project, old_project, name, path, is_test):\n \"\"\"Generates the .xcsheme file for target named |name|.\n\n The file is generated in the new project schemes directory from a template.\n If there is an existing previous project, then the old scheme file is copied\n and the lldbinit setting is set. If lldbinit setting is already correct, the\n file is not modified, just copied.\n \"\"\"\n project_name = os.path.basename(project)\n relative_path = os.path.join('xcshareddata', 'xcschemes', name + '.xcscheme')\n identifier = CreateIdentifier('%s %s' % (name, path))\n\n scheme_path = os.path.join(project, relative_path)\n if not os.path.isdir(os.path.dirname(scheme_path)):\n os.makedirs(os.path.dirname(scheme_path))\n\n substitutions = {\n 'LLDBINIT_PATH': LLDBINIT_PATH,\n 'BLUEPRINT_IDENTIFIER': identifier,\n 'BUILDABLE_NAME': path,\n 'BLUEPRINT_NAME': name,\n 'PROJECT_NAME': project_name\n }\n\n if is_test:\n template = LoadSchemeTemplate(root, 'xcodescheme-testable')\n substitutions['PATH'] = os.environ['PATH']\n\n else:\n template = LoadSchemeTemplate(root, 'xcodescheme')\n\n old_scheme_path = os.path.join(old_project, relative_path)\n if os.path.exists(old_scheme_path):\n\n tree = xml.etree.ElementTree.parse(old_scheme_path)\n tree_root = tree.getroot()\n\n for reference in tree_root.findall('.//BuildableReference'):\n for (attr, value) in (\n ('BuildableName', path),\n ('BlueprintName', name),\n ('BlueprintIdentifier', identifier)):\n if reference.get(attr) != value:\n reference.set(attr, value)\n\n for child in tree_root:\n if child.tag not in ('TestAction', 'LaunchAction'):\n continue\n\n if child.get('customLLDBInitFile') != LLDBINIT_PATH:\n child.set('customLLDBInitFile', LLDBINIT_PATH)\n\n if is_test:\n\n template_tree = xml.etree.ElementTree.parse(\n io.StringIO(template.substitute(**substitutions)))\n\n template_tree_root = template_tree.getroot()\n for child in tree_root:\n if child.tag != 'BuildAction':\n continue\n\n for subchild in list(child):\n child.remove(subchild)\n\n for post_action in template_tree_root.findall('.//PostActions'):\n child.append(post_action)\n\n tree.write(scheme_path, xml_declaration=True, encoding='UTF-8')\n\n else:\n\n with open(scheme_path, 'w') as scheme_file:\n scheme_file.write(template.substitute(**substitutions))\n\n\nclass XcodeProject(object):\n\n def __init__(self, objects, counter = 0):\n self.objects = objects\n self.counter = 0\n\n def AddObject(self, parent_name, obj):\n while True:\n self.counter += 1\n str_id = \"%s %s %d\" % (parent_name, obj['isa'], self.counter)\n new_id = CreateIdentifier(str_id)\n\n # Make sure ID is unique. It's possible there could be an id conflict\n # since this is run after GN runs.\n if new_id not in self.objects:\n self.objects[new_id] = obj\n return new_id\n\n def IterObjectsByIsa(self, isa):\n \"\"\"Iterates overs objects of the |isa| type.\"\"\"\n for key, obj in self.objects.items():\n if obj['isa'] == isa:\n yield (key, obj)\n\n def IterNativeTargetByProductType(self, product_types):\n \"\"\"Iterates over PBXNativeTarget objects of any |product_types| types.\"\"\"\n for key, obj in self.IterObjectsByIsa('PBXNativeTarget'):\n if obj['productType'] in product_types:\n yield (key, obj)\n\n def UpdateBuildScripts(self):\n \"\"\"Update build scripts to respect configuration and platforms.\"\"\"\n for key, obj in self.IterObjectsByIsa('PBXShellScriptBuildPhase'):\n\n shell_path = obj['shellPath']\n shell_code = obj['shellScript']\n if shell_path.endswith('/sh'):\n shell_code = shell_code.replace(\n 'ninja -C .',\n 'ninja -C \"../${CONFIGURATION}${EFFECTIVE_PLATFORM_NAME}\"')\n elif PYTHON_RE.search(shell_path):\n shell_code = shell_code.replace(\n '''ninja_params = [ '-C', '.' ]''',\n '''ninja_params = [ '-C', '../' + os.environ['CONFIGURATION']'''\n ''' + os.environ['EFFECTIVE_PLATFORM_NAME'] ]''')\n\n # Replace the build script in the object.\n obj['shellScript'] = shell_code\n\n\n def UpdateBuildConfigurations(self, configurations):\n \"\"\"Add new configurations, using the first one as default.\"\"\"\n\n # Create a list with all the objects of interest. This is needed\n # because objects will be added to/removed from the project upon\n # iterating this list and python dictionaries cannot be mutated\n # during iteration.\n\n for key, obj in list(self.IterObjectsByIsa('XCConfigurationList')):\n # Use the first build configuration as template for creating all the\n # new build configurations.\n build_config_template = self.objects[obj['buildConfigurations'][0]]\n build_config_template['buildSettings']['CONFIGURATION_BUILD_DIR'] = \\\n '$(PROJECT_DIR)/../$(CONFIGURATION)$(EFFECTIVE_PLATFORM_NAME)'\n\n # Remove the existing build configurations from the project before\n # creating the new ones.\n for build_config_id in obj['buildConfigurations']:\n del self.objects[build_config_id]\n obj['buildConfigurations'] = []\n\n for configuration in configurations:\n build_config = copy.copy(build_config_template)\n build_config['name'] = configuration\n build_config_id = self.AddObject('products', build_config)\n obj['buildConfigurations'].append(build_config_id)\n\n def GetHostMappingForXCTests(self):\n \"\"\"Returns a dict from targets to the list of their xctests modules.\"\"\"\n mapping = collections.defaultdict(list)\n for key, obj in self.IterNativeTargetByProductType(XCTEST_PRODUCT_TYPES):\n build_config_lists_id = obj['buildConfigurationList']\n build_configs = self.objects[build_config_lists_id]['buildConfigurations']\n\n # Use the first build configuration to get the name of the host target.\n # This is arbitrary, but since the build configuration are all identical\n # after UpdateBuildConfiguration, except for their 'name', it is fine.\n build_config = self.objects[build_configs[0]]\n if obj['productType'] == 'com.apple.product-type.bundle.unit-test':\n # The test_host value will look like this:\n # `$(BUILD_PRODUCTS_DIR)/host_app_name.app/host_app_name`\n #\n # Extract the `host_app_name.app` part as key for the output.\n test_host_path = build_config['buildSettings']['TEST_HOST']\n test_host_name = os.path.basename(os.path.dirname(test_host_path))\n else:\n test_host_name = build_config['buildSettings']['TEST_TARGET_NAME']\n\n test_name = obj['name']\n test_path = self.objects[obj['productReference']]['path']\n\n mapping[test_host_name].append((key, test_name, test_path))\n\n return dict(mapping)\n\n\ndef check_output(command):\n \"\"\"Wrapper around subprocess.check_output that decode output as utf-8.\"\"\"\n return subprocess.check_output(command).decode('utf-8')\n\n\ndef CopyFileIfChanged(source_path, target_path):\n \"\"\"Copy |source_path| to |target_path| if different.\"\"\"\n target_dir = os.path.dirname(target_path)\n if not os.path.isdir(target_dir):\n os.makedirs(target_dir)\n if not os.path.exists(target_path) or \\\n not filecmp.cmp(source_path, target_path):\n shutil.copyfile(source_path, target_path)\n\n\ndef CopyTreeIfChanged(source, target):\n \"\"\"Copy |source| to |target| recursively; files are copied iff changed.\"\"\"\n if os.path.isfile(source):\n return CopyFileIfChanged(source, target)\n if not os.path.isdir(target):\n os.makedirs(target)\n for name in os.listdir(source):\n CopyTreeIfChanged(\n os.path.join(source, name),\n os.path.join(target, name))\n\n\ndef LoadXcodeProjectAsJSON(project_dir):\n \"\"\"Return Xcode project at |path| as a JSON string.\"\"\"\n return check_output([\n 'plutil', '-convert', 'json', '-o', '-',\n os.path.join(project_dir, 'project.pbxproj')])\n\n\ndef WriteXcodeProject(output_path, json_string):\n \"\"\"Save Xcode project to |output_path| as XML.\"\"\"\n with tempfile.NamedTemporaryFile() as temp_file:\n temp_file.write(json_string.encode(\"utf-8\"))\n temp_file.flush()\n subprocess.check_call(['plutil', '-convert', 'xml1', temp_file.name])\n CopyFileIfChanged(\n temp_file.name,\n os.path.join(output_path, 'project.pbxproj'))\n\n\ndef UpdateXcodeProject(project_dir, old_project_dir, configurations, root_dir):\n \"\"\"Update inplace Xcode project to support multiple configurations.\n\n Args:\n project_dir: path to the input Xcode project\n configurations: list of string corresponding to the configurations that\n need to be supported by the tweaked Xcode projects, must contains at\n least one value.\n root_dir: path to the root directory used to find markdown files\n \"\"\"\n json_data = json.loads(LoadXcodeProjectAsJSON(project_dir))\n project = XcodeProject(json_data['objects'])\n\n project.UpdateBuildScripts()\n project.UpdateBuildConfigurations(configurations)\n\n mapping = project.GetHostMappingForXCTests()\n\n # Generate schemes for application, extensions and framework targets\n for key, obj in project.IterNativeTargetByProductType(SCHEME_PRODUCT_TYPES):\n product = project.objects[obj['productReference']]\n product_path = product['path']\n\n # Do not generate scheme for the XCTests and XXCUITests target app.\n # Instead, a scheme will be generated for each test modules.\n tests = mapping.get(product_path, []) + mapping.get(obj['name'], [])\n if not tests:\n GenerateSchemeForTarget(\n root_dir, project_dir, old_project_dir,\n obj['name'], product_path, False)\n\n else:\n for (_, test_name, test_path) in tests:\n GenerateSchemeForTarget(\n root_dir, project_dir, old_project_dir,\n test_name, test_path, True)\n\n root_object = project.objects[json_data['rootObject']]\n main_group = project.objects[root_object['mainGroup']]\n\n sources = None\n for child_key in main_group['children']:\n child = project.objects[child_key]\n if child.get('name') == 'Source' or child.get('name') == 'Sources':\n sources = child\n break\n\n if sources is None:\n sources = main_group\n\n AddMarkdownToProject(project, root_dir, sources, sources is main_group)\n SortFileReferencesByName(project, sources, root_object.get('productRefGroup'))\n\n objects = collections.OrderedDict(sorted(project.objects.items()))\n # WriteXcodeProject(project_dir, json.dumps(json_data))\n\n\ndef CreateGroup(project, parent_group, group_name, use_relative_paths):\n group_object = {\n 'children': [],\n 'isa': 'PBXGroup',\n 'sourceTree': '',\n }\n if use_relative_paths:\n group_object['path'] = group_name\n else:\n group_object['name'] = group_name\n parent_group_name = parent_group.get('name', '')\n group_object_key = project.AddObject(parent_group_name, group_object)\n parent_group['children'].append(group_object_key)\n return group_object\n\n\nclass ObjectKey(object):\n\n \"\"\"Wrapper around PBXFileReference and PBXGroup for sorting.\n\n A PBXGroup represents a \"directory\" containing a list of files in an\n Xcode project; it can contain references to a list of directories or\n files.\n\n A PBXFileReference represents a \"file\".\n\n The type is stored in the object \"isa\" property as a string. Since we\n want to sort all directories before all files, the < and > operators\n are defined so that if \"isa\" is different, they are sorted in the\n reverse of alphabetic ordering, otherwise the name (or path) property\n is checked and compared in alphabetic order.\n \"\"\"\n\n def __init__(self, obj, last):\n self.isa = obj['isa']\n if 'name' in obj:\n self.name = obj['name']\n else:\n self.name = obj['path']\n self.last = last\n\n def __lt__(self, other):\n if self.last != other.last:\n return other.last\n if self.isa != other.isa:\n return self.isa > other.isa\n return self.name < other.name\n\n def __gt__(self, other):\n if self.last != other.last:\n return self.last\n if self.isa != other.isa:\n return self.isa < other.isa\n return self.name > other.name\n\n def __eq__(self, other):\n return self.isa == other.isa and self.name == other.name\n\n\ndef SortFileReferencesByName(project, group_object, products_group_ref):\n SortFileReferencesByNameWithSortKey(\n project, group_object,\n lambda ref: ObjectKey(project.objects[ref], ref == products_group_ref))\n\n\ndef SortFileReferencesByNameWithSortKey(project, group_object, sort_key):\n group_object['children'].sort(key=sort_key)\n for key in group_object['children']:\n child = project.objects[key]\n if child['isa'] == 'PBXGroup':\n SortFileReferencesByNameWithSortKey(project, child, sort_key)\n\n\ndef AddMarkdownToProject(project, root_dir, group_object, use_relative_paths):\n list_files_cmd = ['git', '-C', root_dir, 'ls-files', '*.md']\n paths = check_output(list_files_cmd).splitlines()\n ios_internal_dir = os.path.join(root_dir, 'ios_internal')\n if os.path.exists(ios_internal_dir):\n list_files_cmd = ['git', '-C', ios_internal_dir, 'ls-files', '*.md']\n ios_paths = check_output(list_files_cmd).splitlines()\n paths.extend([os.path.join(\"ios_internal\", path) for path in ios_paths])\n for path in paths:\n new_markdown_entry = {\n \"fileEncoding\": \"4\",\n \"isa\": \"PBXFileReference\",\n \"lastKnownFileType\": \"net.daringfireball.markdown\",\n \"sourceTree\": \"\"\n }\n if use_relative_paths:\n new_markdown_entry['path'] = os.path.basename(path)\n else:\n new_markdown_entry['name'] = os.path.basename(path)\n new_markdown_entry['path'] = path\n folder = GetFolderForPath(\n project, group_object, os.path.dirname(path),\n use_relative_paths)\n folder_name = folder.get('name', None)\n if folder_name is None:\n folder_name = folder.get('path', 'sources')\n new_markdown_entry_id = project.AddObject(folder_name, new_markdown_entry)\n folder['children'].append(new_markdown_entry_id)\n\n\ndef GetFolderForPath(project, group_object, path, use_relative_paths):\n objects = project.objects\n if not path:\n return group_object\n for folder in path.split('/'):\n children = group_object['children']\n new_root = None\n for child_key in children:\n child = objects[child_key]\n if child['isa'] == 'PBXGroup':\n child_name = child.get('name', None)\n if child_name is None:\n child_name = child.get('path')\n if child_name == folder:\n new_root = child\n break\n if not new_root:\n # If the folder isn't found we could just cram it into the leaf existing\n # folder, but that leads to folders with tons of README.md inside.\n new_root = CreateGroup(project, group_object, folder, use_relative_paths)\n group_object = new_root\n return group_object\n\n\ndef ConvertGnXcodeProject(root_dir, proj_name, input_dir, output_dir, configs):\n '''Tweak the Xcode project generated by gn to support multiple configurations.\n\n The Xcode projects generated by \"gn gen --ide\" only supports a single\n platform and configuration (as the platform and configuration are set\n per output directory). This method takes as input such projects and\n add support for multiple configurations and platforms (to allow devs\n to select them in Xcode).\n\n Args:\n root_dir: directory that is the root of the project\n proj_name: name of the Xcode project \"file\" (usually `all.xcodeproj`)\n input_dir: directory containing the XCode projects created by \"gn gen --ide\"\n output_dir: directory where the tweaked Xcode projects will be saved\n configs: list of string corresponding to the configurations that need to be\n supported by the tweaked Xcode projects, must contains at least one\n value.\n '''\n\n UpdateXcodeProject(\n os.path.join(input_dir, proj_name),\n os.path.join(output_dir, proj_name),\n configs, root_dir)\n\n CopyTreeIfChanged(os.path.join(input_dir, proj_name),\n os.path.join(output_dir, proj_name))\n\n\ndef Main(args):\n parser = argparse.ArgumentParser(\n description='Convert GN Xcode projects for iOS.')\n parser.add_argument(\n 'input',\n help='directory containing [product|all] Xcode projects.')\n parser.add_argument(\n 'output',\n help='directory where to generate the iOS configuration.')\n parser.add_argument(\n '--add-config', dest='configurations', default=[], action='append',\n help='configuration to add to the Xcode project')\n parser.add_argument(\n '--root', type=os.path.abspath, required=True,\n help='root directory of the project')\n parser.add_argument(\n '--project-name', default='all.xcodeproj', dest='proj_name',\n help='name of the Xcode project (default: %(default)s)')\n args = parser.parse_args(args)\n\n if not os.path.isdir(args.input):\n sys.stderr.write('Input directory does not exists.\\n')\n return 1\n\n if args.proj_name not in os.listdir(args.input):\n sys.stderr.write(\n 'Input directory does not contain the Xcode project.\\n')\n return 1\n\n if not args.configurations:\n sys.stderr.write('At least one configuration required, see --add-config.\\n')\n return 1\n\n ConvertGnXcodeProject(\n args.root,\n args.proj_name,\n args.input,\n args.output,\n args.configurations)\n\nif __name__ == '__main__':\n sys.exit(Main(sys.argv[1:]))\n" }, { "path": "build/ios/setup_ios_gn.config", "content": "# Copyright 2020 The Crashpad Authors\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n\n[xcode]\n# Controls settings for the generated Xcode project. If jobs is non-zero\n# it will be passed to the ninja invocation in Xcode project.\njobs = 0\n\n[build]\n# Controls the build output. The only supported values are \"64-bit\", \"32-bit\"\n# and \"fat\" (for a fat binary supporting both \"32-bit\" and \"64-bit\" cpus).\narch = \"64-bit\"\n\n[gn_args]\n# Values in that section will be copied verbatim in the generated args.gn file.\ntarget_os = \"ios\"\n\n[filters]\n# List of target files to pass to --filters argument of gn gen when generating\n# the Xcode project. By default, list all targets from ios/ and ios_internal/\n# and the targets corresponding to the unit tests run on the bots.\n" }, { "path": "build/ios/setup_ios_gn.py", "content": "#!/usr/bin/env python3\n\n# Copyright 2020 The Crashpad Authors\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n\nimport argparse\nimport configparser\nimport convert_gn_xcodeproj\nimport errno\nimport io\nimport os\nimport platform\nimport re\nimport shutil\nimport subprocess\nimport sys\nimport tempfile\n\n\nSUPPORTED_TARGETS = ('appletvos', 'appletvsimulator', 'iphoneos',\n 'iphonesimulator', 'maccatalyst')\nSUPPORTED_CONFIGS = ('Debug', 'Release', 'Profile', 'Official')\n\n# Pattern matching lines from ~/.lldbinit that must not be copied to the\n# generated .lldbinit file. They match what the user were told to add to\n# their global ~/.lldbinit file before setup-gn.py was updated to generate\n# a project specific file and thus must not be copied as they would cause\n# the settings to be overwritten.\nLLDBINIT_SKIP_PATTERNS = (\n re.compile('^script sys.path\\\\[:0\\\\] = \\\\[\\'.*/src/tools/lldb\\'\\\\]$'),\n re.compile('^script import lldbinit$'),\n re.compile('^settings append target.source-map .* /google/src/.*$'),\n)\n\n\ndef HostCpuArch():\n '''Returns the arch of the host cpu for GN.'''\n HOST_CPU_ARCH = {\n 'arm64': '\"arm64\"',\n 'x86_64': '\"x64\"',\n }\n return HOST_CPU_ARCH[platform.machine()]\n\n\nclass ConfigParserWithStringInterpolation(configparser.ConfigParser):\n\n '''A .ini file parser that supports strings and environment variables.'''\n\n ENV_VAR_PATTERN = re.compile(r'\\$([A-Za-z0-9_]+)')\n\n def values(self, section):\n return filter(\n lambda val: val != '',\n map(lambda kv: self._UnquoteString(self._ExpandEnvVar(kv[1])),\n configparser.ConfigParser.items(self, section)))\n\n def getstring(self, section, option, fallback=''):\n try:\n raw_value = self.get(section, option)\n except configparser.NoOptionError:\n return fallback\n return self._UnquoteString(self._ExpandEnvVar(raw_value))\n\n def _UnquoteString(self, string):\n if not string or string[0] != '\"' or string[-1] != '\"':\n return string\n return string[1:-1]\n\n def _ExpandEnvVar(self, value):\n match = self.ENV_VAR_PATTERN.search(value)\n if not match:\n return value\n name, (begin, end) = match.group(1), match.span(0)\n prefix, suffix = value[:begin], self._ExpandEnvVar(value[end:])\n return prefix + os.environ.get(name, '') + suffix\n\n\nclass GnGenerator(object):\n\n '''Holds configuration for a build and method to generate gn default files.'''\n\n FAT_BUILD_DEFAULT_ARCH = '64-bit'\n\n TARGET_CPU_VALUES = {\n 'appletvos': '\"arm64\"',\n 'appletvsimulator': HostCpuArch(),\n 'iphoneos': '\"arm64\"',\n 'iphonesimulator': HostCpuArch(),\n 'maccatalyst': HostCpuArch(),\n }\n\n TARGET_ENVIRONMENT_VALUES = {\n 'appletvos': '\"device\"',\n 'appletvsimulator': '\"simulator\"',\n 'iphoneos': '\"device\"',\n 'iphonesimulator': '\"simulator\"',\n 'maccatalyst': '\"catalyst\"'\n }\n\n TARGET_PLATFORM_VALUES = {\n 'appletvos': '\"tvos\"',\n 'appletvsimulator': '\"tvos\"',\n 'iphoneos': '\"iphoneos\"',\n 'iphonesimulator': '\"iphoneos\"',\n 'maccatalyst': '\"iphoneos\"'\n }\n\n def __init__(self, settings, config, target):\n assert target in SUPPORTED_TARGETS\n assert config in SUPPORTED_CONFIGS\n self._settings = settings\n self._config = config\n self._target = target\n\n def _GetGnArgs(self):\n \"\"\"Build the list of arguments to pass to gn.\n\n Returns:\n A list of tuple containing gn variable names and variable values (it\n is not a dictionary as the order needs to be preserved).\n \"\"\"\n args = []\n\n is_debug = self._config == 'Debug'\n official = self._config == 'Official'\n is_optim = self._config in ('Profile', 'Official')\n\n args.append(('target_os', '\"ios\"'))\n args.append(('is_debug', is_debug))\n\n if os.environ.get('FORCE_MAC_TOOLCHAIN', '0') == '1':\n args.append(('use_system_xcode', False))\n\n args.append(('target_cpu', self.TARGET_CPU_VALUES[self._target]))\n args.append(\n ('target_environment', self.TARGET_ENVIRONMENT_VALUES[self._target]))\n args.append(('target_platform', self.TARGET_PLATFORM_VALUES[self._target]))\n\n # Add user overrides after the other configurations so that they can\n # refer to them and override them.\n args.extend(self._settings.items('gn_args'))\n return args\n\n\n def Generate(self, gn_path, proj_name, root_path, build_dir):\n self.WriteArgsGn(build_dir, xcode_project_name=proj_name)\n subprocess.check_call(self.GetGnCommand(\n gn_path, root_path, build_dir, xcode_project_name=proj_name))\n\n def CreateGnRules(self, gn_path, root_path, build_dir):\n gn_command = self.GetGnCommand(gn_path, root_path, build_dir)\n self.WriteArgsGn(build_dir)\n self.WriteBuildNinja(gn_command, build_dir)\n self.WriteBuildNinjaDeps(build_dir)\n\n def WriteArgsGn(self, build_dir, xcode_project_name=None):\n with open(os.path.join(build_dir, 'args.gn'), 'w') as stream:\n stream.write('# This file was generated by setup-gn.py. Do not edit\\n')\n stream.write('# but instead use ~/.setup-gn or $repo/.setup-gn files\\n')\n stream.write('# to configure settings.\\n')\n stream.write('\\n')\n\n if self._target != 'maccatalyst':\n if self._settings.has_section('$imports$'):\n for import_rule in self._settings.values('$imports$'):\n stream.write('import(\"%s\")\\n' % import_rule)\n stream.write('\\n')\n\n gn_args = self._GetGnArgs()\n\n for name, value in gn_args:\n if isinstance(value, bool):\n stream.write('%s = %s\\n' % (name, str(value).lower()))\n elif isinstance(value, list):\n stream.write('%s = [%s' % (name, '\\n' if len(value) > 1 else ''))\n if len(value) == 1:\n prefix = ' '\n suffix = ' '\n else:\n prefix = ' '\n suffix = ',\\n'\n for item in value:\n if isinstance(item, bool):\n stream.write('%s%s%s' % (prefix, str(item).lower(), suffix))\n else:\n stream.write('%s%s%s' % (prefix, item, suffix))\n stream.write(']\\n')\n else:\n # ConfigParser removes quote around empty string which confuse\n # `gn gen` so restore them.\n if not value:\n value = '\"\"'\n stream.write('%s = %s\\n' % (name, value))\n\n def WriteBuildNinja(self, gn_command, build_dir):\n with open(os.path.join(build_dir, 'build.ninja'), 'w') as stream:\n stream.write('ninja_required_version = 1.7.2\\n')\n stream.write('\\n')\n stream.write('rule gn\\n')\n stream.write(' command = %s\\n' % NinjaEscapeCommand(gn_command))\n stream.write(' description = Regenerating ninja files\\n')\n stream.write('\\n')\n stream.write('build build.ninja: gn\\n')\n stream.write(' generator = 1\\n')\n stream.write(' depfile = build.ninja.d\\n')\n\n def WriteBuildNinjaDeps(self, build_dir):\n with open(os.path.join(build_dir, 'build.ninja.d'), 'w') as stream:\n stream.write('build.ninja: nonexistant_file.gn\\n')\n\n def GetGnCommand(self, gn_path, src_path, out_path, xcode_project_name=None):\n gn_command = [ gn_path, '--root=%s' % os.path.realpath(src_path), '-q' ]\n if xcode_project_name is not None:\n gn_command.append('--ide=xcode')\n gn_command.append('--ninja-executable=autoninja')\n gn_command.append('--xcode-build-system=new')\n gn_command.append('--xcode-project=%s' % xcode_project_name)\n gn_command.append('--xcode-additional-files-patterns=*.md')\n gn_command.append('--xcode-configs=' + ';'.join(SUPPORTED_CONFIGS))\n gn_command.append('--xcode-config-build-dir='\n '//out/${CONFIGURATION}${EFFECTIVE_PLATFORM_NAME}')\n if self._settings.has_section('filters'):\n target_filters = self._settings.values('filters')\n if target_filters:\n gn_command.append('--filters=%s' % ';'.join(target_filters))\n else:\n gn_command.append('--check')\n gn_command.append('gen')\n gn_command.append('//%s' %\n os.path.relpath(os.path.abspath(out_path), os.path.abspath(src_path)))\n return gn_command\n\n\ndef NinjaNeedEscape(arg):\n '''Returns True if |arg| needs to be escaped when written to .ninja file.'''\n return ':' in arg or '*' in arg or ';' in arg\n\n\ndef NinjaEscapeCommand(command):\n '''Escapes |command| in order to write it to .ninja file.'''\n result = []\n for arg in command:\n if NinjaNeedEscape(arg):\n arg = arg.replace(':', '$:')\n arg = arg.replace(';', '\\\\;')\n arg = arg.replace('*', '\\\\*')\n else:\n result.append(arg)\n return ' '.join(result)\n\n\ndef FindGn():\n '''Returns absolute path to gn binary looking at the PATH env variable.'''\n for path in os.environ['PATH'].split(os.path.pathsep):\n gn_path = os.path.join(path, 'gn')\n if os.path.isfile(gn_path) and os.access(gn_path, os.X_OK):\n return gn_path\n return None\n\n\ndef GenerateXcodeProject(gn_path, root_dir, proj_name, out_dir, settings):\n '''Generate Xcode project with Xcode and convert to multi-configurations.'''\n prefix = os.path.abspath(os.path.join(out_dir, '_temp'))\n temp_path = tempfile.mkdtemp(prefix=prefix)\n try:\n generator = GnGenerator(settings, 'Debug', 'iphonesimulator')\n generator.Generate(gn_path, proj_name, root_dir, temp_path)\n convert_gn_xcodeproj.ConvertGnXcodeProject(\n root_dir,\n '%s.xcodeproj' % proj_name,\n os.path.join(temp_path),\n os.path.join(out_dir, 'build'),\n SUPPORTED_CONFIGS)\n finally:\n if os.path.exists(temp_path):\n shutil.rmtree(temp_path)\n\ndef CreateLLDBInitFile(root_dir, out_dir, settings):\n '''\n Generate an .lldbinit file for the project that load the script that fixes\n the mapping of source files (see docs/ios/build_instructions.md#debugging).\n '''\n with open(os.path.join(out_dir, 'build', '.lldbinit'), 'w') as lldbinit:\n lldb_script_dir = os.path.join(os.path.abspath(root_dir), 'tools', 'lldb')\n lldbinit.write('script sys.path[:0] = [\\'%s\\']\\n' % lldb_script_dir)\n lldbinit.write('script import lldbinit\\n')\n\n workspace_name = settings.getstring(\n 'gn_args',\n 'ios_internal_citc_workspace_name')\n\n if workspace_name != '':\n username = os.environ['USER']\n for shortname in ('googlemac', 'third_party', 'blaze-out'):\n lldbinit.write('settings append target.source-map %s %s\\n' % (\n shortname,\n '/google/src/cloud/%s/%s/google3/%s' % (\n username, workspace_name, shortname)))\n\n # Append the content of //ios/build/tools/lldbinit.defaults if it exists.\n tools_dir = os.path.join(root_dir, 'ios', 'build', 'tools')\n defaults_lldbinit_path = os.path.join(tools_dir, 'lldbinit.defaults')\n if os.path.isfile(defaults_lldbinit_path):\n with open(defaults_lldbinit_path) as defaults_lldbinit:\n for line in defaults_lldbinit:\n lldbinit.write(line)\n\n # Append the content of ~/.lldbinit if it exists. Line that look like they\n # are trying to configure source mapping are skipped as they probably date\n # back from when setup-gn.py was not generating an .lldbinit file.\n global_lldbinit_path = os.path.join(os.environ['HOME'], '.lldbinit')\n if os.path.isfile(global_lldbinit_path):\n with open(global_lldbinit_path) as global_lldbinit:\n for line in global_lldbinit:\n if any(pattern.match(line) for pattern in LLDBINIT_SKIP_PATTERNS):\n continue\n lldbinit.write(line)\n\n\ndef GenerateGnBuildRules(gn_path, root_dir, out_dir, settings):\n '''Generates all template configurations for gn.'''\n for config in SUPPORTED_CONFIGS:\n for target in SUPPORTED_TARGETS:\n build_dir = os.path.join(out_dir, '%s-%s' % (config, target))\n if not os.path.isdir(build_dir):\n os.makedirs(build_dir)\n\n generator = GnGenerator(settings, config, target)\n generator.CreateGnRules(gn_path, root_dir, build_dir)\n\n\ndef Main(args):\n default_root = os.path.normpath(os.path.join(\n os.path.dirname(__file__), os.pardir, os.pardir))\n\n parser = argparse.ArgumentParser(\n description='Generate build directories for use with gn.')\n parser.add_argument(\n 'root', default=default_root, nargs='?',\n help='root directory where to generate multiple out configurations')\n parser.add_argument(\n '--import', action='append', dest='import_rules', default=[],\n help='path to file defining default gn variables')\n parser.add_argument(\n '--gn-path', default=None,\n help='path to gn binary (default: look up in $PATH)')\n parser.add_argument(\n '--build-dir', default='out',\n help='path where the build should be created (default: %(default)s)')\n parser.add_argument(\n '--config-path', default=os.path.expanduser('~/.setup-gn'),\n help='path to the user config file (default: %(default)s)')\n parser.add_argument(\n '--system-config-path', default=os.path.splitext(__file__)[0] + '.config',\n help='path to the default config file (default: %(default)s)')\n parser.add_argument(\n '--project-name', default='all', dest='proj_name',\n help='name of the generated Xcode project (default: %(default)s)')\n parser.add_argument(\n '--no-xcode-project', action='store_true', default=False,\n help='do not generate the build directory with XCode project')\n args = parser.parse_args(args)\n\n # Load configuration (first global and then any user overrides).\n settings = ConfigParserWithStringInterpolation()\n settings.read([\n args.system_config_path,\n args.config_path,\n ])\n\n # Add private sections corresponding to --import argument.\n if args.import_rules:\n settings.add_section('$imports$')\n for i, import_rule in enumerate(args.import_rules):\n if not import_rule.startswith('//'):\n import_rule = '//%s' % os.path.relpath(\n os.path.abspath(import_rule), os.path.abspath(args.root))\n settings.set('$imports$', '$rule%d$' % i, import_rule)\n\n # Validate settings.\n if settings.getstring('build', 'arch') not in ('64-bit', '32-bit', 'fat'):\n sys.stderr.write('ERROR: invalid value for build.arch: %s\\n' %\n settings.getstring('build', 'arch'))\n sys.exit(1)\n\n # Find path to gn binary either from command-line or in PATH.\n if args.gn_path:\n gn_path = args.gn_path\n else:\n gn_path = FindGn()\n if gn_path is None:\n sys.stderr.write('ERROR: cannot find gn in PATH\\n')\n sys.exit(1)\n\n out_dir = os.path.join(args.root, args.build_dir)\n if not os.path.isdir(out_dir):\n os.makedirs(out_dir)\n\n if not args.no_xcode_project:\n GenerateXcodeProject(gn_path, args.root, args.proj_name, out_dir, settings)\n CreateLLDBInitFile(args.root, out_dir, settings)\n GenerateGnBuildRules(gn_path, args.root, out_dir, settings)\n\n\nif __name__ == '__main__':\n sys.exit(Main(sys.argv[1:]))\n" }, { "path": "build/ios/xcodescheme-testable.template", "content": "\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n\n" }, { "path": "build/ios/xcodescheme.template", "content": "\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n\n" }, { "path": "build/run_tests.py", "content": "#!/usr/bin/env python3\n\n# Copyright 2014 The Crashpad Authors\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n\nimport argparse\nimport os\nimport posixpath\nimport re\nimport shlex\nimport subprocess\nimport sys\nimport tempfile\nimport uuid\n\nCRASHPAD_DIR = os.path.join(os.path.dirname(os.path.abspath(__file__)),\n os.pardir)\nIS_WINDOWS_HOST = sys.platform.startswith('win')\n\n\ndef _FindGNFromBinaryDir(binary_dir):\n \"\"\"Attempts to determine the path to a GN binary used to generate the build\n files in the given binary_dir. This is necessary because `gn` might not be\n in the path or might be in a non-standard location, particularly on build\n machines.\"\"\"\n\n build_ninja = os.path.join(binary_dir, 'build.ninja')\n if os.path.isfile(build_ninja):\n with open(build_ninja, 'r') as f:\n # Look for the always-generated regeneration rule of the form:\n #\n # rule gn\n # command = ... arguments ...\n #\n # to extract the gn binary's full path.\n found_rule_gn = False\n for line in f:\n if line.strip() == 'rule gn':\n found_rule_gn = True\n continue\n if found_rule_gn:\n if len(line) == 0 or line[0] != ' ':\n return None\n if line.startswith(' command = '):\n gn_command_line_parts = line.strip().split(' ')\n if len(gn_command_line_parts) > 2:\n return os.path.join(binary_dir,\n gn_command_line_parts[2])\n\n return None\n\n\ndef _GetGNArgument(argument_name, binary_dir):\n \"\"\"Returns the value of a given GN argument, or None if it is not\n explicitly specified.\"\"\"\n\n gn_path = _FindGNFromBinaryDir(binary_dir)\n if gn_path:\n # Look for a GN “target_os”.\n popen = subprocess.Popen([\n gn_path, '--root=' + CRASHPAD_DIR, 'args', binary_dir,\n '--list=%s' % argument_name, '--short'\n ],\n shell=IS_WINDOWS_HOST,\n stdout=subprocess.PIPE,\n stderr=open(os.devnull),\n text=True)\n value = popen.communicate()[0]\n if popen.returncode == 0:\n match = re.match(r'%s = \"(.*)\"$' % argument_name, value)\n if match:\n return match.group(1)\n return None\n\n\ndef _EnableVTProcessingOnWindowsConsole():\n \"\"\"Enables virtual terminal processing for ANSI/VT100-style escape sequences\n on a Windows console attached to standard output. Returns True on success.\n Returns False if standard output is not a console or if virtual terminal\n processing is not supported. The feature was introduced in Windows 10.\n \"\"\"\n\n import pywintypes\n import win32console\n import winerror\n\n stdout_console = win32console.GetStdHandle(win32console.STD_OUTPUT_HANDLE)\n try:\n console_mode = stdout_console.GetConsoleMode()\n except pywintypes.error as e:\n if e.winerror == winerror.ERROR_INVALID_HANDLE:\n # Standard output is not a console.\n return False\n raise\n\n try:\n # From . This would be\n # win32console.ENABLE_VIRTUAL_TERMINAL_PROCESSING, but it’s too new to\n # be defined there.\n ENABLE_VIRTUAL_TERMINAL_PROCESSING = 0x0004\n\n stdout_console.SetConsoleMode(console_mode |\n ENABLE_VIRTUAL_TERMINAL_PROCESSING)\n except pywintypes.error as e:\n if e.winerror == winerror.ERROR_INVALID_PARAMETER:\n # ANSI/VT100-style escape sequence processing isn’t supported before\n # Windows 10.\n return False\n raise\n\n return True\n\n\ndef _RunOnAndroidTarget(binary_dir, test, android_device, extra_command_line):\n local_test_path = os.path.join(binary_dir, test)\n MAYBE_UNSUPPORTED_TESTS = (\n 'crashpad_client_test',\n 'crashpad_handler_test',\n 'crashpad_minidump_test',\n 'crashpad_snapshot_test',\n )\n if not os.path.exists(local_test_path) and test in MAYBE_UNSUPPORTED_TESTS:\n print('This test is not present and may not be supported, skipping')\n return\n\n def _adb(*args):\n # Flush all of this script’s own buffered stdout output before running\n # adb, which will likely produce its own output on stdout.\n sys.stdout.flush()\n\n adb_command = ['adb', '-s', android_device]\n adb_command.extend(args)\n subprocess.check_call(adb_command, shell=IS_WINDOWS_HOST)\n\n def _adb_push(sources, destination):\n args = list(sources)\n args.append(destination)\n _adb('push', *args)\n\n def _adb_shell(command_args, env={}):\n # Build a command to execute via “sh -c” instead of invoking it\n # directly. Here’s why:\n #\n # /system/bin/env isn’t normally present prior to Android 6.0 (M), where\n # toybox was introduced (Android platform/manifest 9a2c01e8450b).\n # Instead, set environment variables by using the shell’s internal\n # “export” command.\n #\n # adbd prior to Android 7.0 (N), and the adb client prior to SDK\n # platform-tools version 24, don’t know how to communicate a shell\n # command’s exit status. This was added in Android platform/system/core\n # 606835ae5c4b). With older adb servers and clients, adb will “exit 0”\n # indicating success even if the command failed on the device. This\n # makes subprocess.check_call() semantics difficult to implement\n # directly. As a workaround, have the device send the command’s exit\n # status over stdout and pick it back up in this function.\n #\n # Both workarounds are implemented by giving the device a simple script,\n # which adbd will run as an “sh -c” argument.\n adb_command = ['adb', '-s', android_device, 'shell']\n script_commands = []\n for k, v in env.items():\n script_commands.append('export %s=%s' %\n (shlex.quote(k), shlex.quote(v)))\n script_commands.extend([\n ' '.join(shlex.quote(x) for x in command_args), 'status=${?}',\n 'echo \"status=${status}\"', 'exit ${status}'\n ])\n adb_command.append('; '.join(script_commands))\n child = subprocess.Popen(adb_command,\n shell=IS_WINDOWS_HOST,\n stdin=open(os.devnull),\n stdout=subprocess.PIPE,\n text=True)\n\n FINAL_LINE_RE = re.compile(r'status=(\\d+)$')\n final_line = None\n while True:\n # Use readline so that the test output appears “live” when running.\n data = child.stdout.readline()\n if data == '':\n break\n if final_line is not None:\n # It wasn’t really the final line.\n print(final_line, end='')\n final_line = None\n if FINAL_LINE_RE.match(data.rstrip()):\n final_line = data\n else:\n print(data, end='')\n\n if final_line is None:\n # Maybe there was some stderr output after the end of stdout. Old\n # versions of adb, prior to when the exit status could be\n # communicated, smush the two together.\n raise subprocess.CalledProcessError(-1, adb_command)\n status = int(FINAL_LINE_RE.match(final_line.rstrip()).group(1))\n if status != 0:\n raise subprocess.CalledProcessError(status, adb_command)\n\n child.wait()\n if child.returncode != 0:\n raise subprocess.CalledProcessError(subprocess.returncode,\n adb_command)\n\n # /system/bin/mktemp isn’t normally present prior to Android 6.0 (M), where\n # toybox was introduced (Android platform/manifest 9a2c01e8450b). Fake it\n # with a host-generated name. This won’t retry if the name is in use, but\n # with 122 bits of randomness, it should be OK. This uses “mkdir” instead of\n # “mkdir -p”because the latter will not indicate failure if the directory\n # already exists.\n device_temp_dir = '/data/local/tmp/%s.%s' % (test, uuid.uuid4().hex)\n _adb_shell(['mkdir', device_temp_dir])\n\n try:\n # Specify test dependencies that must be pushed to the device. This\n # could be determined automatically in a GN build, following the example\n # used for Fuchsia. Since nothing like that exists for GYP, hard-code it\n # for supported tests.\n test_build_artifacts = [test, 'crashpad_handler']\n test_data = ['test/test_paths_test_data_root.txt']\n\n if test == 'crashpad_test_test':\n test_build_artifacts.append(\n 'crashpad_test_test_multiprocess_exec_test_child')\n elif test == 'crashpad_util_test':\n test_data.append('util/net/testdata/')\n\n # Establish the directory structure on the device.\n device_out_dir = posixpath.join(device_temp_dir, 'out')\n device_mkdirs = [device_out_dir]\n for source_path in test_data:\n # A trailing slash could reasonably mean to copy an entire\n # directory, but will interfere with what’s needed from the path\n # split. All parent directories of any source_path need to be be\n # represented in device_mkdirs, but it’s important that no\n # source_path itself wind up in device_mkdirs, even if source_path\n # names a directory, because that would cause the “adb push” of the\n # directory below to behave incorrectly.\n if source_path.endswith(posixpath.sep):\n source_path = source_path[:-1]\n\n device_source_path = posixpath.join(device_temp_dir, source_path)\n device_mkdir = posixpath.split(device_source_path)[0]\n if device_mkdir not in device_mkdirs:\n device_mkdirs.append(device_mkdir)\n adb_mkdir_command = ['mkdir', '-p']\n adb_mkdir_command.extend(device_mkdirs)\n _adb_shell(adb_mkdir_command)\n\n # Push the test binary and any other build output to the device.\n local_test_build_artifacts = []\n for artifact in test_build_artifacts:\n local_test_build_artifacts.append(os.path.join(\n binary_dir, artifact))\n _adb_push(local_test_build_artifacts, device_out_dir)\n\n # Push test data to the device.\n for source_path in test_data:\n _adb_push([os.path.join(CRASHPAD_DIR, source_path)],\n posixpath.join(device_temp_dir, source_path))\n\n # Run the test on the device. Pass the test data root in the\n # environment.\n #\n # Because the test will not run with its standard output attached to a\n # pseudo-terminal device, Google Test will not normally enable colored\n # output, so mimic Google Test’s own logic for deciding whether to\n # enable color by checking this script’s own standard output connection.\n # The list of TERM values comes from Google Test’s\n # googletest/src/gtest.cc testing::internal::ShouldUseColor().\n env = {'CRASHPAD_TEST_DATA_ROOT': device_temp_dir}\n gtest_color = os.environ.get('GTEST_COLOR')\n if gtest_color in ('auto', None):\n if (sys.stdout.isatty() and\n (os.environ.get('TERM')\n in ('xterm', 'xterm-color', 'xterm-256color', 'screen',\n 'screen-256color', 'tmux', 'tmux-256color', 'rxvt-unicode',\n 'rxvt-unicode-256color', 'linux', 'cygwin') or\n (IS_WINDOWS_HOST and _EnableVTProcessingOnWindowsConsole()))):\n gtest_color = 'yes'\n else:\n gtest_color = 'no'\n env['GTEST_COLOR'] = gtest_color\n _adb_shell([posixpath.join(device_out_dir, test)] + extra_command_line,\n env)\n finally:\n _adb_shell(['rm', '-rf', device_temp_dir])\n\n\ndef _RunOnIOSTarget(binary_dir,\n test,\n target_platform,\n is_xcuitest=False,\n gtest_filter=None):\n \"\"\"Runs the given iOS |test| app on a simulator with the default OS version.\"\"\"\n\n target_platform = target_platform or 'iphoneos'\n if target_platform == 'iphoneos':\n dyld_insert_libraries = (\n '__PLATFORMS__/iPhoneSimulator.platform/Developer/usr/lib/'\n 'libXCTestBundleInject.dylib')\n xcodebuild_platform = 'iOS Simulator'\n xcodebuild_device_name = 'iPhone 17'\n elif target_platform == 'tvos':\n dyld_insert_libraries = (\n '__PLATFORMS__/AppleTVSimulator.platform/Developer/usr/lib/'\n 'libXCTestBundleInject.dylib')\n xcodebuild_platform = 'tvOS Simulator'\n xcodebuild_device_name = 'Apple TV 4K (3rd generation)'\n else:\n raise ValueError(f'Unexpected target_platform: {target_platform}')\n\n # E.g. __TESTROOT__/Debug-iphonesimulator.\n dyld_framework_path = '__TESTROOT__/%s' % os.path.basename(binary_dir)\n\n def xctest(binary_dir, test, gtest_filter=None):\n \"\"\"Returns a dict containing the xctestrun data needed to run an\n XCTest-based test app.\"\"\"\n test_path = os.path.join(CRASHPAD_DIR, binary_dir)\n module_data = {\n 'TestBundlePath': os.path.join(test_path, test + '_module.xctest'),\n 'TestHostPath': os.path.join(test_path, test + '.app'),\n 'TestingEnvironmentVariables': {\n 'DYLD_FRAMEWORK_PATH': dyld_framework_path + ':',\n 'DYLD_INSERT_LIBRARIES': dyld_insert_libraries,\n 'DYLD_LIBRARY_PATH': dyld_framework_path,\n 'IDEiPhoneInternalTestBundleName': test + '.app',\n 'XCInjectBundleInto': '__TESTHOST__/' + test,\n }\n }\n if gtest_filter:\n module_data['CommandLineArguments'] = [\n '--gtest_filter=' + gtest_filter\n ]\n return {test: module_data}\n\n def xcuitest(binary_dir, test):\n \"\"\"Returns a dict containing the xctestrun data needed to run an\n XCUITest-based test app.\"\"\"\n\n test_path = os.path.join(CRASHPAD_DIR, binary_dir)\n runner_path = os.path.join(test_path, test + '_module-Runner.app')\n bundle_path = os.path.join(runner_path, 'PlugIns',\n test + '_module.xctest')\n target_app_path = os.path.join(test_path, test + '.app')\n module_data = {\n 'IsUITestBundle': True,\n 'SystemAttachmentLifetime': 'deleteOnSuccess',\n 'IsXCTRunnerHostedTestBundle': True,\n 'TestBundlePath': bundle_path,\n 'TestHostPath': runner_path,\n 'UITargetAppPath': target_app_path,\n 'DependentProductPaths': [\n bundle_path, runner_path, target_app_path\n ],\n 'TestingEnvironmentVariables': {\n 'DYLD_FRAMEWORK_PATH': dyld_framework_path + ':',\n 'DYLD_LIBRARY_PATH': dyld_framework_path,\n 'XCInjectBundleInto': '__TESTHOST__/' + test + '_module-Runner',\n },\n }\n return {test: module_data}\n\n with tempfile.NamedTemporaryFile() as f:\n import plistlib\n\n xctestrun_path = f.name + \".xctestrun\"\n print(xctestrun_path)\n command = [\n 'xcodebuild',\n 'test-without-building',\n '-xctestrun',\n xctestrun_path,\n '-destination',\n f'platform={xcodebuild_platform},name={xcodebuild_device_name}',\n ]\n with open(xctestrun_path, 'wb') as fp:\n if is_xcuitest:\n plistlib.dump(xcuitest(binary_dir, test), fp)\n if gtest_filter:\n command.append('-only-testing:' + test + '/' + gtest_filter)\n else:\n plistlib.dump(xctest(binary_dir, test, gtest_filter), fp)\n subprocess.check_call(command)\n\n\n# This script is primarily used from the waterfall so that the list of tests\n# that are run is maintained in-tree, rather than in a separate infrastructure\n# location in the recipe.\ndef main(args):\n parser = argparse.ArgumentParser(description='Run Crashpad unittests.')\n parser.add_argument('binary_dir', help='Root of build dir')\n parser.add_argument('test', nargs='*', help='Specific test(s) to run.')\n parser.add_argument(\n '--gtest_filter',\n help='Google Test filter applied to Google Test binary runs.')\n args = parser.parse_args()\n\n # Tell 64-bit Windows tests where to find 32-bit test executables, for\n # cross-bitted testing. This relies on the fact that the GYP build by\n # default uses {Debug,Release} for the 32-bit build and {Debug,Release}_x64\n # for the 64-bit build. This is not a universally valid assumption, and if\n # it’s not met, 64-bit tests that require 32-bit build output will disable\n # themselves dynamically.\n if (sys.platform == 'win32' and args.binary_dir.endswith('_x64') and\n 'CRASHPAD_TEST_32_BIT_OUTPUT' not in os.environ):\n binary_dir_32 = args.binary_dir[:-4]\n if os.path.isdir(binary_dir_32):\n os.environ['CRASHPAD_TEST_32_BIT_OUTPUT'] = binary_dir_32\n\n target_os = _GetGNArgument('target_os', args.binary_dir)\n is_android = target_os == 'android'\n is_ios = target_os == 'ios'\n # |target_platform| is only set for iOS-based platforms.\n target_platform = _GetGNArgument('target_platform', args.binary_dir)\n\n tests = [\n 'crashpad_client_test',\n 'crashpad_handler_test',\n 'crashpad_minidump_test',\n 'crashpad_snapshot_test',\n 'crashpad_test_test',\n 'crashpad_util_test',\n ]\n\n if is_android:\n android_device = os.environ.get('ANDROID_DEVICE')\n if not android_device:\n adb_devices = subprocess.check_output(['adb', 'devices'],\n shell=IS_WINDOWS_HOST,\n text=True)\n devices = []\n for line in adb_devices.splitlines():\n line = line\n if (line == 'List of devices attached' or\n re.match(r'^\\* daemon .+ \\*$', line) or line == ''):\n continue\n (device, ignore) = line.split('\\t')\n devices.append(device)\n if len(devices) != 1:\n print(\"Please set ANDROID_DEVICE to your device's id\",\n file=sys.stderr)\n return 2\n android_device = devices[0]\n print('Using autodetected Android device:', android_device)\n elif is_ios:\n tests.append('ios_crash_xcuitests')\n elif IS_WINDOWS_HOST:\n tests.append('snapshot/win/end_to_end_test.py')\n\n if args.test:\n for t in args.test:\n if t not in tests:\n print('Unrecognized test:', t, file=sys.stderr)\n return 3\n tests = args.test\n\n for test in tests:\n print('-' * 80)\n print(test)\n print('-' * 80)\n if test.endswith('.py'):\n subprocess.check_call([\n sys.executable,\n os.path.join(CRASHPAD_DIR, test), args.binary_dir\n ])\n else:\n extra_command_line = []\n if args.gtest_filter:\n extra_command_line.append('--gtest_filter=' + args.gtest_filter)\n if is_android:\n _RunOnAndroidTarget(args.binary_dir, test, android_device,\n extra_command_line)\n elif is_ios:\n _RunOnIOSTarget(args.binary_dir,\n test,\n target_platform,\n is_xcuitest=test.startswith('ios'),\n gtest_filter=args.gtest_filter)\n else:\n subprocess.check_call([os.path.join(args.binary_dir, test)] +\n extra_command_line)\n\n return 0\n\n\nif __name__ == '__main__':\n sys.exit(main(sys.argv[1:]))\n" }, { "path": "build/test.gni", "content": "# Copyright 2017 The Crashpad Authors\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n\nimport(\"crashpad_buildconfig.gni\")\n\nif (crashpad_is_in_chromium) {\n import(\"//testing/test.gni\")\n} else {\n template(\"test\") {\n if (crashpad_is_ios) {\n import(\"//third_party/mini_chromium/mini_chromium/build/ios/rules.gni\")\n\n _launch_image_bundle_target = target_name + \"_launch_image\"\n bundle_data(_launch_image_bundle_target) {\n forward_variables_from(invoker, [ \"testonly\" ])\n sources = [ \"//build/ios/Default.png\" ]\n outputs = [ \"{{bundle_contents_dir}}/{{source_file_part}}\" ]\n }\n\n ios_xctest_test(target_name) {\n testonly = true\n xctest_module_target = \"//test/ios:google_test_runner\"\n info_plist = \"//build/ios/Unittest-Info.plist\"\n extra_substitutions = [ \"GTEST_BUNDLE_ID_SUFFIX=$target_name\" ]\n forward_variables_from(invoker, \"*\")\n if (!defined(deps)) {\n deps = []\n }\n deps += [ \":$_launch_image_bundle_target\" ]\n }\n } else {\n executable(target_name) {\n testonly = true\n forward_variables_from(invoker, \"*\")\n }\n }\n }\n}\n" }, { "path": "client/BUILD.gn", "content": "# Copyright 2015 The Crashpad Authors\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n\nimport(\"../build/crashpad_buildconfig.gni\")\n\ncrashpad_static_library(\"client\") {\n sources = [\n \"crashpad_client.h\",\n \"prune_crash_reports.cc\",\n \"prune_crash_reports.h\",\n \"simulate_crash.h\",\n ]\n\n if (crashpad_is_mac) {\n sources += [\n \"crashpad_client_mac.cc\",\n \"simulate_crash_mac.cc\",\n \"simulate_crash_mac.h\",\n ]\n }\n\n if (crashpad_is_ios) {\n sources += [\n \"crash_handler_base_ios.cc\",\n \"crash_handler_base_ios.h\",\n \"crashpad_client_ios.cc\",\n \"ios_handler/exception_processor.h\",\n \"ios_handler/exception_processor.mm\",\n \"ios_handler/in_process_handler.cc\",\n \"ios_handler/in_process_handler.h\",\n \"ios_handler/in_process_intermediate_dump_handler.cc\",\n \"ios_handler/in_process_intermediate_dump_handler.h\",\n \"ios_handler/prune_intermediate_dumps_and_crash_reports_thread.cc\",\n \"ios_handler/prune_intermediate_dumps_and_crash_reports_thread.h\",\n \"simulate_crash_ios.h\",\n \"upload_behavior_ios.h\",\n ]\n\n if (!crashpad_is_tvos) {\n sources += [\n \"crash_handler_ios.cc\",\n \"crash_handler_ios.h\",\n ]\n } else {\n sources += [\n \"crash_handler_tvos.cc\",\n \"crash_handler_tvos.h\",\n ]\n }\n }\n\n if (crashpad_is_linux || crashpad_is_android) {\n sources += [\n \"crashpad_client_linux.cc\",\n \"simulate_crash_linux.h\",\n ]\n }\n\n if (crashpad_is_linux || crashpad_is_android || crashpad_is_fuchsia) {\n sources += [\n \"client_argv_handling.cc\",\n \"client_argv_handling.h\",\n ]\n }\n\n if (crashpad_is_win) {\n sources += [\n \"crashpad_client_win.cc\",\n \"simulate_crash_win.h\",\n ]\n }\n\n if (crashpad_is_fuchsia) {\n sources += [ \"crashpad_client_fuchsia.cc\" ]\n }\n\n public_configs = [ \"..:crashpad_config\" ]\n\n public_deps = [\n \":common\",\n \"$mini_chromium_source_parent:base\",\n \"../util\",\n ]\n\n deps = [ \":common\" ]\n\n if (crashpad_is_win) {\n libs = [ \"rpcrt4.lib\" ]\n cflags = [ \"/wd4201\" ] # nonstandard extension used : nameless struct/union\n }\n\n if (crashpad_is_apple) {\n deps += [ \"../build:apple_enable_arc\" ]\n }\n\n if (crashpad_is_ios) {\n deps += [\n \"../handler:common\",\n \"../minidump\",\n \"../snapshot\",\n ]\n }\n\n if (crashpad_is_linux || crashpad_is_android) {\n deps += [ \"../third_party/lss\" ]\n }\n\n if (crashpad_is_fuchsia) {\n deps += [ \"../third_party/fuchsia\" ]\n if (crashpad_is_in_fuchsia) {\n deps += [ \"//sdk/lib/fdio\" ]\n }\n }\n}\n\nstatic_library(\"common\") {\n sources = [\n \"annotation.cc\",\n \"annotation.h\",\n \"annotation_list.cc\",\n \"annotation_list.h\",\n \"crash_report_database.cc\",\n \"crash_report_database.h\",\n \"crashpad_info.cc\",\n \"crashpad_info.h\",\n \"length_delimited_ring_buffer.h\",\n \"ring_buffer_annotation.h\",\n \"settings.cc\",\n \"settings.h\",\n \"simple_address_range_bag.h\",\n \"simple_string_dictionary.h\",\n ]\n\n if (crashpad_is_apple) {\n sources += [ \"crash_report_database_mac.mm\" ]\n }\n if (crashpad_is_win) {\n sources += [ \"crash_report_database_win.cc\" ]\n }\n if (crashpad_is_linux || crashpad_is_android || crashpad_is_fuchsia) {\n sources += [\n \"crash_report_database_generic.cc\",\n \"crashpad_info_note.S\",\n ]\n }\n\n public_configs = [ \"..:crashpad_config\" ]\n public_deps = [\n \"$mini_chromium_source_parent:base\",\n \"../util\",\n ]\n deps = [ \"../util\" ]\n configs += [ \"../build:flock_always_supported_defines\" ]\n\n if (crashpad_is_apple) {\n deps += [ \"../build:apple_enable_arc\" ]\n }\n}\n\ncrashpad_executable(\"ring_buffer_annotation_load_test\") {\n testonly = true\n sources = [ \"ring_buffer_annotation_load_test_main.cc\" ]\n deps = [\n \":client\",\n \"$mini_chromium_source_parent:base\",\n \"../tools:tool_support\",\n ]\n}\n\nsource_set(\"client_test\") {\n testonly = true\n\n sources = [\n \"annotation_list_test.cc\",\n \"annotation_test.cc\",\n \"crash_report_database_test.cc\",\n \"crashpad_info_test.cc\",\n \"length_delimited_ring_buffer_test.cc\",\n \"prune_crash_reports_test.cc\",\n \"ring_buffer_annotation_test.cc\",\n \"settings_test.cc\",\n \"simple_address_range_bag_test.cc\",\n \"simple_string_dictionary_test.cc\",\n ]\n\n if (crashpad_is_mac) {\n sources += [ \"simulate_crash_mac_test.cc\" ]\n }\n\n if (crashpad_is_win) {\n sources += [ \"crashpad_client_win_test.cc\" ]\n }\n\n if (crashpad_is_ios) {\n sources += [\n \"crashpad_client_ios_test.mm\",\n \"ios_handler/exception_processor_test.mm\",\n \"ios_handler/in_process_handler_test.cc\",\n \"ios_handler/in_process_intermediate_dump_handler_test.cc\",\n ]\n }\n\n if (crashpad_is_linux || crashpad_is_android) {\n sources += [ \"crashpad_client_linux_test.cc\" ]\n }\n\n deps = [\n \":client\",\n \"$mini_chromium_source_parent:base\",\n \"../compat\",\n \"../snapshot\",\n \"../test\",\n \"../third_party/googletest\",\n \"../third_party/googletest:googlemock\",\n \"../util\",\n ]\n\n if (!crashpad_is_ios && !crashpad_is_fuchsia) {\n data_deps = [ \"../handler:crashpad_handler\" ]\n }\n\n if (crashpad_is_apple) {\n deps += [ \"../build:apple_enable_arc\" ]\n }\n\n if (crashpad_is_win) {\n data_deps += [\n \"../handler:crashpad_handler_console\",\n \"../handler/win/wer:crashpad_wer_handler\",\n ]\n }\n\n if (crashpad_is_ios) {\n deps += [ \"../minidump\" ]\n }\n}\n\nif (crashpad_is_linux || crashpad_is_android) {\n source_set(\"pthread_create\") {\n sources = [ \"pthread_create_linux.cc\" ]\n\n deps = [ \":client\" ]\n }\n}\n" }, { "path": "client/annotation.cc", "content": "// Copyright 2017 The Crashpad Authors\n//\n// Licensed under the Apache License, Version 2.0 (the \"License\");\n// you may not use this file except in compliance with the License.\n// You may obtain a copy of the License at\n//\n// http://www.apache.org/licenses/LICENSE-2.0\n//\n// Unless required by applicable law or agreed to in writing, software\n// distributed under the License is distributed on an \"AS IS\" BASIS,\n// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n// See the License for the specific language governing permissions and\n// limitations under the License.\n\n#include \"client/annotation.h\"\n\n#include \n\n#include \"base/check_op.h\"\n#include \"client/annotation_list.h\"\n\nnamespace crashpad {\n\nstatic_assert(std::is_standard_layout::value,\n \"Annotation must be POD\");\n\n// static\nconstexpr size_t Annotation::kNameMaxLength;\nconstexpr size_t Annotation::kValueMaxSize;\n\nvoid Annotation::SetSize(ValueSizeType size) {\n DCHECK_LT(size, kValueMaxSize);\n size_ = size;\n // Use Register() instead of Get() in case the calling module has not\n // explicitly initialized the annotation list, to avoid crashing.\n AnnotationList::Register()->Add(this);\n}\n\nvoid Annotation::Clear() {\n size_ = 0;\n}\n\n} // namespace crashpad\n" }, { "path": "client/annotation.h", "content": "// Copyright 2017 The Crashpad Authors\n//\n// Licensed under the Apache License, Version 2.0 (the \"License\");\n// you may not use this file except in compliance with the License.\n// You may obtain a copy of the License at\n//\n// http://www.apache.org/licenses/LICENSE-2.0\n//\n// Unless required by applicable law or agreed to in writing, software\n// distributed under the License is distributed on an \"AS IS\" BASIS,\n// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n// See the License for the specific language governing permissions and\n// limitations under the License.\n\n#ifndef CRASHPAD_CLIENT_ANNOTATION_H_\n#define CRASHPAD_CLIENT_ANNOTATION_H_\n\n#include \n#include \n#include \n\n#include \n#include \n#include \n#include \n#include \n\n#include \"base/check.h\"\n#include \"base/numerics/safe_conversions.h\"\n#include \"build/build_config.h\"\n#include \"util/synchronization/scoped_spin_guard.h\"\n\nnamespace crashpad {\n#if BUILDFLAG(IS_IOS)\nnamespace internal {\nclass InProcessIntermediateDumpHandler;\n} // namespace internal\n#endif\nclass AnnotationList;\n\n//! \\brief Base class for an annotation, which records a name-value pair of\n//! arbitrary data when set.\n//!\n//! After an annotation is declared, its `value_ptr_` will not be captured in a\n//! crash report until a call to \\a SetSize() specifies how much data from the\n//! value should be recorded.\n//!\n//! Annotations should be declared with static storage duration.\n//!\n//! An example declaration and usage:\n//!\n//! \\code\n//! // foo.cc:\n//!\n//! namespace {\n//! char g_buffer[1024];\n//! crashpad::Annotation g_buffer_annotation(\n//! crashpad::Annotation::Type::kString, \"buffer_head\", g_buffer);\n//! } // namespace\n//!\n//! void OnBufferProduced(size_t n) {\n//! // Capture the head of the buffer, in case we crash when parsing it.\n//! g_buffer_annotation.SetSize(std::min(64, n));\n//!\n//! // Start parsing the header.\n//! Frobinate(g_buffer, n);\n//! }\n//! \\endcode\n//!\n//! Annotation objects are not inherently thread-safe. To manipulate them\n//! from multiple threads, external synchronization must be used.\n//!\n//! Annotation objects should never be destroyed. Once they are Set(), they\n//! are permanently referenced by a global object.\nclass Annotation {\n public:\n //! \\brief The maximum length of an annotation’s name, in bytes.\n //! Matches the behavior of Breakpad's SimpleStringDictionary.\n static constexpr size_t kNameMaxLength = 256;\n\n //! \\brief The maximum size of an annotation’s value, in bytes.\n static constexpr size_t kValueMaxSize = 5 * 4096;\n\n //! \\brief The type used for \\a SetSize().\n using ValueSizeType = uint32_t;\n\n //! \\brief The type of data stored in the annotation.\n enum class Type : uint16_t {\n //! \\brief An invalid annotation. Reserved for internal use.\n kInvalid = 0,\n\n //! \\brief A `NUL`-terminated C-string.\n kString = 1,\n\n //! \\brief Clients may declare their own custom types by using values\n //! greater than this.\n kUserDefinedStart = 0x8000,\n };\n\n //! \\brief Mode used to guard concurrent reads from writes.\n enum class ConcurrentAccessGuardMode : bool {\n //! \\!brief Annotation does not guard reads from concurrent\n //! writes. Annotation values can be corrupted if the process crashes\n //! mid-write and the handler tries to read from the Annotation while\n //! being written to.\n kUnguarded = false,\n\n //! \\!brief Annotation guards reads from concurrent writes using\n //! ScopedSpinGuard. Clients must use TryCreateScopedSpinGuard()\n //! before reading or writing the data in this Annotation.\n kScopedSpinGuard = true,\n };\n\n //! \\brief Creates a user-defined Annotation::Type.\n //!\n //! This exists to remove the casting overhead of `enum class`.\n //!\n //! \\param[in] value A value used to create a user-defined type.\n //!\n //! \\returns The value added to Type::kUserDefinedStart and casted.\n constexpr static Type UserDefinedType(uint16_t value) {\n using UnderlyingType = std::underlying_type::type;\n // MSVS 2015 doesn't have full C++14 support and complains about local\n // variables defined in a constexpr function, which is valid. Avoid them\n // and the also-problematic DCHECK until all the infrastructure is updated:\n // https://crbug.com/crashpad/201.\n#if !BUILDFLAG(IS_WIN) || (defined(_MSC_VER) && _MSC_VER >= 1910)\n const UnderlyingType start =\n static_cast(Type::kUserDefinedStart);\n const UnderlyingType user_type = start + value;\n DCHECK(user_type > start) << \"User-defined Type is 0 or overflows\";\n return static_cast(user_type);\n#else\n return static_cast(\n static_cast(Type::kUserDefinedStart) + value);\n#endif\n }\n\n //! \\brief Constructs a new annotation.\n //!\n //! Upon construction, the annotation will not be included in any crash\n //! reports until \\sa SetSize() is called with a value greater than `0`.\n //!\n //! \\param[in] type The data type of the value of the annotation.\n //! \\param[in] name A `NUL`-terminated C-string name for the annotation. Names\n //! do not have to be unique, though not all crash processors may handle\n //! Annotations with the same name. Names should be constexpr data with\n //! static storage duration.\n //! \\param[in] value_ptr A pointer to the value for the annotation. The\n //! pointer may not be changed once associated with an annotation, but\n //! the data may be mutated.\n constexpr Annotation(Type type, const char name[], void* value_ptr)\n : Annotation(type,\n name,\n value_ptr,\n ConcurrentAccessGuardMode::kUnguarded) {}\n\n Annotation(const Annotation&) = delete;\n Annotation& operator=(const Annotation&) = delete;\n\n //! \\brief Specifies the number of bytes in \\a value_ptr_ to include when\n //! generating a crash report.\n //!\n //! A size of `0` indicates that no value should be recorded and is the\n //! equivalent of calling \\sa Clear().\n //!\n //! This method does not mutate the data referenced by the annotation, it\n //! merely updates the annotation system's bookkeeping.\n //!\n //! Subclasses of this base class that provide additional Set methods to\n //! mutate the value of the annotation must call always call this method.\n //!\n //! \\param[in] size The number of bytes.\n void SetSize(ValueSizeType size);\n\n //! \\brief Marks the annotation as cleared, indicating the \\a value_ptr_\n //! should not be included in a crash report.\n //!\n //! This method does not mutate the data referenced by the annotation, it\n //! merely updates the annotation system's bookkeeping.\n void Clear();\n\n //! \\brief Tests whether the annotation has been set.\n bool is_set() const { return size_ > 0; }\n\n Type type() const { return type_; }\n ValueSizeType size() const { return size_; }\n const char* name() const { return name_; }\n const void* value() const { return value_ptr_; }\n\n ConcurrentAccessGuardMode concurrent_access_guard_mode() const {\n return concurrent_access_guard_mode_;\n }\n\n //! \\brief If this Annotation guards concurrent access using ScopedSpinGuard,\n //! tries to obtain the spin guard and returns the result.\n //!\n //! \\param[in] timeout_ns The timeout in nanoseconds after which to give up\n //! trying to obtain the spin guard.\n //! \\return std::nullopt if the spin guard could not be obtained within\n //! timeout_ns, or the obtained spin guard otherwise.\n std::optional TryCreateScopedSpinGuard(uint64_t timeout_ns) {\n // This can't use DCHECK_EQ() because ostream doesn't support\n // operator<<(bool).\n DCHECK(concurrent_access_guard_mode_ ==\n ConcurrentAccessGuardMode::kScopedSpinGuard);\n if (concurrent_access_guard_mode_ ==\n ConcurrentAccessGuardMode::kUnguarded) {\n return std::nullopt;\n }\n return ScopedSpinGuard::TryCreateScopedSpinGuard(timeout_ns,\n spin_guard_state_);\n }\n\n protected:\n //! \\brief Constructs a new annotation.\n //!\n //! Upon construction, the annotation will not be included in any crash\n //! reports until \\sa SetSize() is called with a value greater than `0`.\n //!\n //! \\param[in] type The data type of the value of the annotation.\n //! \\param[in] name A `NUL`-terminated C-string name for the annotation. Names\n //! do not have to be unique, though not all crash processors may handle\n //! Annotations with the same name. Names should be constexpr data with\n //! static storage duration.\n //! \\param[in] value_ptr A pointer to the value for the annotation. The\n //! pointer may not be changed once associated with an annotation, but\n //! the data may be mutated.\n //! \\param[in] concurrent_access_guard_mode Mode used to guard concurrent\n //! reads from writes.\n constexpr Annotation(Type type,\n const char name[],\n void* value_ptr,\n ConcurrentAccessGuardMode concurrent_access_guard_mode)\n : link_node_(nullptr),\n name_(name),\n value_ptr_(value_ptr),\n size_(0),\n type_(type),\n concurrent_access_guard_mode_(concurrent_access_guard_mode),\n spin_guard_state_() {}\n\n friend class AnnotationList;\n#if BUILDFLAG(IS_IOS)\n friend class internal::InProcessIntermediateDumpHandler;\n#endif\n\n std::atomic& link_node() { return link_node_; }\n\n Annotation* GetLinkNode(std::memory_order order = std::memory_order_seq_cst) {\n return link_node_.load(order);\n }\n const Annotation* GetLinkNode(\n std::memory_order order = std::memory_order_seq_cst) const {\n return link_node_.load(order);\n }\n\n private:\n //! \\brief Linked list next-node pointer. Accessed only by \\sa AnnotationList.\n //!\n //! This will be null until the first call to \\sa SetSize(), after which the\n //! presence of the pointer will prevent the node from being added to the\n //! list again.\n std::atomic link_node_;\n\n const char* const name_;\n void* const value_ptr_;\n ValueSizeType size_;\n const Type type_;\n\n //! \\brief Mode used to guard concurrent reads from writes.\n const ConcurrentAccessGuardMode concurrent_access_guard_mode_;\n\n SpinGuardState spin_guard_state_;\n};\n\n//! \\brief An \\sa Annotation that stores a `NUL`-terminated C-string value.\n//!\n//! The storage for the value is allocated by the annotation and the template\n//! parameter \\a MaxSize controls the maxmium length for the value.\n//!\n//! It is expected that the string value be valid UTF-8, although this is not\n//! validated.\ntemplate \nclass StringAnnotation : public Annotation {\n public:\n //! \\brief A constructor tag that enables braced initialization in C arrays.\n //!\n //! \\sa StringAnnotation()\n enum class Tag { kArray };\n\n //! \\brief Constructs a new StringAnnotation with the given \\a name.\n //!\n //! \\param[in] name The Annotation name.\n constexpr explicit StringAnnotation(const char name[])\n : Annotation(Type::kString, name, value_), value_() {}\n\n StringAnnotation(const StringAnnotation&) = delete;\n StringAnnotation& operator=(const StringAnnotation&) = delete;\n\n //! \\brief Constructs a new StringAnnotation with the given \\a name.\n //!\n //! This constructor takes the ArrayInitializerTag for use when\n //! initializing a C array of annotations. The main constructor is\n //! explicit and cannot be brace-initialized. As an example:\n //!\n //! \\code\n //! static crashpad::StringAnnotation<32> annotations[] = {\n //! {\"name-1\", crashpad::StringAnnotation<32>::Tag::kArray},\n //! {\"name-2\", crashpad::StringAnnotation<32>::Tag::kArray},\n //! {\"name-3\", crashpad::StringAnnotation<32>::Tag::kArray},\n //! };\n //! \\endcode\n //!\n //! \\param[in] name The Annotation name.\n //! \\param[in] tag A constructor tag.\n constexpr StringAnnotation(const char name[], Tag tag)\n : StringAnnotation(name) {}\n\n //! \\brief Sets the Annotation's string value.\n //!\n //! \\param[in] value The `NUL`-terminated C-string value.\n void Set(const char* value) {\n strncpy(value_, value, MaxSize);\n SetSize(\n std::min(MaxSize, base::saturated_cast(strlen(value))));\n }\n\n //! \\brief Sets the Annotation's string value.\n //!\n //! \\param[in] string The string value.\n void Set(std::string_view string) {\n Annotation::ValueSizeType size =\n std::min(MaxSize, base::saturated_cast(string.size()));\n string = string.substr(0, size);\n std::copy(string.begin(), string.end(), value_);\n // Check for no embedded `NUL` characters.\n DCHECK(string.find('\\0', /*pos=*/0) == std::string_view::npos)\n << \"embedded NUL\";\n SetSize(size);\n }\n\n const std::string_view value() const {\n return std::string_view(value_, size());\n }\n\n private:\n // This value is not `NUL`-terminated, since the size is stored by the base\n // annotation.\n char value_[MaxSize];\n};\n\n} // namespace crashpad\n\n#endif // CRASHPAD_CLIENT_ANNOTATION_H_\n" }, { "path": "client/annotation_list.cc", "content": "// Copyright 2017 The Crashpad Authors\n//\n// Licensed under the Apache License, Version 2.0 (the \"License\");\n// you may not use this file except in compliance with the License.\n// You may obtain a copy of the License at\n//\n// http://www.apache.org/licenses/LICENSE-2.0\n//\n// Unless required by applicable law or agreed to in writing, software\n// distributed under the License is distributed on an \"AS IS\" BASIS,\n// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n// See the License for the specific language governing permissions and\n// limitations under the License.\n\n#include \"client/annotation_list.h\"\n\n#include \"base/check_op.h\"\n#include \"client/crashpad_info.h\"\n\nnamespace crashpad {\n\ntemplate \nT* AnnotationList::IteratorBase::operator*() const {\n CHECK_NE(curr_, tail_);\n return curr_;\n}\n\ntemplate \nT* AnnotationList::IteratorBase::operator->() const {\n CHECK_NE(curr_, tail_);\n return curr_;\n}\n\ntemplate \nAnnotationList::IteratorBase& AnnotationList::IteratorBase::operator++() {\n CHECK_NE(curr_, tail_);\n curr_ = curr_->GetLinkNode();\n return *this;\n}\n\ntemplate \nAnnotationList::IteratorBase AnnotationList::IteratorBase::operator++(\n int) {\n T* const old_curr = curr_;\n ++(*this);\n return IteratorBase(old_curr, tail_);\n}\n\ntemplate \nbool AnnotationList::IteratorBase::operator!=(\n const IteratorBase& other) const {\n return !(*this == other);\n}\n\ntemplate \nAnnotationList::IteratorBase::IteratorBase(T* head, const Annotation* tail)\n : curr_(head), tail_(tail) {}\n\ntemplate class AnnotationList::IteratorBase;\ntemplate class AnnotationList::IteratorBase;\n\nAnnotationList::AnnotationList()\n : tail_pointer_(&tail_),\n head_(Annotation::Type::kInvalid, nullptr, nullptr),\n tail_(Annotation::Type::kInvalid, nullptr, nullptr) {\n head_.link_node().store(&tail_);\n}\n\nAnnotationList::~AnnotationList() {}\n\n// static\nAnnotationList* AnnotationList::Get() {\n return CrashpadInfo::GetCrashpadInfo()->annotations_list();\n}\n\n// static\nAnnotationList* AnnotationList::Register() {\n AnnotationList* list = Get();\n if (!list) {\n list = new AnnotationList();\n CrashpadInfo::GetCrashpadInfo()->set_annotations_list(list);\n }\n return list;\n}\n\nvoid AnnotationList::Add(Annotation* annotation) {\n Annotation* null = nullptr;\n Annotation* head_next = head_.link_node().load(std::memory_order_relaxed);\n if (!annotation->link_node().compare_exchange_strong(null, head_next)) {\n // If |annotation|'s link node is not null, then it has been added to the\n // list already and no work needs to be done.\n return;\n }\n\n // Check that the annotation's name is less than the maximum size. This is\n // done here, since the Annotation constructor must be constexpr and this\n // path is taken once per annotation.\n DCHECK_LT(strlen(annotation->name_), Annotation::kNameMaxLength);\n\n // Update the head link to point to the new |annotation|.\n while (!head_.link_node().compare_exchange_weak(head_next, annotation)) {\n // Another thread has updated the head-next pointer, so try again with the\n // re-loaded |head_next|.\n annotation->link_node().store(head_next, std::memory_order_relaxed);\n }\n}\n\nAnnotationList::Iterator AnnotationList::begin() {\n return Iterator(head_.GetLinkNode(), tail_pointer_);\n}\n\nAnnotationList::ConstIterator AnnotationList::cbegin() const {\n return ConstIterator(head_.GetLinkNode(), tail_pointer_);\n}\n\nAnnotationList::Iterator AnnotationList::end() {\n return Iterator(&tail_, tail_pointer_);\n}\n\nAnnotationList::ConstIterator AnnotationList::cend() const {\n return ConstIterator(&tail_, tail_pointer_);\n}\n\n} // namespace crashpad\n" }, { "path": "client/annotation_list.h", "content": "// Copyright 2017 The Crashpad Authors\n//\n// Licensed under the Apache License, Version 2.0 (the \"License\");\n// you may not use this file except in compliance with the License.\n// You may obtain a copy of the License at\n//\n// http://www.apache.org/licenses/LICENSE-2.0\n//\n// Unless required by applicable law or agreed to in writing, software\n// distributed under the License is distributed on an \"AS IS\" BASIS,\n// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n// See the License for the specific language governing permissions and\n// limitations under the License.\n\n#ifndef CRASHPAD_CLIENT_ANNOTATION_LIST_H_\n#define CRASHPAD_CLIENT_ANNOTATION_LIST_H_\n\n#include \n\n#include \"build/build_config.h\"\n#include \"client/annotation.h\"\n\nnamespace crashpad {\n#if BUILDFLAG(IS_IOS)\nnamespace internal {\nclass InProcessIntermediateDumpHandler;\n} // namespace internal\n#endif\n\n//! \\brief A list that contains all the currently set annotations.\n//!\n//! An instance of this class must be registered on the \\a CrashpadInfo\n//! structure in order to use the annotations system. Once a list object has\n//! been registered on the CrashpadInfo, a different instance should not\n//! be used instead.\nclass AnnotationList {\n public:\n AnnotationList();\n\n AnnotationList(const AnnotationList&) = delete;\n AnnotationList& operator=(const AnnotationList&) = delete;\n\n ~AnnotationList();\n\n //! \\brief Returns the instance of the list that has been registered on the\n //! CrashapdInfo structure.\n static AnnotationList* Get();\n\n //! \\brief Returns the instance of the list, creating and registering\n //! it if one is not already set on the CrashapdInfo structure.\n static AnnotationList* Register();\n\n //! \\brief Adds \\a annotation to the global list. This method does not need\n //! to be called by clients directly. The Annotation object will do so\n //! automatically.\n //!\n //! Once an annotation is added to the list, it is not removed. This is\n //! because the AnnotationList avoids the use of locks/mutexes, in case it is\n //! being manipulated in a compromised context. Instead, an Annotation keeps\n //! track of when it has been cleared, which excludes it from a crash report.\n //! This design also avoids linear scans of the list when repeatedly setting\n //! and/or clearing the value.\n void Add(Annotation* annotation);\n\n //! \\brief An InputIterator for the AnnotationList.\n template \n class IteratorBase {\n public:\n using difference_type = signed int;\n using value_type = T*;\n using reference = T*;\n using pointer = void;\n using iterator_category = std::input_iterator_tag;\n\n IteratorBase(const IteratorBase& other) = default;\n IteratorBase(IteratorBase&& other) = default;\n\n ~IteratorBase() = default;\n\n IteratorBase& operator=(const IteratorBase& other) = default;\n IteratorBase& operator=(IteratorBase&& other) = default;\n\n T* operator*() const;\n T* operator->() const;\n\n IteratorBase& operator++();\n IteratorBase operator++(int);\n\n bool operator==(const IteratorBase& other) const {\n return curr_ == other.curr_;\n }\n\n bool operator!=(const IteratorBase& other) const;\n\n private:\n friend class AnnotationList;\n IteratorBase(T* head, const Annotation* tail);\n\n T* curr_ = nullptr;\n const Annotation* tail_ = nullptr;\n };\n\n using Iterator = IteratorBase;\n using ConstIterator = IteratorBase;\n\n //! \\brief Returns an iterator to the first element of the annotation list.\n Iterator begin();\n ConstIterator begin() const { return cbegin(); }\n ConstIterator cbegin() const;\n\n //! \\brief Returns an iterator past the last element of the annotation list.\n Iterator end();\n ConstIterator end() const { return cend(); }\n ConstIterator cend() const;\n\n protected:\n#if BUILDFLAG(IS_IOS)\n friend class internal::InProcessIntermediateDumpHandler;\n#endif\n\n //! \\brief Returns a pointer to the tail node.\n const Annotation* tail_pointer() const { return tail_pointer_; }\n\n //! \\brief Returns a pointer to the head element.\n const Annotation* head() const { return &head_; }\n\n private:\n // To make it easier for the handler to locate the dummy tail node, store the\n // pointer. Placed first for packing.\n const Annotation* const tail_pointer_;\n\n // Dummy linked-list head and tail elements of \\a Annotation::Type::kInvalid.\n Annotation head_;\n Annotation tail_;\n};\n\n} // namespace crashpad\n\n#endif // CRASHPAD_CLIENT_ANNOTATION_LIST_H_\n" }, { "path": "client/annotation_list_test.cc", "content": "// Copyright 2017 The Crashpad Authors\n//\n// Licensed under the Apache License, Version 2.0 (the \"License\");\n// you may not use this file except in compliance with the License.\n// You may obtain a copy of the License at\n//\n// http://www.apache.org/licenses/LICENSE-2.0\n//\n// Unless required by applicable law or agreed to in writing, software\n// distributed under the License is distributed on an \"AS IS\" BASIS,\n// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n// See the License for the specific language governing permissions and\n// limitations under the License.\n\n#include \"client/annotation.h\"\n\n#include \n#include \n#include \n#include \n#include \n\n#include \"base/rand_util.h\"\n#include \"client/crashpad_info.h\"\n#include \"gtest/gtest.h\"\n#include \"util/misc/clock.h\"\n#include \"util/thread/thread.h\"\n\nnamespace crashpad {\nnamespace test {\nnamespace {\n\n#if (__cplusplus >= 202002L)\ntemplate \n requires std::input_iterator\nvoid VerifyIsInputIterator(Iterator) {}\n#else\ntemplate \nstruct IsLegacyIteratorImpl {\n static constexpr bool value =\n std::is_copy_constructible_v &&\n std::is_copy_assignable_v && std::is_destructible_v &&\n std::is_swappable_v &&\n // check that std::iterator_traits has the necessary types (check only one\n // needed as std::iterator is required to define only if all are defined)\n !std::is_same_v::reference,\n void> &&\n std::is_same_v()), Iterator&> &&\n !std::is_same_v()), void>;\n};\n\ntemplate \nstruct IsLegacyInputIteratorImpl {\n static constexpr bool value =\n IsLegacyIteratorImpl::value &&\n std::is_base_of_v<\n std::input_iterator_tag,\n typename std::iterator_traits::iterator_category> &&\n std::is_convertible_v() !=\n std::declval()),\n bool> &&\n std::is_convertible_v() ==\n std::declval()),\n bool> &&\n std::is_same_v()),\n typename std::iterator_traits::reference> &&\n std::is_same_v()), Iterator&> &&\n std::is_same_v()++), Iterator> &&\n std::is_same_v())),\n typename std::iterator_traits::reference>;\n};\n\ntemplate \nvoid VerifyIsInputIterator(Iterator) {\n static_assert(IsLegacyInputIteratorImpl::value);\n}\n#endif\n\nTEST(AnnotationListStatic, Register) {\n ASSERT_FALSE(AnnotationList::Get());\n EXPECT_TRUE(AnnotationList::Register());\n EXPECT_TRUE(AnnotationList::Get());\n EXPECT_EQ(AnnotationList::Get(), AnnotationList::Register());\n\n // This isn't expected usage of the AnnotationList API, but it is necessary\n // for testing.\n AnnotationList* list = AnnotationList::Get();\n CrashpadInfo::GetCrashpadInfo()->set_annotations_list(nullptr);\n delete list;\n\n EXPECT_FALSE(AnnotationList::Get());\n}\n\nclass AnnotationList : public testing::Test {\n public:\n void SetUp() override {\n CrashpadInfo::GetCrashpadInfo()->set_annotations_list(&annotations_);\n }\n\n void TearDown() override {\n CrashpadInfo::GetCrashpadInfo()->set_annotations_list(nullptr);\n }\n\n // NOTE: Annotations should be declared at file-scope, but in order to test\n // them, they are declared as part of the test. These members are public so\n // they are accessible from global helpers.\n crashpad::StringAnnotation<8> one_{\"First\"};\n crashpad::StringAnnotation<256> two_{\"Second\"};\n crashpad::StringAnnotation<101> three_{\"First\"};\n\n protected:\n using AllAnnotations = std::vector>;\n\n AllAnnotations CollectAnnotations() {\n AllAnnotations annotations;\n\n for (Annotation* curr : annotations_) {\n if (!curr->is_set())\n continue;\n std::string value(static_cast(curr->value()), curr->size());\n annotations.push_back(std::make_pair(curr->name(), value));\n }\n\n return annotations;\n }\n\n bool ContainsNameValue(const AllAnnotations& annotations,\n const std::string& name,\n const std::string& value) {\n return std::find(annotations.begin(),\n annotations.end(),\n std::make_pair(name, value)) != annotations.end();\n }\n\n crashpad::AnnotationList annotations_;\n};\n\nTEST_F(AnnotationList, SetAndClear) {\n one_.Set(\"this is a value longer than 8 bytes\");\n AllAnnotations annotations = CollectAnnotations();\n\n EXPECT_EQ(1u, annotations.size());\n EXPECT_TRUE(ContainsNameValue(annotations, \"First\", \"this is \"));\n\n one_.Clear();\n\n EXPECT_EQ(0u, CollectAnnotations().size());\n\n one_.Set(\"short\");\n two_.Set(std::string(500, 'A').data());\n\n annotations = CollectAnnotations();\n EXPECT_EQ(2u, annotations.size());\n\n EXPECT_EQ(5u, one_.size());\n EXPECT_EQ(256u, two_.size());\n\n EXPECT_TRUE(ContainsNameValue(annotations, \"First\", \"short\"));\n EXPECT_TRUE(ContainsNameValue(annotations, \"Second\", std::string(256, 'A')));\n}\n\nTEST_F(AnnotationList, DuplicateKeys) {\n ASSERT_EQ(0u, CollectAnnotations().size());\n\n one_.Set(\"1\");\n three_.Set(\"2\");\n\n AllAnnotations annotations = CollectAnnotations();\n EXPECT_EQ(2u, annotations.size());\n\n EXPECT_TRUE(ContainsNameValue(annotations, \"First\", \"1\"));\n EXPECT_TRUE(ContainsNameValue(annotations, \"First\", \"2\"));\n\n one_.Clear();\n\n annotations = CollectAnnotations();\n EXPECT_EQ(1u, annotations.size());\n}\n\nTEST_F(AnnotationList, IteratorSingleAnnotation) {\n ASSERT_EQ(annotations_.begin(), annotations_.end());\n ASSERT_EQ(annotations_.cbegin(), annotations_.cend());\n\n one_.Set(\"1\");\n\n auto iterator = annotations_.begin();\n auto const_iterator = annotations_.cbegin();\n\n ASSERT_NE(iterator, annotations_.end());\n ASSERT_NE(const_iterator, annotations_.cend());\n\n EXPECT_EQ(*iterator, &one_);\n EXPECT_EQ(*const_iterator, &one_);\n\n ++iterator;\n ++const_iterator;\n\n EXPECT_EQ(iterator, annotations_.end());\n EXPECT_EQ(const_iterator, annotations_.cend());\n}\n\nTEST_F(AnnotationList, IteratorMultipleAnnotationsInserted) {\n ASSERT_EQ(annotations_.begin(), annotations_.end());\n ASSERT_EQ(annotations_.cbegin(), annotations_.cend());\n\n one_.Set(\"1\");\n two_.Set(\"2\");\n\n // New annotations are inserted to the beginning of the list. Hence, |two_|\n // must be the first annotation, followed by |one_|.\n {\n auto iterator = annotations_.begin();\n auto const_iterator = annotations_.cbegin();\n\n ASSERT_NE(iterator, annotations_.end());\n ASSERT_NE(const_iterator, annotations_.cend());\n\n EXPECT_EQ(*iterator, &two_);\n EXPECT_EQ(*const_iterator, &two_);\n\n ++iterator;\n ++const_iterator;\n\n ASSERT_NE(iterator, annotations_.end());\n ASSERT_NE(const_iterator, annotations_.cend());\n\n EXPECT_EQ(*iterator, &one_);\n EXPECT_EQ(*const_iterator, &one_);\n\n ++iterator;\n ++const_iterator;\n\n EXPECT_EQ(iterator, annotations_.end());\n EXPECT_EQ(const_iterator, annotations_.cend());\n }\n}\n\nTEST_F(AnnotationList, IteratorMultipleAnnotationsInsertedAndRemoved) {\n ASSERT_EQ(annotations_.begin(), annotations_.end());\n ASSERT_EQ(annotations_.cbegin(), annotations_.cend());\n\n one_.Set(\"1\");\n two_.Set(\"2\");\n one_.Clear();\n two_.Clear();\n\n // Even after clearing, Annotations are still inserted in the list and\n // reachable via the iterators.\n auto iterator = annotations_.begin();\n auto const_iterator = annotations_.cbegin();\n\n ASSERT_NE(iterator, annotations_.end());\n ASSERT_NE(const_iterator, annotations_.cend());\n\n EXPECT_EQ(*iterator, &two_);\n EXPECT_EQ(*const_iterator, &two_);\n\n ++iterator;\n ++const_iterator;\n\n ASSERT_NE(iterator, annotations_.end());\n ASSERT_NE(const_iterator, annotations_.cend());\n\n EXPECT_EQ(*iterator, &one_);\n EXPECT_EQ(*const_iterator, &one_);\n\n ++iterator;\n ++const_iterator;\n\n EXPECT_EQ(iterator, annotations_.end());\n EXPECT_EQ(const_iterator, annotations_.cend());\n}\n\nTEST_F(AnnotationList, IteratorIsInputIterator) {\n one_.Set(\"1\");\n two_.Set(\"2\");\n\n // Check explicitly that the iterators meet the interface of an input\n // iterator.\n VerifyIsInputIterator(annotations_.begin());\n VerifyIsInputIterator(annotations_.cbegin());\n VerifyIsInputIterator(annotations_.end());\n VerifyIsInputIterator(annotations_.cend());\n\n // Additionally verify that std::distance accepts the iterators. It requires\n // the iterators to comply to the input iterator interface.\n EXPECT_EQ(std::distance(annotations_.begin(), annotations_.end()), 2);\n EXPECT_EQ(std::distance(annotations_.cbegin(), annotations_.cend()), 2);\n}\n\nclass RaceThread : public Thread {\n public:\n explicit RaceThread(test::AnnotationList* test) : Thread(), test_(test) {}\n\n private:\n void ThreadMain() override {\n for (int i = 0; i <= 50; ++i) {\n if (i % 2 == 0) {\n test_->three_.Set(\"three\");\n test_->two_.Clear();\n } else {\n test_->three_.Clear();\n }\n SleepNanoseconds(base::RandInt(1, 1000));\n }\n }\n\n test::AnnotationList* test_;\n};\n\nTEST_F(AnnotationList, MultipleThreads) {\n ASSERT_EQ(0u, CollectAnnotations().size());\n\n RaceThread other_thread(this);\n other_thread.Start();\n\n for (int i = 0; i <= 50; ++i) {\n if (i % 2 == 0) {\n one_.Set(\"one\");\n two_.Set(\"two\");\n } else {\n one_.Clear();\n }\n SleepNanoseconds(base::RandInt(1, 1000));\n }\n\n other_thread.Join();\n\n AllAnnotations annotations = CollectAnnotations();\n EXPECT_GE(annotations.size(), 2u);\n EXPECT_LE(annotations.size(), 3u);\n\n EXPECT_TRUE(ContainsNameValue(annotations, \"First\", \"one\"));\n EXPECT_TRUE(ContainsNameValue(annotations, \"First\", \"three\"));\n\n if (annotations.size() == 3) {\n EXPECT_TRUE(ContainsNameValue(annotations, \"Second\", \"two\"));\n }\n}\n\n} // namespace\n} // namespace test\n} // namespace crashpad\n" }, { "path": "client/annotation_test.cc", "content": "// Copyright 2017 The Crashpad Authors\n//\n// Licensed under the Apache License, Version 2.0 (the \"License\");\n// you may not use this file except in compliance with the License.\n// You may obtain a copy of the License at\n//\n// http://www.apache.org/licenses/LICENSE-2.0\n//\n// Unless required by applicable law or agreed to in writing, software\n// distributed under the License is distributed on an \"AS IS\" BASIS,\n// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n// See the License for the specific language governing permissions and\n// limitations under the License.\n\n#include \"client/annotation.h\"\n\n#include \n#include \n\n#include \"client/annotation_list.h\"\n#include \"client/crashpad_info.h\"\n#include \"gtest/gtest.h\"\n#include \"test/gtest_death.h\"\n#include \"util/misc/clock.h\"\n#include \"util/synchronization/scoped_spin_guard.h\"\n#include \"util/thread/thread.h\"\n\nnamespace crashpad {\nnamespace test {\nnamespace {\n\nclass SpinGuardAnnotation final : public Annotation {\n public:\n SpinGuardAnnotation(Annotation::Type type, const char name[])\n : Annotation(type,\n name,\n &value_,\n ConcurrentAccessGuardMode::kScopedSpinGuard) {}\n\n bool Set(bool value, uint64_t spin_guard_timeout_ns) {\n auto guard = TryCreateScopedSpinGuard(spin_guard_timeout_ns);\n if (!guard) {\n return false;\n }\n value_ = value;\n SetSize(sizeof(value_));\n return true;\n }\n\n private:\n bool value_;\n};\n\nclass ScopedSpinGuardUnlockThread final : public Thread {\n public:\n ScopedSpinGuardUnlockThread(ScopedSpinGuard scoped_spin_guard,\n uint64_t sleep_time_ns)\n : scoped_spin_guard_(std::move(scoped_spin_guard)),\n sleep_time_ns_(sleep_time_ns) {}\n\n private:\n void ThreadMain() override {\n SleepNanoseconds(sleep_time_ns_);\n\n // Move the ScopedSpinGuard member into a local variable which is\n // destroyed when ThreadMain() returns.\n ScopedSpinGuard local_scoped_spin_guard(std::move(scoped_spin_guard_));\n\n // After this point, local_scoped_spin_guard will be destroyed and unlocked.\n }\n\n ScopedSpinGuard scoped_spin_guard_;\n const uint64_t sleep_time_ns_;\n};\n\nclass Annotation : public testing::Test {\n public:\n void SetUp() override {\n CrashpadInfo::GetCrashpadInfo()->set_annotations_list(&annotations_);\n }\n\n void TearDown() override {\n CrashpadInfo::GetCrashpadInfo()->set_annotations_list(nullptr);\n }\n\n size_t AnnotationsCount() {\n size_t result = 0;\n for (auto* annotation : annotations_) {\n if (annotation->is_set())\n ++result;\n }\n return result;\n }\n\n protected:\n crashpad::AnnotationList annotations_;\n};\n\nTEST_F(Annotation, Basics) {\n constexpr crashpad::Annotation::Type kType =\n crashpad::Annotation::UserDefinedType(1);\n\n const char kName[] = \"annotation 1\";\n char buffer[1024];\n crashpad::Annotation annotation(kType, kName, buffer);\n\n EXPECT_FALSE(annotation.is_set());\n EXPECT_EQ(0u, AnnotationsCount());\n\n EXPECT_EQ(kType, annotation.type());\n EXPECT_EQ(0u, annotation.size());\n EXPECT_EQ(std::string(kName), annotation.name());\n EXPECT_EQ(buffer, annotation.value());\n\n annotation.SetSize(10);\n\n EXPECT_TRUE(annotation.is_set());\n EXPECT_EQ(1u, AnnotationsCount());\n\n EXPECT_EQ(10u, annotation.size());\n EXPECT_EQ(&annotation, *annotations_.begin());\n\n annotation.Clear();\n\n EXPECT_FALSE(annotation.is_set());\n EXPECT_EQ(0u, AnnotationsCount());\n\n EXPECT_EQ(0u, annotation.size());\n}\n\nTEST_F(Annotation, StringType) {\n crashpad::StringAnnotation<5> annotation(\"name\");\n\n EXPECT_FALSE(annotation.is_set());\n\n EXPECT_EQ(crashpad::Annotation::Type::kString, annotation.type());\n EXPECT_EQ(0u, annotation.size());\n EXPECT_EQ(std::string(\"name\"), annotation.name());\n EXPECT_EQ(0u, annotation.value().size());\n\n annotation.Set(\"test\");\n\n EXPECT_TRUE(annotation.is_set());\n EXPECT_EQ(1u, AnnotationsCount());\n\n EXPECT_EQ(4u, annotation.size());\n EXPECT_EQ(\"test\", annotation.value());\n\n annotation.Set(std::string(\"loooooooooooong\"));\n\n EXPECT_TRUE(annotation.is_set());\n EXPECT_EQ(1u, AnnotationsCount());\n\n EXPECT_EQ(5u, annotation.size());\n EXPECT_EQ(\"loooo\", annotation.value());\n}\n\nTEST_F(Annotation, BaseAnnotationShouldNotSupportSpinGuard) {\n char buffer[1024];\n crashpad::Annotation annotation(\n crashpad::Annotation::Type::kString, \"no-spin-guard\", buffer);\n EXPECT_EQ(annotation.concurrent_access_guard_mode(),\n crashpad::Annotation::ConcurrentAccessGuardMode::kUnguarded);\n#if !DCHECK_IS_ON()\n // This fails a DCHECK() in debug builds, so only test it when DCHECK()\n // is not on.\n EXPECT_EQ(std::nullopt, annotation.TryCreateScopedSpinGuard(0));\n#endif\n}\n\nTEST_F(Annotation, CustomAnnotationShouldSupportSpinGuardAndSet) {\n constexpr crashpad::Annotation::Type kType =\n crashpad::Annotation::UserDefinedType(1);\n SpinGuardAnnotation spin_guard_annotation(kType, \"spin-guard\");\n EXPECT_EQ(spin_guard_annotation.concurrent_access_guard_mode(),\n crashpad::Annotation::ConcurrentAccessGuardMode::kScopedSpinGuard);\n EXPECT_TRUE(spin_guard_annotation.Set(true, 0));\n EXPECT_EQ(1U, spin_guard_annotation.size());\n}\n\nTEST_F(Annotation, CustomAnnotationSetShouldFailIfRunConcurrently) {\n constexpr crashpad::Annotation::Type kType =\n crashpad::Annotation::UserDefinedType(1);\n SpinGuardAnnotation spin_guard_annotation(kType, \"spin-guard\");\n auto guard = spin_guard_annotation.TryCreateScopedSpinGuard(0);\n EXPECT_NE(std::nullopt, guard);\n // This should fail, since the guard is already held and the timeout is 0.\n EXPECT_FALSE(spin_guard_annotation.Set(true, 0));\n}\n\nTEST_F(Annotation,\n CustomAnnotationSetShouldSucceedIfSpinGuardUnlockedAsynchronously) {\n constexpr crashpad::Annotation::Type kType =\n crashpad::Annotation::UserDefinedType(1);\n SpinGuardAnnotation spin_guard_annotation(kType, \"spin-guard\");\n auto guard = spin_guard_annotation.TryCreateScopedSpinGuard(0);\n EXPECT_NE(std::nullopt, guard);\n // Pass the guard off to a background thread which unlocks it after 1 ms.\n constexpr uint64_t kSleepTimeNs = 1000000; // 1 ms\n ScopedSpinGuardUnlockThread unlock_thread(std::move(guard.value()),\n kSleepTimeNs);\n unlock_thread.Start();\n\n // Try to set the annotation with a 100 ms timeout.\n constexpr uint64_t kSpinGuardTimeoutNanos = 100000000; // 100 ms\n\n // This should succeed after 1 ms, since the timeout is much larger than the\n // time the background thread holds the guard.\n EXPECT_TRUE(spin_guard_annotation.Set(true, kSpinGuardTimeoutNanos));\n\n unlock_thread.Join();\n}\n\nTEST(StringAnnotation, ArrayOfString) {\n static crashpad::StringAnnotation<4> annotations[] = {\n {\"test-1\", crashpad::StringAnnotation<4>::Tag::kArray},\n {\"test-2\", crashpad::StringAnnotation<4>::Tag::kArray},\n {\"test-3\", crashpad::StringAnnotation<4>::Tag::kArray},\n {\"test-4\", crashpad::StringAnnotation<4>::Tag::kArray},\n };\n\n for (auto& annotation : annotations) {\n EXPECT_FALSE(annotation.is_set());\n }\n}\n\n#if DCHECK_IS_ON()\n\nTEST(AnnotationDeathTest, EmbeddedNUL) {\n crashpad::StringAnnotation<5> annotation(\"name\");\n EXPECT_DEATH_CHECK(annotation.Set(std::string(\"te\\0st\", 5)), \"embedded NUL\");\n}\n\n#endif\n\n} // namespace\n} // namespace test\n} // namespace crashpad\n" }, { "path": "client/client_argv_handling.cc", "content": "// Copyright 2018 The Crashpad Authors\n//\n// Licensed under the Apache License, Version 2.0 (the \"License\");\n// you may not use this file except in compliance with the License.\n// You may obtain a copy of the License at\n//\n// http://www.apache.org/licenses/LICENSE-2.0\n//\n// Unless required by applicable law or agreed to in writing, software\n// distributed under the License is distributed on an \"AS IS\" BASIS,\n// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n// See the License for the specific language governing permissions and\n// limitations under the License.\n\n#include \"client/client_argv_handling.h\"\n\n#include \"base/strings/stringprintf.h\"\n\nnamespace crashpad {\n\nnamespace {\n\nstd::string FormatArgumentString(const std::string& name,\n const std::string& value) {\n return base::StringPrintf(\"--%s=%s\", name.c_str(), value.c_str());\n}\n\n} // namespace\n\nstd::vector BuildHandlerArgvStrings(\n const base::FilePath& handler,\n const base::FilePath& database,\n const base::FilePath& metrics_dir,\n const std::string& url,\n const std::map& annotations,\n const std::vector& arguments,\n const std::vector& attachments) {\n std::vector argv_strings(1, handler.value());\n\n for (const auto& argument : arguments) {\n argv_strings.push_back(argument);\n }\n\n if (!database.empty()) {\n argv_strings.push_back(FormatArgumentString(\"database\", database.value()));\n }\n\n if (!metrics_dir.empty()) {\n argv_strings.push_back(\n FormatArgumentString(\"metrics-dir\", metrics_dir.value()));\n }\n\n if (!url.empty()) {\n argv_strings.push_back(FormatArgumentString(\"url\", url));\n }\n\n for (const auto& kv : annotations) {\n argv_strings.push_back(\n FormatArgumentString(\"annotation\", kv.first + '=' + kv.second));\n }\n\n for (const auto& attachment : attachments) {\n argv_strings.push_back(\n FormatArgumentString(\"attachment\", attachment.value()));\n }\n\n return argv_strings;\n}\n\nvoid StringVectorToCStringVector(const std::vector& strings,\n std::vector* c_strings) {\n c_strings->clear();\n c_strings->reserve(strings.size() + 1);\n for (const auto& str : strings) {\n c_strings->push_back(str.c_str());\n }\n c_strings->push_back(nullptr);\n}\n\n} // namespace crashpad\n" }, { "path": "client/client_argv_handling.h", "content": "// Copyright 2018 The Crashpad Authors\n//\n// Licensed under the Apache License, Version 2.0 (the \"License\");\n// you may not use this file except in compliance with the License.\n// You may obtain a copy of the License at\n//\n// http://www.apache.org/licenses/LICENSE-2.0\n//\n// Unless required by applicable law or agreed to in writing, software\n// distributed under the License is distributed on an \"AS IS\" BASIS,\n// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n// See the License for the specific language governing permissions and\n// limitations under the License.\n\n#ifndef CRASHPAD_CLIENT_CLIENT_ARGV_HANDLING_H_\n#define CRASHPAD_CLIENT_CLIENT_ARGV_HANDLING_H_\n\n#include \n#include \n#include \n\n#include \"base/files/file_path.h\"\n\nnamespace crashpad {\n\n//! \\brief Builds a vector of arguments suitable for invoking a handler process\n//! based on arguments passed to StartHandler-type().\n//!\n//! See StartHandlerAtCrash() for documentation on the input arguments.\n//!\n//! \\return A vector of arguments suitable for starting the handler with.\nstd::vector BuildHandlerArgvStrings(\n const base::FilePath& handler,\n const base::FilePath& database,\n const base::FilePath& metrics_dir,\n const std::string& url,\n const std::map& annotations,\n const std::vector& arguments,\n const std::vector& attachments = {});\n\n//! \\brief Flattens a string vector into a const char* vector suitable for use\n//! in an exec() call.\n//!\n//! \\param[in] strings A vector of string data. This vector must remain valid\n//! for the lifetime of \\a c_strings.\n//! \\param[out] c_strings A vector of pointers to the string data in \\a strings.\nvoid StringVectorToCStringVector(const std::vector& strings,\n std::vector* c_strings);\n\n} // namespace crashpad\n\n#endif // CRASHPAD_CLIENT_CLIENT_ARGV_HANDLING_H_\n" }, { "path": "client/crash_handler_base_ios.cc", "content": "// Copyright 2025 The Chromium Authors\n// Use of this source code is governed by a BSD-style license that can be\n// found in the LICENSE file.\n\n#include \"client/crash_handler_base_ios.h\"\n\n#include \"base/logging.h\"\n#include \"util/posix/signals.h\"\n\nnamespace crashpad {\n\nCrashHandlerBase::CrashHandlerBase() = default;\nCrashHandlerBase::~CrashHandlerBase() = default;\n\nbool CrashHandlerBase::Initialize(\n const base::FilePath& database,\n const std::string& url,\n const std::map& annotations,\n internal::InProcessHandler::ProcessPendingReportsObservationCallback\n callback) {\n INITIALIZATION_STATE_SET_INITIALIZING(initialized_);\n if (!in_process_handler().Initialize(database, url, annotations, callback)) {\n LOG(ERROR) << \"Unable to initialize Crashpad.\";\n return false;\n }\n if (!DoInitialize()) {\n return false;\n }\n INITIALIZATION_STATE_SET_VALID(initialized_);\n return true;\n}\n\nvoid CrashHandlerBase::ProcessIntermediateDumps(\n const std::map& annotations,\n const UserStreamDataSources* user_stream_sources) {\n in_process_handler_.ProcessIntermediateDumps(annotations,\n user_stream_sources);\n}\n\nvoid CrashHandlerBase::ProcessIntermediateDump(\n const base::FilePath& file,\n const std::map& annotations) {\n in_process_handler_.ProcessIntermediateDump(file, annotations);\n}\n\nvoid CrashHandlerBase::DumpWithoutCrash(NativeCPUContext* context,\n bool process_dump) {\n INITIALIZATION_STATE_DCHECK_VALID(initialized_);\n base::FilePath path;\n if (!in_process_handler_.DumpExceptionFromSimulatedMachException(\n context, kMachExceptionSimulated, &path)) {\n return;\n }\n\n if (process_dump) {\n in_process_handler_.ProcessIntermediateDump(path);\n }\n}\n\nvoid CrashHandlerBase::DumpWithoutCrashAtPath(NativeCPUContext* context,\n const base::FilePath& path) {\n in_process_handler_.DumpExceptionFromSimulatedMachExceptionAtPath(\n context, kMachExceptionSimulated, path);\n}\n\nvoid CrashHandlerBase::StartProcessingPendingReports(\n UploadBehavior upload_behavior) {\n INITIALIZATION_STATE_DCHECK_VALID(initialized_);\n in_process_handler_.StartProcessingPendingReports(upload_behavior);\n}\n\nvoid CrashHandlerBase::SetExceptionCallbackForTesting(void (*callback)()) {\n in_process_handler_.SetExceptionCallbackForTesting(callback);\n}\n\nvoid CrashHandlerBase::HandleAndReraiseSignal(int signo,\n siginfo_t* siginfo,\n ucontext_t* context,\n struct sigaction* old_action) {\n in_process_handler_.DumpExceptionFromSignal(siginfo, context);\n\n // Always call system handler.\n Signals::RestoreHandlerAndReraiseSignalOnReturn(siginfo, old_action);\n}\n\nvoid CrashHandlerBase::HandleUncaughtNSException(const uint64_t* frames,\n const size_t num_frames) {\n in_process_handler_.DumpExceptionFromNSExceptionWithFrames(frames,\n num_frames);\n // After uncaught exceptions are reported, the system immediately triggers a\n // call to std::terminate()/abort(). Remove the abort handler so a second\n // dump isn't generated.\n CHECK(Signals::InstallDefaultHandler(SIGABRT));\n}\n\nvoid CrashHandlerBase::HandleUncaughtNSExceptionWithContext(\n NativeCPUContext* context) {\n base::FilePath path;\n in_process_handler_.DumpExceptionFromSimulatedMachException(\n context, kMachExceptionFromNSException, &path);\n\n // After uncaught exceptions are reported, the system immediately triggers a\n // call to std::terminate()/abort(). Remove the abort handler so a second\n // dump isn't generated.\n CHECK(Signals::InstallDefaultHandler(SIGABRT));\n}\n\nvoid CrashHandlerBase::HandleUncaughtNSExceptionWithContextAtPath(\n NativeCPUContext* context,\n const base::FilePath& path) {\n in_process_handler_.DumpExceptionFromSimulatedMachExceptionAtPath(\n context, kMachExceptionFromNSException, path);\n}\n\nbool CrashHandlerBase::MoveIntermediateDumpAtPathToPending(\n const base::FilePath& path) {\n if (in_process_handler_.MoveIntermediateDumpAtPathToPending(path)) {\n // After uncaught exceptions are reported, the system immediately triggers\n // a call to std::terminate()/abort(). Remove the abort handler so a\n // second dump isn't generated.\n CHECK(Signals::InstallDefaultHandler(SIGABRT));\n return true;\n }\n return false;\n}\n\n} // namespace crashpad\n" }, { "path": "client/crash_handler_base_ios.h", "content": "// Copyright 2025 The Chromium Authors\n// Use of this source code is governed by a BSD-style license that can be\n// found in the LICENSE file.\n\n#ifndef CRASHPAD_CLIENT_CRASH_HANDLER_BASE_IOS_H_\n#define CRASHPAD_CLIENT_CRASH_HANDLER_BASE_IOS_H_\n\n#include \n#include \n\n#include \n#include \n\n#include \"base/files/file_path.h\"\n#include \"client/ios_handler/exception_processor.h\"\n#include \"client/ios_handler/in_process_handler.h\"\n#include \"client/upload_behavior_ios.h\"\n#include \"util/misc/capture_context.h\"\n#include \"util/misc/initialization_state_dcheck.h\"\n\nnamespace crashpad {\n\n// Base class shared by the iOS and tvOS CrashHandler implementations.\nclass CrashHandlerBase : public ObjcExceptionDelegate {\n public:\n CrashHandlerBase(const CrashHandlerBase&) = delete;\n CrashHandlerBase& operator=(const CrashHandlerBase&) = delete;\n\n bool Initialize(\n const base::FilePath& database,\n const std::string& url,\n const std::map& annotations,\n internal::InProcessHandler::ProcessPendingReportsObservationCallback\n callback);\n\n void ProcessIntermediateDumps(\n const std::map& annotations,\n const UserStreamDataSources* user_stream_sources);\n\n void ProcessIntermediateDump(\n const base::FilePath& file,\n const std::map& annotations);\n\n void DumpWithoutCrash(NativeCPUContext* context, bool process_dump);\n\n void DumpWithoutCrashAtPath(NativeCPUContext* context,\n const base::FilePath& path);\n\n void StartProcessingPendingReports(UploadBehavior upload_behavior);\n\n void SetExceptionCallbackForTesting(void (*callback)());\n\n protected:\n CrashHandlerBase();\n virtual ~CrashHandlerBase();\n\n // Subclasses are expected to install signal handlers and set up Mach ports in\n // this function.\n virtual bool DoInitialize() = 0;\n\n void HandleAndReraiseSignal(int signo,\n siginfo_t* siginfo,\n ucontext_t* context,\n struct sigaction* old_action);\n\n internal::InProcessHandler& in_process_handler() {\n return in_process_handler_;\n }\n\n private:\n // ObjcExceptionDelegate overrides:\n void HandleUncaughtNSException(const uint64_t* frames,\n const size_t num_frames) override;\n\n void HandleUncaughtNSExceptionWithContext(NativeCPUContext* context) override;\n\n void HandleUncaughtNSExceptionWithContextAtPath(\n NativeCPUContext* context,\n const base::FilePath& path) override;\n\n bool MoveIntermediateDumpAtPathToPending(const base::FilePath& path) override;\n\n internal::InProcessHandler in_process_handler_;\n InitializationStateDcheck initialized_;\n};\n\n} // namespace crashpad\n\n#endif // CRASHPAD_CLIENT_CRASH_HANDLER_BASE_IOS_H_\n" }, { "path": "client/crash_handler_ios.cc", "content": "// Copyright 2025 The Chromium Authors\n// Use of this source code is governed by a BSD-style license that can be\n// found in the LICENSE file.\n\n#include \"client/crash_handler_ios.h\"\n\n#include \n#include \n\n#include \n\n#include \"base/apple/mach_logging.h\"\n#include \"util/ios/raw_logging.h\"\n#include \"util/mach/mach_extensions.h\"\n#include \"util/mach/mach_message.h\"\n#include \"util/mach/mach_message_server.h\"\n#include \"util/posix/signals.h\"\n\nnamespace {\n\nbool IsBeingDebugged() {\n int mib[] = {CTL_KERN, KERN_PROC, KERN_PROC_PID, getpid()};\n size_t len = sizeof(kinfo_proc);\n kinfo_proc kern_proc_info;\n if (sysctl(mib, std::size(mib), &kern_proc_info, &len, nullptr, 0) == 0) {\n return kern_proc_info.kp_proc.p_flag & P_TRACED;\n }\n return false;\n}\n\n} // namespace\n\nnamespace crashpad {\n\nCrashHandler::ThreadSafeScopedMachPortWithReceiveRight::\n ThreadSafeScopedMachPortWithReceiveRight()\n : port_(NewMachPort(MACH_PORT_RIGHT_RECEIVE)) {}\n\nCrashHandler::ThreadSafeScopedMachPortWithReceiveRight::\n ~ThreadSafeScopedMachPortWithReceiveRight() {\n reset();\n}\n\nmach_port_t CrashHandler::ThreadSafeScopedMachPortWithReceiveRight::get() {\n return port_.load();\n}\nvoid CrashHandler::ThreadSafeScopedMachPortWithReceiveRight::reset() {\n mach_port_t old_port = port_.exchange(MACH_PORT_NULL);\n if (old_port == MACH_PORT_NULL) {\n // Already reset, nothing to do.\n return;\n }\n kern_return_t kr = mach_port_mod_refs(\n mach_task_self(), old_port, MACH_PORT_RIGHT_RECEIVE, -1);\n MACH_LOG_IF(ERROR, kr != KERN_SUCCESS, kr)\n << \"ThreadSafeScopedMachPortWithReceiveRight mach_port_mod_refs\";\n kr = mach_port_deallocate(mach_task_self(), old_port);\n MACH_LOG_IF(ERROR, kr != KERN_SUCCESS, kr)\n << \"ThreadSafeScopedMachPortWithReceiveRight mach_port_deallocate\";\n}\n\nCrashHandler* CrashHandler::instance_ = nullptr;\n\nCrashHandler::CrashHandler() = default;\n\nCrashHandler::~CrashHandler() {\n UninstallObjcExceptionPreprocessor();\n // Reset the SIGPIPE handler only if the current handler is the\n // one installed by DoInitialize(). In other words, if an\n // application has set its own SIGPIPE handler after initializing\n // Crashpad, there is no need to change the signal handler here.\n struct sigaction sa;\n if (sigaction(SIGPIPE, nullptr, &sa) == 0 &&\n sa.sa_sigaction == CatchAndReraiseSignalDefaultAction) {\n Signals::InstallDefaultHandler(SIGPIPE);\n }\n Signals::InstallDefaultHandler(SIGABRT);\n UninstallMachExceptionHandler();\n}\n\n// static\nCrashHandler* CrashHandler::Get() {\n if (!instance_)\n instance_ = new CrashHandler();\n return instance_;\n}\n\n// static\nvoid CrashHandler::ResetForTesting() {\n delete instance_;\n instance_ = nullptr;\n}\n\nbool CrashHandler::DoInitialize() {\n if (!InstallMachExceptionHandler() ||\n // xnu turns hardware faults into Mach exceptions, so the only signal\n // left to register is SIGABRT, which never starts off as a hardware\n // fault. Installing a handler for other signals would lead to\n // recording exceptions twice. As a consequence, Crashpad will not\n // generate intermediate dumps for anything manually calling\n // raise(SIG*). In practice, this doesn’t actually happen for crash\n // signals that originate as hardware faults.\n !Signals::InstallHandler(\n SIGABRT, CatchAndReraiseSignal, 0, &old_action_)) {\n return false;\n }\n\n // For applications that haven't ignored or set a handler for SIGPIPE:\n // It’s OK for an application to set its own SIGPIPE handler (including\n // SIG_IGN) before initializing Crashpad, because Crashpad will discover the\n // existing handler and not install its own.\n // It’s OK for Crashpad to install its own SIGPIPE handler and for the\n // application to subsequently install its own (including SIG_IGN)\n // afterwards, because its handler will replace Crashpad’s.\n // This is useful to cover the default situation where nobody installs a\n // SIGPIPE handler and the disposition is at SIG_DFL, because SIGPIPE is a\n // “kill” signal (bsd/sys/signalvar.h sigprop). In that case, without\n // Crashpad, SIGPIPE results in a silent and unreported kill (and not even\n // ReportCrash will record it), but developers probably want to be alerted to\n // the condition.\n struct sigaction sa;\n if (sigaction(SIGPIPE, nullptr, &sa) == 0 && sa.sa_handler == SIG_DFL) {\n Signals::InstallHandler(\n SIGPIPE, CatchAndReraiseSignalDefaultAction, 0, nullptr);\n }\n\n InstallObjcExceptionPreprocessor(this);\n return true;\n}\n\nbool CrashHandler::InstallMachExceptionHandler() {\n mach_port_t exception_port = exception_port_.get();\n if (exception_port == MACH_PORT_NULL) {\n return false;\n }\n\n kern_return_t kr = mach_port_insert_right(mach_task_self(),\n exception_port,\n exception_port,\n MACH_MSG_TYPE_MAKE_SEND);\n if (kr != KERN_SUCCESS) {\n MACH_LOG(ERROR, kr) << \"mach_port_insert_right\";\n return false;\n }\n\n // TODO: Use SwapExceptionPort instead and put back EXC_MASK_BREAKPOINT.\n // Until then, remove |EXC_MASK_BREAKPOINT| while attached to a debugger.\n exception_mask_t mask =\n ExcMaskAll() &\n ~(EXC_MASK_EMULATION | EXC_MASK_SOFTWARE | EXC_MASK_RPC_ALERT |\n EXC_MASK_GUARD | (IsBeingDebugged() ? EXC_MASK_BREAKPOINT : 0));\n\n exception_behavior_t behavior = EXCEPTION_STATE_IDENTITY;\n if (__builtin_available(iOS 18.0, *)) {\n behavior = EXCEPTION_STATE_IDENTITY_PROTECTED;\n }\n\n ExceptionPorts exception_ports(ExceptionPorts::kTargetTypeTask, TASK_NULL);\n if (!exception_ports.GetExceptionPorts(mask, &original_handlers_) ||\n !exception_ports.SetExceptionPort(mask,\n exception_port,\n behavior | MACH_EXCEPTION_CODES,\n MACHINE_THREAD_STATE)) {\n return false;\n }\n\n mach_handler_running_ = true;\n Start();\n return true;\n}\n\nvoid CrashHandler::UninstallMachExceptionHandler() {\n mach_handler_running_ = false;\n exception_port_.reset();\n Join();\n}\n\n// Thread:\n\nvoid CrashHandler::ThreadMain() {\n UniversalMachExcServer universal_mach_exc_server(this);\n while (mach_handler_running_) {\n mach_msg_return_t mr =\n MachMessageServer::Run(&universal_mach_exc_server,\n exception_port_.get(),\n MACH_MSG_OPTION_NONE,\n MachMessageServer::kPersistent,\n MachMessageServer::kReceiveLargeIgnore,\n kMachMessageTimeoutWaitIndefinitely);\n MACH_CHECK(\n mach_handler_running_\n ? mr == MACH_SEND_INVALID_DEST // This shouldn't happen for\n // exception messages that come\n // from the kernel itself, but if\n // something else in-process sends\n // exception messages and breaks,\n // handle that case.\n : (mr == MACH_RCV_PORT_CHANGED || // Port was closed while the\n // thread was listening.\n mr == MACH_RCV_INVALID_NAME), // Port was closed before the\n // thread started listening.\n mr)\n << \"MachMessageServer::Run\";\n }\n}\n\n// UniversalMachExcServer::Interface:\n\nkern_return_t CrashHandler::CatchMachException(\n exception_behavior_t behavior,\n exception_handler_t exception_port,\n thread_t thread,\n task_t task,\n exception_type_t exception,\n const mach_exception_data_type_t* code,\n mach_msg_type_number_t code_count,\n thread_state_flavor_t* flavor,\n ConstThreadState old_state,\n mach_msg_type_number_t old_state_count,\n thread_state_t new_state,\n mach_msg_type_number_t* new_state_count,\n const mach_msg_trailer_t* trailer,\n bool* destroy_complex_request) {\n *destroy_complex_request = true;\n\n // TODO(justincohen): Forward exceptions to original_handlers_ with\n // UniversalExceptionRaise.\n\n // iOS shouldn't have any child processes, but just in case, those will\n // inherit the task exception ports, and this process isn’t prepared to\n // handle them\n if (task != mach_task_self()) {\n CRASHPAD_RAW_LOG(\"MachException task != mach_task_self()\");\n return KERN_FAILURE;\n }\n\n HandleMachException(behavior,\n thread,\n exception,\n code,\n code_count,\n *flavor,\n old_state,\n old_state_count);\n\n // Respond with KERN_FAILURE so the system will continue to handle this\n // exception. xnu will turn this Mach exception into a signal and take the\n // default action to terminate the process. However, if sigprocmask is\n // called before this Mach exception returns (such as by another thread\n // calling abort, see: Libc-1506.40.4/stdlib/FreeBSD/abort.c), the Mach\n // exception will be converted into a signal but delivery will be blocked.\n // Since concurrent exceptions lead to the losing thread sleeping\n // indefinitely, if the abort thread never returns, the thread that\n // triggered this Mach exception will repeatedly trap and the process will\n // never terminate. If the abort thread didn’t have a user-space signal\n // handler that slept forever, the abort would terminate the process even if\n // all other signals had been blocked. Instead, unblock all signals\n // corresponding to all Mach exceptions Crashpad is registered for before\n // returning KERN_FAILURE. There is still racy behavior possible with this\n // call to sigprocmask, but the repeated calls to CatchMachException here\n // will eventually lead to termination.\n sigset_t unblock_set;\n sigemptyset(&unblock_set);\n sigaddset(&unblock_set, SIGILL); // EXC_BAD_INSTRUCTION\n sigaddset(&unblock_set, SIGTRAP); // EXC_BREAKPOINT\n sigaddset(&unblock_set, SIGFPE); // EXC_ARITHMETIC\n sigaddset(&unblock_set, SIGBUS); // EXC_BAD_ACCESS\n sigaddset(&unblock_set, SIGSEGV); // EXC_BAD_ACCESS\n if (sigprocmask(SIG_UNBLOCK, &unblock_set, nullptr) != 0) {\n CRASHPAD_RAW_LOG(\"sigprocmask\");\n }\n return KERN_FAILURE;\n}\n\nvoid CrashHandler::HandleMachException(exception_behavior_t behavior,\n thread_t thread,\n exception_type_t exception,\n const mach_exception_data_type_t* code,\n mach_msg_type_number_t code_count,\n thread_state_flavor_t flavor,\n ConstThreadState old_state,\n mach_msg_type_number_t old_state_count) {\n in_process_handler().DumpExceptionFromMachException(behavior,\n thread,\n exception,\n code,\n code_count,\n flavor,\n old_state,\n old_state_count);\n}\n\n// static\nvoid CrashHandler::CatchAndReraiseSignal(int signo,\n siginfo_t* siginfo,\n void* context) {\n Get()->HandleAndReraiseSignal(signo,\n siginfo,\n reinterpret_cast(context),\n &(Get()->old_action_));\n}\n\n// static\nvoid CrashHandler::CatchAndReraiseSignalDefaultAction(int signo,\n siginfo_t* siginfo,\n void* context) {\n Get()->HandleAndReraiseSignal(\n signo, siginfo, reinterpret_cast(context), nullptr);\n}\n\n} // namespace crashpad\n" }, { "path": "client/crash_handler_ios.h", "content": "// Copyright 2025 The Chromium Authors\n// Use of this source code is governed by a BSD-style license that can be\n// found in the LICENSE file.\n\n#ifndef CRASHPAD_CLIENT_CRASH_HANDLER_IOS_H_\n#define CRASHPAD_CLIENT_CRASH_HANDLER_IOS_H_\n\n#include \n\n#include \"client/crash_handler_base_ios.h\"\n#include \"util/mach/exc_server_variants.h\"\n#include \"util/mach/exception_ports.h\"\n#include \"util/thread/thread.h\"\n\nnamespace crashpad {\n\n// A base class for signal handler and Mach exception server.\nclass CrashHandler : public Thread,\n public UniversalMachExcServer::Interface,\n public CrashHandlerBase {\n public:\n CrashHandler(const CrashHandler&) = delete;\n CrashHandler& operator=(const CrashHandler&) = delete;\n\n static CrashHandler* Get();\n\n static void ResetForTesting();\n\n private:\n // Thread-safe version of `base::apple::ScopedMachReceiveRight` which\n // allocates the Mach port upon construction and deallocates it upon\n // destruction.\n class ThreadSafeScopedMachPortWithReceiveRight {\n public:\n ThreadSafeScopedMachPortWithReceiveRight();\n\n ThreadSafeScopedMachPortWithReceiveRight(\n const ThreadSafeScopedMachPortWithReceiveRight&) = delete;\n ThreadSafeScopedMachPortWithReceiveRight& operator=(\n const ThreadSafeScopedMachPortWithReceiveRight&) = delete;\n\n ~ThreadSafeScopedMachPortWithReceiveRight();\n\n mach_port_t get();\n void reset();\n\n private:\n std::atomic port_;\n };\n\n CrashHandler();\n\n ~CrashHandler() override;\n\n bool DoInitialize() override;\n\n bool InstallMachExceptionHandler();\n\n void UninstallMachExceptionHandler();\n\n // Thread:\n\n void ThreadMain() override;\n\n // UniversalMachExcServer::Interface:\n\n kern_return_t CatchMachException(exception_behavior_t behavior,\n exception_handler_t exception_port,\n thread_t thread,\n task_t task,\n exception_type_t exception,\n const mach_exception_data_type_t* code,\n mach_msg_type_number_t code_count,\n thread_state_flavor_t* flavor,\n ConstThreadState old_state,\n mach_msg_type_number_t old_state_count,\n thread_state_t new_state,\n mach_msg_type_number_t* new_state_count,\n const mach_msg_trailer_t* trailer,\n bool* destroy_complex_request) override;\n\n void HandleMachException(exception_behavior_t behavior,\n thread_t thread,\n exception_type_t exception,\n const mach_exception_data_type_t* code,\n mach_msg_type_number_t code_count,\n thread_state_flavor_t flavor,\n ConstThreadState old_state,\n mach_msg_type_number_t old_state_count);\n\n // The signal handler installed at OS-level.\n static void CatchAndReraiseSignal(int signo,\n siginfo_t* siginfo,\n void* context);\n\n static void CatchAndReraiseSignalDefaultAction(int signo,\n siginfo_t* siginfo,\n void* context);\n\n ThreadSafeScopedMachPortWithReceiveRight exception_port_;\n ExceptionPorts::ExceptionHandlerVector original_handlers_;\n struct sigaction old_action_ = {};\n static CrashHandler* instance_;\n std::atomic mach_handler_running_ = false;\n};\n\n} // namespace crashpad\n\n#endif // CRASHPAD_CLIENT_CRASH_HANDLER_IOS_H_\n" }, { "path": "client/crash_handler_tvos.cc", "content": "// Copyright 2025 The Chromium Authors\n// Use of this source code is governed by a BSD-style license that can be\n// found in the LICENSE file.\n\n#include \"client/crash_handler_tvos.h\"\n\n#include \n\n#include \"util/posix/signals.h\"\n#include \"util/thread/thread.h\"\n\nnamespace crashpad {\n\nCrashHandler* CrashHandler::instance_ = nullptr;\n\nCrashHandler::CrashHandler() = default;\n\nCrashHandler::~CrashHandler() {\n UninstallObjcExceptionPreprocessor();\n for (int signo = 1; signo < NSIG; ++signo) {\n if (!Signals::IsCrashSignal(signo)) {\n Signals::RestoreOrResetHandler(signo,\n old_actions_.ActionForSignal(signo));\n } else if (signo == SIGPIPE) {\n // Reset the SIGPIPE handler only if the current handler is the one\n // installed by DoInitialize(). In other words, if an application has set\n // its own SIGPIPE handler after initializing Crashpad, there is no need\n // to change the signal handler here.\n struct sigaction sa;\n if (sigaction(SIGPIPE, nullptr, &sa) == 0 &&\n sa.sa_sigaction == CatchAndReraiseSignal) {\n Signals::InstallDefaultHandler(SIGPIPE);\n }\n }\n }\n}\n\n// static\nCrashHandler* CrashHandler::Get() {\n if (!instance_) {\n instance_ = new CrashHandler;\n }\n return instance_;\n}\n\n// static\nvoid CrashHandler::ResetForTesting() {\n delete instance_;\n instance_ = nullptr;\n}\n\nuint64_t CrashHandler::GetThreadIdForTesting() {\n return Thread::GetThreadIdForTesting();\n}\n\nbool CrashHandler::DoInitialize() {\n if (!Signals::InstallCrashHandlers(CatchAndReraiseSignal,\n /*flags=*/0,\n &old_actions_)) {\n return false;\n }\n\n // For applications that haven't ignored or set a handler for SIGPIPE:\n // It’s OK for an application to set its own SIGPIPE handler (including\n // SIG_IGN) before initializing Crashpad, because Crashpad will discover the\n // existing handler and not install its own.\n // It’s OK for Crashpad to install its own SIGPIPE handler and for the\n // application to subsequently install its own (including SIG_IGN)\n // afterwards, because its handler will replace Crashpad’s.\n // This is useful to cover the default situation where nobody installs a\n // SIGPIPE handler and the disposition is at SIG_DFL, because SIGPIPE is a\n // “kill” signal (bsd/sys/signalvar.h sigprop). In that case, without\n // Crashpad, SIGPIPE results in a silent and unreported kill (and not even\n // ReportCrash will record it), but developers probably want to be alerted to\n // the condition.\n struct sigaction sa;\n if (sigaction(SIGPIPE, nullptr, &sa) == 0 && sa.sa_handler == SIG_DFL) {\n Signals::InstallHandler(SIGPIPE, CatchAndReraiseSignal, 0, nullptr);\n }\n\n InstallObjcExceptionPreprocessor(this);\n return true;\n}\n\n// static\nvoid CrashHandler::CatchAndReraiseSignal(int signo,\n siginfo_t* siginfo,\n void* context) {\n CrashHandler* self = Get();\n self->HandleAndReraiseSignal(signo,\n siginfo,\n reinterpret_cast(context),\n self->old_actions_.ActionForSignal(signo));\n}\n\n} // namespace crashpad\n" }, { "path": "client/crash_handler_tvos.h", "content": "// Copyright 2025 The Chromium Authors\n// Use of this source code is governed by a BSD-style license that can be\n// found in the LICENSE file.\n\n#ifndef CRASHPAD_CLIENT_CRASH_HANDLER_TVOS_H_\n#define CRASHPAD_CLIENT_CRASH_HANDLER_TVOS_H_\n\n#include \"client/crash_handler_base_ios.h\"\n#include \"util/posix/signals.h\"\n\nnamespace crashpad {\n\n// A crash handler based on POSIX signals.\n// The APIs to handle Mach exceptions are not available to third-party\n// applications on tvOS.\nclass CrashHandler final : public CrashHandlerBase {\n public:\n CrashHandler(const CrashHandler&) = delete;\n CrashHandler& operator=(const CrashHandler&) = delete;\n\n static CrashHandler* Get();\n\n static void ResetForTesting();\n\n uint64_t GetThreadIdForTesting();\n\n private:\n CrashHandler();\n ~CrashHandler() override;\n\n bool DoInitialize() override;\n\n // The signal handler installed at OS-level.\n static void CatchAndReraiseSignal(int signo,\n siginfo_t* siginfo,\n void* context);\n\n Signals::OldActions old_actions_ = {};\n static CrashHandler* instance_;\n};\n\n} // namespace crashpad\n\n#endif // CRASHPAD_CLIENT_CRASH_HANDLER_TVOS_H_\n" }, { "path": "client/crash_report_database.cc", "content": "// Copyright 2015 The Crashpad Authors\n//\n// Licensed under the Apache License, Version 2.0 (the \"License\");\n// you may not use this file except in compliance with the License.\n// You may obtain a copy of the License at\n//\n// http://www.apache.org/licenses/LICENSE-2.0\n//\n// Unless required by applicable law or agreed to in writing, software\n// distributed under the License is distributed on an \"AS IS\" BASIS,\n// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n// See the License for the specific language governing permissions and\n// limitations under the License.\n\n#include \"client/crash_report_database.h\"\n\n#include \n\n#include \"base/logging.h\"\n#include \"base/strings/utf_string_conversions.h\"\n#include \"build/build_config.h\"\n#include \"util/file/directory_reader.h\"\n#include \"util/file/filesystem.h\"\n\nnamespace crashpad {\n\nnamespace {\nconstexpr base::FilePath::CharType kAttachmentsDirectory[] =\n FILE_PATH_LITERAL(\"attachments\");\n\nbool AttachmentNameIsOK(const std::string& name) {\n for (const char c : name) {\n if (c != '_' && c != '-' && c != '.' && !isalnum(c))\n return false;\n }\n return true;\n}\n} // namespace\n\nCrashReportDatabase::Report::Report()\n : uuid(),\n file_path(),\n id(),\n creation_time(0),\n uploaded(false),\n last_upload_attempt_time(0),\n upload_attempts(0),\n upload_explicitly_requested(false),\n total_size(0u) {}\n\nCrashReportDatabase::NewReport::NewReport()\n : writer_(std::make_unique()),\n file_remover_(),\n attachment_writers_(),\n attachment_removers_(),\n uuid_(),\n database_() {}\n\nCrashReportDatabase::NewReport::~NewReport() = default;\n\nbool CrashReportDatabase::NewReport::Initialize(\n CrashReportDatabase* database,\n const base::FilePath& directory,\n const base::FilePath::StringType& extension) {\n database_ = database;\n\n if (!uuid_.InitializeWithNew()) {\n return false;\n }\n\n#if BUILDFLAG(IS_WIN)\n const std::wstring uuid_string = uuid_.ToWString();\n#else\n const std::string uuid_string = uuid_.ToString();\n#endif\n\n const base::FilePath path = directory.Append(uuid_string + extension);\n if (!writer_->Open(\n path, FileWriteMode::kCreateOrFail, FilePermissions::kOwnerOnly)) {\n return false;\n }\n file_remover_.reset(path);\n return true;\n}\n\nFileReaderInterface* CrashReportDatabase::NewReport::Reader() {\n auto reader = std::make_unique();\n if (!reader->Open(file_remover_.get())) {\n return nullptr;\n }\n reader_ = std::move(reader);\n return reader_.get();\n}\n\nFileWriter* CrashReportDatabase::NewReport::AddAttachment(\n const std::string& name) {\n if (!AttachmentNameIsOK(name)) {\n LOG(ERROR) << \"invalid name for attachment \" << name;\n return nullptr;\n }\n base::FilePath report_attachments_dir = database_->AttachmentsPath(uuid_);\n if (!LoggingCreateDirectory(\n report_attachments_dir, FilePermissions::kOwnerOnly, true)) {\n return nullptr;\n }\n#if BUILDFLAG(IS_WIN)\n const std::wstring name_string = base::UTF8ToWide(name);\n#else\n const std::string name_string = name;\n#endif\n base::FilePath attachment_path = report_attachments_dir.Append(name_string);\n auto writer = std::make_unique();\n if (!writer->Open(attachment_path,\n FileWriteMode::kCreateOrFail,\n FilePermissions::kOwnerOnly)) {\n return nullptr;\n }\n attachment_writers_.emplace_back(std::move(writer));\n attachment_removers_.emplace_back(ScopedRemoveFile(attachment_path));\n return attachment_writers_.back().get();\n}\n\nvoid CrashReportDatabase::UploadReport::InitializeAttachments() {\n base::FilePath report_attachments_dir = database_->AttachmentsPath(uuid);\n DirectoryReader dir_reader;\n if (!dir_reader.Open(report_attachments_dir)) {\n return;\n }\n\n base::FilePath filename;\n DirectoryReader::Result dir_result;\n while ((dir_result = dir_reader.NextFile(&filename)) ==\n DirectoryReader::Result::kSuccess) {\n const base::FilePath filepath(report_attachments_dir.Append(filename));\n std::unique_ptr file_reader(std::make_unique());\n if (!file_reader->Open(filepath)) {\n continue;\n }\n attachment_readers_.emplace_back(std::move(file_reader));\n#if BUILDFLAG(IS_WIN)\n const std::string name_string = base::WideToUTF8(filename.value());\n#else\n const std::string name_string = filename.value();\n#endif\n attachment_map_[name_string] = attachment_readers_.back().get();\n }\n}\n\nCrashReportDatabase::UploadReport::UploadReport()\n : Report(),\n reader_(std::make_unique()),\n database_(nullptr),\n attachment_readers_(),\n attachment_map_(),\n report_metrics_(false) {}\n\nCrashReportDatabase::UploadReport::~UploadReport() {\n if (database_) {\n database_->RecordUploadAttempt(this, false, std::string());\n }\n}\n\nbool CrashReportDatabase::UploadReport::Initialize(const base::FilePath& path,\n CrashReportDatabase* db) {\n database_ = db;\n InitializeAttachments();\n return reader_->Open(path);\n}\n\nCrashReportDatabase::OperationStatus CrashReportDatabase::RecordUploadComplete(\n std::unique_ptr report_in,\n const std::string& id) {\n UploadReport* report = const_cast(report_in.get());\n\n report->database_ = nullptr;\n return RecordUploadAttempt(report, true, id);\n}\n\nbase::FilePath CrashReportDatabase::AttachmentsPath(const UUID& uuid) {\n#if BUILDFLAG(IS_WIN)\n const std::wstring uuid_string = uuid.ToWString();\n#else\n const std::string uuid_string = uuid.ToString();\n#endif\n\n return DatabasePath().Append(kAttachmentsDirectory).Append(uuid_string);\n}\n\nbase::FilePath CrashReportDatabase::AttachmentsRootPath() {\n return DatabasePath().Append(kAttachmentsDirectory);\n}\n\nvoid CrashReportDatabase::RemoveAttachmentsByUUID(const UUID& uuid) {\n base::FilePath report_attachment_dir = AttachmentsPath(uuid);\n if (!IsDirectory(report_attachment_dir, /*allow_symlinks=*/false)) {\n return;\n }\n DirectoryReader reader;\n if (!reader.Open(report_attachment_dir)) {\n return;\n }\n\n base::FilePath filename;\n DirectoryReader::Result result;\n while ((result = reader.NextFile(&filename)) ==\n DirectoryReader::Result::kSuccess) {\n const base::FilePath attachment_path(\n report_attachment_dir.Append(filename));\n LoggingRemoveFile(attachment_path);\n }\n\n LoggingRemoveDirectory(report_attachment_dir);\n}\n\n} // namespace crashpad\n" }, { "path": "client/crash_report_database.h", "content": "// Copyright 2015 The Crashpad Authors\n//\n// Licensed under the Apache License, Version 2.0 (the \"License\");\n// you may not use this file except in compliance with the License.\n// You may obtain a copy of the License at\n//\n// http://www.apache.org/licenses/LICENSE-2.0\n//\n// Unless required by applicable law or agreed to in writing, software\n// distributed under the License is distributed on an \"AS IS\" BASIS,\n// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n// See the License for the specific language governing permissions and\n// limitations under the License.\n\n#ifndef CRASHPAD_CLIENT_CRASH_REPORT_DATABASE_H_\n#define CRASHPAD_CLIENT_CRASH_REPORT_DATABASE_H_\n\n#include \n#include \n\n#include \n#include \n#include \n#include \n\n#include \"base/files/file_path.h\"\n#include \"util/file/file_io.h\"\n#include \"util/file/file_reader.h\"\n#include \"util/file/file_writer.h\"\n#include \"util/file/scoped_remove_file.h\"\n#include \"util/misc/metrics.h\"\n#include \"util/misc/uuid.h\"\n\nnamespace crashpad {\n\nclass Settings;\nclass SettingsReader;\n\n//! \\brief An interface for managing a collection of crash report files and\n//! metadata associated with the crash reports.\n//!\n//! All Report objects that are returned by this class are logically const.\n//! They are snapshots of the database at the time the query was run, and the\n//! data returned is liable to change after the query is executed.\n//!\n//! The lifecycle of a crash report has three stages:\n//!\n//! 1. New: A crash report is created with PrepareNewCrashReport(), the\n//! the client then writes the report, and then calls\n//! FinishedWritingCrashReport() to make the report Pending.\n//! 2. Pending: The report has been written but has not been locally\n//! processed, or it was has been brought back from 'Completed' state by\n//! user request.\n//! 3. Completed: The report has been locally processed, either by uploading\n//! it to a collection server and calling RecordUploadComplete(), or by\n//! calling SkipReportUpload().\nclass CrashReportDatabase {\n public:\n //! \\brief A crash report record.\n //!\n //! This represents the metadata for a crash report, as well as the location\n //! of the report itself. A CrashReportDatabase maintains at least this\n //! information.\n struct Report {\n Report();\n\n //! A unique identifier by which this report will always be known to the\n //! database.\n UUID uuid;\n\n //! The current location of the crash report on the client’s filesystem.\n //! The location of a crash report may change over time, so the UUID should\n //! be used as the canonical identifier.\n base::FilePath file_path;\n\n //! An identifier issued to this crash report by a collection server.\n std::string id;\n\n //! The time at which the report was generated.\n time_t creation_time;\n\n //! Whether this crash report was successfully uploaded to a collection\n //! server.\n bool uploaded;\n\n //! The last timestamp at which an attempt was made to submit this crash\n //! report to a collection server. If this is zero, then the report has\n //! never been uploaded. If #uploaded is true, then this timestamp is the\n //! time at which the report was uploaded, and no other attempts to upload\n //! this report will be made.\n time_t last_upload_attempt_time;\n\n //! The number of times an attempt was made to submit this report to\n //! a collection server. If this is more than zero, then\n //! #last_upload_attempt_time will be set to the timestamp of the most\n //! recent attempt.\n int upload_attempts;\n\n //! Whether this crash report was explicitly requested by user to be\n //! uploaded. This can be true only if report is in the 'pending' state.\n bool upload_explicitly_requested;\n\n //! The total size in bytes taken by the report, including any potential\n //! attachments.\n uint64_t total_size;\n };\n\n //! \\brief A crash report that is in the process of being written.\n //!\n //! An instance of this class should be created via PrepareNewCrashReport().\n class NewReport {\n public:\n NewReport();\n\n NewReport(const NewReport&) = delete;\n NewReport& operator=(const NewReport&) = delete;\n\n ~NewReport();\n\n //! \\brief An open FileWriter with which to write the report.\n FileWriter* Writer() const { return writer_.get(); }\n\n //! \\brief Returns a FileReaderInterface to the report, or `nullptr` with a\n //! message logged.\n FileReaderInterface* Reader();\n\n //! A unique identifier by which this report will always be known to the\n //! database.\n const UUID& ReportID() const { return uuid_; }\n\n //! \\brief Adds an attachment to the report.\n //!\n //! \\param[in] name The key and name for the attachment, which will be\n //! included in the http upload. The attachment will not appear in the\n //! minidump report. \\a name should only use characters from the set\n //! `[a-zA-Z0-9._-]`.\n //! \\return A FileWriter that the caller should use to write the contents of\n //! the attachment, or `nullptr` on failure with an error logged.\n FileWriter* AddAttachment(const std::string& name);\n\n private:\n friend class CrashReportDatabaseGeneric;\n friend class CrashReportDatabaseMac;\n friend class CrashReportDatabaseWin;\n\n bool Initialize(CrashReportDatabase* database,\n const base::FilePath& directory,\n const base::FilePath::StringType& extension);\n\n std::unique_ptr writer_;\n std::unique_ptr reader_;\n ScopedRemoveFile file_remover_;\n std::vector> attachment_writers_;\n std::vector attachment_removers_;\n UUID uuid_;\n CrashReportDatabase* database_;\n };\n\n //! \\brief A crash report that is in the process of being uploaded.\n //!\n //! An instance of this class should be created via GetReportForUploading().\n class UploadReport : public Report {\n public:\n UploadReport();\n\n UploadReport(const UploadReport&) = delete;\n UploadReport& operator=(const UploadReport&) = delete;\n\n virtual ~UploadReport();\n\n //! \\brief An open FileReader with which to read the report.\n FileReader* Reader() const { return reader_.get(); }\n\n //! \\brief Obtains a mapping of names to file readers for any attachments\n //! for the report.\n std::map GetAttachments() const {\n return attachment_map_;\n }\n\n private:\n friend class CrashReportDatabase;\n friend class CrashReportDatabaseGeneric;\n friend class CrashReportDatabaseMac;\n friend class CrashReportDatabaseWin;\n\n bool Initialize(const base::FilePath& path, CrashReportDatabase* database);\n void InitializeAttachments();\n\n std::unique_ptr reader_;\n CrashReportDatabase* database_;\n std::vector> attachment_readers_;\n std::map attachment_map_;\n bool report_metrics_;\n };\n\n //! \\brief The result code for operations performed on a database.\n enum OperationStatus {\n //! \\brief No error occurred.\n kNoError = 0,\n\n //! \\brief The report that was requested could not be located.\n //!\n //! This may occur when the report is present in the database but not in a\n //! state appropriate for the requested operation, for example, if\n //! GetReportForUploading() is called to obtain report that’s already in the\n //! completed state.\n kReportNotFound,\n\n //! \\brief An error occured while performing a file operation on a crash\n //! report.\n //!\n //! A database is responsible for managing both the metadata about a report\n //! and the actual crash report itself. This error is returned when an\n //! error occurred when managing the report file. Additional information\n //! will be logged.\n kFileSystemError,\n\n //! \\brief An error occured while recording metadata for a crash report or\n //! database-wide settings.\n //!\n //! A database is responsible for managing both the metadata about a report\n //! and the actual crash report itself. This error is returned when an\n //! error occurred when managing the metadata about a crash report or\n //! database-wide settings. Additional information will be logged.\n kDatabaseError,\n\n //! \\brief The operation could not be completed because a concurrent\n //! operation affecting the report is occurring.\n kBusyError,\n\n //! \\brief The report cannot be uploaded by user request as it has already\n //! been uploaded.\n kCannotRequestUpload,\n };\n\n CrashReportDatabase(const CrashReportDatabase&) = delete;\n CrashReportDatabase& operator=(const CrashReportDatabase&) = delete;\n\n virtual ~CrashReportDatabase() {}\n\n //! \\brief Opens a database of crash reports, possibly creating it.\n //!\n //! \\param[in] path A path to the database to be created or opened. If the\n //! database does not yet exist, it will be created if possible. Note that\n //! for databases implemented as directory structures, existence refers\n //! solely to the outermost directory.\n //!\n //! \\return A database object on success, `nullptr` on failure with an error\n //! logged.\n //!\n //! \\sa InitializeWithoutCreating\n static std::unique_ptr Initialize(\n const base::FilePath& path);\n\n //! \\brief Opens an existing database of crash reports.\n //!\n //! \\param[in] path A path to the database to be opened. If the database does\n //! not yet exist, it will not be created. Note that for databases\n //! implemented as directory structures, existence refers solely to the\n //! outermost directory. On such databases, as long as the outermost\n //! directory is present, this method will create the inner structure.\n //!\n //! \\return A database object on success, `nullptr` on failure with an error\n //! logged.\n //!\n //! \\sa Initialize\n static std::unique_ptr InitializeWithoutCreating(\n const base::FilePath& path);\n\n //! \\brief Given a database path, return a read-only view of its settings.\n //!\n //! \\param[in] path A path to the database. If the database does not exist, or\n //! the settings file does not exist, the returned reader will fail its\n //! read methods.\n //!\n //! \\return A SettingsReader.\n static std::unique_ptr GetSettingsReaderForDatabasePath(\n const base::FilePath& path);\n\n //! \\brief Returns the Settings object for this database.\n //!\n //! \\return A weak pointer to the Settings object, which is owned by the\n //! database.\n virtual Settings* GetSettings() = 0;\n\n //! \\brief Creates a record of a new crash report.\n //!\n //! Callers should write the crash report using the FileWriter provided.\n //! Callers should then call FinishedWritingCrashReport() to complete report\n //! creation. If an error is encountered while writing the crash report, no\n //! special action needs to be taken. If FinishedWritingCrashReport() is not\n //! called, the report will be removed from the database when \\a report is\n //! destroyed.\n //!\n //! \\param[out] report A NewReport object containing a FileWriter with which\n //! to write the report data. Only valid if this returns #kNoError.\n //!\n //! \\return The operation status code.\n virtual OperationStatus PrepareNewCrashReport(\n std::unique_ptr* report) = 0;\n\n //! \\brief Informs the database that a crash report has been successfully\n //! written.\n //!\n //! \\param[in] report A NewReport obtained with PrepareNewCrashReport(). The\n //! NewReport object will be invalidated as part of this call.\n //! \\param[out] uuid The UUID of this crash report.\n //!\n //! \\return The operation status code.\n virtual OperationStatus FinishedWritingCrashReport(\n std::unique_ptr report,\n UUID* uuid) = 0;\n\n //! \\brief Returns the crash report record for the unique identifier.\n //!\n //! \\param[in] uuid The crash report record unique identifier.\n //! \\param[out] report A crash report record. Only valid if this returns\n //! #kNoError.\n //!\n //! \\return The operation status code.\n virtual OperationStatus LookUpCrashReport(const UUID& uuid,\n Report* report) = 0;\n\n //! \\brief Returns a list of crash report records that have not been uploaded.\n //!\n //! \\param[out] reports A list of crash report record objects. This must be\n //! empty on entry. Only valid if this returns #kNoError.\n //!\n //! \\return The operation status code.\n virtual OperationStatus GetPendingReports(std::vector* reports) = 0;\n\n //! \\brief Returns a list of crash report records that have been completed,\n //! either by being uploaded or by skipping upload.\n //!\n //! \\param[out] reports A list of crash report record objects. This must be\n //! empty on entry. Only valid if this returns #kNoError.\n //!\n //! \\return The operation status code.\n virtual OperationStatus GetCompletedReports(std::vector* reports) = 0;\n\n //! \\brief Obtains and locks a report object for uploading to a collection\n //! server. On iOS the file lock is released and mutual-exclusion is kept\n //! via a file attribute.\n //!\n //! Callers should upload the crash report using the FileReader provided.\n //! Callers should then call RecordUploadComplete() to record a successful\n //! upload. If RecordUploadComplete() is not called, the upload attempt will\n //! be recorded as unsuccessful and the report lock released when \\a report is\n //! destroyed.\n //!\n //! On iOS, holding a lock during a slow upload can lead to watchdog kills if\n //! the app is suspended mid-upload. Instead, if the client can obtain the\n //! lock, the database sets a lock-time file attribute and releases the lock.\n //! The attribute is cleared when the upload is completed. The lock-time\n //! attribute can be used to prevent file access from other processes, or to\n //! discard reports that likely were terminated mid-upload.\n //!\n //! \\param[in] uuid The unique identifier for the crash report record.\n //! \\param[out] report A crash report record for the report to be uploaded.\n //! Only valid if this returns #kNoError.\n //! \\param[in] report_metrics If `false`, metrics will not be recorded for\n //! this upload attempt when RecordUploadComplete() is called or \\a report\n //! is destroyed. Metadata for the upload attempt will still be recorded\n //! in the database.\n //!\n //! \\return The operation status code.\n virtual OperationStatus GetReportForUploading(\n const UUID& uuid,\n std::unique_ptr* report,\n bool report_metrics = true) = 0;\n\n //! \\brief Records a successful upload for a report and updates the last\n //! upload attempt time as returned by\n //! Settings::GetLastUploadAttemptTime().\n //!\n //! \\param[in] report A UploadReport object obtained from\n //! GetReportForUploading(). The UploadReport object will be invalidated\n //! and the report unlocked as part of this call.\n //! \\param[in] id The possibly empty identifier assigned to this crash report\n //! by the collection server.\n //!\n //! \\return The operation status code.\n OperationStatus RecordUploadComplete(\n std::unique_ptr report,\n const std::string& id);\n\n //! \\brief Moves a report from the pending state to the completed state, but\n //! without the report being uploaded.\n //!\n //! This can be used if the user has disabled crash report collection, but\n //! crash generation is still enabled in the product.\n //!\n //! \\param[in] uuid The unique identifier for the crash report record.\n //! \\param[in] reason The reason the report upload is being skipped for\n //! metrics tracking purposes.\n //!\n //! \\return The operation status code.\n virtual OperationStatus SkipReportUpload(\n const UUID& uuid,\n Metrics::CrashSkippedReason reason) = 0;\n\n //! \\brief Deletes a crash report file and its associated metadata.\n //!\n //! \\param[in] uuid The UUID of the report to delete.\n //!\n //! \\return The operation status code.\n virtual OperationStatus DeleteReport(const UUID& uuid) = 0;\n\n //! \\brief Marks a crash report as explicitly requested to be uploaded by the\n //! user and moves it to 'pending' state.\n //!\n //! \\param[in] uuid The unique identifier for the crash report record.\n //!\n //! \\return The operation status code.\n virtual OperationStatus RequestUpload(const UUID& uuid) = 0;\n\n //! \\brief Cleans the database of expired lockfiles, metadata without report\n //! files, report files without metadata, and attachments without report\n //! files.\n //!\n //! As the macOS implementation does not use lock or metadata files, the\n //! cleaning is limited to attachments without report files.\n //!\n //! \\param[in] lockfile_ttl The number of seconds at which lockfiles or new\n //! report files are considered expired.\n //! \\return The number of reports cleaned.\n virtual int CleanDatabase(time_t lockfile_ttl) { return 0; }\n\n protected:\n CrashReportDatabase() = default;\n\n //! \\brief The path to the database passed to Initialize.\n //!\n //! \\return The filepath of the database;\n virtual base::FilePath DatabasePath() = 0;\n\n //! \\brief Build a filepath for the root attachments directory.\n //!\n //! \\return The filepath to the attachments directory.\n base::FilePath AttachmentsRootPath();\n\n //! \\brief Build a filepath for the directory for the report to hold\n //! attachments.\n //!\n //! \\param[in] uuid The unique identifier for the crash report record.\n //!\n //! \\return The filepath to the report attachments directory.\n base::FilePath AttachmentsPath(const UUID& uuid);\n\n //! \\brief Attempts to remove any attachments associated with the given\n //! report UUID. There may not be any, so failing is not an error.\n //!\n //! \\param[in] uuid The unique identifier for the crash report record.\n void RemoveAttachmentsByUUID(const UUID& uuid);\n\n private:\n //! \\brief Adjusts a crash report record’s metadata to account for an upload\n //! attempt, and updates the last upload attempt time as returned by\n //! Settings::GetLastUploadAttemptTime().\n //!\n //! \\param[in] report The report object obtained from\n //! GetReportForUploading().\n //! \\param[in] successful Whether the upload attempt was successful.\n //! \\param[in] id The identifier assigned to this crash report by the\n //! collection server. Must be empty if \\a successful is `false`; may be\n //! empty if it is `true`.\n //!\n //! \\return The operation status code.\n virtual OperationStatus RecordUploadAttempt(UploadReport* report,\n bool successful,\n const std::string& id) = 0;\n};\n\n} // namespace crashpad\n\n#endif // CRASHPAD_CLIENT_CRASH_REPORT_DATABASE_H_\n" }, { "path": "client/crash_report_database_generic.cc", "content": "// Copyright 2018 The Crashpad Authors\n//\n// Licensed under the Apache License, Version 2.0 (the \"License\");\n// you may not use this file except in compliance with the License.\n// You may obtain a copy of the License at\n//\n// http://www.apache.org/licenses/LICENSE-2.0\n//\n// Unless required by applicable law or agreed to in writing, software\n// distributed under the License is distributed on an \"AS IS\" BASIS,\n// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n// See the License for the specific language governing permissions and\n// limitations under the License.\n\n#include \"client/crash_report_database.h\"\n\n#include \n#include \n#include \n\n#include \n#include \n#include \n\n#include \"base/check_op.h\"\n#include \"base/logging.h\"\n#include \"build/build_config.h\"\n#include \"client/settings.h\"\n#include \"util/file/directory_reader.h\"\n#include \"util/file/filesystem.h\"\n#include \"util/misc/initialization_state_dcheck.h\"\n#include \"util/misc/memory_sanitizer.h\"\n\nnamespace crashpad {\n\nnamespace {\n\nbase::FilePath ReplaceFinalExtension(\n const base::FilePath& path,\n const base::FilePath::StringType extension) {\n return base::FilePath(path.RemoveFinalExtension().value() + extension);\n}\n\nUUID UUIDFromReportPath(const base::FilePath& path) {\n UUID uuid;\n uuid.InitializeFromString(path.RemoveFinalExtension().BaseName().value());\n return uuid;\n}\n\nusing OperationStatus = CrashReportDatabase::OperationStatus;\n\nconstexpr base::FilePath::CharType kSettings[] =\n FILE_PATH_LITERAL(\"settings.dat\");\n\nconstexpr base::FilePath::CharType kCrashReportExtension[] =\n FILE_PATH_LITERAL(\".dmp\");\nconstexpr base::FilePath::CharType kMetadataExtension[] =\n FILE_PATH_LITERAL(\".meta\");\nconstexpr base::FilePath::CharType kLockExtension[] =\n FILE_PATH_LITERAL(\".lock\");\n\nconstexpr base::FilePath::CharType kNewDirectory[] = FILE_PATH_LITERAL(\"new\");\nconstexpr base::FilePath::CharType kPendingDirectory[] =\n FILE_PATH_LITERAL(\"pending\");\nconstexpr base::FilePath::CharType kCompletedDirectory[] =\n FILE_PATH_LITERAL(\"completed\");\n\nconstexpr const base::FilePath::CharType* kReportDirectories[] = {\n kNewDirectory,\n kPendingDirectory,\n kCompletedDirectory,\n};\n\nenum {\n //! \\brief Corresponds to uploaded bit of the report state.\n kAttributeUploaded = 1 << 0,\n\n //! \\brief Corresponds to upload_explicity_requested bit of the report state.\n kAttributeUploadExplicitlyRequested = 1 << 1,\n};\n\nstruct ReportMetadata {\n static constexpr int32_t kVersion = 1;\n\n int32_t version = kVersion;\n int32_t upload_attempts = 0;\n int64_t last_upload_attempt_time = 0;\n time_t creation_time = 0;\n uint8_t attributes = 0;\n};\n\n// A lock held while using database resources.\nclass ScopedLockFile {\n public:\n ScopedLockFile() = default;\n\n ScopedLockFile(const ScopedLockFile&) = delete;\n ScopedLockFile& operator=(const ScopedLockFile&) = delete;\n\n ~ScopedLockFile() = default;\n\n ScopedLockFile& operator=(ScopedLockFile&& other) {\n lock_file_.reset(other.lock_file_.release());\n return *this;\n }\n\n // Attempt to acquire a lock for the report at report_path.\n // Return `true` on success, otherwise `false`.\n bool ResetAcquire(const base::FilePath& report_path) {\n lock_file_.reset();\n\n base::FilePath lock_path(report_path.RemoveFinalExtension().value() +\n kLockExtension);\n ScopedFileHandle lock_fd(LoggingOpenFileForWrite(\n lock_path, FileWriteMode::kCreateOrFail, FilePermissions::kOwnerOnly));\n if (!lock_fd.is_valid()) {\n return false;\n }\n lock_file_.reset(lock_path);\n\n time_t timestamp = time(nullptr);\n if (!LoggingWriteFile(lock_fd.get(), ×tamp, sizeof(timestamp))) {\n return false;\n }\n\n return true;\n }\n\n // Returns `true` if the lock is held.\n bool is_valid() const { return lock_file_.is_valid(); }\n\n // Returns `true` if the lockfile at lock_path has expired.\n static bool IsExpired(const base::FilePath& lock_path, time_t lockfile_ttl) {\n time_t now = time(nullptr);\n\n timespec filetime;\n if (FileModificationTime(lock_path, &filetime) &&\n filetime.tv_sec > now + lockfile_ttl) {\n return false;\n }\n\n ScopedFileHandle lock_fd(LoggingOpenFileForReadAndWrite(\n lock_path, FileWriteMode::kReuseOrFail, FilePermissions::kOwnerOnly));\n if (!lock_fd.is_valid()) {\n return false;\n }\n\n time_t timestamp;\n if (!LoggingReadFileExactly(lock_fd.get(), ×tamp, sizeof(timestamp))) {\n return false;\n }\n\n return now >= timestamp + lockfile_ttl;\n }\n\n private:\n ScopedRemoveFile lock_file_;\n};\n} // namespace\n\nclass CrashReportDatabaseGeneric : public CrashReportDatabase {\n public:\n explicit CrashReportDatabaseGeneric(const base::FilePath& path);\n\n CrashReportDatabaseGeneric(const CrashReportDatabaseGeneric&) = delete;\n CrashReportDatabaseGeneric& operator=(const CrashReportDatabaseGeneric&) =\n delete;\n\n ~CrashReportDatabaseGeneric() override;\n\n bool Initialize(bool may_create);\n\n // CrashReportDatabase:\n Settings* GetSettings() override;\n OperationStatus PrepareNewCrashReport(\n std::unique_ptr* report) override;\n OperationStatus FinishedWritingCrashReport(std::unique_ptr report,\n UUID* uuid) override;\n OperationStatus LookUpCrashReport(const UUID& uuid, Report* report) override;\n OperationStatus GetPendingReports(std::vector* reports) override;\n OperationStatus GetCompletedReports(std::vector* reports) override;\n OperationStatus GetReportForUploading(\n const UUID& uuid,\n std::unique_ptr* report,\n bool report_metrics) override;\n OperationStatus SkipReportUpload(const UUID& uuid,\n Metrics::CrashSkippedReason reason) override;\n OperationStatus DeleteReport(const UUID& uuid) override;\n OperationStatus RequestUpload(const UUID& uuid) override;\n int CleanDatabase(time_t lockfile_ttl) override;\n base::FilePath DatabasePath() override;\n\n private:\n struct LockfileUploadReport : public UploadReport {\n ScopedLockFile lock_file;\n };\n\n enum ReportState : int32_t {\n kUninitialized = -1,\n\n // Being created by a caller of PrepareNewCrashReport().\n kNew,\n\n // Created by FinishedWritingCrashReport(), but not yet uploaded.\n kPending,\n\n // Upload completed or skipped.\n kCompleted,\n\n // Specifies either kPending or kCompleted.\n kSearchable,\n };\n\n // CrashReportDatabase:\n OperationStatus RecordUploadAttempt(UploadReport* report,\n bool successful,\n const std::string& id) override;\n\n // Builds a filepath for the report with the specified uuid and state.\n base::FilePath ReportPath(const UUID& uuid, ReportState state);\n\n // Locates the report with id uuid and returns its file path in path and a\n // lock for the report in lock_file. This method succeeds as long as the\n // report file exists and the lock can be acquired. No validation is done on\n // the existence or content of the metadata file.\n OperationStatus LocateAndLockReport(const UUID& uuid,\n ReportState state,\n base::FilePath* path,\n ScopedLockFile* lock_file);\n\n // Locates, locks, and reads the metadata for the report with the specified\n // uuid and state. This method will fail and may remove reports if invalid\n // metadata is detected. state may be kPending, kCompleted, or kSearchable.\n OperationStatus CheckoutReport(const UUID& uuid,\n ReportState state,\n base::FilePath* path,\n ScopedLockFile* lock_file,\n Report* report);\n\n // Reads metadata for all reports in state and returns it in reports.\n OperationStatus ReportsInState(ReportState state,\n std::vector* reports);\n\n // Cleans lone metadata, reports, or expired locks in a particular state.\n int CleanReportsInState(ReportState state, time_t lockfile_ttl);\n\n // Cleans any attachments that have no associated report in any state.\n void CleanOrphanedAttachments();\n\n // Reads the metadata for a report from path and returns it in report.\n bool ReadMetadata(const base::FilePath& path, Report* report);\n\n // Wraps ReadMetadata and removes the report from the database on failure.\n bool CleaningReadMetadata(const base::FilePath& path, Report* report);\n\n // Writes metadata for a new report to the filesystem at path.\n static bool WriteNewMetadata(const base::FilePath& path);\n\n // Writes the metadata for report to the filesystem at path.\n static bool WriteMetadata(const base::FilePath& path, const Report& report);\n\n Settings& SettingsInternal() {\n std::call_once(settings_init_, [this]() { settings_.Initialize(); });\n return settings_;\n }\n\n const base::FilePath base_dir_;\n Settings settings_;\n std::once_flag settings_init_;\n InitializationStateDcheck initialized_;\n};\n\nCrashReportDatabaseGeneric::CrashReportDatabaseGeneric(\n const base::FilePath& path)\n : base_dir_(path), settings_(path.Append(kSettings)) {}\n\nCrashReportDatabaseGeneric::~CrashReportDatabaseGeneric() = default;\n\nbool CrashReportDatabaseGeneric::Initialize(bool may_create) {\n INITIALIZATION_STATE_SET_INITIALIZING(initialized_);\n\n if (!IsDirectory(base_dir_, true) &&\n !(may_create &&\n LoggingCreateDirectory(base_dir_, FilePermissions::kOwnerOnly, true))) {\n return false;\n }\n\n for (const base::FilePath::CharType* subdir : kReportDirectories) {\n if (!LoggingCreateDirectory(\n base_dir_.Append(subdir), FilePermissions::kOwnerOnly, true)) {\n return false;\n }\n }\n\n if (!LoggingCreateDirectory(\n AttachmentsRootPath(), FilePermissions::kOwnerOnly, true)) {\n return false;\n }\n\n INITIALIZATION_STATE_SET_VALID(initialized_);\n return true;\n}\n\nbase::FilePath CrashReportDatabaseGeneric::DatabasePath() {\n return base_dir_;\n}\n\nSettings* CrashReportDatabaseGeneric::GetSettings() {\n INITIALIZATION_STATE_DCHECK_VALID(initialized_);\n return &SettingsInternal();\n}\n\nOperationStatus CrashReportDatabaseGeneric::PrepareNewCrashReport(\n std::unique_ptr* report) {\n INITIALIZATION_STATE_DCHECK_VALID(initialized_);\n\n auto new_report = std::make_unique();\n if (!new_report->Initialize(\n this, base_dir_.Append(kNewDirectory), kCrashReportExtension)) {\n return kFileSystemError;\n }\n\n report->reset(new_report.release());\n return kNoError;\n}\n\nOperationStatus CrashReportDatabaseGeneric::FinishedWritingCrashReport(\n std::unique_ptr report,\n UUID* uuid) {\n INITIALIZATION_STATE_DCHECK_VALID(initialized_);\n\n base::FilePath path = ReportPath(report->ReportID(), kPending);\n ScopedLockFile lock_file;\n if (!lock_file.ResetAcquire(path)) {\n return kBusyError;\n }\n\n if (!WriteNewMetadata(ReplaceFinalExtension(path, kMetadataExtension))) {\n return kDatabaseError;\n }\n\n FileOffset size = report->Writer()->Seek(0, SEEK_END);\n\n report->Writer()->Close();\n if (!MoveFileOrDirectory(report->file_remover_.get(), path)) {\n return kFileSystemError;\n }\n // We've moved the report to pending, so it no longer needs to be removed.\n std::ignore = report->file_remover_.release();\n\n // Close all the attachments and disarm their removers too.\n for (auto& writer : report->attachment_writers_) {\n writer->Close();\n }\n for (auto& remover : report->attachment_removers_) {\n std::ignore = remover.release();\n }\n\n *uuid = report->ReportID();\n\n Metrics::CrashReportPending(Metrics::PendingReportReason::kNewlyCreated);\n Metrics::CrashReportSize(size);\n\n return kNoError;\n}\n\nOperationStatus CrashReportDatabaseGeneric::LookUpCrashReport(const UUID& uuid,\n Report* report) {\n INITIALIZATION_STATE_DCHECK_VALID(initialized_);\n\n ScopedLockFile lock_file;\n base::FilePath path;\n return CheckoutReport(uuid, kSearchable, &path, &lock_file, report);\n}\n\nOperationStatus CrashReportDatabaseGeneric::GetPendingReports(\n std::vector* reports) {\n INITIALIZATION_STATE_DCHECK_VALID(initialized_);\n return ReportsInState(kPending, reports);\n}\n\nOperationStatus CrashReportDatabaseGeneric::GetCompletedReports(\n std::vector* reports) {\n INITIALIZATION_STATE_DCHECK_VALID(initialized_);\n return ReportsInState(kCompleted, reports);\n}\n\nOperationStatus CrashReportDatabaseGeneric::GetReportForUploading(\n const UUID& uuid,\n std::unique_ptr* report,\n bool report_metrics) {\n INITIALIZATION_STATE_DCHECK_VALID(initialized_);\n\n auto upload_report = std::make_unique();\n\n base::FilePath path;\n OperationStatus os = CheckoutReport(\n uuid, kPending, &path, &upload_report->lock_file, upload_report.get());\n if (os != kNoError) {\n return os;\n }\n\n if (!upload_report->Initialize(path, this)) {\n return kFileSystemError;\n }\n upload_report->report_metrics_ = report_metrics;\n\n report->reset(upload_report.release());\n return kNoError;\n}\n\nOperationStatus CrashReportDatabaseGeneric::SkipReportUpload(\n const UUID& uuid,\n Metrics::CrashSkippedReason reason) {\n INITIALIZATION_STATE_DCHECK_VALID(initialized_);\n\n Metrics::CrashUploadSkipped(reason);\n\n base::FilePath path;\n ScopedLockFile lock_file;\n Report report;\n OperationStatus os =\n CheckoutReport(uuid, kPending, &path, &lock_file, &report);\n if (os != kNoError) {\n return os;\n }\n\n base::FilePath completed_path(ReportPath(uuid, kCompleted));\n ScopedLockFile completed_lock_file;\n if (!completed_lock_file.ResetAcquire(completed_path)) {\n return kBusyError;\n }\n\n report.upload_explicitly_requested = false;\n if (!WriteMetadata(completed_path, report)) {\n return kDatabaseError;\n }\n\n if (!MoveFileOrDirectory(path, completed_path)) {\n return kFileSystemError;\n }\n\n if (!LoggingRemoveFile(ReplaceFinalExtension(path, kMetadataExtension))) {\n return kDatabaseError;\n }\n\n return kNoError;\n}\n\nOperationStatus CrashReportDatabaseGeneric::DeleteReport(const UUID& uuid) {\n INITIALIZATION_STATE_DCHECK_VALID(initialized_);\n\n base::FilePath path;\n ScopedLockFile lock_file;\n OperationStatus os =\n LocateAndLockReport(uuid, kSearchable, &path, &lock_file);\n if (os != kNoError) {\n return os;\n }\n\n if (!LoggingRemoveFile(path)) {\n return kFileSystemError;\n }\n\n if (!LoggingRemoveFile(ReplaceFinalExtension(path, kMetadataExtension))) {\n return kDatabaseError;\n }\n\n RemoveAttachmentsByUUID(uuid);\n\n return kNoError;\n}\n\nOperationStatus CrashReportDatabaseGeneric::RequestUpload(const UUID& uuid) {\n INITIALIZATION_STATE_DCHECK_VALID(initialized_);\n\n base::FilePath path;\n ScopedLockFile lock_file;\n Report report;\n OperationStatus os =\n CheckoutReport(uuid, kSearchable, &path, &lock_file, &report);\n if (os != kNoError) {\n return os;\n }\n\n if (report.uploaded) {\n return kCannotRequestUpload;\n }\n\n report.upload_explicitly_requested = true;\n base::FilePath pending_path = ReportPath(uuid, kPending);\n if (!MoveFileOrDirectory(path, pending_path)) {\n return kFileSystemError;\n }\n\n if (!WriteMetadata(pending_path, report)) {\n return kDatabaseError;\n }\n\n if (pending_path != path) {\n if (!LoggingRemoveFile(ReplaceFinalExtension(path, kMetadataExtension))) {\n return kDatabaseError;\n }\n }\n\n Metrics::CrashReportPending(Metrics::PendingReportReason::kUserInitiated);\n return kNoError;\n}\n\nint CrashReportDatabaseGeneric::CleanDatabase(time_t lockfile_ttl) {\n int removed = 0;\n time_t now = time(nullptr);\n\n DirectoryReader reader;\n const base::FilePath new_dir(base_dir_.Append(kNewDirectory));\n if (reader.Open(new_dir)) {\n base::FilePath filename;\n DirectoryReader::Result result;\n while ((result = reader.NextFile(&filename)) ==\n DirectoryReader::Result::kSuccess) {\n const base::FilePath filepath(new_dir.Append(filename));\n timespec filetime;\n if (!FileModificationTime(filepath, &filetime)) {\n continue;\n }\n if (filetime.tv_sec <= now - lockfile_ttl) {\n if (LoggingRemoveFile(filepath)) {\n ++removed;\n }\n }\n }\n }\n\n removed += CleanReportsInState(kPending, lockfile_ttl);\n removed += CleanReportsInState(kCompleted, lockfile_ttl);\n CleanOrphanedAttachments();\n#if !CRASHPAD_FLOCK_ALWAYS_SUPPORTED\n base::FilePath settings_path(kSettings);\n if (Settings::IsLockExpired(settings_path, lockfile_ttl)) {\n base::FilePath lockfile_path(settings_path.value() +\n Settings::kLockfileExtension);\n if (LoggingRemoveFile(lockfile_path)) {\n ++removed;\n }\n }\n#endif // !CRASHPAD_FLOCK_ALWAYS_SUPPORTED\n return removed;\n}\n\nOperationStatus CrashReportDatabaseGeneric::RecordUploadAttempt(\n UploadReport* report,\n bool successful,\n const std::string& id) {\n INITIALIZATION_STATE_DCHECK_VALID(initialized_);\n\n if (report->report_metrics_) {\n Metrics::CrashUploadAttempted(successful);\n }\n time_t now = time(nullptr);\n\n report->id = id;\n report->uploaded = successful;\n report->last_upload_attempt_time = now;\n ++report->upload_attempts;\n\n base::FilePath report_path(report->file_path);\n\n ScopedLockFile lock_file;\n if (successful) {\n report->upload_explicitly_requested = false;\n\n base::FilePath completed_report_path = ReportPath(report->uuid, kCompleted);\n\n if (!lock_file.ResetAcquire(completed_report_path)) {\n return kBusyError;\n }\n\n report->Reader()->Close();\n if (!MoveFileOrDirectory(report_path, completed_report_path)) {\n return kFileSystemError;\n }\n\n LoggingRemoveFile(ReplaceFinalExtension(report_path, kMetadataExtension));\n report_path = completed_report_path;\n }\n\n if (!WriteMetadata(report_path, *report)) {\n return kDatabaseError;\n }\n\n if (!SettingsInternal().SetLastUploadAttemptTime(now)) {\n return kDatabaseError;\n }\n\n return kNoError;\n}\n\nbase::FilePath CrashReportDatabaseGeneric::ReportPath(const UUID& uuid,\n ReportState state) {\n DCHECK_NE(state, kUninitialized);\n DCHECK_NE(state, kSearchable);\n\n#if BUILDFLAG(IS_WIN)\n const std::wstring uuid_string = uuid.ToWString();\n#else\n const std::string uuid_string = uuid.ToString();\n#endif\n\n return base_dir_.Append(kReportDirectories[state])\n .Append(uuid_string + kCrashReportExtension);\n}\n\nOperationStatus CrashReportDatabaseGeneric::LocateAndLockReport(\n const UUID& uuid,\n ReportState desired_state,\n base::FilePath* path,\n ScopedLockFile* lock_file) {\n std::vector searchable_states;\n if (desired_state == kSearchable) {\n searchable_states.push_back(kPending);\n searchable_states.push_back(kCompleted);\n } else {\n DCHECK(desired_state == kPending || desired_state == kCompleted);\n searchable_states.push_back(desired_state);\n }\n\n for (const ReportState state : searchable_states) {\n base::FilePath local_path(ReportPath(uuid, state));\n ScopedLockFile local_lock;\n if (!local_lock.ResetAcquire(local_path)) {\n return kBusyError;\n }\n\n if (!IsRegularFile(local_path)) {\n continue;\n }\n\n *path = local_path;\n *lock_file = std::move(local_lock);\n return kNoError;\n }\n\n return kReportNotFound;\n}\n\nOperationStatus CrashReportDatabaseGeneric::CheckoutReport(\n const UUID& uuid,\n ReportState state,\n base::FilePath* path,\n ScopedLockFile* lock_file,\n Report* report) {\n ScopedLockFile local_lock;\n base::FilePath local_path;\n OperationStatus os =\n LocateAndLockReport(uuid, state, &local_path, &local_lock);\n if (os != kNoError) {\n return os;\n }\n\n if (!CleaningReadMetadata(local_path, report)) {\n return kDatabaseError;\n }\n\n *path = local_path;\n *lock_file = std::move(local_lock);\n return kNoError;\n}\n\nOperationStatus CrashReportDatabaseGeneric::ReportsInState(\n ReportState state,\n std::vector* reports) {\n DCHECK(reports->empty());\n DCHECK_NE(state, kUninitialized);\n DCHECK_NE(state, kSearchable);\n DCHECK_NE(state, kNew);\n\n const base::FilePath dir_path(base_dir_.Append(kReportDirectories[state]));\n DirectoryReader reader;\n if (!reader.Open(dir_path)) {\n return kDatabaseError;\n }\n\n base::FilePath filename;\n DirectoryReader::Result result;\n while ((result = reader.NextFile(&filename)) ==\n DirectoryReader::Result::kSuccess) {\n const base::FilePath::StringType extension(filename.FinalExtension());\n if (extension.compare(kCrashReportExtension) != 0) {\n continue;\n }\n\n const base::FilePath filepath(dir_path.Append(filename));\n ScopedLockFile lock_file;\n if (!lock_file.ResetAcquire(filepath)) {\n continue;\n }\n\n Report report;\n if (!CleaningReadMetadata(filepath, &report)) {\n continue;\n }\n reports->push_back(report);\n reports->back().file_path = filepath;\n }\n return kNoError;\n}\n\nint CrashReportDatabaseGeneric::CleanReportsInState(ReportState state,\n time_t lockfile_ttl) {\n const base::FilePath dir_path(base_dir_.Append(kReportDirectories[state]));\n DirectoryReader reader;\n if (!reader.Open(dir_path)) {\n return 0;\n }\n\n int removed = 0;\n base::FilePath filename;\n DirectoryReader::Result result;\n while ((result = reader.NextFile(&filename)) ==\n DirectoryReader::Result::kSuccess) {\n const base::FilePath::StringType extension(filename.FinalExtension());\n const base::FilePath filepath(dir_path.Append(filename));\n\n // Remove any report files without metadata.\n if (extension.compare(kCrashReportExtension) == 0) {\n const base::FilePath metadata_path(\n ReplaceFinalExtension(filepath, kMetadataExtension));\n ScopedLockFile report_lock;\n if (report_lock.ResetAcquire(filepath) && !IsRegularFile(metadata_path) &&\n LoggingRemoveFile(filepath)) {\n ++removed;\n RemoveAttachmentsByUUID(UUIDFromReportPath(filepath));\n }\n continue;\n }\n\n // Remove any metadata files without report files.\n if (extension.compare(kMetadataExtension) == 0) {\n const base::FilePath report_path(\n ReplaceFinalExtension(filepath, kCrashReportExtension));\n ScopedLockFile report_lock;\n if (report_lock.ResetAcquire(report_path) &&\n !IsRegularFile(report_path) && LoggingRemoveFile(filepath)) {\n ++removed;\n RemoveAttachmentsByUUID(UUIDFromReportPath(filepath));\n }\n continue;\n }\n\n // Remove any expired locks only if we can remove the report and metadata.\n if (extension.compare(kLockExtension) == 0 &&\n ScopedLockFile::IsExpired(filepath, lockfile_ttl)) {\n const base::FilePath no_ext(filepath.RemoveFinalExtension());\n const base::FilePath report_path(no_ext.value() + kCrashReportExtension);\n const base::FilePath metadata_path(no_ext.value() + kMetadataExtension);\n if ((IsRegularFile(report_path) && !LoggingRemoveFile(report_path)) ||\n (IsRegularFile(metadata_path) && !LoggingRemoveFile(metadata_path))) {\n continue;\n }\n\n if (LoggingRemoveFile(filepath)) {\n ++removed;\n RemoveAttachmentsByUUID(UUIDFromReportPath(filepath));\n }\n continue;\n }\n }\n\n return removed;\n}\n\nvoid CrashReportDatabaseGeneric::CleanOrphanedAttachments() {\n base::FilePath root_attachments_dir(AttachmentsRootPath());\n DirectoryReader reader;\n if (!reader.Open(root_attachments_dir)) {\n return;\n }\n\n base::FilePath filename;\n DirectoryReader::Result result;\n while ((result = reader.NextFile(&filename)) ==\n DirectoryReader::Result::kSuccess) {\n const base::FilePath report_attachment_dir(\n root_attachments_dir.Append(filename));\n if (IsDirectory(report_attachment_dir, false)) {\n UUID uuid;\n if (!uuid.InitializeFromString(filename.value())) {\n LOG(ERROR) << \"unexpected attachment dir name \" << filename.value();\n continue;\n }\n\n // Check to see if the report is being created in \"new\".\n base::FilePath new_dir_path =\n base_dir_.Append(kNewDirectory)\n .Append(uuid.ToString() + kCrashReportExtension);\n if (IsRegularFile(new_dir_path)) {\n continue;\n }\n\n // Check to see if the report is in \"pending\" or \"completed\".\n ScopedLockFile local_lock;\n base::FilePath local_path;\n OperationStatus os =\n LocateAndLockReport(uuid, kSearchable, &local_path, &local_lock);\n if (os != kReportNotFound) {\n continue;\n }\n\n // Couldn't find a report, assume these attachments are orphaned.\n RemoveAttachmentsByUUID(uuid);\n }\n }\n}\n\nbool CrashReportDatabaseGeneric::ReadMetadata(const base::FilePath& path,\n Report* report) {\n const base::FilePath metadata_path(\n ReplaceFinalExtension(path, kMetadataExtension));\n\n ScopedFileHandle handle(LoggingOpenFileForRead(metadata_path));\n if (!handle.is_valid()) {\n return false;\n }\n\n UUID uuid;\n if (!uuid.InitializeFromString(\n path.BaseName().RemoveFinalExtension().value())) {\n LOG(ERROR) << \"Couldn't interpret report uuid\";\n return false;\n }\n\n ReportMetadata metadata;\n if (!LoggingReadFileExactly(handle.get(), &metadata, sizeof(metadata))) {\n return false;\n }\n\n if (metadata.version != ReportMetadata::kVersion) {\n LOG(ERROR) << \"metadata version mismatch\";\n return false;\n }\n\n if (!LoggingReadToEOF(handle.get(), &report->id)) {\n return false;\n }\n\n // Seed the total size with the main report size and then add the sizes of any\n // potential attachments.\n uint64_t total_size = GetFileSize(path);\n total_size += GetDirectorySize(AttachmentsPath(uuid));\n\n report->uuid = uuid;\n report->upload_attempts = metadata.upload_attempts;\n report->last_upload_attempt_time = metadata.last_upload_attempt_time;\n report->creation_time = metadata.creation_time;\n report->uploaded = (metadata.attributes & kAttributeUploaded) != 0;\n report->upload_explicitly_requested =\n (metadata.attributes & kAttributeUploadExplicitlyRequested) != 0;\n report->file_path = path;\n report->total_size = total_size;\n return true;\n}\n\nbool CrashReportDatabaseGeneric::CleaningReadMetadata(\n const base::FilePath& path,\n Report* report) {\n if (ReadMetadata(path, report)) {\n return true;\n }\n\n LoggingRemoveFile(path);\n LoggingRemoveFile(ReplaceFinalExtension(path, kMetadataExtension));\n RemoveAttachmentsByUUID(report->uuid);\n return false;\n}\n\n// static\nbool CrashReportDatabaseGeneric::WriteNewMetadata(const base::FilePath& path) {\n const base::FilePath metadata_path(\n ReplaceFinalExtension(path, kMetadataExtension));\n\n ScopedFileHandle handle(LoggingOpenFileForWrite(metadata_path,\n FileWriteMode::kCreateOrFail,\n FilePermissions::kOwnerOnly));\n if (!handle.is_valid()) {\n return false;\n }\n\n ReportMetadata metadata;\n#if defined(MEMORY_SANITIZER)\n // memset() + re-initialization is required to zero padding bytes for MSan.\n memset(&metadata, 0, sizeof(metadata));\n#endif // defined(MEMORY_SANITIZER)\n metadata = {};\n metadata.creation_time = time(nullptr);\n\n return LoggingWriteFile(handle.get(), &metadata, sizeof(metadata));\n}\n\n// static\nbool CrashReportDatabaseGeneric::WriteMetadata(const base::FilePath& path,\n const Report& report) {\n const base::FilePath metadata_path(\n ReplaceFinalExtension(path, kMetadataExtension));\n\n ScopedFileHandle handle(\n LoggingOpenFileForWrite(metadata_path,\n FileWriteMode::kTruncateOrCreate,\n FilePermissions::kOwnerOnly));\n if (!handle.is_valid()) {\n return false;\n }\n\n ReportMetadata metadata;\n#if defined(MEMORY_SANITIZER)\n // memset() + re-initialization is required to zero padding bytes for MSan.\n memset(&metadata, 0, sizeof(metadata));\n#endif // defined(MEMORY_SANITIZER)\n metadata = {};\n metadata.creation_time = report.creation_time;\n metadata.last_upload_attempt_time = report.last_upload_attempt_time;\n metadata.upload_attempts = report.upload_attempts;\n metadata.attributes =\n (report.uploaded ? kAttributeUploaded : 0) |\n (report.upload_explicitly_requested ? kAttributeUploadExplicitlyRequested\n : 0);\n\n return LoggingWriteFile(handle.get(), &metadata, sizeof(metadata)) &&\n LoggingWriteFile(handle.get(), report.id.c_str(), report.id.size());\n}\n\n// static\nstd::unique_ptr CrashReportDatabase::Initialize(\n const base::FilePath& path) {\n auto database = std::make_unique(path);\n return database->Initialize(true) ? std::move(database) : nullptr;\n}\n\n// static\nstd::unique_ptr\nCrashReportDatabase::InitializeWithoutCreating(const base::FilePath& path) {\n auto database = std::make_unique(path);\n return database->Initialize(false) ? std::move(database) : nullptr;\n}\n\n// static\nstd::unique_ptr\nCrashReportDatabase::GetSettingsReaderForDatabasePath(\n const base::FilePath& path) {\n return std::make_unique(path.Append(kSettings));\n}\n\n} // namespace crashpad\n" }, { "path": "client/crash_report_database_mac.mm", "content": "// Copyright 2015 The Crashpad Authors\n//\n// Licensed under the Apache License, Version 2.0 (the \"License\");\n// you may not use this file except in compliance with the License.\n// You may obtain a copy of the License at\n//\n// http://www.apache.org/licenses/LICENSE-2.0\n//\n// Unless required by applicable law or agreed to in writing, software\n// distributed under the License is distributed on an \"AS IS\" BASIS,\n// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n// See the License for the specific language governing permissions and\n// limitations under the License.\n\n#include \"client/crash_report_database.h\"\n\n#import \n#include \n#include \n#include \n#include \n#include \n#include \n#include \n#include \n#include \n\n#include \n#include \n#include \n#include \n#include \n\n#include \"base/apple/scoped_nsautorelease_pool.h\"\n#include \"base/logging.h\"\n#include \"base/posix/eintr_wrapper.h\"\n#include \"base/scoped_generic.h\"\n#include \"base/strings/strcat.h\"\n#include \"base/strings/sys_string_conversions.h\"\n#include \"client/settings.h\"\n#include \"util/file/directory_reader.h\"\n#include \"util/file/file_io.h\"\n#include \"util/file/filesystem.h\"\n#include \"util/mac/xattr.h\"\n#include \"util/misc/initialization_state_dcheck.h\"\n#include \"util/misc/metrics.h\"\n\n#if BUILDFLAG(IS_IOS)\n#include \"util/ios/scoped_background_task.h\"\n#endif // BUILDFLAG(IS_IOS)\n\nnamespace crashpad {\n\nnamespace {\n\nconstexpr char kWriteDirectory[] = \"new\";\nconstexpr char kUploadPendingDirectory[] = \"pending\";\nconstexpr char kCompletedDirectory[] = \"completed\";\n\nconstexpr char kSettings[] = \"settings.dat\";\n\nconstexpr std::array kReportDirectories = {\n kWriteDirectory,\n kUploadPendingDirectory,\n kCompletedDirectory,\n};\n\nconstexpr char kCrashReportFileExtension[] = \"dmp\";\n\nconstexpr char kXattrUUID[] = \"uuid\";\nconstexpr char kXattrCollectorID[] = \"id\";\nconstexpr char kXattrCreationTime[] = \"creation_time\";\nconstexpr char kXattrIsUploaded[] = \"uploaded\";\n#if BUILDFLAG(IS_IOS)\nconstexpr char kXattrUploadStartTime[] = \"upload_start_time\";\n#endif\nconstexpr char kXattrLastUploadTime[] = \"last_upload_time\";\nconstexpr char kXattrUploadAttemptCount[] = \"upload_count\";\nconstexpr char kXattrIsUploadExplicitlyRequested[] =\n \"upload_explicitly_requested\";\n\nconstexpr char kXattrDatabaseInitialized[] = \"initialized\";\n\n// Ensures that the node at |path| is a directory. If the |path| refers to a\n// file, rather than a directory, returns false. Otherwise, returns true,\n// indicating that |path| already was a directory.\nbool EnsureDirectoryExists(const base::FilePath& path) {\n struct stat st;\n if (stat(path.value().c_str(), &st) != 0) {\n PLOG(ERROR) << \"stat \" << path.value();\n return false;\n }\n if (!S_ISDIR(st.st_mode)) {\n LOG(ERROR) << \"stat \" << path.value() << \": not a directory\";\n return false;\n }\n return true;\n}\n\n// Ensures that the node at |path| is a directory, and creates it if it does\n// not exist. If the |path| refers to a file, rather than a directory, or the\n// directory could not be created, returns false. Otherwise, returns true,\n// indicating that |path| already was or now is a directory.\nbool CreateOrEnsureDirectoryExists(const base::FilePath& path) {\n if (mkdir(path.value().c_str(), 0755) == 0) {\n return true;\n }\n if (errno != EEXIST) {\n PLOG(ERROR) << \"mkdir \" << path.value();\n return false;\n }\n return EnsureDirectoryExists(path);\n}\n\n// Creates a long database xattr name from the short constant name. These names\n// have changed, and new_name determines whether the returned xattr name will be\n// the old name or its new equivalent.\nstd::string XattrNameInternal(std::string_view name, bool new_name) {\n return base::StrCat({new_name ? \"org.chromium.crashpad.database.\"\n : \"com.googlecode.crashpad.\",\n name});\n}\n\n} // namespace\n\n//! \\brief A CrashReportDatabase that uses HFS+ extended attributes to store\n//! report metadata.\n//!\n//! The database maintains three directories of reports: `\"new\"` to hold crash\n//! reports that are in the process of being written, `\"completed\"` to hold\n//! reports that have been written and are awaiting upload, and `\"uploaded\"` to\n//! hold reports successfully uploaded to a collection server. If the user has\n//! opted out of report collection, reports will still be written and moved\n//! to the completed directory, but they just will not be uploaded.\n//!\n//! The database stores its metadata in extended filesystem attributes. To\n//! ensure safe access, the report file is locked using `O_EXLOCK` during all\n//! extended attribute operations. The lock should be obtained using\n//! ObtainReportLock().\nclass CrashReportDatabaseMac : public CrashReportDatabase {\n public:\n explicit CrashReportDatabaseMac(const base::FilePath& path);\n\n CrashReportDatabaseMac(const CrashReportDatabaseMac&) = delete;\n CrashReportDatabaseMac& operator=(const CrashReportDatabaseMac&) = delete;\n\n virtual ~CrashReportDatabaseMac();\n\n bool Initialize(bool may_create);\n\n // CrashReportDatabase:\n Settings* GetSettings() override;\n OperationStatus PrepareNewCrashReport(\n std::unique_ptr* report) override;\n OperationStatus FinishedWritingCrashReport(std::unique_ptr report,\n UUID* uuid) override;\n OperationStatus LookUpCrashReport(const UUID& uuid, Report* report) override;\n OperationStatus GetPendingReports(std::vector* reports) override;\n OperationStatus GetCompletedReports(std::vector* reports) override;\n OperationStatus GetReportForUploading(\n const UUID& uuid,\n std::unique_ptr* report,\n bool report_metrics) override;\n OperationStatus SkipReportUpload(const UUID& uuid,\n Metrics::CrashSkippedReason reason) override;\n OperationStatus DeleteReport(const UUID& uuid) override;\n OperationStatus RequestUpload(const UUID& uuid) override;\n int CleanDatabase(time_t lockfile_ttl) override;\n base::FilePath DatabasePath() override;\n\n private:\n // CrashReportDatabase:\n OperationStatus RecordUploadAttempt(UploadReport* report,\n bool successful,\n const std::string& id) override;\n\n //! \\brief Report states for use with LocateCrashReport().\n //!\n //! ReportState may be considered to be a bitfield.\n enum ReportState : uint8_t {\n kReportStateWrite = 1 << 0, // in kWriteDirectory\n kReportStatePending = 1 << 1, // in kUploadPendingDirectory\n kReportStateCompleted = 1 << 2, // in kCompletedDirectory\n kReportStateAny =\n kReportStateWrite | kReportStatePending | kReportStateCompleted,\n };\n\n //! \\brief A private extension of the Report class that maintains bookkeeping\n //! information of the database.\n struct UploadReportMac : public UploadReport {\n#if BUILDFLAG(IS_IOS)\n //! \\brief Obtain a background task assertion while a flock is in use.\n //! Ensure this is defined first so it is destroyed last.\n internal::ScopedBackgroundTask ios_background_task{\"UploadReportMac\"};\n#else\n //! \\brief Stores the flock of the file for the duration of\n //! GetReportForUploading() and RecordUploadAttempt().\n base::ScopedFD lock_fd;\n#endif // BUILDFLAG(IS_IOS)\n };\n\n //! \\brief Locates a crash report in the database by UUID.\n //!\n //! \\param[in] uuid The UUID of the crash report to locate.\n //! \\param[in] desired_state The state of the report to locate, composed of\n //! ReportState values.\n //!\n //! \\return The full path to the report file, or an empty path if it cannot be\n //! found.\n base::FilePath LocateCrashReport(const UUID& uuid, uint8_t desired_state);\n\n //! \\brief Obtains an exclusive advisory lock on a file.\n //!\n //! The flock is used to prevent cross-process concurrent metadata reads or\n //! writes. While xattrs do not observe the lock, if the lock-then-mutate\n //! protocol is observed by all clients of the database, it still enforces\n //! synchronization.\n //!\n //! This does not block, and so callers must ensure that the lock is valid\n //! after calling.\n //!\n //! \\param[in] path The path of the file to lock.\n //!\n //! \\return A scoped lock object. If the result is not valid, an error is\n //! logged.\n static base::ScopedFD ObtainReportLock(const base::FilePath& path);\n\n //! \\brief Reads all the database xattrs from a file into a Report. The file\n //! must be locked with ObtainReportLock.\n //!\n //! \\param[in] path The path of the report.\n //! \\param[out] report The object into which data will be read.\n //!\n //! \\return `true` if all the metadata was read successfully, `false`\n //! otherwise.\n bool ReadReportMetadataLocked(const base::FilePath& path, Report* report);\n\n //! \\brief Reads the metadata from all the reports in a database subdirectory.\n //! Invalid reports are skipped.\n //!\n //! \\param[in] path The database subdirectory path.\n //! \\param[out] reports An empty vector of reports, which will be filled.\n //!\n //! \\return The operation status code.\n OperationStatus ReportsInDirectory(const base::FilePath& path,\n std::vector* reports);\n\n //! \\brief Creates a database xattr name from the short constant name.\n //!\n //! \\param[in] name The short name of the extended attribute.\n //!\n //! \\return The long name of the extended attribute.\n std::string XattrName(std::string_view name);\n\n //! \\brief Marks a report with a given path as completed.\n //!\n //! Assumes that the report is locked.\n //!\n //! \\param[in] report_path The path of the file to mark completed.\n //! \\param[out] out_path The path of the new file. This parameter is optional.\n //!\n //! \\return The operation status code.\n CrashReportDatabase::OperationStatus MarkReportCompletedLocked(\n const base::FilePath& report_path,\n base::FilePath* out_path);\n\n // Cleans any attachments that have no associated report in any state.\n void CleanOrphanedAttachments();\n\n Settings& SettingsInternal() {\n std::call_once(settings_init_, [this]() { settings_.Initialize(); });\n return settings_;\n }\n\n const base::FilePath base_dir_;\n Settings settings_;\n std::once_flag settings_init_;\n bool xattr_new_names_;\n InitializationStateDcheck initialized_;\n};\n\nCrashReportDatabaseMac::CrashReportDatabaseMac(const base::FilePath& path)\n : CrashReportDatabase(),\n base_dir_(path),\n settings_(path.Append(kSettings)),\n settings_init_(),\n xattr_new_names_(false),\n initialized_() {}\n\nCrashReportDatabaseMac::~CrashReportDatabaseMac() {}\n\nbool CrashReportDatabaseMac::Initialize(bool may_create) {\n INITIALIZATION_STATE_SET_INITIALIZING(initialized_);\n\n // Check if the database already exists.\n if (may_create) {\n if (!CreateOrEnsureDirectoryExists(base_dir_)) {\n return false;\n }\n } else if (!EnsureDirectoryExists(base_dir_)) {\n return false;\n }\n\n // Create the three processing directories for the database.\n for (const auto& dir : kReportDirectories) {\n if (!CreateOrEnsureDirectoryExists(base_dir_.Append(dir)))\n return false;\n }\n\n if (!CreateOrEnsureDirectoryExists(AttachmentsRootPath())) {\n return false;\n }\n\n // Do an xattr operation as the last step, to ensure the filesystem has\n // support for them. This xattr also serves as a marker for whether the\n // database uses old or new xattr names.\n bool value;\n if (ReadXattrBool(base_dir_,\n XattrNameInternal(kXattrDatabaseInitialized, true),\n &value) == XattrStatus::kOK &&\n value) {\n xattr_new_names_ = true;\n } else if (ReadXattrBool(base_dir_,\n XattrNameInternal(kXattrDatabaseInitialized, false),\n &value) == XattrStatus::kOK &&\n value) {\n xattr_new_names_ = false;\n } else {\n xattr_new_names_ = true;\n if (!WriteXattrBool(base_dir_, XattrName(kXattrDatabaseInitialized), true))\n return false;\n }\n\n INITIALIZATION_STATE_SET_VALID(initialized_);\n return true;\n}\n\nbase::FilePath CrashReportDatabaseMac::DatabasePath() {\n return base_dir_;\n}\n\nSettings* CrashReportDatabaseMac::GetSettings() {\n INITIALIZATION_STATE_DCHECK_VALID(initialized_);\n return &SettingsInternal();\n}\n\nCrashReportDatabase::OperationStatus\nCrashReportDatabaseMac::PrepareNewCrashReport(\n std::unique_ptr* out_report) {\n INITIALIZATION_STATE_DCHECK_VALID(initialized_);\n\n std::unique_ptr report(new NewReport());\n if (!report->Initialize(this,\n base_dir_.Append(kWriteDirectory),\n std::string(\".\") + kCrashReportFileExtension)) {\n return kFileSystemError;\n }\n\n // TODO(rsesek): Potentially use an fsetxattr() here instead.\n if (!WriteXattr(report->file_remover_.get(),\n XattrName(kXattrUUID),\n report->ReportID().ToString())) {\n return kDatabaseError;\n }\n\n out_report->reset(report.release());\n return kNoError;\n}\n\nCrashReportDatabase::OperationStatus\nCrashReportDatabaseMac::FinishedWritingCrashReport(\n std::unique_ptr report,\n UUID* uuid) {\n INITIALIZATION_STATE_DCHECK_VALID(initialized_);\n\n const base::FilePath& path = report->file_remover_.get();\n\n // Get the report's UUID to return.\n std::string uuid_string;\n if (ReadXattr(path, XattrName(kXattrUUID), &uuid_string) !=\n XattrStatus::kOK ||\n !uuid->InitializeFromString(uuid_string)) {\n LOG(ERROR) << \"Failed to read UUID for crash report \" << path.value();\n return kDatabaseError;\n }\n\n if (*uuid != report->ReportID()) {\n LOG(ERROR) << \"UUID mismatch for crash report \" << path.value();\n return kDatabaseError;\n }\n\n // Record the creation time of this report.\n if (!WriteXattrTimeT(path, XattrName(kXattrCreationTime), time(nullptr))) {\n return kDatabaseError;\n }\n\n FileOffset size = report->Writer()->Seek(0, SEEK_END);\n\n // Move the report to its new location for uploading.\n base::FilePath new_path =\n base_dir_.Append(kUploadPendingDirectory).Append(path.BaseName());\n if (rename(path.value().c_str(), new_path.value().c_str()) != 0) {\n PLOG(ERROR) << \"rename \" << path.value() << \" to \" << new_path.value();\n return kFileSystemError;\n }\n std::ignore = report->file_remover_.release();\n\n // Close all the attachments and disarm their removers too.\n for (auto& writer : report->attachment_writers_) {\n writer->Close();\n }\n for (auto& remover : report->attachment_removers_) {\n std::ignore = remover.release();\n }\n\n Metrics::CrashReportPending(Metrics::PendingReportReason::kNewlyCreated);\n Metrics::CrashReportSize(size);\n\n return kNoError;\n}\n\nCrashReportDatabase::OperationStatus\nCrashReportDatabaseMac::LookUpCrashReport(const UUID& uuid,\n CrashReportDatabase::Report* report) {\n INITIALIZATION_STATE_DCHECK_VALID(initialized_);\n\n base::FilePath path = LocateCrashReport(uuid, kReportStateAny);\n if (path.empty())\n return kReportNotFound;\n\n base::ScopedFD lock(ObtainReportLock(path));\n if (!lock.is_valid())\n return kBusyError;\n\n *report = Report();\n report->file_path = path;\n if (!ReadReportMetadataLocked(path, report))\n return kDatabaseError;\n\n return kNoError;\n}\n\nCrashReportDatabase::OperationStatus\nCrashReportDatabaseMac::GetPendingReports(\n std::vector* reports) {\n INITIALIZATION_STATE_DCHECK_VALID(initialized_);\n\n return ReportsInDirectory(base_dir_.Append(kUploadPendingDirectory), reports);\n}\n\nCrashReportDatabase::OperationStatus\nCrashReportDatabaseMac::GetCompletedReports(\n std::vector* reports) {\n INITIALIZATION_STATE_DCHECK_VALID(initialized_);\n\n return ReportsInDirectory(base_dir_.Append(kCompletedDirectory), reports);\n}\n\nCrashReportDatabase::OperationStatus\nCrashReportDatabaseMac::GetReportForUploading(\n const UUID& uuid,\n std::unique_ptr* report,\n bool report_metrics) {\n INITIALIZATION_STATE_DCHECK_VALID(initialized_);\n\n auto upload_report = std::make_unique();\n\n upload_report->file_path = LocateCrashReport(uuid, kReportStatePending);\n if (upload_report->file_path.empty())\n return kReportNotFound;\n\n base::ScopedFD lock(ObtainReportLock(upload_report->file_path));\n if (!lock.is_valid())\n return kBusyError;\n\n if (!ReadReportMetadataLocked(upload_report->file_path, upload_report.get()))\n return kDatabaseError;\n\n#if BUILDFLAG(IS_IOS)\n time_t upload_start_time = 0;\n if (ReadXattrTimeT(upload_report->file_path,\n XattrName(kXattrUploadStartTime),\n &upload_start_time) == XattrStatus::kOtherError) {\n return kDatabaseError;\n }\n\n time_t now = time(nullptr);\n if (upload_start_time) {\n // If we were able to ObtainReportLock but kXattrUploadStartTime is set,\n // either another client is uploading this report or a client was terminated\n // during an upload. CrashReportUploadThread sets the timeout to 20 seconds\n // for iOS. If kXattrUploadStartTime is less than 5 minutes ago, consider\n // the report locked and return kBusyError. Otherwise, consider the upload a\n // failure and skip the report.\n if (upload_start_time > now - 15 * internal::kUploadReportTimeoutSeconds) {\n return kBusyError;\n } else {\n // SkipReportUpload expects an unlocked report.\n lock.reset();\n CrashReportDatabase::OperationStatus os = SkipReportUpload(\n upload_report->uuid, Metrics::CrashSkippedReason::kUploadFailed);\n if (os != kNoError) {\n return kDatabaseError;\n }\n return kReportNotFound;\n }\n }\n\n if (!WriteXattrTimeT(\n upload_report->file_path, XattrName(kXattrUploadStartTime), now)) {\n return kDatabaseError;\n }\n#endif\n\n if (!upload_report->Initialize(upload_report->file_path, this)) {\n return kFileSystemError;\n }\n\n upload_report->database_ = this;\n#if !BUILDFLAG(IS_IOS)\n upload_report->lock_fd.reset(lock.release());\n#endif\n upload_report->report_metrics_ = report_metrics;\n report->reset(upload_report.release());\n return kNoError;\n}\n\nCrashReportDatabase::OperationStatus\nCrashReportDatabaseMac::RecordUploadAttempt(UploadReport* report,\n bool successful,\n const std::string& id) {\n INITIALIZATION_STATE_DCHECK_VALID(initialized_);\n\n if (report->report_metrics_) {\n Metrics::CrashUploadAttempted(successful);\n }\n\n DCHECK(report);\n DCHECK(successful || id.empty());\n\n base::FilePath report_path =\n LocateCrashReport(report->uuid, kReportStatePending);\n if (report_path.empty())\n return kReportNotFound;\n\n if (successful) {\n CrashReportDatabase::OperationStatus os =\n MarkReportCompletedLocked(report_path, &report_path);\n if (os != kNoError)\n return os;\n }\n\n#if BUILDFLAG(IS_IOS)\n if (RemoveXattr(report_path, XattrName(kXattrUploadStartTime)) ==\n XattrStatus::kOtherError) {\n return kDatabaseError;\n }\n#endif\n\n if (!WriteXattrBool(report_path, XattrName(kXattrIsUploaded), successful)) {\n return kDatabaseError;\n }\n if (!WriteXattr(report_path, XattrName(kXattrCollectorID), id)) {\n return kDatabaseError;\n }\n\n time_t now = time(nullptr);\n if (!WriteXattrTimeT(report_path, XattrName(kXattrLastUploadTime), now)) {\n return kDatabaseError;\n }\n\n int upload_attempts = 0;\n std::string name = XattrName(kXattrUploadAttemptCount);\n if (ReadXattrInt(report_path, name, &upload_attempts) ==\n XattrStatus::kOtherError) {\n return kDatabaseError;\n }\n if (!WriteXattrInt(report_path, name, ++upload_attempts)) {\n return kDatabaseError;\n }\n\n if (!SettingsInternal().SetLastUploadAttemptTime(now)) {\n return kDatabaseError;\n }\n\n return kNoError;\n}\n\nCrashReportDatabase::OperationStatus CrashReportDatabaseMac::SkipReportUpload(\n const UUID& uuid,\n Metrics::CrashSkippedReason reason) {\n INITIALIZATION_STATE_DCHECK_VALID(initialized_);\n\n Metrics::CrashUploadSkipped(reason);\n\n base::FilePath report_path = LocateCrashReport(uuid, kReportStatePending);\n if (report_path.empty())\n return kReportNotFound;\n\n base::ScopedFD lock(ObtainReportLock(report_path));\n if (!lock.is_valid())\n return kBusyError;\n\n#if BUILDFLAG(IS_IOS)\n if (RemoveXattr(report_path, XattrName(kXattrUploadStartTime)) ==\n XattrStatus::kOtherError) {\n return kDatabaseError;\n }\n#endif\n\n return MarkReportCompletedLocked(report_path, nullptr);\n}\n\nCrashReportDatabase::OperationStatus CrashReportDatabaseMac::DeleteReport(\n const UUID& uuid) {\n INITIALIZATION_STATE_DCHECK_VALID(initialized_);\n\n base::FilePath report_path = LocateCrashReport(uuid, kReportStateAny);\n if (report_path.empty())\n return kReportNotFound;\n\n base::ScopedFD lock(ObtainReportLock(report_path));\n if (!lock.is_valid())\n return kBusyError;\n\n if (unlink(report_path.value().c_str()) != 0) {\n PLOG(ERROR) << \"unlink \" << report_path.value();\n return kFileSystemError;\n }\n\n RemoveAttachmentsByUUID(uuid);\n\n return kNoError;\n}\n\nbase::FilePath CrashReportDatabaseMac::LocateCrashReport(\n const UUID& uuid,\n uint8_t desired_state) {\n const std::string target_uuid = uuid.ToString();\n\n std::vector report_directories;\n if (desired_state & kReportStateWrite) {\n report_directories.push_back(kWriteDirectory);\n }\n if (desired_state & kReportStatePending) {\n report_directories.push_back(kUploadPendingDirectory);\n }\n if (desired_state & kReportStateCompleted) {\n report_directories.push_back(kCompletedDirectory);\n }\n\n for (const std::string& report_directory : report_directories) {\n base::FilePath path =\n base_dir_.Append(report_directory)\n .Append(target_uuid + \".\" + kCrashReportFileExtension);\n\n // Test if the path exists.\n struct stat st;\n if (lstat(path.value().c_str(), &st)) {\n continue;\n }\n\n // Check that the UUID of the report matches.\n std::string uuid_string;\n if (ReadXattr(path, XattrName(kXattrUUID),\n &uuid_string) == XattrStatus::kOK &&\n uuid_string == target_uuid) {\n return path;\n }\n }\n\n return base::FilePath();\n}\n\nCrashReportDatabase::OperationStatus CrashReportDatabaseMac::RequestUpload(\n const UUID& uuid) {\n INITIALIZATION_STATE_DCHECK_VALID(initialized_);\n\n base::FilePath report_path =\n LocateCrashReport(uuid, kReportStatePending | kReportStateCompleted);\n if (report_path.empty())\n return kReportNotFound;\n\n base::ScopedFD lock(ObtainReportLock(report_path));\n if (!lock.is_valid())\n return kBusyError;\n\n // If the crash report has already been uploaded, don't request new upload.\n bool uploaded = false;\n XattrStatus status =\n ReadXattrBool(report_path, XattrName(kXattrIsUploaded), &uploaded);\n if (status == XattrStatus::kOtherError)\n return kDatabaseError;\n if (uploaded)\n return kCannotRequestUpload;\n\n // Mark the crash report as having upload explicitly requested by the user,\n // and move it to the pending state.\n if (!WriteXattrBool(\n report_path, XattrName(kXattrIsUploadExplicitlyRequested), true)) {\n return kDatabaseError;\n }\n\n base::FilePath new_path =\n base_dir_.Append(kUploadPendingDirectory).Append(report_path.BaseName());\n if (rename(report_path.value().c_str(), new_path.value().c_str()) != 0) {\n PLOG(ERROR) << \"rename \" << report_path.value() << \" to \"\n << new_path.value();\n return kFileSystemError;\n }\n\n Metrics::CrashReportPending(Metrics::PendingReportReason::kUserInitiated);\n\n return kNoError;\n}\n\nint CrashReportDatabaseMac::CleanDatabase(time_t lockfile_ttl) {\n int removed = 0;\n time_t now = time(nullptr);\n\n DirectoryReader reader;\n const base::FilePath new_dir(base_dir_.Append(kWriteDirectory));\n if (reader.Open(new_dir)) {\n base::FilePath filename;\n DirectoryReader::Result result;\n while ((result = reader.NextFile(&filename)) ==\n DirectoryReader::Result::kSuccess) {\n const base::FilePath filepath(new_dir.Append(filename));\n timespec filetime;\n if (!FileModificationTime(filepath, &filetime)) {\n continue;\n }\n if (filetime.tv_sec <= now - lockfile_ttl) {\n if (LoggingRemoveFile(filepath)) {\n ++removed;\n }\n }\n }\n }\n\n CleanOrphanedAttachments();\n return removed;\n}\n\n// static\nbase::ScopedFD CrashReportDatabaseMac::ObtainReportLock(\n const base::FilePath& path) {\n int fd = HANDLE_EINTR(\n open(path.value().c_str(),\n O_RDONLY | O_NONBLOCK | O_EXLOCK | O_NOCTTY | O_CLOEXEC));\n PLOG_IF(ERROR, fd < 0) << \"open lock \" << path.value();\n return base::ScopedFD(fd);\n}\n\nbool CrashReportDatabaseMac::ReadReportMetadataLocked(\n const base::FilePath& path, Report* report) {\n std::string uuid_string;\n if (ReadXattr(path, XattrName(kXattrUUID),\n &uuid_string) != XattrStatus::kOK ||\n !report->uuid.InitializeFromString(uuid_string)) {\n return false;\n }\n\n if (ReadXattrTimeT(path, XattrName(kXattrCreationTime),\n &report->creation_time) != XattrStatus::kOK) {\n return false;\n }\n\n report->id = std::string();\n if (ReadXattr(path, XattrName(kXattrCollectorID),\n &report->id) == XattrStatus::kOtherError) {\n return false;\n }\n\n report->uploaded = false;\n if (ReadXattrBool(path, XattrName(kXattrIsUploaded),\n &report->uploaded) == XattrStatus::kOtherError) {\n return false;\n }\n\n report->last_upload_attempt_time = 0;\n if (ReadXattrTimeT(path, XattrName(kXattrLastUploadTime),\n &report->last_upload_attempt_time) ==\n XattrStatus::kOtherError) {\n return false;\n }\n\n report->upload_attempts = 0;\n if (ReadXattrInt(path, XattrName(kXattrUploadAttemptCount),\n &report->upload_attempts) == XattrStatus::kOtherError) {\n return false;\n }\n\n report->upload_explicitly_requested = false;\n if (ReadXattrBool(path,\n XattrName(kXattrIsUploadExplicitlyRequested),\n &report->upload_explicitly_requested) ==\n XattrStatus::kOtherError) {\n return false;\n }\n\n // Seed the total size with the main report size and then add the sizes of any\n // potential attachments.\n uint64_t total_size = GetFileSize(path);\n total_size += GetDirectorySize(AttachmentsPath(report->uuid));\n report->total_size = total_size;\n\n return true;\n}\n\nCrashReportDatabase::OperationStatus CrashReportDatabaseMac::ReportsInDirectory(\n const base::FilePath& path,\n std::vector* reports) {\n base::apple::ScopedNSAutoreleasePool pool;\n\n DCHECK(reports->empty());\n\n NSError* error = nil;\n NSArray* paths = [[NSFileManager defaultManager]\n contentsOfDirectoryAtPath:base::SysUTF8ToNSString(path.value())\n error:&error];\n if (error) {\n LOG(ERROR) << \"Failed to enumerate reports in directory \" << path.value()\n << \": \" << [[error description] UTF8String];\n return kFileSystemError;\n }\n\n reports->reserve([paths count]);\n for (NSString* entry in paths) {\n Report report;\n report.file_path = path.Append([entry fileSystemRepresentation]);\n base::ScopedFD lock(ObtainReportLock(report.file_path));\n if (!lock.is_valid())\n continue;\n\n if (!ReadReportMetadataLocked(report.file_path, &report)) {\n LOG(WARNING) << \"Failed to read report metadata for \"\n << report.file_path.value();\n continue;\n }\n reports->push_back(report);\n }\n\n return kNoError;\n}\n\nstd::string CrashReportDatabaseMac::XattrName(std::string_view name) {\n return XattrNameInternal(name, xattr_new_names_);\n}\n\nCrashReportDatabase::OperationStatus\nCrashReportDatabaseMac::MarkReportCompletedLocked(\n const base::FilePath& report_path,\n base::FilePath* out_path) {\n if (RemoveXattr(report_path, XattrName(kXattrIsUploadExplicitlyRequested)) ==\n XattrStatus::kOtherError) {\n return kDatabaseError;\n }\n\n base::FilePath new_path =\n base_dir_.Append(kCompletedDirectory).Append(report_path.BaseName());\n if (rename(report_path.value().c_str(), new_path.value().c_str()) != 0) {\n PLOG(ERROR) << \"rename \" << report_path.value() << \" to \"\n << new_path.value();\n return kFileSystemError;\n }\n\n if (out_path)\n *out_path = new_path;\n return kNoError;\n}\n\nvoid CrashReportDatabaseMac::CleanOrphanedAttachments() {\n base::FilePath root_attachments_dir(AttachmentsRootPath());\n DirectoryReader reader;\n if (!reader.Open(root_attachments_dir)) {\n return;\n }\n\n base::FilePath filename;\n DirectoryReader::Result result;\n while ((result = reader.NextFile(&filename)) ==\n DirectoryReader::Result::kSuccess) {\n const base::FilePath report_attachment_dir(\n root_attachments_dir.Append(filename));\n if (IsDirectory(report_attachment_dir, false)) {\n UUID uuid;\n if (!uuid.InitializeFromString(filename.value())) {\n LOG(ERROR) << \"unexpected attachment dir name \" << filename.value();\n continue;\n }\n\n // Check to see if the report is being created in \"new\".\n base::FilePath new_dir_path =\n base_dir_.Append(kWriteDirectory)\n .Append(uuid.ToString() + \".\" + kCrashReportFileExtension);\n if (IsRegularFile(new_dir_path)) {\n continue;\n }\n\n // Check to see if the report is in \"pending\" or \"completed\".\n base::FilePath local_path =\n LocateCrashReport(uuid, kReportStatePending | kReportStateCompleted);\n if (!local_path.empty()) {\n continue;\n }\n\n // Couldn't find a report, assume these attachments are orphaned.\n RemoveAttachmentsByUUID(uuid);\n }\n }\n}\n\nnamespace {\n\nstd::unique_ptr InitializeInternal(\n const base::FilePath& path,\n bool may_create) {\n std::unique_ptr database_mac(\n new CrashReportDatabaseMac(path));\n if (!database_mac->Initialize(may_create))\n database_mac.reset();\n\n return std::unique_ptr(database_mac.release());\n}\n\n} // namespace\n\n// static\nstd::unique_ptr CrashReportDatabase::Initialize(\n const base::FilePath& path) {\n return InitializeInternal(path, true);\n}\n\n// static\nstd::unique_ptr\nCrashReportDatabase::InitializeWithoutCreating(const base::FilePath& path) {\n return InitializeInternal(path, false);\n}\n\n// static\nstd::unique_ptr\nCrashReportDatabase::GetSettingsReaderForDatabasePath(\n const base::FilePath& path) {\n return std::make_unique(path.Append(kSettings));\n}\n\n} // namespace crashpad\n" }, { "path": "client/crash_report_database_test.cc", "content": "// Copyright 2015 The Crashpad Authors\n//\n// Licensed under the Apache License, Version 2.0 (the \"License\");\n// you may not use this file except in compliance with the License.\n// You may obtain a copy of the License at\n//\n// http://www.apache.org/licenses/LICENSE-2.0\n//\n// Unless required by applicable law or agreed to in writing, software\n// distributed under the License is distributed on an \"AS IS\" BASIS,\n// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n// See the License for the specific language governing permissions and\n// limitations under the License.\n\n#include \"client/crash_report_database.h\"\n\n#include \"build/build_config.h\"\n#include \"client/settings.h\"\n#include \"gtest/gtest.h\"\n#include \"test/errors.h\"\n#include \"test/file.h\"\n#include \"test/filesystem.h\"\n#include \"test/scoped_temp_dir.h\"\n#include \"util/file/file_io.h\"\n#include \"util/file/filesystem.h\"\n\n#if BUILDFLAG(IS_IOS)\n#include \"util/mac/xattr.h\"\n#endif\n\nnamespace crashpad {\nnamespace test {\nnamespace {\n\nclass CrashReportDatabaseTest : public testing::Test {\n public:\n CrashReportDatabaseTest() {}\n\n CrashReportDatabaseTest(const CrashReportDatabaseTest&) = delete;\n CrashReportDatabaseTest& operator=(const CrashReportDatabaseTest&) = delete;\n\n protected:\n // testing::Test:\n void SetUp() override {\n db_ = CrashReportDatabase::Initialize(path());\n ASSERT_TRUE(db_);\n }\n\n void ResetDatabase() { db_.reset(); }\n\n CrashReportDatabase* db() { return db_.get(); }\n base::FilePath path() const {\n return temp_dir_.path().Append(FILE_PATH_LITERAL(\"crashpad_test_database\"));\n }\n\n void CreateCrashReport(CrashReportDatabase::Report* report) {\n std::unique_ptr new_report;\n ASSERT_EQ(db_->PrepareNewCrashReport(&new_report),\n CrashReportDatabase::kNoError);\n static constexpr char kTest[] = \"test\";\n ASSERT_TRUE(new_report->Writer()->Write(kTest, sizeof(kTest)));\n\n char contents[sizeof(kTest)];\n FileReaderInterface* reader = new_report->Reader();\n ASSERT_TRUE(reader->ReadExactly(contents, sizeof(contents)));\n EXPECT_EQ(memcmp(contents, kTest, sizeof(contents)), 0);\n EXPECT_EQ(reader->ReadExactly(contents, 1), 0);\n\n UUID uuid;\n EXPECT_EQ(db_->FinishedWritingCrashReport(std::move(new_report), &uuid),\n CrashReportDatabase::kNoError);\n\n EXPECT_EQ(db_->LookUpCrashReport(uuid, report),\n CrashReportDatabase::kNoError);\n ExpectPreparedCrashReport(*report);\n }\n\n void UploadReport(const UUID& uuid, bool successful, const std::string& id) {\n Settings* const settings = db_->GetSettings();\n ASSERT_TRUE(settings);\n time_t times[2];\n ASSERT_TRUE(settings->GetLastUploadAttemptTime(×[0]));\n\n std::unique_ptr report;\n ASSERT_EQ(db_->GetReportForUploading(uuid, &report),\n CrashReportDatabase::kNoError);\n EXPECT_NE(report->uuid, UUID());\n EXPECT_FALSE(report->file_path.empty());\n EXPECT_TRUE(FileExists(report->file_path)) << report->file_path.value();\n EXPECT_GT(report->creation_time, 0);\n if (successful) {\n EXPECT_EQ(db_->RecordUploadComplete(std::move(report), id),\n CrashReportDatabase::kNoError);\n } else {\n report.reset();\n }\n\n ASSERT_TRUE(settings->GetLastUploadAttemptTime(×[1]));\n EXPECT_NE(times[1], 0);\n EXPECT_GE(times[1], times[0]);\n }\n\n void ExpectPreparedCrashReport(const CrashReportDatabase::Report& report) {\n EXPECT_NE(report.uuid, UUID());\n EXPECT_FALSE(report.file_path.empty());\n EXPECT_TRUE(FileExists(report.file_path)) << report.file_path.value();\n EXPECT_TRUE(report.id.empty());\n EXPECT_GT(report.creation_time, 0);\n EXPECT_FALSE(report.uploaded);\n EXPECT_EQ(report.last_upload_attempt_time, 0);\n EXPECT_EQ(report.upload_attempts, 0);\n EXPECT_FALSE(report.upload_explicitly_requested);\n EXPECT_GE(report.total_size, 0u);\n }\n\n void RelocateDatabase() {\n ResetDatabase();\n temp_dir_.Rename();\n SetUp();\n }\n\n CrashReportDatabase::OperationStatus RequestUpload(const UUID& uuid) {\n CrashReportDatabase::OperationStatus os = db()->RequestUpload(uuid);\n\n CrashReportDatabase::Report report;\n EXPECT_EQ(db_->LookUpCrashReport(uuid, &report),\n CrashReportDatabase::kNoError);\n\n return os;\n }\n\n private:\n ScopedTempDir temp_dir_;\n std::unique_ptr db_;\n};\n\nTEST_F(CrashReportDatabaseTest, Initialize) {\n // Initialize the database for the first time, creating it.\n ASSERT_TRUE(db());\n\n Settings* settings = db()->GetSettings();\n\n UUID client_ids[3];\n ASSERT_TRUE(settings->GetClientID(&client_ids[0]));\n EXPECT_NE(client_ids[0], UUID());\n\n time_t last_upload_attempt_time;\n ASSERT_TRUE(settings->GetLastUploadAttemptTime(&last_upload_attempt_time));\n EXPECT_EQ(last_upload_attempt_time, 0);\n\n // Close and reopen the database at the same path.\n ResetDatabase();\n EXPECT_FALSE(db());\n auto db = CrashReportDatabase::InitializeWithoutCreating(path());\n ASSERT_TRUE(db);\n\n settings = db->GetSettings();\n\n ASSERT_TRUE(settings->GetClientID(&client_ids[1]));\n EXPECT_EQ(client_ids[1], client_ids[0]);\n\n ASSERT_TRUE(settings->GetLastUploadAttemptTime(&last_upload_attempt_time));\n EXPECT_EQ(last_upload_attempt_time, 0);\n\n // Check that the database can also be opened by the method that is permitted\n // to create it.\n db = CrashReportDatabase::Initialize(path());\n ASSERT_TRUE(db);\n\n settings = db->GetSettings();\n\n ASSERT_TRUE(settings->GetClientID(&client_ids[2]));\n EXPECT_EQ(client_ids[2], client_ids[0]);\n\n ASSERT_TRUE(settings->GetLastUploadAttemptTime(&last_upload_attempt_time));\n EXPECT_EQ(last_upload_attempt_time, 0);\n\n std::vector reports;\n EXPECT_EQ(db->GetPendingReports(&reports), CrashReportDatabase::kNoError);\n EXPECT_TRUE(reports.empty());\n reports.clear();\n EXPECT_EQ(db->GetCompletedReports(&reports), CrashReportDatabase::kNoError);\n EXPECT_TRUE(reports.empty());\n\n // InitializeWithoutCreating() shouldn’t create a nonexistent database.\n base::FilePath non_database_path =\n path().DirName().Append(FILE_PATH_LITERAL(\"not_a_database\"));\n db = CrashReportDatabase::InitializeWithoutCreating(non_database_path);\n EXPECT_FALSE(db);\n}\n\nTEST_F(CrashReportDatabaseTest, Settings) {\n // Initialize three databases and ensure settings.dat isn't created yet.\n ASSERT_TRUE(db());\n\n base::FilePath settings_path =\n path().Append(FILE_PATH_LITERAL(\"settings.dat\"));\n EXPECT_FALSE(FileExists(settings_path));\n\n std::unique_ptr db2 =\n CrashReportDatabase::Initialize(path());\n ASSERT_TRUE(db2);\n EXPECT_FALSE(FileExists(settings_path));\n\n std::unique_ptr db3 =\n CrashReportDatabase::Initialize(path());\n ASSERT_TRUE(db3);\n EXPECT_FALSE(FileExists(settings_path));\n\n // Ensure settings.dat exists after getter.\n Settings* settings = db3->GetSettings();\n ASSERT_TRUE(settings);\n EXPECT_TRUE(FileExists(settings_path));\n\n time_t last_upload_attempt_time = 42;\n ASSERT_TRUE(settings->SetLastUploadAttemptTime(last_upload_attempt_time));\n\n // Ensure the first two databases read the same value.\n ASSERT_TRUE(\n db2->GetSettings()->GetLastUploadAttemptTime(&last_upload_attempt_time));\n EXPECT_EQ(last_upload_attempt_time, 42);\n ASSERT_TRUE(\n db()->GetSettings()->GetLastUploadAttemptTime(&last_upload_attempt_time));\n EXPECT_EQ(last_upload_attempt_time, 42);\n}\n\nTEST_F(CrashReportDatabaseTest, NewCrashReport) {\n std::unique_ptr new_report;\n EXPECT_EQ(db()->PrepareNewCrashReport(&new_report),\n CrashReportDatabase::kNoError);\n UUID expect_uuid = new_report->ReportID();\n UUID uuid;\n EXPECT_EQ(db()->FinishedWritingCrashReport(std::move(new_report), &uuid),\n CrashReportDatabase::kNoError);\n EXPECT_EQ(uuid, expect_uuid);\n\n CrashReportDatabase::Report report;\n EXPECT_EQ(db()->LookUpCrashReport(uuid, &report),\n CrashReportDatabase::kNoError);\n ExpectPreparedCrashReport(report);\n\n std::vector reports;\n EXPECT_EQ(db()->GetPendingReports(&reports), CrashReportDatabase::kNoError);\n ASSERT_EQ(reports.size(), 1u);\n EXPECT_EQ(reports[0].uuid, report.uuid);\n\n reports.clear();\n EXPECT_EQ(db()->GetCompletedReports(&reports), CrashReportDatabase::kNoError);\n EXPECT_TRUE(reports.empty());\n}\n\nTEST_F(CrashReportDatabaseTest, LookUpCrashReport) {\n UUID uuid;\n\n {\n CrashReportDatabase::Report report;\n CreateCrashReport(&report);\n uuid = report.uuid;\n }\n\n {\n CrashReportDatabase::Report report;\n EXPECT_EQ(db()->LookUpCrashReport(uuid, &report),\n CrashReportDatabase::kNoError);\n EXPECT_EQ(report.uuid, uuid);\n EXPECT_NE(report.file_path.value().find(path().value()), std::string::npos);\n EXPECT_EQ(report.id, std::string());\n EXPECT_FALSE(report.uploaded);\n EXPECT_EQ(report.last_upload_attempt_time, 0);\n EXPECT_EQ(report.upload_attempts, 0);\n EXPECT_FALSE(report.upload_explicitly_requested);\n }\n\n UploadReport(uuid, true, \"test\");\n\n {\n CrashReportDatabase::Report report;\n EXPECT_EQ(db()->LookUpCrashReport(uuid, &report),\n CrashReportDatabase::kNoError);\n EXPECT_EQ(report.uuid, uuid);\n EXPECT_NE(report.file_path.value().find(path().value()), std::string::npos);\n EXPECT_EQ(report.id, \"test\");\n EXPECT_TRUE(report.uploaded);\n EXPECT_NE(report.last_upload_attempt_time, 0);\n EXPECT_EQ(report.upload_attempts, 1);\n EXPECT_FALSE(report.upload_explicitly_requested);\n }\n}\n\nTEST_F(CrashReportDatabaseTest, RecordUploadAttempt) {\n std::vector reports(3);\n CreateCrashReport(&reports[0]);\n CreateCrashReport(&reports[1]);\n CreateCrashReport(&reports[2]);\n\n // Record two attempts: one successful, one not.\n UploadReport(reports[1].uuid, false, std::string());\n UploadReport(reports[2].uuid, true, \"abc123\");\n\n std::vector query(3);\n EXPECT_EQ(db()->LookUpCrashReport(reports[0].uuid, &query[0]),\n CrashReportDatabase::kNoError);\n EXPECT_EQ(db()->LookUpCrashReport(reports[1].uuid, &query[1]),\n CrashReportDatabase::kNoError);\n EXPECT_EQ(db()->LookUpCrashReport(reports[2].uuid, &query[2]),\n CrashReportDatabase::kNoError);\n\n EXPECT_EQ(query[0].id, std::string());\n EXPECT_EQ(query[1].id, std::string());\n EXPECT_EQ(query[2].id, \"abc123\");\n\n EXPECT_FALSE(query[0].uploaded);\n EXPECT_FALSE(query[1].uploaded);\n EXPECT_TRUE(query[2].uploaded);\n\n EXPECT_EQ(query[0].last_upload_attempt_time, 0);\n EXPECT_NE(query[1].last_upload_attempt_time, 0);\n EXPECT_NE(query[2].last_upload_attempt_time, 0);\n\n EXPECT_EQ(query[0].upload_attempts, 0);\n EXPECT_EQ(query[1].upload_attempts, 1);\n EXPECT_EQ(query[2].upload_attempts, 1);\n\n // Attempt to upload and fail again.\n UploadReport(reports[1].uuid, false, std::string());\n\n time_t report_2_upload_time = query[2].last_upload_attempt_time;\n\n EXPECT_EQ(db()->LookUpCrashReport(reports[0].uuid, &query[0]),\n CrashReportDatabase::kNoError);\n EXPECT_EQ(db()->LookUpCrashReport(reports[1].uuid, &query[1]),\n CrashReportDatabase::kNoError);\n EXPECT_EQ(db()->LookUpCrashReport(reports[2].uuid, &query[2]),\n CrashReportDatabase::kNoError);\n\n EXPECT_FALSE(query[0].uploaded);\n EXPECT_FALSE(query[1].uploaded);\n EXPECT_TRUE(query[2].uploaded);\n\n EXPECT_EQ(query[0].last_upload_attempt_time, 0);\n EXPECT_GE(query[1].last_upload_attempt_time, report_2_upload_time);\n EXPECT_EQ(query[2].last_upload_attempt_time, report_2_upload_time);\n\n EXPECT_EQ(query[0].upload_attempts, 0);\n EXPECT_EQ(query[1].upload_attempts, 2);\n EXPECT_EQ(query[2].upload_attempts, 1);\n\n // Third time's the charm: upload and succeed.\n UploadReport(reports[1].uuid, true, \"666hahaha\");\n\n time_t report_1_upload_time = query[1].last_upload_attempt_time;\n\n EXPECT_EQ(db()->LookUpCrashReport(reports[0].uuid, &query[0]),\n CrashReportDatabase::kNoError);\n EXPECT_EQ(db()->LookUpCrashReport(reports[1].uuid, &query[1]),\n CrashReportDatabase::kNoError);\n EXPECT_EQ(db()->LookUpCrashReport(reports[2].uuid, &query[2]),\n CrashReportDatabase::kNoError);\n\n EXPECT_FALSE(query[0].uploaded);\n EXPECT_TRUE(query[1].uploaded);\n EXPECT_TRUE(query[2].uploaded);\n\n EXPECT_EQ(query[0].last_upload_attempt_time, 0);\n EXPECT_GE(query[1].last_upload_attempt_time, report_1_upload_time);\n EXPECT_EQ(query[2].last_upload_attempt_time, report_2_upload_time);\n\n EXPECT_EQ(query[0].upload_attempts, 0);\n EXPECT_EQ(query[1].upload_attempts, 3);\n EXPECT_EQ(query[2].upload_attempts, 1);\n}\n\n// This test covers both query functions since they are related.\nTEST_F(CrashReportDatabaseTest, GetCompletedAndNotUploadedReports) {\n std::vector reports(5);\n CreateCrashReport(&reports[0]);\n CreateCrashReport(&reports[1]);\n CreateCrashReport(&reports[2]);\n CreateCrashReport(&reports[3]);\n CreateCrashReport(&reports[4]);\n\n const UUID& report_0_uuid = reports[0].uuid;\n const UUID& report_1_uuid = reports[1].uuid;\n const UUID& report_2_uuid = reports[2].uuid;\n const UUID& report_3_uuid = reports[3].uuid;\n const UUID& report_4_uuid = reports[4].uuid;\n\n std::vector pending;\n EXPECT_EQ(db()->GetPendingReports(&pending), CrashReportDatabase::kNoError);\n\n std::vector completed;\n EXPECT_EQ(db()->GetCompletedReports(&completed),\n CrashReportDatabase::kNoError);\n\n EXPECT_EQ(pending.size(), reports.size());\n EXPECT_EQ(completed.size(), 0u);\n\n // Upload one report successfully.\n UploadReport(report_1_uuid, true, \"report1\");\n\n pending.clear();\n EXPECT_EQ(db()->GetPendingReports(&pending), CrashReportDatabase::kNoError);\n completed.clear();\n EXPECT_EQ(db()->GetCompletedReports(&completed),\n CrashReportDatabase::kNoError);\n\n EXPECT_EQ(pending.size(), 4u);\n ASSERT_EQ(completed.size(), 1u);\n\n for (const auto& report : pending) {\n EXPECT_NE(report.uuid, report_1_uuid);\n EXPECT_FALSE(report.file_path.empty());\n }\n EXPECT_EQ(completed[0].uuid, report_1_uuid);\n EXPECT_EQ(completed[0].id, \"report1\");\n EXPECT_EQ(completed[0].uploaded, true);\n EXPECT_GT(completed[0].last_upload_attempt_time, 0);\n EXPECT_EQ(completed[0].upload_attempts, 1);\n\n // Fail to upload one report.\n UploadReport(report_2_uuid, false, std::string());\n\n pending.clear();\n EXPECT_EQ(db()->GetPendingReports(&pending), CrashReportDatabase::kNoError);\n completed.clear();\n EXPECT_EQ(db()->GetCompletedReports(&completed),\n CrashReportDatabase::kNoError);\n\n EXPECT_EQ(pending.size(), 4u);\n ASSERT_EQ(completed.size(), 1u);\n\n for (const auto& report : pending) {\n if (report.upload_attempts != 0) {\n EXPECT_EQ(report.uuid, report_2_uuid);\n EXPECT_GT(report.last_upload_attempt_time, 0);\n EXPECT_FALSE(report.uploaded);\n EXPECT_TRUE(report.id.empty());\n }\n EXPECT_FALSE(report.file_path.empty());\n }\n\n // Upload a second report.\n UploadReport(report_4_uuid, true, \"report_4\");\n\n pending.clear();\n EXPECT_EQ(db()->GetPendingReports(&pending), CrashReportDatabase::kNoError);\n completed.clear();\n EXPECT_EQ(db()->GetCompletedReports(&completed),\n CrashReportDatabase::kNoError);\n\n EXPECT_EQ(pending.size(), 3u);\n ASSERT_EQ(completed.size(), 2u);\n\n // Succeed the failed report.\n UploadReport(report_2_uuid, true, \"report 2\");\n\n pending.clear();\n EXPECT_EQ(db()->GetPendingReports(&pending), CrashReportDatabase::kNoError);\n completed.clear();\n EXPECT_EQ(db()->GetCompletedReports(&completed),\n CrashReportDatabase::kNoError);\n\n EXPECT_EQ(pending.size(), 2u);\n ASSERT_EQ(completed.size(), 3u);\n\n for (const auto& report : pending) {\n EXPECT_TRUE(report.uuid == report_0_uuid || report.uuid == report_3_uuid);\n EXPECT_FALSE(report.file_path.empty());\n }\n\n // Skip upload for one report.\n EXPECT_EQ(db()->SkipReportUpload(\n report_3_uuid, Metrics::CrashSkippedReason::kUploadsDisabled),\n CrashReportDatabase::kNoError);\n\n pending.clear();\n EXPECT_EQ(db()->GetPendingReports(&pending), CrashReportDatabase::kNoError);\n completed.clear();\n EXPECT_EQ(db()->GetCompletedReports(&completed),\n CrashReportDatabase::kNoError);\n\n ASSERT_EQ(pending.size(), 1u);\n ASSERT_EQ(completed.size(), 4u);\n\n EXPECT_EQ(pending[0].uuid, report_0_uuid);\n\n for (const auto& report : completed) {\n if (report.uuid == report_3_uuid) {\n EXPECT_FALSE(report.uploaded);\n EXPECT_EQ(report.upload_attempts, 0);\n EXPECT_EQ(report.last_upload_attempt_time, 0);\n } else {\n EXPECT_TRUE(report.uploaded);\n EXPECT_GT(report.upload_attempts, 0);\n EXPECT_GT(report.last_upload_attempt_time, 0);\n }\n EXPECT_FALSE(report.file_path.empty());\n }\n}\n\nTEST_F(CrashReportDatabaseTest, DuelingUploads) {\n CrashReportDatabase::Report report;\n CreateCrashReport(&report);\n\n std::unique_ptr upload_report;\n EXPECT_EQ(db()->GetReportForUploading(report.uuid, &upload_report),\n CrashReportDatabase::kNoError);\n\n std::unique_ptr upload_report_2;\n EXPECT_EQ(db()->GetReportForUploading(report.uuid, &upload_report_2),\n CrashReportDatabase::kBusyError);\n EXPECT_FALSE(upload_report_2);\n\n EXPECT_EQ(db()->RecordUploadComplete(std::move(upload_report), std::string()),\n CrashReportDatabase::kNoError);\n}\n\n#if BUILDFLAG(IS_IOS)\nTEST_F(CrashReportDatabaseTest, InterruptedIOSUploads) {\n CrashReportDatabase::Report report;\n CreateCrashReport(&report);\n\n std::unique_ptr upload_report;\n EXPECT_EQ(db()->GetReportForUploading(report.uuid, &upload_report),\n CrashReportDatabase::kNoError);\n\n // Set upload_start_time to 10 minutes ago.\n time_t ten_minutes_ago = time(nullptr) - 10 * 60;\n ASSERT_TRUE(\n WriteXattrTimeT(report.file_path,\n \"org.chromium.crashpad.database.upload_start_time\",\n ten_minutes_ago));\n\n std::vector reports;\n EXPECT_EQ(db()->GetPendingReports(&reports), CrashReportDatabase::kNoError);\n ASSERT_EQ(reports.size(), 1u);\n reports.clear();\n EXPECT_EQ(db()->GetCompletedReports(&reports), CrashReportDatabase::kNoError);\n EXPECT_TRUE(reports.empty());\n\n // Getting a stale report will automatically skip it.\n std::unique_ptr upload_report_2;\n EXPECT_EQ(db()->GetReportForUploading(report.uuid, &upload_report_2),\n CrashReportDatabase::kReportNotFound);\n EXPECT_FALSE(upload_report_2);\n\n // Confirm report was moved from pending to completed.\n EXPECT_EQ(db()->GetPendingReports(&reports), CrashReportDatabase::kNoError);\n EXPECT_TRUE(reports.empty());\n EXPECT_EQ(db()->GetCompletedReports(&reports), CrashReportDatabase::kNoError);\n ASSERT_EQ(reports.size(), 1u);\n\n EXPECT_EQ(db()->RecordUploadComplete(std::move(upload_report), std::string()),\n CrashReportDatabase::kReportNotFound);\n}\n#endif\n\nTEST_F(CrashReportDatabaseTest, UploadAlreadyUploaded) {\n CrashReportDatabase::Report report;\n CreateCrashReport(&report);\n\n std::unique_ptr upload_report;\n EXPECT_EQ(db()->GetReportForUploading(report.uuid, &upload_report),\n CrashReportDatabase::kNoError);\n EXPECT_EQ(db()->RecordUploadComplete(std::move(upload_report), std::string()),\n CrashReportDatabase::kNoError);\n\n std::unique_ptr upload_report_2;\n EXPECT_EQ(db()->GetReportForUploading(report.uuid, &upload_report_2),\n CrashReportDatabase::kReportNotFound);\n EXPECT_FALSE(upload_report_2.get());\n}\n\nTEST_F(CrashReportDatabaseTest, MoveDatabase) {\n std::unique_ptr new_report;\n EXPECT_EQ(db()->PrepareNewCrashReport(&new_report),\n CrashReportDatabase::kNoError);\n UUID uuid;\n EXPECT_EQ(db()->FinishedWritingCrashReport(std::move(new_report), &uuid),\n CrashReportDatabase::kNoError);\n\n RelocateDatabase();\n\n CrashReportDatabase::Report report;\n EXPECT_EQ(db()->LookUpCrashReport(uuid, &report),\n CrashReportDatabase::kNoError);\n ExpectPreparedCrashReport(report);\n}\n\nTEST_F(CrashReportDatabaseTest, ReportRemoved) {\n std::unique_ptr new_report;\n EXPECT_EQ(db()->PrepareNewCrashReport(&new_report),\n CrashReportDatabase::kNoError);\n\n UUID uuid;\n EXPECT_EQ(db()->FinishedWritingCrashReport(std::move(new_report), &uuid),\n CrashReportDatabase::kNoError);\n\n CrashReportDatabase::Report report;\n EXPECT_EQ(db()->LookUpCrashReport(uuid, &report),\n CrashReportDatabase::kNoError);\n\n EXPECT_TRUE(LoggingRemoveFile(report.file_path));\n\n EXPECT_EQ(db()->LookUpCrashReport(uuid, &report),\n CrashReportDatabase::kReportNotFound);\n}\n\nTEST_F(CrashReportDatabaseTest, DeleteReport) {\n CrashReportDatabase::Report keep_pending;\n CrashReportDatabase::Report delete_pending;\n CrashReportDatabase::Report keep_completed;\n CrashReportDatabase::Report delete_completed;\n\n CreateCrashReport(&keep_pending);\n CreateCrashReport(&delete_pending);\n CreateCrashReport(&keep_completed);\n CreateCrashReport(&delete_completed);\n\n EXPECT_TRUE(FileExists(keep_pending.file_path));\n EXPECT_TRUE(FileExists(delete_pending.file_path));\n EXPECT_TRUE(FileExists(keep_completed.file_path));\n EXPECT_TRUE(FileExists(delete_completed.file_path));\n\n UploadReport(keep_completed.uuid, true, \"1\");\n UploadReport(delete_completed.uuid, true, \"2\");\n\n EXPECT_EQ(db()->LookUpCrashReport(keep_completed.uuid, &keep_completed),\n CrashReportDatabase::kNoError);\n EXPECT_EQ(db()->LookUpCrashReport(delete_completed.uuid, &delete_completed),\n CrashReportDatabase::kNoError);\n\n EXPECT_TRUE(FileExists(keep_completed.file_path));\n EXPECT_TRUE(FileExists(delete_completed.file_path));\n\n EXPECT_EQ(db()->DeleteReport(delete_pending.uuid),\n CrashReportDatabase::kNoError);\n EXPECT_FALSE(FileExists(delete_pending.file_path));\n EXPECT_EQ(db()->LookUpCrashReport(delete_pending.uuid, &delete_pending),\n CrashReportDatabase::kReportNotFound);\n EXPECT_EQ(db()->DeleteReport(delete_pending.uuid),\n CrashReportDatabase::kReportNotFound);\n\n EXPECT_EQ(db()->DeleteReport(delete_completed.uuid),\n CrashReportDatabase::kNoError);\n EXPECT_FALSE(FileExists(delete_completed.file_path));\n EXPECT_EQ(db()->LookUpCrashReport(delete_completed.uuid, &delete_completed),\n CrashReportDatabase::kReportNotFound);\n EXPECT_EQ(db()->DeleteReport(delete_completed.uuid),\n CrashReportDatabase::kReportNotFound);\n\n EXPECT_EQ(db()->LookUpCrashReport(keep_pending.uuid, &keep_pending),\n CrashReportDatabase::kNoError);\n EXPECT_EQ(db()->LookUpCrashReport(keep_completed.uuid, &keep_completed),\n CrashReportDatabase::kNoError);\n}\n\nTEST_F(CrashReportDatabaseTest, DeleteReportEmptyingDatabase) {\n CrashReportDatabase::Report report;\n CreateCrashReport(&report);\n\n EXPECT_TRUE(FileExists(report.file_path));\n\n UploadReport(report.uuid, true, \"1\");\n\n EXPECT_EQ(db()->LookUpCrashReport(report.uuid, &report),\n CrashReportDatabase::kNoError);\n\n EXPECT_TRUE(FileExists(report.file_path));\n\n // This causes an empty database to be written, make sure this is handled.\n EXPECT_EQ(db()->DeleteReport(report.uuid), CrashReportDatabase::kNoError);\n EXPECT_FALSE(FileExists(report.file_path));\n}\n\nTEST_F(CrashReportDatabaseTest, ReadEmptyDatabase) {\n CrashReportDatabase::Report report;\n CreateCrashReport(&report);\n EXPECT_EQ(db()->DeleteReport(report.uuid), CrashReportDatabase::kNoError);\n\n // Deleting and the creating another report causes an empty database to be\n // loaded. Make sure this is handled.\n\n CrashReportDatabase::Report report2;\n CreateCrashReport(&report2);\n}\n\nTEST_F(CrashReportDatabaseTest, RequestUpload) {\n std::vector reports(2);\n CreateCrashReport(&reports[0]);\n CreateCrashReport(&reports[1]);\n\n const UUID& report_0_uuid = reports[0].uuid;\n const UUID& report_1_uuid = reports[1].uuid;\n\n // Skipped report gets back to pending state after RequestUpload is called.\n EXPECT_EQ(db()->SkipReportUpload(\n report_1_uuid, Metrics::CrashSkippedReason::kUploadsDisabled),\n CrashReportDatabase::kNoError);\n\n std::vector pending_reports;\n CrashReportDatabase::OperationStatus os =\n db()->GetPendingReports(&pending_reports);\n EXPECT_EQ(os, CrashReportDatabase::kNoError);\n ASSERT_EQ(pending_reports.size(), 1u);\n EXPECT_EQ(report_0_uuid, pending_reports[0].uuid);\n\n pending_reports.clear();\n EXPECT_EQ(RequestUpload(report_1_uuid), CrashReportDatabase::kNoError);\n os = db()->GetPendingReports(&pending_reports);\n EXPECT_EQ(os, CrashReportDatabase::kNoError);\n ASSERT_EQ(pending_reports.size(), 2u);\n\n // Check individual reports.\n const CrashReportDatabase::Report* explicitly_requested_report;\n const CrashReportDatabase::Report* pending_report;\n if (pending_reports[0].uuid == report_0_uuid) {\n pending_report = &pending_reports[0];\n explicitly_requested_report = &pending_reports[1];\n } else {\n pending_report = &pending_reports[1];\n explicitly_requested_report = &pending_reports[0];\n }\n\n EXPECT_EQ(pending_report->uuid, report_0_uuid);\n EXPECT_FALSE(pending_report->upload_explicitly_requested);\n\n EXPECT_EQ(explicitly_requested_report->uuid, report_1_uuid);\n EXPECT_TRUE(explicitly_requested_report->upload_explicitly_requested);\n\n // Explicitly requested reports will not have upload_explicitly_requested bit\n // after getting skipped.\n EXPECT_EQ(db()->SkipReportUpload(\n report_1_uuid, Metrics::CrashSkippedReason::kUploadsDisabled),\n CrashReportDatabase::kNoError);\n CrashReportDatabase::Report report;\n EXPECT_EQ(db()->LookUpCrashReport(report_1_uuid, &report),\n CrashReportDatabase::kNoError);\n EXPECT_FALSE(report.upload_explicitly_requested);\n\n // Pending report gets correctly affected after RequestUpload is called.\n pending_reports.clear();\n EXPECT_EQ(RequestUpload(report_0_uuid), CrashReportDatabase::kNoError);\n os = db()->GetPendingReports(&pending_reports);\n EXPECT_EQ(os, CrashReportDatabase::kNoError);\n EXPECT_EQ(pending_reports.size(), 1u);\n EXPECT_EQ(report_0_uuid, pending_reports[0].uuid);\n EXPECT_TRUE(pending_reports[0].upload_explicitly_requested);\n\n // Already uploaded report cannot be requested for the new upload.\n UploadReport(report_0_uuid, true, \"1\");\n EXPECT_EQ(RequestUpload(report_0_uuid),\n CrashReportDatabase::kCannotRequestUpload);\n}\n\nTEST_F(CrashReportDatabaseTest, Attachments) {\n std::unique_ptr new_report;\n ASSERT_EQ(db()->PrepareNewCrashReport(&new_report),\n CrashReportDatabase::kNoError);\n\n FileWriter* attach_some_file = new_report->AddAttachment(\"some_file\");\n ASSERT_NE(attach_some_file, nullptr);\n static constexpr char test_data[] = \"test data\";\n attach_some_file->Write(test_data, sizeof(test_data));\n\n FileWriter* failed_attach = new_report->AddAttachment(\"not/a valid fi!e\");\n EXPECT_EQ(failed_attach, nullptr);\n\n UUID expect_uuid = new_report->ReportID();\n UUID uuid;\n ASSERT_EQ(db()->FinishedWritingCrashReport(std::move(new_report), &uuid),\n CrashReportDatabase::kNoError);\n EXPECT_EQ(uuid, expect_uuid);\n\n CrashReportDatabase::Report report;\n EXPECT_EQ(db()->LookUpCrashReport(uuid, &report),\n CrashReportDatabase::kNoError);\n ExpectPreparedCrashReport(report);\n\n std::vector reports;\n EXPECT_EQ(db()->GetPendingReports(&reports), CrashReportDatabase::kNoError);\n ASSERT_EQ(reports.size(), 1u);\n EXPECT_EQ(reports[0].uuid, report.uuid);\n\n std::unique_ptr upload_report;\n ASSERT_EQ(db()->GetReportForUploading(reports[0].uuid, &upload_report),\n CrashReportDatabase::kNoError);\n std::map result_attachments =\n upload_report->GetAttachments();\n EXPECT_EQ(result_attachments.size(), 1u);\n EXPECT_NE(result_attachments.find(\"some_file\"), result_attachments.end());\n char result_buffer[sizeof(test_data)];\n result_attachments[\"some_file\"]->Read(result_buffer, sizeof(result_buffer));\n EXPECT_EQ(memcmp(test_data, result_buffer, sizeof(test_data)), 0);\n}\n\nTEST_F(CrashReportDatabaseTest, OrphanedAttachments) {\n std::unique_ptr new_report;\n ASSERT_EQ(db()->PrepareNewCrashReport(&new_report),\n CrashReportDatabase::kNoError);\n\n FileWriter* file1 = new_report->AddAttachment(\"file1\");\n ASSERT_NE(file1, nullptr);\n FileWriter* file2 = new_report->AddAttachment(\"file2\");\n ASSERT_NE(file2, nullptr);\n\n UUID expect_uuid = new_report->ReportID();\n UUID uuid;\n ASSERT_EQ(db()->FinishedWritingCrashReport(std::move(new_report), &uuid),\n CrashReportDatabase::kNoError);\n EXPECT_EQ(uuid, expect_uuid);\n\n#if BUILDFLAG(IS_WIN)\n const std::wstring uuid_string = uuid.ToWString();\n#else\n const std::string uuid_string = uuid.ToString();\n#endif\n const base::FilePath report_attachments_dir(\n path().Append(FILE_PATH_LITERAL(\"attachments\")).Append(uuid_string));\n const base::FilePath file_path1(\n report_attachments_dir.Append(FILE_PATH_LITERAL(\"file1\")));\n const base::FilePath file_path2(\n report_attachments_dir.Append(FILE_PATH_LITERAL(\"file2\")));\n\n CrashReportDatabase::Report report;\n ASSERT_EQ(db()->LookUpCrashReport(uuid, &report),\n CrashReportDatabase::kNoError);\n\n // Cleaning a consistent database does not remove the attachements.\n EXPECT_EQ(db()->CleanDatabase(0), 0);\n EXPECT_TRUE(FileExists(file_path1));\n EXPECT_TRUE(FileExists(file_path1));\n\n ASSERT_TRUE(LoggingRemoveFile(report.file_path));\n\n#if !BUILDFLAG(IS_APPLE) && !BUILDFLAG(IS_WIN)\n // CrashReportDatabaseMac stores metadata in xattrs and does not have .meta\n // files.\n // CrashReportDatabaseWin stores metadata in a global metadata file and not\n // per report.\n ASSERT_TRUE(LoggingRemoveFile(base::FilePath(\n report.file_path.RemoveFinalExtension().value() + \".meta\")));\n#endif\n\n ASSERT_EQ(db()->LookUpCrashReport(uuid, &report),\n CrashReportDatabase::kReportNotFound);\n\n EXPECT_TRUE(FileExists(file_path1));\n EXPECT_TRUE(FileExists(file_path1));\n\n#if BUILDFLAG(IS_WIN)\n // On Windows, reports removed from metadata are counted, even if the file\n // is not on the disk.\n EXPECT_EQ(db()->CleanDatabase(0), 1);\n#else\n EXPECT_EQ(db()->CleanDatabase(0), 0);\n#endif\n\n EXPECT_FALSE(FileExists(file_path1));\n EXPECT_FALSE(FileExists(file_path2));\n EXPECT_FALSE(FileExists(report_attachments_dir));\n}\n\n// This test uses knowledge of the database format to break it, so it only\n// applies to the unfified database implementation.\n#if !BUILDFLAG(IS_APPLE) && !BUILDFLAG(IS_WIN)\nTEST_F(CrashReportDatabaseTest, CleanBrokenDatabase) {\n // Remove report files if metadata goes missing.\n CrashReportDatabase::Report report;\n ASSERT_NO_FATAL_FAILURE(CreateCrashReport(&report));\n\n const base::FilePath metadata(\n report.file_path.RemoveFinalExtension().value() +\n FILE_PATH_LITERAL(\".meta\"));\n ASSERT_TRUE(PathExists(report.file_path));\n ASSERT_TRUE(PathExists(metadata));\n\n ASSERT_TRUE(LoggingRemoveFile(metadata));\n EXPECT_EQ(db()->CleanDatabase(0), 1);\n\n EXPECT_FALSE(PathExists(report.file_path));\n EXPECT_FALSE(PathExists(metadata));\n\n // Remove metadata files if reports go missing.\n ASSERT_NO_FATAL_FAILURE(CreateCrashReport(&report));\n const base::FilePath metadata2(\n report.file_path.RemoveFinalExtension().value() +\n FILE_PATH_LITERAL(\".meta\"));\n ASSERT_TRUE(PathExists(report.file_path));\n ASSERT_TRUE(PathExists(metadata2));\n\n ASSERT_TRUE(LoggingRemoveFile(report.file_path));\n EXPECT_EQ(db()->CleanDatabase(0), 1);\n\n EXPECT_FALSE(PathExists(report.file_path));\n EXPECT_FALSE(PathExists(metadata2));\n\n // Remove stale new files.\n std::unique_ptr new_report;\n EXPECT_EQ(db()->PrepareNewCrashReport(&new_report),\n CrashReportDatabase::kNoError);\n new_report->Writer()->Close();\n EXPECT_EQ(db()->CleanDatabase(0), 1);\n\n // Remove stale lock files and their associated reports.\n ASSERT_NO_FATAL_FAILURE(CreateCrashReport(&report));\n const base::FilePath metadata3(\n report.file_path.RemoveFinalExtension().value() +\n FILE_PATH_LITERAL(\".meta\"));\n ASSERT_TRUE(PathExists(report.file_path));\n ASSERT_TRUE(PathExists(metadata3));\n\n const base::FilePath lockpath(\n report.file_path.RemoveFinalExtension().value() +\n FILE_PATH_LITERAL(\".lock\"));\n ScopedFileHandle handle(LoggingOpenFileForWrite(\n lockpath, FileWriteMode::kCreateOrFail, FilePermissions::kOwnerOnly));\n ASSERT_TRUE(handle.is_valid());\n\n time_t expired_timestamp = time(nullptr) - 60 * 60 * 24 * 3;\n\n ASSERT_TRUE(LoggingWriteFile(\n handle.get(), &expired_timestamp, sizeof(expired_timestamp)));\n ASSERT_TRUE(LoggingCloseFile(handle.release()));\n\n EXPECT_EQ(db()->CleanDatabase(0), 1);\n\n EXPECT_FALSE(PathExists(report.file_path));\n EXPECT_FALSE(PathExists(metadata3));\n}\n#endif // !BUILDFLAG(IS_APPLE) && !BUILDFLAG(IS_WIN)\n\nTEST_F(CrashReportDatabaseTest, TotalSize_MainReportOnly) {\n std::unique_ptr new_report;\n ASSERT_EQ(db()->PrepareNewCrashReport(&new_report),\n CrashReportDatabase::kNoError);\n\n // Main report.\n static constexpr char main_report_data[] = \"dlbvandslhb\";\n ASSERT_TRUE(\n new_report->Writer()->Write(main_report_data, sizeof(main_report_data)));\n\n UUID uuid;\n ASSERT_EQ(db()->FinishedWritingCrashReport(std::move(new_report), &uuid),\n CrashReportDatabase::kNoError);\n\n CrashReportDatabase::Report report;\n ASSERT_EQ(db()->LookUpCrashReport(uuid, &report),\n CrashReportDatabase::kNoError);\n\n EXPECT_EQ(report.total_size, sizeof(main_report_data));\n}\n\nTEST_F(CrashReportDatabaseTest, GetReportSize_RightSizeWithAttachments) {\n std::unique_ptr new_report;\n ASSERT_EQ(db()->PrepareNewCrashReport(&new_report),\n CrashReportDatabase::kNoError);\n\n // Main report.\n static constexpr char main_report_data[] = \"dlbvandslhb\";\n ASSERT_TRUE(\n new_report->Writer()->Write(main_report_data, sizeof(main_report_data)));\n\n // First attachment.\n FileWriter* attachment_1 = new_report->AddAttachment(\"my_attachment_1\");\n ASSERT_NE(attachment_1, nullptr);\n static constexpr char attachment_1_data[] = \"vKDnidhvbiudshoihbvdsoiuh nhh\";\n attachment_1->Write(attachment_1_data, sizeof(attachment_1_data));\n\n // Second attachment.\n FileWriter* attachment_2 = new_report->AddAttachment(\"my_attachment_2\");\n ASSERT_NE(attachment_2, nullptr);\n static constexpr char attachment_2_data[] = \"sgvsvgusiyguysigfkhpmo-[\";\n attachment_2->Write(attachment_2_data, sizeof(attachment_2_data));\n\n UUID uuid;\n ASSERT_EQ(db()->FinishedWritingCrashReport(std::move(new_report), &uuid),\n CrashReportDatabase::kNoError);\n\n CrashReportDatabase::Report report;\n ASSERT_EQ(db()->LookUpCrashReport(uuid, &report),\n CrashReportDatabase::kNoError);\n EXPECT_EQ(report.total_size,\n sizeof(main_report_data) + sizeof(attachment_1_data) +\n sizeof(attachment_2_data));\n}\n\nTEST_F(CrashReportDatabaseTest, InitializeFromLargerFileRetainsClientId) {\n // Initialize the database for the first time, creating it.\n ASSERT_TRUE(db());\n\n const base::FilePath settings_path =\n path().Append(FILE_PATH_LITERAL(\"settings.dat\"));\n EXPECT_FALSE(FileExists(settings_path));\n\n Settings* settings = db()->GetSettings();\n ASSERT_TRUE(settings);\n EXPECT_TRUE(FileExists(settings_path));\n\n UUID client_id;\n ASSERT_TRUE(settings->GetClientID(&client_id));\n EXPECT_NE(client_id, UUID());\n\n // Close and reopen the database at the same path.\n ResetDatabase();\n EXPECT_FALSE(db());\n EXPECT_TRUE(FileExists(settings_path));\n\n // Append some data, to ensure that we can open settings even if a future\n // version has added additional field to Settings (forwards compatible).\n FileWriter settings_writer;\n ASSERT_TRUE(settings_writer.Open(\n settings_path, FileWriteMode::kReuseOrFail, FilePermissions::kOwnerOnly));\n ASSERT_NE(settings_writer.Seek(0, SEEK_END), 0);\n constexpr uint64_t extra_garbage = 0xBADF00D;\n ASSERT_TRUE(settings_writer.Write(&extra_garbage, sizeof(extra_garbage)));\n settings_writer.Close();\n\n auto db = CrashReportDatabase::InitializeWithoutCreating(path());\n ASSERT_TRUE(db);\n\n settings = db->GetSettings();\n ASSERT_TRUE(settings);\n\n // Make sure that the reopened settings retained the original client id and\n // wasn't recreated.\n UUID reopened_client_id;\n ASSERT_TRUE(settings->GetClientID(&reopened_client_id));\n EXPECT_EQ(client_id, reopened_client_id);\n}\n\n} // namespace\n} // namespace test\n} // namespace crashpad\n" }, { "path": "client/crash_report_database_win.cc", "content": "// Copyright 2015 The Crashpad Authors\n//\n// Licensed under the Apache License, Version 2.0 (the \"License\");\n// you may not use this file except in compliance with the License.\n// You may obtain a copy of the License at\n//\n// http://www.apache.org/licenses/LICENSE-2.0\n//\n// Unless required by applicable law or agreed to in writing, software\n// distributed under the License is distributed on an \"AS IS\" BASIS,\n// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n// See the License for the specific language governing permissions and\n// limitations under the License.\n\n#include \"client/crash_report_database.h\"\n\n#include \n#include \n#include \n#include \n#include \n#include \n\n#include \n#include \n#include \n\n#include \"base/check_op.h\"\n#include \"base/logging.h\"\n#include \"base/numerics/safe_math.h\"\n#include \"base/strings/utf_string_conversions.h\"\n#include \"client/settings.h\"\n#include \"util/file/directory_reader.h\"\n#include \"util/file/filesystem.h\"\n#include \"util/misc/implicit_cast.h\"\n#include \"util/misc/initialization_state_dcheck.h\"\n#include \"util/misc/metrics.h\"\n\nnamespace crashpad {\n\nnamespace {\n\nconstexpr wchar_t kReportsDirectory[] = L\"reports\";\nconstexpr wchar_t kMetadataFileName[] = L\"metadata\";\n\nconstexpr wchar_t kSettings[] = L\"settings.dat\";\n\nconstexpr wchar_t kCrashReportFileExtension[] = L\"dmp\";\n\nconstexpr uint32_t kMetadataFileHeaderMagic = 'CPAD';\nconstexpr uint32_t kMetadataFileVersion = 1;\n\nusing OperationStatus = CrashReportDatabase::OperationStatus;\n\n// Helpers ---------------------------------------------------------------------\n\n// Adds a string to the string table and returns the byte index where it was\n// added.\nuint32_t AddStringToTable(std::string* string_table, const std::string& str) {\n uint32_t offset = base::checked_cast(string_table->size());\n *string_table += str;\n *string_table += '\\0';\n return offset;\n}\n\n// Converts |str| to UTF8, adds the result to the string table and returns the\n// byte index where it was added.\nuint32_t AddStringToTable(std::string* string_table, const std::wstring& str) {\n return AddStringToTable(string_table, base::WideToUTF8(str));\n}\n\n// Reads from the current file position to EOF and returns as a string of bytes.\nstd::string ReadRestOfFileAsString(FileHandle file) {\n FileOffset read_from = LoggingSeekFile(file, 0, SEEK_CUR);\n FileOffset end = LoggingSeekFile(file, 0, SEEK_END);\n FileOffset original = LoggingSeekFile(file, read_from, SEEK_SET);\n if (read_from == -1 || end == -1 || original == -1 || read_from == end)\n return std::string();\n DCHECK_EQ(read_from, original);\n DCHECK_GT(end, read_from);\n size_t data_length = static_cast(end - read_from);\n std::string buffer(data_length, '\\0');\n return LoggingReadFileExactly(file, &buffer[0], data_length) ? buffer\n : std::string();\n}\n\nbool UUIDFromReportPath(const base::FilePath& path, UUID* uuid) {\n return uuid->InitializeFromString(\n path.RemoveFinalExtension().BaseName().value());\n}\n\n// Helper structures, and conversions ------------------------------------------\n\n// The format of the on disk metadata file is a MetadataFileHeader, followed by\n// a number of fixed size records of MetadataFileReportRecord, followed by a\n// string table in UTF8 format, where each string is \\0 terminated.\nstruct MetadataFileHeader {\n uint32_t magic;\n uint32_t version;\n uint32_t num_records;\n uint32_t padding;\n};\n\nstruct ReportDisk;\n\nenum class ReportState {\n //! \\brief Created and filled out by caller, owned by database.\n kPending,\n //! \\brief In the process of uploading, owned by caller.\n kUploading,\n //! \\brief Upload completed or skipped, owned by database.\n kCompleted,\n};\n\nenum {\n //! \\brief Corresponds to uploaded bit of the report state.\n kAttributeUploaded = 1 << 0,\n\n //! \\brief Corresponds to upload_explicity_requested bit of the report state.\n kAttributeUploadExplicitlyRequested = 1 << 1,\n};\n\nstruct MetadataFileReportRecord {\n // Note that this default constructor does no initialization. It is used only\n // to create an array of records that are immediately initialized by reading\n // from disk in Metadata::Read().\n MetadataFileReportRecord() {}\n\n // Constructs from a ReportDisk, adding to |string_table| and storing indices\n // as strings into that table.\n MetadataFileReportRecord(const ReportDisk& report, std::string* string_table);\n\n UUID uuid; // UUID is a 16 byte, standard layout structure.\n uint32_t file_path_index; // Index into string table. File name is relative\n // to the reports directory when on disk.\n uint32_t id_index; // Index into string table.\n int64_t creation_time; // Holds a time_t.\n int64_t last_upload_attempt_time; // Holds a time_t.\n int32_t upload_attempts;\n int32_t state; // A ReportState.\n uint8_t attributes; // Bitfield of kAttribute*.\n uint8_t padding[7];\n};\n\n//! \\brief A private extension of the Report class that includes additional data\n//! that's stored on disk in the metadata file.\nstruct ReportDisk : public CrashReportDatabase::Report {\n ReportDisk(const MetadataFileReportRecord& record,\n const base::FilePath& report_dir,\n const std::string& string_table);\n\n ReportDisk(const UUID& uuid,\n const base::FilePath& path,\n time_t creation_tim,\n ReportState state);\n\n //! \\brief The current state of the report.\n ReportState state;\n};\n\nMetadataFileReportRecord::MetadataFileReportRecord(const ReportDisk& report,\n std::string* string_table)\n : uuid(report.uuid),\n file_path_index(\n AddStringToTable(string_table, report.file_path.BaseName().value())),\n id_index(AddStringToTable(string_table, report.id)),\n creation_time(report.creation_time),\n last_upload_attempt_time(report.last_upload_attempt_time),\n upload_attempts(report.upload_attempts),\n state(static_cast(report.state)),\n attributes((report.uploaded ? kAttributeUploaded : 0) |\n (report.upload_explicitly_requested\n ? kAttributeUploadExplicitlyRequested\n : 0)) {\n memset(&padding, 0, sizeof(padding));\n}\n\nReportDisk::ReportDisk(const MetadataFileReportRecord& record,\n const base::FilePath& report_dir,\n const std::string& string_table)\n : Report() {\n uuid = record.uuid;\n file_path = report_dir.Append(\n base::UTF8ToWide(&string_table[record.file_path_index]));\n id = &string_table[record.id_index];\n creation_time = record.creation_time;\n last_upload_attempt_time = record.last_upload_attempt_time;\n upload_attempts = record.upload_attempts;\n state = static_cast(record.state);\n uploaded = (record.attributes & kAttributeUploaded) != 0;\n upload_explicitly_requested =\n (record.attributes & kAttributeUploadExplicitlyRequested) != 0;\n}\n\nReportDisk::ReportDisk(const UUID& uuid,\n const base::FilePath& path,\n time_t creation_time,\n ReportState state)\n : Report() {\n this->uuid = uuid;\n this->file_path = path;\n this->creation_time = creation_time;\n this->state = state;\n}\n\n// Metadata --------------------------------------------------------------------\n\n//! \\brief Manages the metadata for the set of reports, handling serialization\n//! to disk, and queries.\nclass Metadata {\n public:\n Metadata(const Metadata&) = delete;\n Metadata& operator=(const Metadata&) = delete;\n\n //! \\brief Writes any changes if necessary, unlocks and closes the file\n //! handle.\n ~Metadata();\n\n static std::unique_ptr Create(\n const base::FilePath& metadata_file,\n const base::FilePath& report_dir,\n const base::FilePath& attachments_dir);\n\n //! \\brief Adds a new report to the set.\n //!\n //! \\param[in] new_report_disk The record to add. The #state field must be set\n //! to kPending.\n void AddNewRecord(const ReportDisk& new_report_disk);\n\n //! \\brief Finds all reports in a given state. The \\a reports vector is only\n //! valid when CrashReportDatabase::kNoError is returned.\n //!\n //! \\param[in] desired_state The state to match.\n //! \\param[out] reports Matching reports, must be empty on entry.\n OperationStatus FindReports(\n ReportState desired_state,\n std::vector* reports) const;\n\n //! \\brief Finds the report matching the given UUID.\n //!\n //! The returned report is only valid if CrashReportDatabase::kNoError is\n //! returned.\n //!\n //! \\param[in] uuid The report identifier.\n //! \\param[out] report_disk The found report, valid only if\n //! CrashReportDatabase::kNoError is returned. Ownership is not\n //! transferred to the caller, and the report may not be modified.\n OperationStatus FindSingleReport(const UUID& uuid,\n const ReportDisk** report_disk) const;\n\n //! \\brief Finds a single report matching the given UUID and in the desired\n //! state, and returns a mutable ReportDisk* if found.\n //!\n //! This marks the metadata as dirty, and on destruction, changes will be\n //! written to disk via Write().\n //!\n //! \\return #kNoError on success. #kReportNotFound if there was no report with\n //! the specified UUID, or if the report was not in the specified state\n //! and was not uploading. #kBusyError if the report was not in the\n //! specified state and was uploading.\n OperationStatus FindSingleReportAndMarkDirty(const UUID& uuid,\n ReportState desired_state,\n ReportDisk** report_disk);\n\n //! \\brief Removes a report from the metadata database, without touching the\n //! on-disk file.\n //!\n //! The returned report is only valid if CrashReportDatabase::kNoError is\n //! returned. This will mark the database as dirty. Future metadata\n //! operations for this report will not succeed.\n //!\n //! \\param[in] uuid The report identifier to remove.\n //! \\param[out] report_path The found report's file_path, valid only if\n //! CrashReportDatabase::kNoError is returned.\n OperationStatus DeleteReport(const UUID& uuid,\n base::FilePath* report_path);\n\n //! \\brief Removes reports from the metadata database, that don't have\n //! corresponding report files.\n //!\n //! \\return number of metadata entries removed\n int CleanDatabase();\n\n private:\n Metadata(FileHandle handle,\n const base::FilePath& report_dir,\n const base::FilePath& attachments_dir);\n\n bool Rewind();\n\n void Read();\n void Write();\n\n //! \\brief Confirms that the corresponding report actually exists on disk\n //! (that is, the dump file has not been removed), and that the report is\n //! in the given state.\n static OperationStatus VerifyReport(const ReportDisk& report_disk,\n ReportState desired_state);\n //! \\brief Confirms that the corresponding report actually exists on disk\n //! (that is, the dump file has not been removed).\n static OperationStatus VerifyReportAnyState(const ReportDisk& report_disk);\n\n ScopedFileHandle handle_;\n const base::FilePath report_dir_;\n const base::FilePath attachments_dir_;\n bool dirty_; //! \\brief `true` when a Write() is required on destruction.\n std::vector reports_;\n};\n\nMetadata::~Metadata() {\n if (dirty_)\n Write();\n // Not actually async, UnlockFileEx requires the Offset fields.\n OVERLAPPED overlapped = {0};\n if (!UnlockFileEx(handle_.get(), 0, MAXDWORD, MAXDWORD, &overlapped))\n PLOG(ERROR) << \"UnlockFileEx\";\n}\n\n// static\nstd::unique_ptr Metadata::Create(\n const base::FilePath& metadata_file,\n const base::FilePath& report_dir,\n const base::FilePath& attachments_dir) {\n // It is important that dwShareMode be non-zero so that concurrent access to\n // this file results in a successful open. This allows us to get to LockFileEx\n // which then blocks to guard access.\n FileHandle handle = CreateFile(metadata_file.value().c_str(),\n GENERIC_READ | GENERIC_WRITE,\n FILE_SHARE_READ | FILE_SHARE_WRITE,\n nullptr,\n OPEN_ALWAYS,\n FILE_ATTRIBUTE_NORMAL,\n nullptr);\n if (handle == kInvalidFileHandle)\n return std::unique_ptr();\n // Not actually async, LockFileEx requires the Offset fields.\n OVERLAPPED overlapped = {0};\n if (!LockFileEx(handle,\n LOCKFILE_EXCLUSIVE_LOCK,\n 0,\n MAXDWORD,\n MAXDWORD,\n &overlapped)) {\n PLOG(ERROR) << \"LockFileEx\";\n return std::unique_ptr();\n }\n\n std::unique_ptr metadata(\n new Metadata(handle, report_dir, attachments_dir));\n // If Read() fails, for whatever reason (corruption, etc.) metadata will not\n // have been modified and will be in a clean empty state. We continue on and\n // return an empty database to hopefully recover. This means that existing\n // crash reports have been orphaned.\n metadata->Read();\n return metadata;\n}\n\nvoid Metadata::AddNewRecord(const ReportDisk& new_report_disk) {\n DCHECK(new_report_disk.state == ReportState::kPending);\n reports_.push_back(new_report_disk);\n dirty_ = true;\n}\n\nOperationStatus Metadata::FindReports(\n ReportState desired_state,\n std::vector* reports) const {\n DCHECK(reports->empty());\n for (const auto& report : reports_) {\n if (report.state == desired_state &&\n VerifyReport(report, desired_state) == CrashReportDatabase::kNoError) {\n reports->push_back(report);\n }\n }\n return CrashReportDatabase::kNoError;\n}\n\nOperationStatus Metadata::FindSingleReport(\n const UUID& uuid,\n const ReportDisk** out_report) const {\n auto report_iter = std::find_if(\n reports_.begin(), reports_.end(), [uuid](const ReportDisk& report) {\n return report.uuid == uuid;\n });\n if (report_iter == reports_.end())\n return CrashReportDatabase::kReportNotFound;\n OperationStatus os = VerifyReportAnyState(*report_iter);\n if (os == CrashReportDatabase::kNoError)\n *out_report = &*report_iter;\n return os;\n}\n\nOperationStatus Metadata::FindSingleReportAndMarkDirty(\n const UUID& uuid,\n ReportState desired_state,\n ReportDisk** report_disk) {\n auto report_iter = std::find_if(\n reports_.begin(), reports_.end(), [uuid](const ReportDisk& report) {\n return report.uuid == uuid;\n });\n if (report_iter == reports_.end())\n return CrashReportDatabase::kReportNotFound;\n OperationStatus os = VerifyReport(*report_iter, desired_state);\n if (os == CrashReportDatabase::kNoError) {\n dirty_ = true;\n *report_disk = &*report_iter;\n }\n return os;\n}\n\nOperationStatus Metadata::DeleteReport(const UUID& uuid,\n base::FilePath* report_path) {\n auto report_iter = std::find_if(\n reports_.begin(), reports_.end(), [uuid](const ReportDisk& report) {\n return report.uuid == uuid;\n });\n if (report_iter == reports_.end())\n return CrashReportDatabase::kReportNotFound;\n *report_path = report_iter->file_path;\n reports_.erase(report_iter);\n dirty_ = true;\n return CrashReportDatabase::kNoError;\n}\n\nint Metadata::CleanDatabase() {\n int removed = 0;\n for (auto report_iter = reports_.begin(); report_iter != reports_.end();) {\n if (!IsRegularFile(report_iter->file_path)) {\n report_iter = reports_.erase(report_iter);\n ++removed;\n dirty_ = true;\n } else {\n ++report_iter;\n }\n }\n return removed;\n}\n\nMetadata::Metadata(FileHandle handle,\n const base::FilePath& report_dir,\n const base::FilePath& attachments_dir)\n : handle_(handle),\n report_dir_(report_dir),\n attachments_dir_(attachments_dir),\n dirty_(false),\n reports_() {}\n\nbool Metadata::Rewind() {\n FileOffset result = LoggingSeekFile(handle_.get(), 0, SEEK_SET);\n DCHECK_EQ(result, 0);\n return result == 0;\n}\n\nvoid Metadata::Read() {\n FileOffset length = LoggingSeekFile(handle_.get(), 0, SEEK_END);\n if (length <= 0) // Failed, or empty: Abort.\n return;\n if (!Rewind()) {\n LOG(ERROR) << \"failed to rewind to read\";\n return;\n }\n\n MetadataFileHeader header;\n if (!LoggingReadFileExactly(handle_.get(), &header, sizeof(header))) {\n LOG(ERROR) << \"failed to read header\";\n return;\n }\n if (header.magic != kMetadataFileHeaderMagic ||\n header.version != kMetadataFileVersion) {\n LOG(ERROR) << \"unexpected header\";\n return;\n }\n\n base::CheckedNumeric records_size =\n base::CheckedNumeric(header.num_records) *\n static_cast(sizeof(MetadataFileReportRecord));\n if (!records_size.IsValid()) {\n LOG(ERROR) << \"record size out of range\";\n return;\n }\n\n std::vector reports;\n if (header.num_records > 0) {\n std::vector records(header.num_records);\n if (!LoggingReadFileExactly(\n handle_.get(), &records[0], records_size.ValueOrDie())) {\n LOG(ERROR) << \"failed to read records\";\n return;\n }\n\n std::string string_table = ReadRestOfFileAsString(handle_.get());\n if (string_table.empty() || string_table.back() != '\\0') {\n LOG(ERROR) << \"bad string table\";\n return;\n }\n\n for (const auto& record : records) {\n if (record.file_path_index >= string_table.size() ||\n record.id_index >= string_table.size()) {\n LOG(ERROR) << \"invalid string table index\";\n return;\n }\n ReportDisk report_disk(record, report_dir_, string_table);\n\n report_disk.total_size = GetFileSize(report_disk.file_path);\n base::FilePath report_attachment_dir =\n attachments_dir_.Append(report_disk.uuid.ToWString());\n report_disk.total_size += GetDirectorySize(report_attachment_dir);\n reports.push_back(report_disk);\n }\n }\n reports_.swap(reports);\n}\n\nvoid Metadata::Write() {\n if (!Rewind()) {\n LOG(ERROR) << \"failed to rewind to write\";\n return;\n }\n\n // Truncate to ensure that a partial write doesn't cause a mix of old and new\n // data causing an incorrect interpretation on read.\n if (!SetEndOfFile(handle_.get())) {\n PLOG(ERROR) << \"failed to truncate\";\n return;\n }\n\n size_t num_records = reports_.size();\n\n // Fill and write out the header.\n MetadataFileHeader header = {0};\n header.magic = kMetadataFileHeaderMagic;\n header.version = kMetadataFileVersion;\n header.num_records = base::checked_cast(num_records);\n if (!LoggingWriteFile(handle_.get(), &header, sizeof(header))) {\n LOG(ERROR) << \"failed to write header\";\n return;\n }\n\n if (num_records == 0)\n return;\n\n // Build the records and string table we're going to write.\n std::string string_table;\n std::vector records;\n records.reserve(num_records);\n for (const auto& report : reports_) {\n const base::FilePath& path = report.file_path;\n if (path.DirName() != report_dir_) {\n LOG(ERROR) << path << \" expected to start with \" << report_dir_;\n return;\n }\n records.push_back(MetadataFileReportRecord(report, &string_table));\n }\n\n if (!LoggingWriteFile(handle_.get(),\n &records[0],\n records.size() * sizeof(MetadataFileReportRecord))) {\n LOG(ERROR) << \"failed to write records\";\n return;\n }\n if (!LoggingWriteFile(\n handle_.get(), string_table.c_str(), string_table.size())) {\n LOG(ERROR) << \"failed to write string table\";\n return;\n }\n}\n\n// static\nOperationStatus Metadata::VerifyReportAnyState(const ReportDisk& report_disk) {\n DWORD fileattr = GetFileAttributes(report_disk.file_path.value().c_str());\n if (fileattr == INVALID_FILE_ATTRIBUTES)\n return CrashReportDatabase::kReportNotFound;\n return (fileattr & FILE_ATTRIBUTE_DIRECTORY)\n ? CrashReportDatabase::kFileSystemError\n : CrashReportDatabase::kNoError;\n}\n\n// static\nOperationStatus Metadata::VerifyReport(const ReportDisk& report_disk,\n ReportState desired_state) {\n if (report_disk.state == desired_state) {\n return VerifyReportAnyState(report_disk);\n }\n\n return report_disk.state == ReportState::kUploading\n ? CrashReportDatabase::kBusyError\n : CrashReportDatabase::kReportNotFound;\n}\n\nbool EnsureDirectory(const base::FilePath& path) {\n DWORD fileattr = GetFileAttributes(path.value().c_str());\n if (fileattr == INVALID_FILE_ATTRIBUTES) {\n PLOG(ERROR) << \"GetFileAttributes \" << path;\n return false;\n }\n if ((fileattr & FILE_ATTRIBUTE_DIRECTORY) == 0) {\n LOG(ERROR) << \"GetFileAttributes \" << path << \": not a directory\";\n return false;\n }\n return true;\n}\n\n//! \\brief Ensures that the node at path is a directory, and creates it if it\n//! does not exist.\n//!\n//! \\return If the path points to a file, rather than a directory, or the\n//! directory could not be created, returns `false`. Otherwise, returns\n//! `true`, indicating that path already was or now is a directory.\nbool CreateDirectoryIfNecessary(const base::FilePath& path) {\n if (CreateDirectory(path.value().c_str(), nullptr))\n return true;\n if (GetLastError() != ERROR_ALREADY_EXISTS) {\n PLOG(ERROR) << \"CreateDirectory \" << base::WideToUTF8(path.value());\n return false;\n }\n return EnsureDirectory(path);\n}\n\n} // namespace\n\n// CrashReportDatabaseWin ------------------------------------------------------\n\nclass CrashReportDatabaseWin : public CrashReportDatabase {\n public:\n explicit CrashReportDatabaseWin(const base::FilePath& path);\n\n CrashReportDatabaseWin(const CrashReportDatabaseWin&) = delete;\n CrashReportDatabaseWin& operator=(const CrashReportDatabaseWin&) = delete;\n\n ~CrashReportDatabaseWin() override;\n\n bool Initialize(bool may_create);\n\n // CrashReportDatabase:\n Settings* GetSettings() override;\n OperationStatus PrepareNewCrashReport(\n std::unique_ptr* report) override;\n OperationStatus FinishedWritingCrashReport(std::unique_ptr report,\n UUID* uuid) override;\n OperationStatus LookUpCrashReport(const UUID& uuid, Report* report) override;\n OperationStatus GetPendingReports(std::vector* reports) override;\n OperationStatus GetCompletedReports(std::vector* reports) override;\n OperationStatus GetReportForUploading(\n const UUID& uuid,\n std::unique_ptr* report,\n bool report_metrics) override;\n OperationStatus SkipReportUpload(const UUID& uuid,\n Metrics::CrashSkippedReason reason) override;\n OperationStatus DeleteReport(const UUID& uuid) override;\n OperationStatus RequestUpload(const UUID& uuid) override;\n int CleanDatabase(time_t lockfile_ttl) override;\n base::FilePath DatabasePath() override;\n\n private:\n // CrashReportDatabase:\n OperationStatus RecordUploadAttempt(UploadReport* report,\n bool successful,\n const std::string& id) override;\n\n // Cleans any attachments that have no associated report.\n void CleanOrphanedAttachments();\n\n std::unique_ptr AcquireMetadata();\n\n Settings& SettingsInternal() {\n std::call_once(settings_init_, [this]() { settings_.Initialize(); });\n return settings_;\n }\n\n const base::FilePath base_dir_;\n Settings settings_;\n std::once_flag settings_init_;\n InitializationStateDcheck initialized_;\n};\n\nCrashReportDatabaseWin::CrashReportDatabaseWin(const base::FilePath& path)\n : CrashReportDatabase(),\n base_dir_(path),\n settings_(path.Append(kSettings)),\n settings_init_(),\n initialized_() {}\n\nCrashReportDatabaseWin::~CrashReportDatabaseWin() {\n}\n\nbool CrashReportDatabaseWin::Initialize(bool may_create) {\n INITIALIZATION_STATE_SET_INITIALIZING(initialized_);\n\n // Ensure the database directory exists.\n if (may_create) {\n if (!CreateDirectoryIfNecessary(base_dir_))\n return false;\n } else if (!EnsureDirectory(base_dir_)) {\n return false;\n }\n\n // Ensure that the report subdirectory exists.\n if (!CreateDirectoryIfNecessary(base_dir_.Append(kReportsDirectory)))\n return false;\n\n if (!CreateDirectoryIfNecessary(AttachmentsRootPath()))\n return false;\n\n INITIALIZATION_STATE_SET_VALID(initialized_);\n return true;\n}\n\nbase::FilePath CrashReportDatabaseWin::DatabasePath() {\n return base_dir_;\n}\n\nSettings* CrashReportDatabaseWin::GetSettings() {\n INITIALIZATION_STATE_DCHECK_VALID(initialized_);\n return &SettingsInternal();\n}\n\nOperationStatus CrashReportDatabaseWin::PrepareNewCrashReport(\n std::unique_ptr* report) {\n INITIALIZATION_STATE_DCHECK_VALID(initialized_);\n\n std::unique_ptr new_report(new NewReport());\n if (!new_report->Initialize(this,\n base_dir_.Append(kReportsDirectory),\n std::wstring(L\".\") + kCrashReportFileExtension)) {\n return kFileSystemError;\n }\n\n report->reset(new_report.release());\n return kNoError;\n}\n\nOperationStatus CrashReportDatabaseWin::FinishedWritingCrashReport(\n std::unique_ptr report,\n UUID* uuid) {\n INITIALIZATION_STATE_DCHECK_VALID(initialized_);\n\n std::unique_ptr metadata(AcquireMetadata());\n if (!metadata)\n return kDatabaseError;\n metadata->AddNewRecord(ReportDisk(report->ReportID(),\n report->file_remover_.get(),\n time(nullptr),\n ReportState::kPending));\n\n std::ignore = report->file_remover_.release();\n\n // Close all the attachments and disarm their removers too.\n for (auto& writer : report->attachment_writers_) {\n writer->Close();\n }\n for (auto& remover : report->attachment_removers_) {\n std::ignore = remover.release();\n }\n\n *uuid = report->ReportID();\n\n Metrics::CrashReportPending(Metrics::PendingReportReason::kNewlyCreated);\n Metrics::CrashReportSize(report->Writer()->Seek(0, SEEK_END));\n\n return kNoError;\n}\n\nOperationStatus CrashReportDatabaseWin::LookUpCrashReport(const UUID& uuid,\n Report* report) {\n INITIALIZATION_STATE_DCHECK_VALID(initialized_);\n\n std::unique_ptr metadata(AcquireMetadata());\n if (!metadata)\n return kDatabaseError;\n // Find and return a copy of the matching report.\n const ReportDisk* report_disk;\n OperationStatus os = metadata->FindSingleReport(uuid, &report_disk);\n if (os == kNoError)\n *report = *report_disk;\n return os;\n}\n\nOperationStatus CrashReportDatabaseWin::GetPendingReports(\n std::vector* reports) {\n INITIALIZATION_STATE_DCHECK_VALID(initialized_);\n\n std::unique_ptr metadata(AcquireMetadata());\n return metadata ? metadata->FindReports(ReportState::kPending, reports)\n : kDatabaseError;\n}\n\nOperationStatus CrashReportDatabaseWin::GetCompletedReports(\n std::vector* reports) {\n INITIALIZATION_STATE_DCHECK_VALID(initialized_);\n\n std::unique_ptr metadata(AcquireMetadata());\n return metadata ? metadata->FindReports(ReportState::kCompleted, reports)\n : kDatabaseError;\n}\n\nOperationStatus CrashReportDatabaseWin::GetReportForUploading(\n const UUID& uuid,\n std::unique_ptr* report,\n bool report_metrics) {\n INITIALIZATION_STATE_DCHECK_VALID(initialized_);\n\n std::unique_ptr metadata(AcquireMetadata());\n if (!metadata)\n return kDatabaseError;\n\n ReportDisk* report_disk;\n OperationStatus os = metadata->FindSingleReportAndMarkDirty(\n uuid, ReportState::kPending, &report_disk);\n if (os == kNoError) {\n report_disk->state = ReportState::kUploading;\n auto upload_report = std::make_unique();\n *implicit_cast(upload_report.get()) = *report_disk;\n\n if (!upload_report->Initialize(upload_report->file_path, this)) {\n return kFileSystemError;\n }\n upload_report->report_metrics_ = report_metrics;\n\n report->reset(upload_report.release());\n }\n return os;\n}\n\nOperationStatus CrashReportDatabaseWin::RecordUploadAttempt(\n UploadReport* report,\n bool successful,\n const std::string& id) {\n INITIALIZATION_STATE_DCHECK_VALID(initialized_);\n\n if (report->report_metrics_) {\n Metrics::CrashUploadAttempted(successful);\n }\n\n std::unique_ptr metadata(AcquireMetadata());\n if (!metadata)\n return kDatabaseError;\n ReportDisk* report_disk;\n OperationStatus os = metadata->FindSingleReportAndMarkDirty(\n report->uuid, ReportState::kUploading, &report_disk);\n if (os != kNoError)\n return os;\n\n time_t now = time(nullptr);\n\n report_disk->uploaded = successful;\n report_disk->id = id;\n report_disk->last_upload_attempt_time = now;\n report_disk->upload_attempts++;\n if (successful) {\n report_disk->state = ReportState::kCompleted;\n report_disk->upload_explicitly_requested = false;\n } else {\n report_disk->state = ReportState::kPending;\n report_disk->upload_explicitly_requested =\n report->upload_explicitly_requested;\n }\n\n if (!SettingsInternal().SetLastUploadAttemptTime(now))\n return kDatabaseError;\n\n return kNoError;\n}\n\nOperationStatus CrashReportDatabaseWin::DeleteReport(const UUID& uuid) {\n INITIALIZATION_STATE_DCHECK_VALID(initialized_);\n\n std::unique_ptr metadata(AcquireMetadata());\n if (!metadata)\n return kDatabaseError;\n\n base::FilePath report_path;\n OperationStatus os = metadata->DeleteReport(uuid, &report_path);\n if (os != kNoError)\n return os;\n\n if (!DeleteFile(report_path.value().c_str())) {\n PLOG(ERROR) << \"DeleteFile \" << report_path;\n return kFileSystemError;\n }\n\n RemoveAttachmentsByUUID(uuid);\n\n return kNoError;\n}\n\nOperationStatus CrashReportDatabaseWin::SkipReportUpload(\n const UUID& uuid,\n Metrics::CrashSkippedReason reason) {\n INITIALIZATION_STATE_DCHECK_VALID(initialized_);\n\n Metrics::CrashUploadSkipped(reason);\n\n std::unique_ptr metadata(AcquireMetadata());\n if (!metadata)\n return kDatabaseError;\n ReportDisk* report_disk;\n OperationStatus os = metadata->FindSingleReportAndMarkDirty(\n uuid, ReportState::kPending, &report_disk);\n if (os == kNoError) {\n report_disk->state = ReportState::kCompleted;\n report_disk->upload_explicitly_requested = false;\n }\n return os;\n}\n\nstd::unique_ptr CrashReportDatabaseWin::AcquireMetadata() {\n base::FilePath metadata_file = base_dir_.Append(kMetadataFileName);\n return Metadata::Create(metadata_file,\n base_dir_.Append(kReportsDirectory),\n AttachmentsRootPath());\n}\n\nOperationStatus CrashReportDatabaseWin::RequestUpload(const UUID& uuid) {\n INITIALIZATION_STATE_DCHECK_VALID(initialized_);\n\n std::unique_ptr metadata(AcquireMetadata());\n if (!metadata)\n return kDatabaseError;\n\n ReportDisk* report_disk;\n // TODO(gayane): Search for the report only once regardless of its state.\n OperationStatus os = metadata->FindSingleReportAndMarkDirty(\n uuid, ReportState::kCompleted, &report_disk);\n if (os == kReportNotFound) {\n os = metadata->FindSingleReportAndMarkDirty(\n uuid, ReportState::kPending, &report_disk);\n }\n\n if (os != kNoError)\n return os;\n\n // If the crash report has already been uploaded, don't request new upload.\n if (report_disk->uploaded)\n return kCannotRequestUpload;\n\n // Mark the crash report as having upload explicitly requested by the user,\n // and move it to the pending state.\n report_disk->upload_explicitly_requested = true;\n report_disk->state = ReportState::kPending;\n\n Metrics::CrashReportPending(Metrics::PendingReportReason::kUserInitiated);\n\n return kNoError;\n}\n\nint CrashReportDatabaseWin::CleanDatabase(time_t lockfile_ttl) {\n int removed = 0;\n const base::FilePath dir_path(base_dir_.Append(kReportsDirectory));\n DirectoryReader reader;\n if (!reader.Open(dir_path)) {\n return removed;\n }\n\n base::FilePath filename;\n DirectoryReader::Result result;\n time_t now = time(nullptr);\n\n std::unique_ptr metadata(AcquireMetadata());\n if (!metadata) {\n return removed;\n }\n\n // Remove old reports without metadata.\n while ((result = reader.NextFile(&filename)) ==\n DirectoryReader::Result::kSuccess) {\n timespec filetime;\n const base::FilePath report_path(dir_path.Append(filename));\n if (!FileModificationTime(report_path, &filetime) ||\n filetime.tv_sec > now - lockfile_ttl) {\n continue;\n }\n\n const ReportDisk* report_disk;\n UUID uuid;\n bool is_uuid = UUIDFromReportPath(report_path, &uuid);\n // ignore files whose base name is not uuid\n if (!is_uuid) {\n continue;\n }\n OperationStatus os = metadata->FindSingleReport(uuid, &report_disk);\n\n if (os == OperationStatus::kReportNotFound) {\n if (LoggingRemoveFile(report_path)) {\n ++removed;\n RemoveAttachmentsByUUID(uuid);\n }\n continue;\n }\n }\n\n // Remove any metadata records without report files.\n removed += metadata->CleanDatabase();\n\n CleanOrphanedAttachments();\n return removed;\n}\n\nvoid CrashReportDatabaseWin::CleanOrphanedAttachments() {\n base::FilePath root_attachments_dir = AttachmentsRootPath();\n DirectoryReader reader;\n if (!reader.Open(root_attachments_dir)) {\n return;\n }\n\n base::FilePath filename;\n DirectoryReader::Result result;\n base::FilePath reports_dir = base_dir_.Append(kReportsDirectory);\n while ((result = reader.NextFile(&filename)) ==\n DirectoryReader::Result::kSuccess) {\n const base::FilePath path(root_attachments_dir.Append(filename));\n if (IsDirectory(path, false)) {\n UUID uuid;\n if (!uuid.InitializeFromString(filename.value())) {\n LOG(ERROR) << \"unexpected attachment dir name \" << filename;\n continue;\n }\n\n // Remove attachments if corresponding report doesn't exist.\n base::FilePath report_path = reports_dir.Append(\n uuid.ToWString() + L\".\" + kCrashReportFileExtension);\n if (!IsRegularFile(report_path)) {\n RemoveAttachmentsByUUID(uuid);\n }\n }\n }\n}\n\nnamespace {\n\nstd::unique_ptr InitializeInternal(\n const base::FilePath& path,\n bool may_create) {\n std::unique_ptr database_win(\n new CrashReportDatabaseWin(path));\n return database_win->Initialize(may_create)\n ? std::move(database_win)\n : std::unique_ptr();\n}\n\n} // namespace\n\n// static\nstd::unique_ptr CrashReportDatabase::Initialize(\n const base::FilePath& path) {\n return InitializeInternal(path, true);\n}\n\n// static\nstd::unique_ptr\nCrashReportDatabase::InitializeWithoutCreating(const base::FilePath& path) {\n return InitializeInternal(path, false);\n}\n\n// static\nstd::unique_ptr\nCrashReportDatabase::GetSettingsReaderForDatabasePath(\n const base::FilePath& path) {\n return std::make_unique(path.Append(kSettings));\n}\n\n} // namespace crashpad\n" }, { "path": "client/crashpad_client.h", "content": "// Copyright 2014 The Crashpad Authors\n//\n// Licensed under the Apache License, Version 2.0 (the \"License\");\n// you may not use this file except in compliance with the License.\n// You may obtain a copy of the License at\n//\n// http://www.apache.org/licenses/LICENSE-2.0\n//\n// Unless required by applicable law or agreed to in writing, software\n// distributed under the License is distributed on an \"AS IS\" BASIS,\n// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n// See the License for the specific language governing permissions and\n// limitations under the License.\n\n#ifndef CRASHPAD_CLIENT_CRASHPAD_CLIENT_H_\n#define CRASHPAD_CLIENT_CRASHPAD_CLIENT_H_\n\n#include \n#include \n#include \n#include \n#include \n\n#include \n\n#include \"base/files/file_path.h\"\n#include \"build/build_config.h\"\n#include \"util/file/file_io.h\"\n\n#if !BUILDFLAG(IS_FUCHSIA)\n#include \"util/misc/capture_context.h\"\n#endif // !BUILDFLAG(IS_FUCHSIA)\n\n#if BUILDFLAG(IS_APPLE)\n#include \"base/apple/scoped_mach_port.h\"\n#elif BUILDFLAG(IS_WIN)\n#include \n#include \"util/win/scoped_handle.h\"\n#elif BUILDFLAG(IS_LINUX) || BUILDFLAG(IS_CHROMEOS) || BUILDFLAG(IS_ANDROID)\n#include \n#include \n#endif\n\n#if BUILDFLAG(IS_IOS)\n#include \"client/upload_behavior_ios.h\"\n#include \"handler/user_stream_data_source.h\" // nogncheck\n#endif\n\nnamespace crashpad {\n\n//! \\brief The primary interface for an application to have Crashpad monitor\n//! it for crashes.\nclass CrashpadClient {\n public:\n CrashpadClient();\n\n CrashpadClient(const CrashpadClient&) = delete;\n CrashpadClient& operator=(const CrashpadClient&) = delete;\n\n ~CrashpadClient();\n\n //! \\brief Starts a Crashpad handler process, performing any necessary\n //! handshake to configure it.\n //!\n //! This method directs crashes to the Crashpad handler. On macOS, this is\n //! applicable to this process and all subsequent child processes. On Windows,\n //! child processes must also register by using SetHandlerIPCPipe().\n //!\n //! On macOS, this method starts a Crashpad handler and obtains a Mach send\n //! right corresponding to a receive right held by the handler process. The\n //! handler process runs an exception server on this port. This method sets\n //! the task’s exception port for `EXC_CRASH`, `EXC_RESOURCE`, and `EXC_GUARD`\n //! exceptions to the Mach send right obtained. The handler will be installed\n //! with behavior `EXCEPTION_STATE_IDENTITY | MACH_EXCEPTION_CODES` and thread\n //! state flavor `MACHINE_THREAD_STATE`. Exception ports are inherited, so a\n //! Crashpad handler started here will remain the handler for any child\n //! processes created after StartHandler() is called. These child processes do\n //! not need to call StartHandler() or be aware of Crashpad in any way. The\n //! Crashpad handler will receive crashes from child processes that have\n //! inherited it as their exception handler even after the process that called\n //! StartHandler() exits.\n //!\n //! On Windows, if \\a asynchronous_start is `true`, this function will not\n //! directly call `CreateProcess()`, making it suitable for use in a\n //! `DllMain()`. In that case, the handler is started from a background\n //! thread, deferring the handler's startup. Nevertheless, regardless of the\n //! value of \\a asynchronous_start, after calling this method, the global\n //! unhandled exception filter is set up, and all crashes will be handled by\n //! Crashpad. Optionally, use WaitForHandlerStart() to join with the\n //! background thread and retrieve the status of handler startup.\n //!\n //! On Fuchsia, this method binds to the exception port of the current default\n //! job, and starts a Crashpad handler to monitor that port.\n //!\n //! On Linux, this method starts a Crashpad handler, connected to this process\n //! via an `AF_UNIX` socket pair and installs signal handlers to request crash\n //! dumps on the client's socket end.\n //!\n //! \\param[in] handler The path to a Crashpad handler executable.\n //! \\param[in] database The path to a Crashpad database. The handler will be\n //! started with this path as its `--database` argument.\n //! \\param[in] metrics_dir The path to an already existing directory where\n //! metrics files can be stored. The handler will be started with this\n //! path as its `--metrics-dir` argument.\n //! \\param[in] url The URL of an upload server. The handler will be started\n //! with this URL as its `--url` argument.\n //! \\param[in] annotations Process annotations to set in each crash report.\n //! The handler will be started with an `--annotation` argument for each\n //! element in this map.\n //! \\param[in] arguments Additional arguments to pass to the Crashpad handler.\n //! Arguments passed in other parameters and arguments required to perform\n //! the handshake are the responsibility of this method, and must not be\n //! specified in this parameter.\n //! \\param[in] restartable If `true`, the handler will be restarted if it\n //! dies, if this behavior is supported. This option is not available on\n //! all platforms, and does not function on all OS versions. If it is\n //! not supported, it will be ignored.\n //! \\param[out] asynchronous_start If `true`, the handler will be started from\n //! a background thread. Optionally, WaitForHandlerStart() can be used at\n //! a suitable time to retreive the result of background startup. This\n //! option is only used on Windows.\n //! \\param[in] attachments Vector that stores file paths that should be\n //! captured with each report at the time of the crash.\n //!\n //! \\return `true` on success, `false` on failure with a message logged.\n bool StartHandler(const base::FilePath& handler,\n const base::FilePath& database,\n const base::FilePath& metrics_dir,\n const std::string& url,\n const std::map& annotations,\n const std::vector& arguments,\n bool restartable,\n bool asynchronous_start,\n const std::vector& attachments = {});\n\n#if BUILDFLAG(IS_ANDROID) || BUILDFLAG(IS_LINUX) || BUILDFLAG(IS_CHROMEOS) || \\\n DOXYGEN\n //! \\brief Retrieve the socket and process ID for the handler.\n //!\n //! `StartHandler()` must have successfully been called before calling this\n //! method.\n //!\n //! \\param[out] sock The socket connected to the handler, if not `nullptr`.\n //! \\param[out] pid The handler's process ID, if not `nullptr`.\n //! \\return `true` on success. Otherwise `false` with a message logged.\n static bool GetHandlerSocket(int* sock, pid_t* pid);\n\n //! \\brief Sets the socket to a presumably-running Crashpad handler process\n //! which was started with StartHandler().\n //!\n //! This method installs a signal handler to request crash dumps on \\a sock.\n //!\n //! \\param[in] sock A socket connected to a Crashpad handler.\n //! \\param[in] pid The process ID of the handler, used to set the handler as\n //! this process' ptracer. 0 indicates it is not necessary to set the\n //! handler as this process' ptracer. -1 indicates that the handler's\n //! process ID should be determined by communicating over the socket.\n bool SetHandlerSocket(ScopedFileHandle sock, pid_t pid);\n\n //! \\brief Uses `sigaltstack()` to allocate a signal stack for the calling\n //! thread.\n //!\n //! This method allocates an alternate stack to handle signals delivered to\n //! the calling thread and should be called early in the lifetime of each\n //! thread. Installing an alternate stack allows signals to be delivered in\n //! the event that the call stack's stack pointer points to invalid memory,\n //! as in the case of stack overflow.\n //!\n //! This method is called automatically by SetHandlerSocket() and\n //! the various StartHandler() methods. It is harmless to call multiple times.\n //! A new signal stack will be allocated only if there is no existing stack or\n //! the existing stack is too small. The stack will be automatically freed\n //! when the thread exits.\n //!\n //! An application might choose to diligently call this method from the start\n //! routine for each thread, call it from a `pthread_create()` wrapper which\n //! the application provides, or link the provided \"client:pthread_create\"\n //! target.\n //!\n //! \\return `true` on success. Otherwise `false` with a message logged.\n static bool InitializeSignalStackForThread();\n#endif // BUILDFLAG(IS_ANDROID) || BUILDFLAG(IS_LINUX) ||\n // BUILDFLAG(IS_CHROMEOS) || DOXYGEN\n\n#if BUILDFLAG(IS_ANDROID) || DOXYGEN\n //! \\brief Installs a signal handler to execute `/system/bin/app_process` and\n //! load a Java class in response to a crash.\n //!\n //! \\param[in] class_name The fully qualified class name to load, which must\n //! define a `main()` method to be invoked by `app_process`. Arguments\n //! will be passed to this method as though it were the Crashpad handler.\n //! This class is expected to load a native library defining\n //! crashpad::HandlerMain() and pass the arguments to it.\n //! \\param[in] env A vector of environment variables of the form `var=value`\n //! defining the environment in which to execute `app_process`. If this\n //! value is `nullptr`, the application's environment at the time of the\n //! crash will be used.\n //! \\param[in] database The path to a Crashpad database. The handler will be\n //! started with this path as its `--database` argument.\n //! \\param[in] metrics_dir The path to an already existing directory where\n //! metrics files can be stored. The handler will be started with this\n //! path as its `--metrics-dir` argument.\n //! \\param[in] url The URL of an upload server. The handler will be started\n //! with this URL as its `--url` argument.\n //! \\param[in] annotations Process annotations to set in each crash report.\n //! The handler will be started with an `--annotation` argument for each\n //! element in this map.\n //! \\param[in] arguments Additional arguments to pass to the Crashpad handler.\n //! Arguments passed in other parameters and arguments required to perform\n //! the handshake are the responsibility of this method, and must not be\n //! specified in this parameter.\n //!\n //! \\return `true` on success, `false` on failure with a message logged.\n bool StartJavaHandlerAtCrash(\n const std::string& class_name,\n const std::vector* env,\n const base::FilePath& database,\n const base::FilePath& metrics_dir,\n const std::string& url,\n const std::map& annotations,\n const std::vector& arguments);\n\n //! \\brief Executes `/system/bin/app_process` and loads a Java class.\n //!\n //! \\param[in] class_name The fully qualified class name to load, which must\n //! define a `main()` method to be invoked by `app_process`. Arguments\n //! will be passed to this method as though it were the Crashpad handler.\n //! This class is expected to load a native library defining\n //! crashpad::HandlerMain() and pass the arguments to it.\n //! \\param[in] env A vector of environment variables of the form `var=value`\n //! defining the environment in which to execute `app_process`. If this\n //! value is `nullptr`, the application's current environment will be\n //! used.\n //! \\param[in] database The path to a Crashpad database. The handler will be\n //! started with this path as its `--database` argument.\n //! \\param[in] metrics_dir The path to an already existing directory where\n //! metrics files can be stored. The handler will be started with this\n //! path as its `--metrics-dir` argument.\n //! \\param[in] url The URL of an upload server. The handler will be started\n //! with this URL as its `--url` argument.\n //! \\param[in] annotations Process annotations to set in each crash report.\n //! The handler will be started with an `--annotation` argument for each\n //! element in this map.\n //! \\param[in] arguments Additional arguments to pass to the Crashpad handler.\n //! Arguments passed in other parameters and arguments required to perform\n //! the handshake are the responsibility of this method, and must not be\n //! specified in this parameter.\n //! \\param[in] socket The server end of a socket pair. The client end should\n //! be used with an ExceptionHandlerClient.\n //!\n //! \\return `true` on success, `false` on failure with a message logged.\n static bool StartJavaHandlerForClient(\n const std::string& class_name,\n const std::vector* env,\n const base::FilePath& database,\n const base::FilePath& metrics_dir,\n const std::string& url,\n const std::map& annotations,\n const std::vector& arguments,\n int socket);\n\n //! \\brief Installs a signal handler to start a Crashpad handler process by\n //! loading it with `/system/bin/linker`.\n //!\n //! This method is only supported by Android Q+.\n //!\n //! \\param[in] handler_trampoline The path to a Crashpad handler trampoline\n //! executable, possibly located within an apk, e.g.\n //! \"/data/app/myapk.apk!/myabi/libcrashpad_handler_trampoline.so\".\n //! \\param[in] handler_library The name of a library exporting the symbol\n //! `CrashpadHandlerMain()`. The path to this library must be present in\n //! `LD_LIBRARY_PATH`.\n //! \\param[in] is_64_bit `true` if \\a handler_trampoline and \\a\n //! handler_library are 64-bit objects. They must have the same bitness.\n //! \\param[in] env A vector of environment variables of the form `var=value`\n //! defining the environment in which to execute `app_process`. If this\n //! value is `nullptr`, the application's environment at the time of the\n //! crash will be used.\n //! \\param[in] database The path to a Crashpad database. The handler will be\n //! started with this path as its `--database` argument.\n //! \\param[in] metrics_dir The path to an already existing directory where\n //! metrics files can be stored. The handler will be started with this\n //! path as its `--metrics-dir` argument.\n //! \\param[in] url The URL of an upload server. The handler will be started\n //! with this URL as its `--url` argument.\n //! \\param[in] annotations Process annotations to set in each crash report.\n //! The handler will be started with an `--annotation` argument for each\n //! element in this map.\n //! \\param[in] arguments Additional arguments to pass to the Crashpad handler.\n //! Arguments passed in other parameters and arguments required to perform\n //! the handshake are the responsibility of this method, and must not be\n //! specified in this parameter.\n //!\n //! \\return `true` on success, `false` on failure with a message logged.\n bool StartHandlerWithLinkerAtCrash(\n const std::string& handler_trampoline,\n const std::string& handler_library,\n bool is_64_bit,\n const std::vector* env,\n const base::FilePath& database,\n const base::FilePath& metrics_dir,\n const std::string& url,\n const std::map& annotations,\n const std::vector& arguments);\n\n //! \\brief Starts a Crashpad handler process with an initial client by loading\n //! it with `/system/bin/linker`.\n //!\n //! This method is only supported by Android Q+.\n //!\n //! \\param[in] handler_trampoline The path to a Crashpad handler trampoline\n //! executable, possibly located within an apk, e.g.\n //! \"/data/app/myapk.apk!/myabi/libcrashpad_handler_trampoline.so\".\n //! \\param[in] handler_library The name of a library exporting the symbol\n //! `CrashpadHandlerMain()`. The path to this library must be present in\n //! `LD_LIBRARY_PATH`.\n //! \\param[in] is_64_bit `true` if \\a handler_trampoline and \\a\n //! handler_library are 64-bit objects. They must have the same bitness.\n //! \\param[in] env A vector of environment variables of the form `var=value`\n //! defining the environment in which to execute `app_process`. If this\n //! value is `nullptr`, the application's current environment will be\n //! used.\n //! \\param[in] database The path to a Crashpad database. The handler will be\n //! started with this path as its `--database` argument.\n //! \\param[in] metrics_dir The path to an already existing directory where\n //! metrics files can be stored. The handler will be started with this\n //! path as its `--metrics-dir` argument.\n //! \\param[in] url The URL of an upload server. The handler will be started\n //! with this URL as its `--url` argument.\n //! \\param[in] annotations Process annotations to set in each crash report.\n //! The handler will be started with an `--annotation` argument for each\n //! element in this map.\n //! \\param[in] arguments Additional arguments to pass to the Crashpad handler.\n //! Arguments passed in other parameters and arguments required to perform\n //! the handshake are the responsibility of this method, and must not be\n //! specified in this parameter.\n //! \\param[in] socket The server end of a socket pair. The client end should\n //! be used with an ExceptionHandlerClient.\n //!\n //! \\return `true` on success, `false` on failure with a message logged.\n static bool StartHandlerWithLinkerForClient(\n const std::string& handler_trampoline,\n const std::string& handler_library,\n bool is_64_bit,\n const std::vector* env,\n const base::FilePath& database,\n const base::FilePath& metrics_dir,\n const std::string& url,\n const std::map& annotations,\n const std::vector& arguments,\n int socket);\n#endif // BUILDFLAG(IS_ANDROID) || DOXYGEN\n\n#if BUILDFLAG(IS_LINUX) || BUILDFLAG(IS_ANDROID) || BUILDFLAG(IS_CHROMEOS) || \\\n DOXYGEN\n //! \\brief Installs a signal handler to launch a handler process in reponse to\n //! a crash.\n //!\n //! The handler process will create a crash dump for this process and exit.\n //!\n //! \\param[in] handler The path to a Crashpad handler executable.\n //! \\param[in] database The path to a Crashpad database. The handler will be\n //! started with this path as its `--database` argument.\n //! \\param[in] metrics_dir The path to an already existing directory where\n //! metrics files can be stored. The handler will be started with this\n //! path as its `--metrics-dir` argument.\n //! \\param[in] url The URL of an upload server. The handler will be started\n //! with this URL as its `--url` argument.\n //! \\param[in] annotations Process annotations to set in each crash report.\n //! The handler will be started with an `--annotation` argument for each\n //! element in this map.\n //! \\param[in] arguments Additional arguments to pass to the Crashpad handler.\n //! Arguments passed in other parameters and arguments required to perform\n //! the handshake are the responsibility of this method, and must not be\n //! specified in this parameter.\n //! \\param[in] attachments Attachment paths to pass to the Crashpad handler.\n //! The handler will be started with an `--attachment` argument for each\n //! path in this vector.\n //!\n //! \\return `true` on success, `false` on failure with a message logged.\n bool StartHandlerAtCrash(\n const base::FilePath& handler,\n const base::FilePath& database,\n const base::FilePath& metrics_dir,\n const std::string& url,\n const std::map& annotations,\n const std::vector& arguments,\n const std::vector& attachments = {});\n\n //! \\brief Starts a handler process with an initial client.\n //!\n //! This method allows a process to launch the handler process on behalf of\n //! another process.\n //!\n //! \\param[in] handler The path to a Crashpad handler executable.\n //! \\param[in] database The path to a Crashpad database. The handler will be\n //! started with this path as its `--database` argument.\n //! \\param[in] metrics_dir The path to an already existing directory where\n //! metrics files can be stored. The handler will be started with this\n //! path as its `--metrics-dir` argument.\n //! \\param[in] url The URL of an upload server. The handler will be started\n //! with this URL as its `--url` argument.\n //! \\param[in] annotations Process annotations to set in each crash report.\n //! The handler will be started with an `--annotation` argument for each\n //! element in this map.\n //! \\param[in] arguments Additional arguments to pass to the Crashpad handler.\n //! Arguments passed in other parameters and arguments required to perform\n //! the handshake are the responsibility of this method, and must not be\n //! specified in this parameter.\n //! \\param[in] socket The server end of a socket pair. The client end should\n //! be used with an ExceptionHandlerClient.\n //!\n //! \\return `true` on success, `false` on failure with a message logged.\n static bool StartHandlerForClient(\n const base::FilePath& handler,\n const base::FilePath& database,\n const base::FilePath& metrics_dir,\n const std::string& url,\n const std::map& annotations,\n const std::vector& arguments,\n int socket);\n\n //! \\brief Requests that the handler capture a dump even though there hasn't\n //! been a crash.\n //!\n //! A handler must have already been installed before calling this method.\n //!\n //! TODO(jperaza): Floating point information in the context is zeroed out\n //! until CaptureContext() supports collecting that information.\n //!\n //! \\param[in] context A NativeCPUContext, generally captured by\n //! CaptureContext() or similar.\n static void DumpWithoutCrash(NativeCPUContext* context);\n\n //! \\brief Disables any installed crash handler, not including any\n //! FirstChanceHandler and crashes the current process.\n //!\n //! \\param[in] message A message to be logged before crashing.\n [[noreturn]] static void CrashWithoutDump(const std::string& message);\n\n //! \\brief The type for custom handlers installed by clients.\n using FirstChanceHandler = bool (*)(int, siginfo_t*, ucontext_t*);\n\n //! \\brief Installs a custom crash signal handler which runs before the\n //! currently installed Crashpad handler.\n //!\n //! Handling signals appropriately can be tricky and use of this method\n //! should be avoided, if possible.\n //!\n //! A handler must have already been installed before calling this method.\n //!\n //! The custom handler runs in a signal handler context and must be safe for\n //! that purpose.\n //!\n //! If the custom handler returns `true`, the signal is considered handled and\n //! the signal handler returns. Otherwise, the currently installed Crashpad\n //! signal handler is run.\n //!\n //! \\param[in] handler The custom crash signal handler to install.\n static void SetFirstChanceExceptionHandler(FirstChanceHandler handler);\n\n //! \\brief Installs a custom crash signal handler which runs after the\n //! currently installed Crashpad handler.\n //!\n //! Handling signals appropriately can be tricky and use of this method\n //! should be avoided, if possible.\n //!\n //! A handler must have already been installed before calling this method.\n //!\n //! The custom handler runs in a signal handler context and must be safe for\n //! that purpose.\n //!\n //! If the custom handler returns `true`, the signal is not reraised.\n //!\n //! \\param[in] handler The custom crash signal handler to install.\n static void SetLastChanceExceptionHandler(bool (*handler)(int,\n siginfo_t*,\n ucontext_t*));\n\n //! \\brief Configures a set of signals that shouldn't have Crashpad signal\n //! handlers installed.\n //!\n //! This method should be called before calling StartHandler(),\n //! SetHandlerSocket(), or other methods that install Crashpad signal\n //! handlers.\n //!\n //! \\param[in] unhandled_signals The set of unhandled signals\n void SetUnhandledSignals(const std::set& unhandled_signals);\n#endif // BUILDFLAG(IS_LINUX) || BUILDFLAG(IS_ANDROID) ||\n // BUILDFLAG(IS_CHROMEOS) || DOXYGEN\n\n#if BUILDFLAG(IS_IOS) || DOXYGEN\n //! \\brief Observation callback invoked each time this object finishes\n //! processing and attempting to upload on-disk crash reports (whether or\n //! not the uploads succeeded).\n //!\n //! This callback is copied into this object. Any references or pointers\n //! inside must outlive this object.\n //!\n //! The callback might be invoked on a background thread, so clients must\n //! synchronize appropriately.\n using ProcessPendingReportsObservationCallback = std::function;\n\n //! \\brief Configures the process to direct its crashes to the iOS in-process\n //! Crashpad handler.\n //!\n //! This method is only defined on iOS.\n //!\n //! \\param[in] database The path to a Crashpad database.\n //! \\param[in] url The URL of an upload server.\n //! \\param[in] annotations Process annotations to set in each crash report.\n //! \\param[in] callback Optional callback invoked zero or more times\n //! on a background thread each time the handler finishes\n //! processing and attempting to upload on-disk crash reports.\n //! If this callback is empty, it is not invoked.\n //! \\return `true` on success, `false` on failure with a message logged.\n static bool StartCrashpadInProcessHandler(\n const base::FilePath& database,\n const std::string& url,\n const std::map& annotations,\n ProcessPendingReportsObservationCallback callback);\n\n //! \\brief Requests that the handler convert intermediate dumps into\n //! minidumps and trigger an upload if possible.\n //!\n //! A handler must have already been installed before calling this method.\n //! This method should be called when an application is ready to start\n //! processing previously created intermediate dumps. Processing will block,\n //! so this should not be called on the main UI thread. No intermediate dumps\n //! will be processed until this method is called.\n //!\n //! \\param[in] annotations Process annotations to set in each crash report.\n //! Useful when adding crash annotations detected on the next run after a\n //! crash but before upload.\n //! \\param[in] user_stream_sources An optional vector containing the\n //! extensibility data sources to call on crash. Each time a minidump is\n //! created, the sources are called in turn. Any streams returned are\n //! added to the minidump.\n static void ProcessIntermediateDumps(\n const std::map& annotations = {},\n const UserStreamDataSources* user_stream_sources = nullptr);\n\n //! \\brief Requests that the handler convert a single intermediate dump at \\a\n //! file generated by DumpWithoutCrashAndDeferProcessingAtPath into a\n //! minidump and trigger an upload if possible.\n //!\n //! A handler must have already been installed before calling this method.\n //! This method should be called when an application is ready to start\n //! processing previously created intermediate dumps. Processing will block,\n //! so this should not be called on the main UI thread.\n //!\n //! \\param[in] file The intermediate dump to process.\n //! \\param[in] annotations Process annotations to set in each crash report.\n //! Useful when adding crash annotations detected on the next run after a\n //! crash but before upload.\n static void ProcessIntermediateDump(\n const base::FilePath& file,\n const std::map& annotations = {});\n\n //! \\brief Requests that the handler begin in-process uploading of any\n //! pending reports.\n //!\n //! Once called the handler will start looking for pending reports to upload\n //! on another thread. This method does not block.\n //!\n //! A handler must have already been installed before calling this method.\n //!\n //! \\param[in] upload_behavior Controls when the upload thread will run and\n //! process pending reports. By default, only uploads pending reports\n //! when the application is active.\n static void StartProcessingPendingReports(\n UploadBehavior upload_behavior = UploadBehavior::kUploadWhenAppIsActive);\n\n //! \\brief Requests that the handler capture an intermediate dump even though\n //! there hasn't been a crash. The intermediate dump will be converted\n //! to a mindump immediately. If StartProcessingPendingReports() has been\n //! called, this will also trigger an upload.\n //!\n //! For internal use only. Clients should use CRASHPAD_SIMULATE_CRASH().\n //!\n //! A handler must have already been installed before calling this method.\n //!\n //! \\param[in] context A NativeCPUContext, generally captured by\n //! CaptureContext() or similar.\n static void DumpWithoutCrash(NativeCPUContext* context);\n\n //! \\brief Requests that the handler capture an intermediate dump even though\n //! there hasn't been a crash. The intermediate dump will not be converted\n //! to a mindump until ProcessIntermediateDumps() is called.\n //!\n //! For internal use only. Clients should use\n //! CRASHPAD_SIMULATE_CRASH_AND_DEFER_PROCESSING().\n //!\n //! A handler must have already been installed before calling this method.\n //!\n //! \\param[in] context A NativeCPUContext, generally captured by\n //! CaptureContext() or similar.\n static void DumpWithoutCrashAndDeferProcessing(NativeCPUContext* context);\n\n //! \\brief Requests that the handler capture an intermediate dump and store it\n //! in path, even though there hasn't been a crash. The intermediate dump\n //! will not be converted to a mindump until ProcessIntermediateDump() is\n //! called.\n //!\n //! For internal use only. Clients should use\n //! CRASHPAD_SIMULATE_CRASH_AND_DEFER_PROCESSING_AT_PATH().\n //!\n //! A handler must have already been installed before calling this method.\n //!\n //! \\param[in] context A NativeCPUContext, generally captured by\n //! CaptureContext() or similar.\n //! \\param[in] path The path for writing the intermediate dump.\n static void DumpWithoutCrashAndDeferProcessingAtPath(\n NativeCPUContext* context,\n const base::FilePath path);\n\n //! \\brief Unregister the Crashpad client. Intended to be used by tests so\n //! multiple Crashpad clients can be started and stopped. Not expected to\n //! be used in a shipping application.\n static void ResetForTesting();\n\n //! \\brief Inject a callback into the Mach exception and signal handling\n //! mechanisms. Intended to be used by tests to trigger a reentrant\n // exception.\n static void SetExceptionCallbackForTesting(void (*callback)());\n\n //! \\brief Returns the thread id of the Mach exception thread, used by tests.\n static uint64_t GetThreadIdForTesting();\n#endif\n\n#if BUILDFLAG(IS_APPLE) || DOXYGEN\n //! \\brief Sets the process’ crash handler to a Mach service registered with\n //! the bootstrap server.\n //!\n //! This method is only defined on macOS.\n //!\n //! See StartHandler() for more detail on how the port and handler are\n //! configured.\n //!\n //! \\param[in] service_name The service name of a Crashpad exception handler\n //! service previously registered with the bootstrap server.\n //!\n //! \\return `true` on success, `false` on failure with a message logged.\n bool SetHandlerMachService(const std::string& service_name);\n\n //! \\brief Sets the process’ crash handler to a Mach port.\n //!\n //! This method is only defined on macOS.\n //!\n //! See StartHandler() for more detail on how the port and handler are\n //! configured.\n //!\n //! \\param[in] exception_port An `exception_port_t` corresponding to a\n //! Crashpad exception handler service.\n //!\n //! \\return `true` on success, `false` on failure with a message logged.\n bool SetHandlerMachPort(base::apple::ScopedMachSendRight exception_port);\n\n //! \\brief Retrieves a send right to the process’ crash handler Mach port.\n //!\n //! This method is only defined on macOS.\n //!\n //! This method can be used to obtain the crash handler Mach port when a\n //! Crashpad client process wishes to provide a send right to this port to\n //! another process. The IPC mechanism used to convey the right is under the\n //! application’s control. If the other process wishes to become a client of\n //! the same crash handler, it can provide the transferred right to\n //! SetHandlerMachPort().\n //!\n //! See StartHandler() for more detail on how the port and handler are\n //! configured.\n //!\n //! \\return The Mach port set by SetHandlerMachPort(), possibly indirectly by\n //! a call to another method such as StartHandler() or\n //! SetHandlerMachService(). This method must only be called after a\n //! successful call to one of those methods. `MACH_PORT_NULL` on failure\n //! with a message logged.\n base::apple::ScopedMachSendRight GetHandlerMachPort() const;\n#endif\n\n#if BUILDFLAG(IS_WIN) || DOXYGEN\n //! \\brief Sets the IPC pipe of a presumably-running Crashpad handler process\n //! which was started with StartHandler() or by other compatible means\n //! and does an IPC message exchange to register this process with the\n //! handler. Crashes will be serviced once this method returns.\n //!\n //! This method is only defined on Windows.\n //!\n //! This method sets the unhandled exception handler to a local\n //! function that when reached will \"signal and wait\" for the crash handler\n //! process to create the dump.\n //!\n //! \\param[in] ipc_pipe The full name of the crash handler IPC pipe. This is\n //! a string of the form `"\\\\.\\pipe\\NAME"`.\n //!\n //! \\return `true` on success and `false` on failure.\n bool SetHandlerIPCPipe(const std::wstring& ipc_pipe);\n\n //! \\brief Retrieves the IPC pipe name used to register with the Crashpad\n //! handler.\n //!\n //! This method is only defined on Windows.\n //!\n //! This method retrieves the IPC pipe name set by SetHandlerIPCPipe(), or a\n //! suitable IPC pipe name chosen by StartHandler(). It must only be called\n //! after a successful call to one of those methods. It is intended to be used\n //! to obtain the IPC pipe name so that it may be passed to other processes,\n //! so that they may register with an existing Crashpad handler by calling\n //! SetHandlerIPCPipe().\n //!\n //! \\return The full name of the crash handler IPC pipe, a string of the form\n //! `"\\\\.\\pipe\\NAME"`.\n std::wstring GetHandlerIPCPipe() const;\n\n //! \\brief When `asynchronous_start` is used with StartHandler(), this method\n //! can be used to block until the handler launch has been completed to\n //! retrieve status information.\n //!\n //! This method should not be used unless `asynchronous_start` was `true`.\n //!\n //! \\param[in] timeout_ms The number of milliseconds to wait for a result from\n //! the background launch, or `0xffffffff` to block indefinitely.\n //!\n //! \\return `true` if the hander startup succeeded, `false` otherwise, and an\n //! error message will have been logged.\n bool WaitForHandlerStart(unsigned int timeout_ms);\n\n //! \\brief Register a DLL using WerRegisterExceptionModule().\n //!\n //! This method should only be called after a successful call to\n //! SetHandlerIPCPipe() or StartHandler(). The registration is valid for the\n //! lifetime of this object.\n //!\n //! \\param[in] full_path The full path to the DLL that will be registered.\n //! The DLL path should also be set in an appropriate\n //! `Windows Error Reporting` registry key.\n //!\n //! \\return `true` if the DLL was registered. Note: Windows just stashes the\n //! path somewhere so this returns `true` even if the DLL is not yet\n //! set in an appropriate registry key, or does not exist.\n bool RegisterWerModule(const std::wstring& full_path);\n\n //! \\brief Requests that the handler capture a dump even though there hasn't\n //! been a crash.\n //!\n //! \\param[in] context A `CONTEXT`, generally captured by CaptureContext() or\n //! similar.\n static void DumpWithoutCrash(const CONTEXT& context);\n\n //! \\brief Requests that the handler capture a dump using the given \\a\n //! exception_pointers to get the `EXCEPTION_RECORD` and `CONTEXT`.\n //!\n //! This function is not necessary in general usage as an unhandled exception\n //! filter is installed by StartHandler() or SetHandlerIPCPipe().\n //!\n //! \\param[in] exception_pointers An `EXCEPTION_POINTERS`, as would generally\n //! passed to an unhandled exception filter.\n static void DumpAndCrash(EXCEPTION_POINTERS* exception_pointers);\n\n //! \\brief Requests that the handler capture a dump of a different process.\n //!\n //! The target process must be an already-registered Crashpad client. An\n //! exception will be triggered in the target process, and the regular dump\n //! mechanism used. This function will block until the exception in the target\n //! process has been handled by the Crashpad handler.\n //!\n //! This function is unavailable when running on Windows XP and will return\n //! `false`.\n //!\n //! \\param[in] process A `HANDLE` identifying the process to be dumped.\n //! \\param[in] blame_thread If non-null, a `HANDLE` valid in the caller's\n //! process, referring to a thread in the target process. If this is\n //! supplied, instead of the exception referring to the location where the\n //! exception was injected, an exception record will be fabricated that\n //! refers to the current location of the given thread.\n //! \\param[in] exception_code If \\a blame_thread is non-null, this will be\n //! used as the exception code in the exception record.\n //!\n //! \\return `true` if the exception was triggered successfully.\n static bool DumpAndCrashTargetProcess(HANDLE process,\n HANDLE blame_thread,\n DWORD exception_code);\n#endif\n\n#if BUILDFLAG(IS_APPLE) || DOXYGEN\n //! \\brief Configures the process to direct its crashes to the default handler\n //! for the operating system.\n //!\n //! On macOS, this sets the task’s exception port as in SetHandlerMachPort(),\n //! but the exception handler used is obtained from\n //! SystemCrashReporterHandler(). If the system’s crash reporter handler\n //! cannot be determined or set, the task’s exception ports for crash-type\n //! exceptions are cleared.\n //!\n //! Use of this function is strongly discouraged.\n //!\n //! \\warning After a call to this function, Crashpad will no longer monitor\n //! the process for crashes until a subsequent call to\n //! SetHandlerMachPort().\n //!\n //! \\note This is provided as a static function to allow it to be used in\n //! situations where a CrashpadClient object is not otherwise available.\n //! This may be useful when a child process inherits its parent’s Crashpad\n //! handler, but wants to sever this tie.\n static void UseSystemDefaultHandler();\n#endif\n\n#if BUILDFLAG(IS_CHROMEOS)\n //! \\brief Sets a timestamp on the signal handler to be passed on to\n //! crashpad_handler and then eventually Chrome OS's crash_reporter.\n //!\n //! \\note This method is used by clients that use `StartHandler()` to start\n //! a handler and not by clients that use any other handler starting\n //! methods.\n static void SetCrashLoopBefore(uint64_t crash_loop_before_time);\n#endif\n\n private:\n#if BUILDFLAG(IS_WIN) || DOXYGEN\n //! \\brief Registers process handlers for the client.\n void RegisterHandlers();\n#endif\n\n#if BUILDFLAG(IS_APPLE)\n base::apple::ScopedMachSendRight exception_port_;\n#elif BUILDFLAG(IS_WIN)\n std::wstring ipc_pipe_;\n ScopedKernelHANDLE handler_start_thread_;\n ScopedVectoredExceptionRegistration vectored_handler_;\n#elif BUILDFLAG(IS_LINUX) || BUILDFLAG(IS_CHROMEOS) || BUILDFLAG(IS_ANDROID)\n std::set unhandled_signals_;\n#endif // BUILDFLAG(IS_APPLE)\n};\n\n} // namespace crashpad\n\n#endif // CRASHPAD_CLIENT_CRASHPAD_CLIENT_H_\n" }, { "path": "client/crashpad_client_fuchsia.cc", "content": "// Copyright 2017 The Crashpad Authors\n//\n// Licensed under the Apache License, Version 2.0 (the \"License\");\n// you may not use this file except in compliance with the License.\n// You may obtain a copy of the License at\n//\n// http://www.apache.org/licenses/LICENSE-2.0\n//\n// Unless required by applicable law or agreed to in writing, software\n// distributed under the License is distributed on an \"AS IS\" BASIS,\n// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n// See the License for the specific language governing permissions and\n// limitations under the License.\n\n#include \"client/crashpad_client.h\"\n\n#include \n#include \n#include \n#include \n#include \n\n#include \"base/check_op.h\"\n#include \"base/fuchsia/fuchsia_logging.h\"\n#include \"base/logging.h\"\n#include \"client/client_argv_handling.h\"\n\nnamespace crashpad {\n\nCrashpadClient::CrashpadClient() {}\n\nCrashpadClient::~CrashpadClient() {}\n\nbool CrashpadClient::StartHandler(\n const base::FilePath& handler,\n const base::FilePath& database,\n const base::FilePath& metrics_dir,\n const std::string& url,\n const std::map& annotations,\n const std::vector& arguments,\n bool restartable,\n bool asynchronous_start,\n const std::vector& attachments) {\n DCHECK(attachments.empty()); // Attachments are not implemented on Fuchsia yet.\n DCHECK_EQ(restartable, false); // Not used on Fuchsia.\n DCHECK_EQ(asynchronous_start, false); // Not used on Fuchsia.\n\n std::vector argv_strings = BuildHandlerArgvStrings(\n handler, database, metrics_dir, url, annotations, arguments);\n\n std::vector argv;\n StringVectorToCStringVector(argv_strings, &argv);\n\n // Set up handles to send to the spawned process:\n // 0. PA_USER0 job\n // 1. PA_USER0 exception channel\n //\n // Currently it is assumed that this process's default job handle is the\n // exception channel that should be monitored. In the future, it might be\n // useful for this to be configurable by the client.\n zx::job job;\n zx_status_t status =\n zx::job::default_job()->duplicate(ZX_RIGHT_SAME_RIGHTS, &job);\n if (status != ZX_OK) {\n ZX_LOG(ERROR, status) << \"zx_handle_duplicate\";\n return false;\n }\n\n zx::channel exception_channel;\n status = job.create_exception_channel(0, &exception_channel);\n if (status != ZX_OK) {\n ZX_LOG(ERROR, status) << \"zx_task_create_exception_channel\";\n return false;\n }\n\n constexpr size_t kActionCount = 2;\n fdio_spawn_action_t actions[] = {\n {.action = FDIO_SPAWN_ACTION_ADD_HANDLE,\n .h = {.id = PA_HND(PA_USER0, 0), .handle = job.release()}},\n {.action = FDIO_SPAWN_ACTION_ADD_HANDLE,\n .h = {.id = PA_HND(PA_USER0, 1), .handle = exception_channel.release()}},\n };\n\n char error_message[FDIO_SPAWN_ERR_MSG_MAX_LENGTH];\n zx::process child;\n // TODO(scottmg): https://crashpad.chromium.org/bug/196, FDIO_SPAWN_CLONE_ALL\n // is useful during bringup, but should probably be made minimal for real\n // usage.\n status = fdio_spawn_etc(ZX_HANDLE_INVALID,\n FDIO_SPAWN_CLONE_ALL,\n argv[0],\n argv.data(),\n nullptr,\n kActionCount,\n actions,\n child.reset_and_get_address(),\n error_message);\n if (status != ZX_OK) {\n ZX_LOG(ERROR, status) << \"fdio_spawn_etc: \" << error_message;\n return false;\n }\n\n return true;\n}\n\n} // namespace crashpad\n" }, { "path": "client/crashpad_client_ios.cc", "content": "// Copyright 2020 The Crashpad Authors\n//\n// Licensed under the Apache License, Version 2.0 (the \"License\");\n// you may not use this file except in compliance with the License.\n// You may obtain a copy of the License at\n//\n// http://www.apache.org/licenses/LICENSE-2.0\n//\n// Unless required by applicable law or agreed to in writing, software\n// distributed under the License is distributed on an \"AS IS\" BASIS,\n// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n// See the License for the specific language governing permissions and\n// limitations under the License.\n\n#include \"client/crashpad_client.h\"\n\n#include \"build/buildflag.h\"\n#include \"client/ios_handler/in_process_handler.h\"\n\n#if !BUILDFLAG(IS_IOS_TVOS)\n#include \"client/crash_handler_ios.h\"\n#else\n#include \"client/crash_handler_tvos.h\"\n#endif\n\nnamespace crashpad {\n\nCrashpadClient::CrashpadClient() {}\n\nCrashpadClient::~CrashpadClient() {}\n\n// static\nbool CrashpadClient::StartCrashpadInProcessHandler(\n const base::FilePath& database,\n const std::string& url,\n const std::map& annotations,\n ProcessPendingReportsObservationCallback callback) {\n CrashHandler* crash_handler = CrashHandler::Get();\n DCHECK(crash_handler);\n return crash_handler->Initialize(database, url, annotations, callback);\n}\n\n// static\nvoid CrashpadClient::ProcessIntermediateDumps(\n const std::map& annotations,\n const UserStreamDataSources* user_stream_sources) {\n CrashHandler* crash_handler = CrashHandler::Get();\n DCHECK(crash_handler);\n crash_handler->ProcessIntermediateDumps(annotations, user_stream_sources);\n}\n\n// static\nvoid CrashpadClient::ProcessIntermediateDump(\n const base::FilePath& file,\n const std::map& annotations) {\n CrashHandler* crash_handler = CrashHandler::Get();\n DCHECK(crash_handler);\n crash_handler->ProcessIntermediateDump(file, annotations);\n}\n\n// static\nvoid CrashpadClient::StartProcessingPendingReports(\n UploadBehavior upload_behavior) {\n CrashHandler* crash_handler = CrashHandler::Get();\n DCHECK(crash_handler);\n crash_handler->StartProcessingPendingReports(upload_behavior);\n}\n\n// static\nvoid CrashpadClient::DumpWithoutCrash(NativeCPUContext* context) {\n CrashHandler* crash_handler = CrashHandler::Get();\n DCHECK(crash_handler);\n crash_handler->DumpWithoutCrash(context, /*process_dump=*/true);\n}\n\n// static\nvoid CrashpadClient::DumpWithoutCrashAndDeferProcessing(\n NativeCPUContext* context) {\n CrashHandler* crash_handler = CrashHandler::Get();\n DCHECK(crash_handler);\n crash_handler->DumpWithoutCrash(context, /*process_dump=*/false);\n}\n\n// static\nvoid CrashpadClient::DumpWithoutCrashAndDeferProcessingAtPath(\n NativeCPUContext* context,\n const base::FilePath path) {\n CrashHandler* crash_handler = CrashHandler::Get();\n DCHECK(crash_handler);\n crash_handler->DumpWithoutCrashAtPath(context, path);\n}\n\nvoid CrashpadClient::ResetForTesting() {\n CrashHandler* crash_handler = CrashHandler::Get();\n DCHECK(crash_handler);\n crash_handler->ResetForTesting();\n}\n\nvoid CrashpadClient::SetExceptionCallbackForTesting(void (*callback)()) {\n CrashHandler* crash_handler = CrashHandler::Get();\n DCHECK(crash_handler);\n crash_handler->SetExceptionCallbackForTesting(callback);\n}\n\nuint64_t CrashpadClient::GetThreadIdForTesting() {\n CrashHandler* crash_handler = CrashHandler::Get();\n DCHECK(crash_handler);\n return crash_handler->GetThreadIdForTesting();\n}\n\n} // namespace crashpad\n" }, { "path": "client/crashpad_client_ios_test.mm", "content": "// Copyright 2020 The Crashpad Authors\n//\n// Licensed under the Apache License, Version 2.0 (the \"License\");\n// you may not use this file except in compliance with the License.\n// You may obtain a copy of the License at\n//\n// http://www.apache.org/licenses/LICENSE-2.0\n//\n// Unless required by applicable law or agreed to in writing, software\n// distributed under the License is distributed on an \"AS IS\" BASIS,\n// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n// See the License for the specific language governing permissions and\n// limitations under the License.\n\n#include \"client/crashpad_client.h\"\n\n#import \n\n#include \n#include \n\n#include \"base/strings/sys_string_conversions.h\"\n#include \"client/crash_report_database.h\"\n#include \"client/ios_handler/exception_processor.h\"\n#include \"client/simulate_crash.h\"\n#include \"gtest/gtest.h\"\n#include \"test/scoped_temp_dir.h\"\n#include \"testing/platform_test.h\"\n#include \"util/thread/thread.h\"\n\nnamespace crashpad {\nnamespace test {\nnamespace {\n\nclass CrashpadIOSClient : public PlatformTest {\n protected:\n // testing::Test:\n\n void SetUp() override {\n ASSERT_TRUE(client_.StartCrashpadInProcessHandler(\n base::FilePath(database_dir.path()),\n \"\",\n {},\n CrashpadClient::ProcessPendingReportsObservationCallback()));\n database_ = CrashReportDatabase::Initialize(database_dir.path());\n }\n\n void TearDown() override { client_.ResetForTesting(); }\n\n auto& Client() { return client_; }\n auto& Database() { return database_; }\n\n private:\n std::unique_ptr database_;\n CrashpadClient client_;\n ScopedTempDir database_dir;\n};\n\nTEST_F(CrashpadIOSClient, DumpWithoutCrash) {\n std::vector reports;\n EXPECT_EQ(Database()->GetPendingReports(&reports),\n CrashReportDatabase::kNoError);\n ASSERT_EQ(reports.size(), 0u);\n CRASHPAD_SIMULATE_CRASH();\n\n EXPECT_EQ(Database()->GetPendingReports(&reports),\n CrashReportDatabase::kNoError);\n ASSERT_EQ(reports.size(), 1u);\n}\n\nTEST_F(CrashpadIOSClient, DumpWithoutCrashAndDefer) {\n std::vector reports;\n CRASHPAD_SIMULATE_CRASH_AND_DEFER_PROCESSING();\n EXPECT_EQ(Database()->GetPendingReports(&reports),\n CrashReportDatabase::kNoError);\n ASSERT_EQ(reports.size(), 0u);\n Client().ProcessIntermediateDumps();\n EXPECT_EQ(Database()->GetPendingReports(&reports),\n CrashReportDatabase::kNoError);\n ASSERT_EQ(reports.size(), 1u);\n}\n\nTEST_F(CrashpadIOSClient, DumpWithoutCrashAndDeferAtPath) {\n std::vector reports;\n ScopedTempDir crash_dir;\n UUID uuid;\n uuid.InitializeWithNew();\n CRASHPAD_SIMULATE_CRASH_AND_DEFER_PROCESSING_AT_PATH(\n crash_dir.path().Append(uuid.ToString()));\n EXPECT_EQ(Database()->GetPendingReports(&reports),\n CrashReportDatabase::kNoError);\n ASSERT_EQ(reports.size(), 0u);\n\n NSError* error = nil;\n NSArray* paths = [[NSFileManager defaultManager]\n contentsOfDirectoryAtPath:base::SysUTF8ToNSString(\n crash_dir.path().value())\n error:&error];\n ASSERT_EQ([paths count], 1u);\n Client().ProcessIntermediateDump(\n crash_dir.path().Append([paths[0] fileSystemRepresentation]));\n reports.clear();\n EXPECT_EQ(Database()->GetPendingReports(&reports),\n CrashReportDatabase::kNoError);\n ASSERT_EQ(reports.size(), 1u);\n}\n\nclass RaceThread : public Thread {\n public:\n explicit RaceThread() : Thread() {}\n\n private:\n void ThreadMain() override {\n for (int i = 0; i < 10; ++i) {\n CRASHPAD_SIMULATE_CRASH();\n }\n }\n};\n\nTEST_F(CrashpadIOSClient, MultipleThreadsSimulateCrash) {\n RaceThread race_threads[2];\n for (RaceThread& race_thread : race_threads) {\n race_thread.Start();\n }\n\n for (int i = 0; i < 10; ++i) {\n CRASHPAD_SIMULATE_CRASH();\n }\n for (RaceThread& race_thread : race_threads) {\n race_thread.Join();\n }\n\n std::vector reports;\n ASSERT_EQ(Database()->GetPendingReports(&reports),\n CrashReportDatabase::kNoError);\n EXPECT_EQ(reports.size(), 30u);\n}\n\n// This test is covered by a similar XCUITest, but for development purposes it's\n// sometimes easier and faster to run in Google Test. However, there's no way\n// to correctly run this in Google Test. Leave the test here, disabled, for use\n// during development only.\nTEST_F(CrashpadIOSClient, DISABLED_ThrowNSException) {\n [NSException raise:@\"GoogleTestNSException\" format:@\"ThrowException\"];\n}\n\n// This test is covered by a similar XCUITest, but for development purposes it's\n// sometimes easier and faster to run in Google Test. However, there's no way\n// to correctly run this in Google Test. Leave the test here, disabled, for use\n// during development only.\nTEST_F(CrashpadIOSClient, DISABLED_ThrowException) {\n std::vector empty_vector;\n std::ignore = empty_vector.at(42);\n}\n\n} // namespace\n} // namespace test\n} // namespace crashpad\n" }, { "path": "client/crashpad_client_linux.cc", "content": "// Copyright 2018 The Crashpad Authors\n//\n// Licensed under the Apache License, Version 2.0 (the \"License\");\n// you may not use this file except in compliance with the License.\n// You may obtain a copy of the License at\n//\n// http://www.apache.org/licenses/LICENSE-2.0\n//\n// Unless required by applicable law or agreed to in writing, software\n// distributed under the License is distributed on an \"AS IS\" BASIS,\n// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n// See the License for the specific language governing permissions and\n// limitations under the License.\n\n#include \"client/crashpad_client.h\"\n\n#include \n#include \n#include \n#include \n#include \n#include \n#include \n#include \n#include \n#include \n#include \n#include \n#include \n\n#include \n\n#include \"base/check_op.h\"\n#include \"base/logging.h\"\n#include \"base/strings/stringprintf.h\"\n#include \"build/build_config.h\"\n#include \"client/client_argv_handling.h\"\n#include \"third_party/lss/lss.h\"\n#include \"util/file/file_io.h\"\n#include \"util/file/filesystem.h\"\n#include \"util/linux/exception_handler_client.h\"\n#include \"util/linux/exception_information.h\"\n#include \"util/linux/scoped_pr_set_dumpable.h\"\n#include \"util/linux/scoped_pr_set_ptracer.h\"\n#include \"util/linux/socket.h\"\n#include \"util/misc/address_sanitizer.h\"\n#include \"util/misc/from_pointer_cast.h\"\n#include \"util/posix/scoped_mmap.h\"\n#include \"util/posix/signals.h\"\n#include \"util/posix/spawn_subprocess.h\"\n\nnamespace crashpad {\n\nnamespace {\n\nstd::string FormatArgumentInt(const std::string& name, int value) {\n return base::StringPrintf(\"--%s=%d\", name.c_str(), value);\n}\n\nstd::string FormatArgumentAddress(const std::string& name, const void* addr) {\n return base::StringPrintf(\"--%s=%p\", name.c_str(), addr);\n}\n\n#if BUILDFLAG(IS_ANDROID)\n\nstd::vector BuildAppProcessArgs(\n const std::string& class_name,\n const base::FilePath& database,\n const base::FilePath& metrics_dir,\n const std::string& url,\n const std::map& annotations,\n const std::vector& arguments,\n int socket) {\n#if defined(ARCH_CPU_64_BITS)\n static constexpr char kAppProcess[] = \"/system/bin/app_process64\";\n#else\n static constexpr char kAppProcess[] = \"/system/bin/app_process32\";\n#endif\n\n std::vector argv;\n argv.push_back(kAppProcess);\n argv.push_back(\"/system/bin\");\n argv.push_back(\"--application\");\n argv.push_back(class_name);\n\n std::vector handler_argv =\n BuildHandlerArgvStrings(base::FilePath(kAppProcess),\n database,\n metrics_dir,\n url,\n annotations,\n arguments);\n\n if (socket != kInvalidFileHandle) {\n handler_argv.push_back(FormatArgumentInt(\"initial-client-fd\", socket));\n }\n\n argv.insert(argv.end(), handler_argv.begin(), handler_argv.end());\n return argv;\n}\n\nstd::vector BuildArgsToLaunchWithLinker(\n const std::string& handler_trampoline,\n const std::string& handler_library,\n bool is_64_bit,\n const base::FilePath& database,\n const base::FilePath& metrics_dir,\n const std::string& url,\n const std::map& annotations,\n const std::vector& arguments,\n int socket) {\n std::vector argv;\n if (is_64_bit) {\n argv.push_back(\"/system/bin/linker64\");\n } else {\n argv.push_back(\"/system/bin/linker\");\n }\n argv.push_back(handler_trampoline);\n argv.push_back(handler_library);\n\n std::vector handler_argv = BuildHandlerArgvStrings(\n base::FilePath(), database, metrics_dir, url, annotations, arguments);\n\n if (socket != kInvalidFileHandle) {\n handler_argv.push_back(FormatArgumentInt(\"initial-client-fd\", socket));\n }\n\n argv.insert(argv.end(), handler_argv.begin() + 1, handler_argv.end());\n return argv;\n}\n\n#endif // BUILDFLAG(IS_ANDROID)\n\nusing LastChanceHandler = bool (*)(int, siginfo_t*, ucontext_t*);\n\n// A base class for Crashpad signal handler implementations.\nclass SignalHandler {\n public:\n SignalHandler(const SignalHandler&) = delete;\n SignalHandler& operator=(const SignalHandler&) = delete;\n\n // Returns the currently installed signal hander. May be `nullptr` if no\n // handler has been installed.\n static SignalHandler* Get() { return handler_; }\n\n // Disables any installed Crashpad signal handler. If a crash signal is\n // received, any previously installed (non-Crashpad) signal handler will be\n // restored and the signal reraised.\n static void Disable() {\n if (!handler_->disabled_.test_and_set()) {\n handler_->WakeThreads();\n }\n }\n\n void SetFirstChanceHandler(CrashpadClient::FirstChanceHandler handler) {\n first_chance_handler_ = handler;\n }\n\n void SetLastChanceExceptionHandler(LastChanceHandler handler) {\n last_chance_handler_ = handler;\n }\n\n // The base implementation for all signal handlers, suitable for calling\n // directly to simulate signal delivery.\n void HandleCrash(int signo, siginfo_t* siginfo, void* context) {\n exception_information_.siginfo_address =\n FromPointerCast(\n siginfo);\n exception_information_.context_address =\n FromPointerCast(\n context);\n exception_information_.thread_id = sys_gettid();\n\n ScopedPrSetDumpable set_dumpable(false);\n HandleCrashImpl();\n }\n\n protected:\n SignalHandler() = default;\n ~SignalHandler() = default;\n\n bool Install(const std::set* unhandled_signals) {\n bool signal_stack_initialized =\n CrashpadClient::InitializeSignalStackForThread();\n DCHECK(signal_stack_initialized);\n\n DCHECK(!handler_);\n handler_ = this;\n return Signals::InstallCrashHandlers(HandleOrReraiseSignal,\n SA_ONSTACK | SA_EXPOSE_TAGBITS,\n &old_actions_,\n unhandled_signals);\n }\n\n const ExceptionInformation& GetExceptionInfo() {\n return exception_information_;\n }\n\n virtual void HandleCrashImpl() = 0;\n\n private:\n static constexpr int32_t kDumpNotDone = 0;\n static constexpr int32_t kDumpDone = 1;\n\n // The signal handler installed at OS-level.\n static void HandleOrReraiseSignal(int signo,\n siginfo_t* siginfo,\n void* context) {\n if (handler_->first_chance_handler_ &&\n handler_->first_chance_handler_(\n signo, siginfo, static_cast(context))) {\n return;\n }\n\n // Only handle the first fatal signal observed. If another thread receives a\n // crash signal, it waits for the first dump to complete instead of\n // requesting another.\n if (!handler_->disabled_.test_and_set()) {\n handler_->HandleCrash(signo, siginfo, context);\n handler_->WakeThreads();\n if (handler_->last_chance_handler_ &&\n handler_->last_chance_handler_(\n signo, siginfo, static_cast(context))) {\n return;\n }\n } else {\n // Processes on Android normally have several chained signal handlers that\n // co-operate to report crashes. e.g. WebView will have this signal\n // handler installed, the app embedding WebView may have a signal handler\n // installed, and Bionic will have a signal handler. Each signal handler\n // runs in succession, possibly managed by libsigchain. This wait is\n // intended to avoid ill-effects from multiple signal handlers from\n // different layers (possibly all trying to use ptrace()) from running\n // simultaneously. It does not block forever so that in most conditions,\n // those signal handlers will still have a chance to run and ensures\n // process termination in case the first crashing thread crashes again in\n // its signal handler. Though less typical, this situation also occurs on\n // other Linuxes, e.g. to produce in-process stack traces for debug\n // builds.\n handler_->WaitForDumpDone();\n }\n\n Signals::RestoreHandlerAndReraiseSignalOnReturn(\n siginfo, handler_->old_actions_.ActionForSignal(signo));\n }\n\n void WaitForDumpDone() {\n kernel_timespec timeout;\n timeout.tv_sec = 5;\n timeout.tv_nsec = 0;\n sys_futex(&dump_done_futex_,\n FUTEX_WAIT_PRIVATE,\n kDumpNotDone,\n &timeout,\n nullptr,\n 0);\n }\n\n void WakeThreads() {\n dump_done_futex_ = kDumpDone;\n sys_futex(\n &dump_done_futex_, FUTEX_WAKE_PRIVATE, INT_MAX, nullptr, nullptr, 0);\n }\n\n Signals::OldActions old_actions_ = {};\n ExceptionInformation exception_information_ = {};\n CrashpadClient::FirstChanceHandler first_chance_handler_ = nullptr;\n LastChanceHandler last_chance_handler_ = nullptr;\n int32_t dump_done_futex_ = kDumpNotDone;\n#if !defined(__cpp_lib_atomic_value_initialization) || \\\n __cpp_lib_atomic_value_initialization < 201911L\n std::atomic_flag disabled_ = ATOMIC_FLAG_INIT;\n#else\n std::atomic_flag disabled_;\n#endif\n\n static SignalHandler* handler_;\n};\nSignalHandler* SignalHandler::handler_ = nullptr;\n\n// Launches a single use handler to snapshot this process.\nclass LaunchAtCrashHandler : public SignalHandler {\n public:\n LaunchAtCrashHandler(const LaunchAtCrashHandler&) = delete;\n LaunchAtCrashHandler& operator=(const LaunchAtCrashHandler&) = delete;\n\n static LaunchAtCrashHandler* Get() {\n static LaunchAtCrashHandler* instance = new LaunchAtCrashHandler();\n return instance;\n }\n\n bool Initialize(std::vector* argv_in,\n const std::vector* envp,\n const std::set* unhandled_signals) {\n argv_strings_.swap(*argv_in);\n\n if (envp) {\n envp_strings_ = *envp;\n StringVectorToCStringVector(envp_strings_, &envp_);\n set_envp_ = true;\n }\n\n argv_strings_.push_back(FormatArgumentAddress(\"trace-parent-with-exception\",\n &GetExceptionInfo()));\n\n StringVectorToCStringVector(argv_strings_, &argv_);\n return Install(unhandled_signals);\n }\n\n void HandleCrashImpl() override {\n ScopedPrSetPtracer set_ptracer(sys_getpid(), /* may_log= */ false);\n\n pid_t pid = fork();\n if (pid < 0) {\n return;\n }\n if (pid == 0) {\n if (set_envp_) {\n execve(argv_[0],\n const_cast(argv_.data()),\n const_cast(envp_.data()));\n } else {\n execv(argv_[0], const_cast(argv_.data()));\n }\n _exit(EXIT_FAILURE);\n }\n\n int status;\n waitpid(pid, &status, 0);\n }\n\n private:\n LaunchAtCrashHandler() = default;\n\n ~LaunchAtCrashHandler() = delete;\n\n std::vector argv_strings_;\n std::vector argv_;\n std::vector envp_strings_;\n std::vector envp_;\n bool set_envp_ = false;\n};\n\nclass RequestCrashDumpHandler : public SignalHandler {\n public:\n RequestCrashDumpHandler(const RequestCrashDumpHandler&) = delete;\n RequestCrashDumpHandler& operator=(const RequestCrashDumpHandler&) = delete;\n\n static RequestCrashDumpHandler* Get() {\n static RequestCrashDumpHandler* instance = new RequestCrashDumpHandler();\n return instance;\n }\n\n // pid < 0 indicates the handler pid should be determined by communicating\n // over the socket.\n // pid == 0 indicates it is not necessary to set the handler as this process'\n // ptracer. e.g. if the handler has CAP_SYS_PTRACE or if this process is in a\n // user namespace and the handler's uid matches the uid of the process that\n // created the namespace.\n // pid > 0 directly indicates what the handler's pid is expected to be, so\n // retrieving this information from the handler is not necessary.\n bool Initialize(ScopedFileHandle sock,\n pid_t pid,\n const std::set* unhandled_signals) {\n ExceptionHandlerClient client(sock.get(), true);\n if (pid < 0) {\n ucred creds;\n if (!client.GetHandlerCredentials(&creds)) {\n return false;\n }\n pid = creds.pid;\n }\n if (pid > 0) {\n pthread_atfork(nullptr, nullptr, SetPtracerAtFork);\n if (prctl(PR_SET_PTRACER, pid, 0, 0, 0) != 0) {\n PLOG(WARNING) << \"prctl\";\n }\n }\n sock_to_handler_.reset(sock.release());\n handler_pid_ = pid;\n return Install(unhandled_signals);\n }\n\n bool GetHandlerSocket(int* sock, pid_t* pid) {\n if (!sock_to_handler_.is_valid()) {\n return false;\n }\n if (sock) {\n *sock = sock_to_handler_.get();\n }\n if (pid) {\n *pid = handler_pid_;\n }\n return true;\n }\n\n void HandleCrashImpl() override {\n // Attempt to set the ptracer again, in case a crash occurs after a fork,\n // before SetPtracerAtFork() has been called. Ignore errors because the\n // system call may be disallowed if the sandbox is engaged.\n if (handler_pid_ > 0) {\n sys_prctl(PR_SET_PTRACER, handler_pid_, 0, 0, 0);\n }\n\n ExceptionHandlerProtocol::ClientInformation info = {};\n info.exception_information_address =\n FromPointerCast(&GetExceptionInfo());\n#if BUILDFLAG(IS_CHROMEOS)\n info.crash_loop_before_time = crash_loop_before_time_;\n#endif\n\n ExceptionHandlerClient client(sock_to_handler_.get(), true);\n client.RequestCrashDump(info);\n }\n\n#if BUILDFLAG(IS_CHROMEOS)\n void SetCrashLoopBefore(uint64_t crash_loop_before_time) {\n crash_loop_before_time_ = crash_loop_before_time;\n }\n#endif\n\n private:\n RequestCrashDumpHandler() = default;\n\n ~RequestCrashDumpHandler() = delete;\n\n static void SetPtracerAtFork() {\n auto handler = RequestCrashDumpHandler::Get();\n if (handler->handler_pid_ > 0 &&\n prctl(PR_SET_PTRACER, handler->handler_pid_, 0, 0, 0) != 0) {\n PLOG(WARNING) << \"prctl\";\n }\n }\n\n ScopedFileHandle sock_to_handler_;\n pid_t handler_pid_ = -1;\n\n#if BUILDFLAG(IS_CHROMEOS)\n // An optional UNIX timestamp passed to us from Chrome.\n // This will pass to crashpad_handler and then to Chrome OS crash_reporter.\n // This should really be a time_t, but it's basically an opaque value (we\n // don't anything with it except pass it along).\n uint64_t crash_loop_before_time_ = 0;\n#endif\n};\n\n} // namespace\n\nCrashpadClient::CrashpadClient() {}\n\nCrashpadClient::~CrashpadClient() {}\n\nbool CrashpadClient::StartHandler(\n const base::FilePath& handler,\n const base::FilePath& database,\n const base::FilePath& metrics_dir,\n const std::string& url,\n const std::map& annotations,\n const std::vector& arguments,\n bool restartable,\n bool asynchronous_start,\n const std::vector& attachments) {\n DCHECK(!asynchronous_start);\n\n ScopedFileHandle client_sock, handler_sock;\n if (!UnixCredentialSocket::CreateCredentialSocketpair(&client_sock,\n &handler_sock)) {\n return false;\n }\n\n std::vector argv = BuildHandlerArgvStrings(\n handler, database, metrics_dir, url, annotations, arguments, attachments);\n\n argv.push_back(FormatArgumentInt(\"initial-client-fd\", handler_sock.get()));\n argv.push_back(\"--shared-client-connection\");\n if (!SpawnSubprocess(argv, nullptr, handler_sock.get(), false, nullptr)) {\n return false;\n }\n handler_sock.reset();\n\n pid_t handler_pid = -1;\n if (!IsRegularFile(base::FilePath(\"/proc/sys/kernel/yama/ptrace_scope\"))) {\n handler_pid = 0;\n }\n\n auto signal_handler = RequestCrashDumpHandler::Get();\n return signal_handler->Initialize(\n std::move(client_sock), handler_pid, &unhandled_signals_);\n}\n\n#if BUILDFLAG(IS_ANDROID) || BUILDFLAG(IS_LINUX) || BUILDFLAG(IS_CHROMEOS)\n// static\nbool CrashpadClient::GetHandlerSocket(int* sock, pid_t* pid) {\n auto signal_handler = RequestCrashDumpHandler::Get();\n return signal_handler->GetHandlerSocket(sock, pid);\n}\n\nbool CrashpadClient::SetHandlerSocket(ScopedFileHandle sock, pid_t pid) {\n auto signal_handler = RequestCrashDumpHandler::Get();\n return signal_handler->Initialize(std::move(sock), pid, &unhandled_signals_);\n}\n\n// static\nbool CrashpadClient::InitializeSignalStackForThread() {\n stack_t stack;\n if (sigaltstack(nullptr, &stack) != 0) {\n PLOG(ERROR) << \"sigaltstack\";\n return false;\n }\n\n DCHECK_EQ(stack.ss_flags & SS_ONSTACK, 0);\n\n const size_t page_size = getpagesize();\n#if defined(ADDRESS_SANITIZER)\n const size_t kStackSize = 2 * ((SIGSTKSZ + page_size - 1) & ~(page_size - 1));\n#else\n const size_t kStackSize = (SIGSTKSZ + page_size - 1) & ~(page_size - 1);\n#endif // ADDRESS_SANITIZER\n if (stack.ss_flags & SS_DISABLE || stack.ss_size < kStackSize) {\n const size_t kGuardPageSize = page_size;\n const size_t kStackAllocSize = kStackSize + 2 * kGuardPageSize;\n\n static void (*stack_destructor)(void*) = [](void* stack_mem) {\n const size_t page_size = getpagesize();\n const size_t kGuardPageSize = page_size;\n#if defined(ADDRESS_SANITIZER)\n const size_t kStackSize =\n 2 * ((SIGSTKSZ + page_size - 1) & ~(page_size - 1));\n#else\n const size_t kStackSize = (SIGSTKSZ + page_size - 1) & ~(page_size - 1);\n#endif // ADDRESS_SANITIZER\n const size_t kStackAllocSize = kStackSize + 2 * kGuardPageSize;\n\n stack_t stack;\n stack.ss_flags = SS_DISABLE;\n if (sigaltstack(&stack, &stack) != 0) {\n PLOG(ERROR) << \"sigaltstack\";\n } else if (stack.ss_sp !=\n static_cast(stack_mem) + kGuardPageSize) {\n PLOG_IF(ERROR, sigaltstack(&stack, nullptr) != 0) << \"sigaltstack\";\n }\n\n if (munmap(stack_mem, kStackAllocSize) != 0) {\n PLOG(ERROR) << \"munmap\";\n }\n };\n\n static pthread_key_t stack_key;\n static int key_error = []() {\n errno = pthread_key_create(&stack_key, stack_destructor);\n PLOG_IF(ERROR, errno) << \"pthread_key_create\";\n return errno;\n }();\n if (key_error) {\n return false;\n }\n\n auto old_stack = static_cast(pthread_getspecific(stack_key));\n if (old_stack) {\n stack.ss_sp = old_stack + kGuardPageSize;\n } else {\n ScopedMmap stack_mem;\n if (!stack_mem.ResetMmap(nullptr,\n kStackAllocSize,\n PROT_NONE,\n MAP_PRIVATE | MAP_ANONYMOUS,\n -1,\n 0)) {\n return false;\n }\n\n if (mprotect(stack_mem.addr_as() + kGuardPageSize,\n kStackSize,\n PROT_READ | PROT_WRITE) != 0) {\n PLOG(ERROR) << \"mprotect\";\n return false;\n }\n\n stack.ss_sp = stack_mem.addr_as() + kGuardPageSize;\n\n errno = pthread_setspecific(stack_key, stack_mem.release());\n PCHECK(errno == 0) << \"pthread_setspecific\";\n }\n\n stack.ss_size = kStackSize;\n stack.ss_flags =\n (stack.ss_flags & SS_DISABLE) ? 0 : stack.ss_flags & SS_AUTODISARM;\n if (sigaltstack(&stack, nullptr) != 0) {\n PLOG(ERROR) << \"sigaltstack\";\n return false;\n }\n }\n return true;\n}\n#endif // BUILDFLAG(IS_ANDROID) || BUILDFLAG(IS_LINUX) ||\n // BUILDFLAG(IS_CHROMEOS)\n\n#if BUILDFLAG(IS_ANDROID)\n\nbool CrashpadClient::StartJavaHandlerAtCrash(\n const std::string& class_name,\n const std::vector* env,\n const base::FilePath& database,\n const base::FilePath& metrics_dir,\n const std::string& url,\n const std::map& annotations,\n const std::vector& arguments) {\n std::vector argv = BuildAppProcessArgs(class_name,\n database,\n metrics_dir,\n url,\n annotations,\n arguments,\n kInvalidFileHandle);\n\n auto signal_handler = LaunchAtCrashHandler::Get();\n return signal_handler->Initialize(&argv, env, &unhandled_signals_);\n}\n\n// static\nbool CrashpadClient::StartJavaHandlerForClient(\n const std::string& class_name,\n const std::vector* env,\n const base::FilePath& database,\n const base::FilePath& metrics_dir,\n const std::string& url,\n const std::map& annotations,\n const std::vector& arguments,\n int socket) {\n std::vector argv = BuildAppProcessArgs(\n class_name, database, metrics_dir, url, annotations, arguments, socket);\n return SpawnSubprocess(argv, env, socket, false, nullptr);\n}\n\nbool CrashpadClient::StartHandlerWithLinkerAtCrash(\n const std::string& handler_trampoline,\n const std::string& handler_library,\n bool is_64_bit,\n const std::vector* env,\n const base::FilePath& database,\n const base::FilePath& metrics_dir,\n const std::string& url,\n const std::map& annotations,\n const std::vector& arguments) {\n std::vector argv =\n BuildArgsToLaunchWithLinker(handler_trampoline,\n handler_library,\n is_64_bit,\n database,\n metrics_dir,\n url,\n annotations,\n arguments,\n kInvalidFileHandle);\n auto signal_handler = LaunchAtCrashHandler::Get();\n return signal_handler->Initialize(&argv, env, &unhandled_signals_);\n}\n\n// static\nbool CrashpadClient::StartHandlerWithLinkerForClient(\n const std::string& handler_trampoline,\n const std::string& handler_library,\n bool is_64_bit,\n const std::vector* env,\n const base::FilePath& database,\n const base::FilePath& metrics_dir,\n const std::string& url,\n const std::map& annotations,\n const std::vector& arguments,\n int socket) {\n std::vector argv =\n BuildArgsToLaunchWithLinker(handler_trampoline,\n handler_library,\n is_64_bit,\n database,\n metrics_dir,\n url,\n annotations,\n arguments,\n socket);\n return SpawnSubprocess(argv, env, socket, false, nullptr);\n}\n\n#endif\n\nbool CrashpadClient::StartHandlerAtCrash(\n const base::FilePath& handler,\n const base::FilePath& database,\n const base::FilePath& metrics_dir,\n const std::string& url,\n const std::map& annotations,\n const std::vector& arguments,\n const std::vector& attachments) {\n std::vector argv = BuildHandlerArgvStrings(\n handler, database, metrics_dir, url, annotations, arguments, attachments);\n\n auto signal_handler = LaunchAtCrashHandler::Get();\n return signal_handler->Initialize(&argv, nullptr, &unhandled_signals_);\n}\n\n// static\nbool CrashpadClient::StartHandlerForClient(\n const base::FilePath& handler,\n const base::FilePath& database,\n const base::FilePath& metrics_dir,\n const std::string& url,\n const std::map& annotations,\n const std::vector& arguments,\n int socket) {\n std::vector argv = BuildHandlerArgvStrings(\n handler, database, metrics_dir, url, annotations, arguments);\n\n argv.push_back(FormatArgumentInt(\"initial-client-fd\", socket));\n\n return SpawnSubprocess(argv, nullptr, socket, true, nullptr);\n}\n\n// static\nvoid CrashpadClient::DumpWithoutCrash(NativeCPUContext* context) {\n if (!SignalHandler::Get()) {\n DLOG(ERROR) << \"Crashpad isn't enabled\";\n return;\n }\n\n#if defined(ARCH_CPU_ARMEL)\n memset(context->uc_regspace, 0, sizeof(context->uc_regspace));\n#elif defined(ARCH_CPU_ARM64)\n memset(context->uc_mcontext.__reserved,\n 0,\n sizeof(context->uc_mcontext.__reserved));\n#endif\n\n siginfo_t siginfo;\n siginfo.si_signo = Signals::kSimulatedSigno;\n siginfo.si_errno = 0;\n siginfo.si_code = 0;\n SignalHandler::Get()->HandleCrash(\n siginfo.si_signo, &siginfo, reinterpret_cast(context));\n}\n\n// static\nvoid CrashpadClient::CrashWithoutDump(const std::string& message) {\n SignalHandler::Disable();\n LOG(FATAL) << message;\n}\n\n// static\nvoid CrashpadClient::SetFirstChanceExceptionHandler(\n FirstChanceHandler handler) {\n DCHECK(SignalHandler::Get());\n SignalHandler::Get()->SetFirstChanceHandler(handler);\n}\n\n// static\nvoid CrashpadClient::SetLastChanceExceptionHandler(LastChanceHandler handler) {\n DCHECK(SignalHandler::Get());\n SignalHandler::Get()->SetLastChanceExceptionHandler(handler);\n}\n\nvoid CrashpadClient::SetUnhandledSignals(const std::set& signals) {\n DCHECK(!SignalHandler::Get());\n unhandled_signals_ = signals;\n}\n\n#if BUILDFLAG(IS_CHROMEOS)\n// static\nvoid CrashpadClient::SetCrashLoopBefore(uint64_t crash_loop_before_time) {\n auto request_crash_dump_handler = RequestCrashDumpHandler::Get();\n request_crash_dump_handler->SetCrashLoopBefore(crash_loop_before_time);\n}\n#endif\n\n} // namespace crashpad\n" }, { "path": "client/crashpad_client_linux_test.cc", "content": "// Copyright 2018 The Crashpad Authors\n//\n// Licensed under the Apache License, Version 2.0 (the \"License\");\n// you may not use this file except in compliance with the License.\n// You may obtain a copy of the License at\n//\n// http://www.apache.org/licenses/LICENSE-2.0\n//\n// Unless required by applicable law or agreed to in writing, software\n// distributed under the License is distributed on an \"AS IS\" BASIS,\n// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n// See the License for the specific language governing permissions and\n// limitations under the License.\n\n#include \"client/crashpad_client.h\"\n\n#include \n#include \n#include \n#include \n#include \n#include \n#include \n#include \n\n#include \"base/check_op.h\"\n#include \"build/build_config.h\"\n#include \"client/annotation.h\"\n#include \"client/annotation_list.h\"\n#include \"client/crash_report_database.h\"\n#include \"client/crashpad_info.h\"\n#include \"client/simulate_crash.h\"\n#include \"gtest/gtest.h\"\n#include \"snapshot/annotation_snapshot.h\"\n#include \"snapshot/minidump/process_snapshot_minidump.h\"\n#include \"snapshot/sanitized/sanitization_information.h\"\n#include \"test/errors.h\"\n#include \"test/multiprocess.h\"\n#include \"test/multiprocess_exec.h\"\n#include \"test/scoped_temp_dir.h\"\n#include \"test/test_paths.h\"\n#include \"util/file/file_io.h\"\n#include \"util/file/filesystem.h\"\n#include \"util/linux/exception_handler_client.h\"\n#include \"util/linux/exception_information.h\"\n#include \"util/linux/socket.h\"\n#include \"util/misc/address_sanitizer.h\"\n#include \"util/misc/address_types.h\"\n#include \"util/misc/from_pointer_cast.h\"\n#include \"util/misc/memory_sanitizer.h\"\n#include \"util/posix/scoped_mmap.h\"\n#include \"util/posix/signals.h\"\n#include \"util/thread/thread.h\"\n\n#if BUILDFLAG(IS_ANDROID)\n#include \n#include \"dlfcn_internal.h\"\n\n// Normally this comes from set_abort_message.h, but only at API level 21.\nextern \"C\" void android_set_abort_message(const char* msg)\n __attribute__((weak));\n#endif\n\nnamespace crashpad {\nnamespace test {\nnamespace {\n\nenum class CrashType : uint32_t {\n kSimulated,\n kBuiltinTrap,\n kInfiniteRecursion,\n kSegvWithTagBits,\n // kFakeSegv is meant to simulate a MTE segv error.\n kFakeSegv,\n};\n\nstruct StartHandlerForSelfTestOptions {\n bool start_handler_at_crash;\n bool set_first_chance_handler;\n bool set_last_chance_handler;\n bool crash_non_main_thread;\n bool client_uses_signals;\n bool gather_indirectly_referenced_memory;\n CrashType crash_type;\n};\n\nclass StartHandlerForSelfTest\n : public testing::TestWithParam<\n std::tuple> {\n public:\n StartHandlerForSelfTest() = default;\n\n StartHandlerForSelfTest(const StartHandlerForSelfTest&) = delete;\n StartHandlerForSelfTest& operator=(const StartHandlerForSelfTest&) = delete;\n\n ~StartHandlerForSelfTest() = default;\n\n void SetUp() override {\n // MSAN requires that padding bytes have been initialized for structs that\n // are written to files.\n memset(&options_, 0, sizeof(options_));\n std::tie(options_.start_handler_at_crash,\n options_.set_first_chance_handler,\n options_.set_last_chance_handler,\n options_.crash_non_main_thread,\n options_.client_uses_signals,\n options_.gather_indirectly_referenced_memory,\n options_.crash_type) = GetParam();\n }\n\n const StartHandlerForSelfTestOptions& Options() const { return options_; }\n\n private:\n StartHandlerForSelfTestOptions options_;\n};\n\nbool InstallHandler(CrashpadClient* client,\n bool start_at_crash,\n const base::FilePath& handler_path,\n const base::FilePath& database_path,\n const std::vector& attachments) {\n return start_at_crash\n ? client->StartHandlerAtCrash(handler_path,\n database_path,\n base::FilePath(),\n \"\",\n std::map(),\n std::vector(),\n attachments)\n : client->StartHandler(handler_path,\n database_path,\n base::FilePath(),\n \"\",\n std::map(),\n std::vector(),\n false,\n false,\n attachments);\n}\n\nconstexpr char kTestAnnotationName[] = \"name_of_annotation\";\nconstexpr char kTestAnnotationValue[] = \"value_of_annotation\";\nconstexpr char kTestAttachmentName[] = \"test_attachment\";\nconstexpr char kTestAttachmentContent[] = \"attachment_content\";\n\n#if BUILDFLAG(IS_ANDROID)\nconstexpr char kTestAbortMessage[] = \"test abort message\";\n#endif\n\nvoid ValidateAttachment(const CrashReportDatabase::UploadReport* report) {\n auto attachments = report->GetAttachments();\n ASSERT_EQ(attachments.size(), 1u);\n char buf[sizeof(kTestAttachmentContent)];\n attachments.at(kTestAttachmentName)->Read(buf, sizeof(buf));\n ASSERT_EQ(memcmp(kTestAttachmentContent, buf, sizeof(kTestAttachmentContent)),\n 0);\n}\n\nvoid ValidateExtraMemory(const StartHandlerForSelfTestOptions& options,\n const ProcessSnapshotMinidump& minidump) {\n // Verify that if we have an exception, then the code around the instruction\n // pointer is included in the extra memory.\n const ExceptionSnapshot* exception = minidump.Exception();\n if (exception == nullptr)\n return;\n uint64_t pc = exception->Context()->InstructionPointer();\n std::vector snippets = minidump.ExtraMemory();\n bool pc_found = false;\n for (const MemorySnapshot* snippet : snippets) {\n uint64_t start = snippet->Address();\n uint64_t end = start + snippet->Size();\n if (pc >= start && pc < end) {\n pc_found = true;\n break;\n }\n }\n EXPECT_EQ(pc_found, options.gather_indirectly_referenced_memory);\n\n if (options.crash_type == CrashType::kSegvWithTagBits) {\n EXPECT_EQ(exception->ExceptionAddress(), 0xefull << 56);\n }\n}\n\nvoid ValidateDump(const StartHandlerForSelfTestOptions& options,\n const CrashReportDatabase::UploadReport* report) {\n ProcessSnapshotMinidump minidump_snapshot;\n ASSERT_TRUE(minidump_snapshot.Initialize(report->Reader()));\n\n#if BUILDFLAG(IS_ANDROID)\n // This part of the test requires Q. The API level on Q devices will be 28\n // until the API is finalized, so we can't check API level yet. For now, test\n // for the presence of a libc symbol which was introduced in Q.\n if (crashpad::internal::Dlsym(RTLD_DEFAULT, \"android_fdsan_close_with_tag\")) {\n const auto& annotations = minidump_snapshot.AnnotationsSimpleMap();\n auto abort_message = annotations.find(\"abort_message\");\n ASSERT_NE(annotations.end(), abort_message);\n EXPECT_EQ(kTestAbortMessage, abort_message->second);\n }\n#endif\n ValidateAttachment(report);\n\n ValidateExtraMemory(options, minidump_snapshot);\n\n for (const ModuleSnapshot* module : minidump_snapshot.Modules()) {\n for (const AnnotationSnapshot& annotation : module->AnnotationObjects()) {\n if (static_cast(annotation.type) !=\n Annotation::Type::kString) {\n continue;\n }\n\n if (annotation.name == kTestAnnotationName) {\n std::string value(\n reinterpret_cast(annotation.value.data()),\n annotation.value.size());\n EXPECT_EQ(value, kTestAnnotationValue);\n return;\n }\n }\n }\n ADD_FAILURE();\n}\n\n#pragma clang diagnostic push\n#pragma clang diagnostic ignored \"-Winfinite-recursion\"\n// Clang (masquerading as gcc) is too smart, and removes the recursion\n// otherwise. May need to change if either clang or another compiler becomes\n// smarter.\n#if defined(COMPILER_GCC)\n__attribute__((noinline))\n#endif\n#if defined(__clang__)\n__attribute__((optnone))\n#endif\nint RecurseInfinitely(int* ptr) {\n int buf[1 << 20];\n return *ptr + RecurseInfinitely(buf);\n}\n#pragma clang diagnostic pop\n\nsigjmp_buf do_crash_sigjmp_env;\n\nbool HandleCrashSuccessfully(int, siginfo_t*, ucontext_t*) {\n siglongjmp(do_crash_sigjmp_env, 1);\n#pragma clang diagnostic push\n#pragma clang diagnostic ignored \"-Wunreachable-code-return\"\n return true;\n#pragma clang diagnostic pop\n}\n\nbool HandleCrashSuccessfullyAfterReporting(int, siginfo_t*, ucontext_t*) {\n return true;\n}\n\nvoid DoCrash(const StartHandlerForSelfTestOptions& options,\n CrashpadClient* client) {\n if (sigsetjmp(do_crash_sigjmp_env, 1) != 0) {\n return;\n }\n\n switch (options.crash_type) {\n case CrashType::kSimulated: {\n CRASHPAD_SIMULATE_CRASH();\n break;\n }\n\n case CrashType::kBuiltinTrap: {\n __builtin_trap();\n }\n\n case CrashType::kInfiniteRecursion: {\n int val = 42;\n exit(RecurseInfinitely(&val));\n }\n\n case CrashType::kSegvWithTagBits: {\n volatile char* x = nullptr;\n#ifdef __aarch64__\n x += 0xefull << 56;\n#endif // __aarch64__\n *x;\n break;\n }\n\n case CrashType::kFakeSegv: {\n // With a regular SIGSEGV like null dereference, the signal gets reraised\n // automatically, causing HandleOrReraiseSignal() to be called a second\n // time, terminating the process with the signal regardless of the last\n // chance handler.\n raise(SIGSEGV);\n break;\n }\n }\n}\n\nclass ScopedAltSignalStack {\n public:\n ScopedAltSignalStack() = default;\n\n ScopedAltSignalStack(const ScopedAltSignalStack&) = delete;\n ScopedAltSignalStack& operator=(const ScopedAltSignalStack&) = delete;\n\n ~ScopedAltSignalStack() {\n if (stack_mem_.is_valid()) {\n stack_t stack;\n stack.ss_flags = SS_DISABLE;\n if (sigaltstack(&stack, nullptr) != 0) {\n ADD_FAILURE() << ErrnoMessage(\"sigaltstack\");\n }\n }\n }\n\n void Initialize() {\n ScopedMmap local_stack_mem;\n const size_t stack_size = MINSIGSTKSZ;\n ASSERT_TRUE(local_stack_mem.ResetMmap(nullptr,\n stack_size,\n PROT_READ | PROT_WRITE,\n MAP_PRIVATE | MAP_ANONYMOUS,\n -1,\n 0));\n\n stack_t stack;\n stack.ss_sp = local_stack_mem.addr();\n stack.ss_size = stack_size;\n stack.ss_flags = 0;\n ASSERT_EQ(sigaltstack(&stack, nullptr), 0) << ErrnoMessage(\"sigaltstack\");\n stack_mem_.ResetAddrLen(local_stack_mem.release(), stack_size);\n }\n\n private:\n ScopedMmap stack_mem_;\n};\n\nclass CrashThread : public Thread {\n public:\n CrashThread(const StartHandlerForSelfTestOptions& options,\n CrashpadClient* client)\n : client_signal_stack_(), options_(options), client_(client) {}\n\n CrashThread(const CrashThread&) = delete;\n CrashThread& operator=(const CrashThread&) = delete;\n\n private:\n void ThreadMain() override {\n // It is only necessary to call InitializeSignalStackForThread() once, but\n // should be harmless to call multiple times and durable against the client\n // using sigaltstack() either before or after it is called.\n CrashpadClient::InitializeSignalStackForThread();\n if (options_.client_uses_signals) {\n client_signal_stack_.Initialize();\n }\n CrashpadClient::InitializeSignalStackForThread();\n\n DoCrash(options_, client_);\n }\n\n ScopedAltSignalStack client_signal_stack_;\n const StartHandlerForSelfTestOptions& options_;\n CrashpadClient* client_;\n};\n\nCRASHPAD_CHILD_TEST_MAIN(StartHandlerForSelfTestChild) {\n FileHandle in = StdioFileHandle(StdioStream::kStandardInput);\n\n VMSize temp_dir_length;\n CheckedReadFileExactly(in, &temp_dir_length, sizeof(temp_dir_length));\n\n std::string temp_dir(temp_dir_length, '\\0');\n CheckedReadFileExactly(in, &temp_dir[0], temp_dir_length);\n\n StartHandlerForSelfTestOptions options;\n CheckedReadFileExactly(in, &options, sizeof(options));\n\n ScopedAltSignalStack client_signal_stack;\n if (options.client_uses_signals) {\n client_signal_stack.Initialize();\n\n static Signals::OldActions old_actions;\n static Signals::Handler client_handler =\n [](int signo, siginfo_t* siginfo, void*) {\n FileHandle out = StdioFileHandle(StdioStream::kStandardOutput);\n char c = 0;\n WriteFile(out, &c, sizeof(c));\n\n Signals::RestoreHandlerAndReraiseSignalOnReturn(\n siginfo, old_actions.ActionForSignal(signo));\n };\n\n CHECK(Signals::InstallCrashHandlers(\n client_handler, SA_ONSTACK, &old_actions));\n }\n\n if (options.gather_indirectly_referenced_memory) {\n CrashpadInfo::GetCrashpadInfo()->set_gather_indirectly_referenced_memory(\n TriState::kEnabled, 1024 * 1024 * 4);\n }\n\n base::FilePath handler_path = TestPaths::Executable().DirName().Append(\n FILE_PATH_LITERAL(\"crashpad_handler\"));\n\n crashpad::AnnotationList::Register();\n\n static StringAnnotation<32> test_annotation(kTestAnnotationName);\n test_annotation.Set(kTestAnnotationValue);\n\n const std::vector attachments = {\n base::FilePath(temp_dir).Append(kTestAttachmentName)};\n\n crashpad::CrashpadClient client;\n if (!InstallHandler(&client,\n options.start_handler_at_crash,\n handler_path,\n base::FilePath(temp_dir),\n attachments)) {\n return EXIT_FAILURE;\n }\n\n if (options.set_first_chance_handler) {\n client.SetFirstChanceExceptionHandler(HandleCrashSuccessfully);\n }\n\n if (options.set_last_chance_handler) {\n client.SetLastChanceExceptionHandler(HandleCrashSuccessfullyAfterReporting);\n }\n\n#if BUILDFLAG(IS_ANDROID)\n if (android_set_abort_message) {\n android_set_abort_message(kTestAbortMessage);\n }\n#endif\n\n if (options.crash_non_main_thread) {\n CrashThread thread(options, &client);\n thread.Start();\n thread.Join();\n } else {\n DoCrash(options, &client);\n }\n\n return EXIT_SUCCESS;\n}\n\nclass StartHandlerForSelfInChildTest : public MultiprocessExec {\n public:\n StartHandlerForSelfInChildTest(const StartHandlerForSelfTestOptions& options)\n : MultiprocessExec(), options_(options) {\n SetChildTestMainFunction(\"StartHandlerForSelfTestChild\");\n if (!options.set_first_chance_handler) {\n switch (options.crash_type) {\n case CrashType::kSimulated:\n // kTerminationNormal, EXIT_SUCCESS\n break;\n case CrashType::kBuiltinTrap:\n SetExpectedChildTerminationBuiltinTrap();\n break;\n case CrashType::kInfiniteRecursion:\n SetExpectedChildTermination(TerminationReason::kTerminationSignal,\n SIGSEGV);\n break;\n case CrashType::kSegvWithTagBits:\n SetExpectedChildTermination(TerminationReason::kTerminationSignal,\n SIGSEGV);\n break;\n case CrashType::kFakeSegv:\n if (!options.set_last_chance_handler) {\n SetExpectedChildTermination(TerminationReason::kTerminationSignal,\n SIGSEGV);\n } else {\n SetExpectedChildTermination(TerminationReason::kTerminationNormal,\n EXIT_SUCCESS);\n }\n break;\n }\n }\n }\n\n StartHandlerForSelfInChildTest(const StartHandlerForSelfInChildTest&) =\n delete;\n StartHandlerForSelfInChildTest& operator=(\n const StartHandlerForSelfInChildTest&) = delete;\n\n private:\n void MultiprocessParent() override {\n ScopedTempDir temp_dir;\n VMSize temp_dir_length = temp_dir.path().value().size();\n ASSERT_TRUE(LoggingWriteFile(\n WritePipeHandle(), &temp_dir_length, sizeof(temp_dir_length)));\n ASSERT_TRUE(LoggingWriteFile(\n WritePipeHandle(), temp_dir.path().value().data(), temp_dir_length));\n ASSERT_TRUE(\n LoggingWriteFile(WritePipeHandle(), &options_, sizeof(options_)));\n\n FileWriter writer;\n base::FilePath test_attachment_path =\n temp_dir.path().Append(kTestAttachmentName);\n bool is_created = writer.Open(test_attachment_path,\n FileWriteMode::kCreateOrFail,\n FilePermissions::kOwnerOnly);\n ASSERT_TRUE(is_created);\n writer.Write(kTestAttachmentContent, sizeof(kTestAttachmentContent));\n writer.Close();\n\n if (options_.client_uses_signals && !options_.set_first_chance_handler &&\n options_.crash_type != CrashType::kSimulated &&\n // The last chance handler will prevent the client handler from being\n // called if crash type is kFakeSegv.\n (!options_.set_last_chance_handler ||\n options_.crash_type != CrashType::kFakeSegv)) {\n // Wait for child's client signal handler.\n char c;\n EXPECT_TRUE(LoggingReadFileExactly(ReadPipeHandle(), &c, sizeof(c)));\n }\n\n // Wait for child to finish.\n CheckedReadFileAtEOF(ReadPipeHandle());\n\n auto database = CrashReportDatabase::Initialize(temp_dir.path());\n ASSERT_TRUE(database);\n\n std::vector reports;\n ASSERT_EQ(database->GetCompletedReports(&reports),\n CrashReportDatabase::kNoError);\n EXPECT_EQ(reports.size(), 0u);\n\n reports.clear();\n ASSERT_EQ(database->GetPendingReports(&reports),\n CrashReportDatabase::kNoError);\n\n bool report_expected = !options_.set_first_chance_handler ||\n options_.crash_type == CrashType::kSimulated;\n ASSERT_EQ(reports.size(), report_expected ? 1u : 0u);\n\n if (!report_expected) {\n return;\n }\n\n std::unique_ptr report;\n ASSERT_EQ(database->GetReportForUploading(reports[0].uuid, &report),\n CrashReportDatabase::kNoError);\n ValidateDump(options_, report.get());\n }\n\n StartHandlerForSelfTestOptions options_;\n};\n\nTEST_P(StartHandlerForSelfTest, StartHandlerInChild) {\n#if defined(ADDRESS_SANITIZER) || defined(MEMORY_SANITIZER) || \\\n defined(UNDEFINED_SANITIZER)\n if (Options().crash_type == CrashType::kInfiniteRecursion) {\n GTEST_SKIP();\n }\n#endif // defined(ADDRESS_SANITIZER)\n\n // kFakeSegv does raise(SIGSEGV) to simulate a MTE error which is a SEGSEGV\n // that doesn't get reraised automatically, but this causes the child process\n // to flakily terminate normally on some bots (e.g. android-nougat-x86-rel)\n // for some reason so this is skipped.\n if (!Options().set_last_chance_handler &&\n Options().crash_type == CrashType::kFakeSegv) {\n GTEST_SKIP();\n }\n\n if (Options().crash_type == CrashType::kSegvWithTagBits) {\n#if !defined(ARCH_CPU_ARM64)\n GTEST_SKIP() << \"Testing for tag bits only exists on aarch64.\";\n#else\n struct utsname uname_info;\n ASSERT_EQ(uname(&uname_info), 0);\n ASSERT_NE(uname_info.release, nullptr);\n\n char* release = uname_info.release;\n unsigned major = strtoul(release, &release, 10);\n ASSERT_EQ(*release++, '.');\n unsigned minor = strtoul(release, nullptr, 10);\n\n if (major < 5 || (major == 5 && minor < 11)) {\n GTEST_SKIP() << \"Linux kernel v\" << uname_info.release\n << \" does not support SA_EXPOSE_TAGBITS\";\n }\n#endif // !defined(ARCH_CPU_ARM64)\n }\n\n StartHandlerForSelfInChildTest test(Options());\n test.Run();\n}\n\nINSTANTIATE_TEST_SUITE_P(\n StartHandlerForSelfTestSuite,\n StartHandlerForSelfTest,\n testing::Combine(testing::Bool(),\n testing::Bool(),\n testing::Bool(),\n testing::Bool(),\n testing::Bool(),\n testing::Bool(),\n testing::Values(CrashType::kSimulated,\n CrashType::kBuiltinTrap,\n CrashType::kInfiniteRecursion,\n CrashType::kSegvWithTagBits,\n CrashType::kFakeSegv)));\n\n// Test state for starting the handler for another process.\nclass StartHandlerForClientTest {\n public:\n StartHandlerForClientTest() = default;\n\n StartHandlerForClientTest(const StartHandlerForClientTest&) = delete;\n StartHandlerForClientTest& operator=(const StartHandlerForClientTest&) =\n delete;\n\n ~StartHandlerForClientTest() = default;\n\n bool Initialize(bool sanitize) {\n sanitize_ = sanitize;\n return UnixCredentialSocket::CreateCredentialSocketpair(&client_sock_,\n &server_sock_);\n }\n\n bool StartHandlerOnDemand() {\n char c;\n if (!LoggingReadFileExactly(server_sock_.get(), &c, sizeof(c))) {\n ADD_FAILURE();\n return false;\n }\n\n base::FilePath handler_path = TestPaths::Executable().DirName().Append(\n FILE_PATH_LITERAL(\"crashpad_handler\"));\n\n CrashpadClient client;\n if (!client.StartHandlerForClient(handler_path,\n temp_dir_.path(),\n base::FilePath(),\n \"\",\n std::map(),\n std::vector(),\n server_sock_.get())) {\n ADD_FAILURE();\n return false;\n }\n\n return true;\n }\n\n void ExpectReport() {\n auto database =\n CrashReportDatabase::InitializeWithoutCreating(temp_dir_.path());\n ASSERT_TRUE(database);\n\n std::vector reports;\n ASSERT_EQ(database->GetCompletedReports(&reports),\n CrashReportDatabase::kNoError);\n EXPECT_EQ(reports.size(), 0u);\n\n reports.clear();\n ASSERT_EQ(database->GetPendingReports(&reports),\n CrashReportDatabase::kNoError);\n if (sanitize_) {\n EXPECT_EQ(reports.size(), 0u);\n } else {\n EXPECT_EQ(reports.size(), 1u);\n }\n }\n\n bool InstallHandler() {\n auto signal_handler = SandboxedHandler::Get();\n return signal_handler->Initialize(client_sock_.get(), sanitize_);\n }\n\n private:\n // A signal handler that defers handler process startup to another, presumably\n // more privileged, process.\n class SandboxedHandler {\n public:\n SandboxedHandler(const SandboxedHandler&) = delete;\n SandboxedHandler& operator=(const SandboxedHandler&) = delete;\n\n static SandboxedHandler* Get() {\n static SandboxedHandler* instance = new SandboxedHandler();\n return instance;\n }\n\n bool Initialize(FileHandle client_sock, bool sanitize) {\n client_sock_ = client_sock;\n sanitize_ = sanitize;\n return Signals::InstallCrashHandlers(HandleCrash, 0, nullptr);\n }\n\n private:\n SandboxedHandler() = default;\n ~SandboxedHandler() = delete;\n\n static void HandleCrash(int signo, siginfo_t* siginfo, void* context) {\n auto state = Get();\n\n char c = 0;\n CHECK(LoggingWriteFile(state->client_sock_, &c, sizeof(c)));\n\n ExceptionInformation exception_information;\n exception_information.siginfo_address =\n FromPointerCast(\n siginfo);\n exception_information.context_address =\n FromPointerCast(\n context);\n exception_information.thread_id = syscall(SYS_gettid);\n\n ExceptionHandlerProtocol::ClientInformation info;\n info.exception_information_address =\n FromPointerCast(\n &exception_information);\n\n SanitizationInformation sanitization_info = {};\n if (state->sanitize_) {\n info.sanitization_information_address =\n FromPointerCast(&sanitization_info);\n // Target a non-module address to prevent a crash dump.\n sanitization_info.target_module_address =\n FromPointerCast(&sanitization_info);\n }\n\n ExceptionHandlerClient handler_client(state->client_sock_, false);\n CHECK_EQ(handler_client.RequestCrashDump(info), 0);\n\n Signals::RestoreHandlerAndReraiseSignalOnReturn(siginfo, nullptr);\n }\n\n FileHandle client_sock_;\n bool sanitize_;\n };\n\n ScopedTempDir temp_dir_;\n ScopedFileHandle client_sock_;\n ScopedFileHandle server_sock_;\n bool sanitize_;\n};\n\n// Tests starting the handler for a child process.\nclass StartHandlerForChildTest : public Multiprocess {\n public:\n StartHandlerForChildTest() = default;\n\n StartHandlerForChildTest(const StartHandlerForChildTest&) = delete;\n StartHandlerForChildTest& operator=(const StartHandlerForChildTest&) = delete;\n\n ~StartHandlerForChildTest() = default;\n\n bool Initialize(bool sanitize) {\n SetExpectedChildTerminationBuiltinTrap();\n return test_state_.Initialize(sanitize);\n }\n\n private:\n void MultiprocessParent() {\n ASSERT_TRUE(test_state_.StartHandlerOnDemand());\n\n // Wait for chlid to finish.\n CheckedReadFileAtEOF(ReadPipeHandle());\n\n test_state_.ExpectReport();\n }\n\n [[noreturn]] void MultiprocessChild() {\n CHECK(test_state_.InstallHandler());\n\n __builtin_trap();\n }\n\n StartHandlerForClientTest test_state_;\n};\n\nTEST(CrashpadClient, StartHandlerForChild) {\n StartHandlerForChildTest test;\n ASSERT_TRUE(test.Initialize(/* sanitize= */ false));\n test.Run();\n}\n\nTEST(CrashpadClient, SanitizedChild) {\n StartHandlerForChildTest test;\n ASSERT_TRUE(test.Initialize(/* sanitize= */ true));\n test.Run();\n}\n\n} // namespace\n} // namespace test\n} // namespace crashpad\n" }, { "path": "client/crashpad_client_mac.cc", "content": "// Copyright 2014 The Crashpad Authors\n//\n// Licensed under the Apache License, Version 2.0 (the \"License\");\n// you may not use this file except in compliance with the License.\n// You may obtain a copy of the License at\n//\n// http://www.apache.org/licenses/LICENSE-2.0\n//\n// Unless required by applicable law or agreed to in writing, software\n// distributed under the License is distributed on an \"AS IS\" BASIS,\n// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n// See the License for the specific language governing permissions and\n// limitations under the License.\n\n#include \"client/crashpad_client.h\"\n\n#include \n#include \n#include \n#include \n#include \n\n#include \n#include \n#include \n\n#include \"base/apple/mach_logging.h\"\n#include \"base/check_op.h\"\n#include \"base/logging.h\"\n#include \"base/strings/stringprintf.h\"\n#include \"util/mac/mac_util.h\"\n#include \"util/mach/bootstrap.h\"\n#include \"util/mach/child_port_handshake.h\"\n#include \"util/mach/exception_ports.h\"\n#include \"util/mach/mach_extensions.h\"\n#include \"util/mach/mach_message.h\"\n#include \"util/mach/notify_server.h\"\n#include \"util/misc/clock.h\"\n#include \"util/misc/implicit_cast.h\"\n#include \"util/posix/spawn_subprocess.h\"\n\nnamespace crashpad {\n\nnamespace {\n\nstd::string FormatArgumentString(const std::string& name,\n const std::string& value) {\n return base::StringPrintf(\"--%s=%s\", name.c_str(), value.c_str());\n}\n\nstd::string FormatArgumentInt(const std::string& name, int value) {\n return base::StringPrintf(\"--%s=%d\", name.c_str(), value);\n}\n\n// Set the exception handler for EXC_CRASH, EXC_RESOURCE, and EXC_GUARD.\n//\n// EXC_CRASH is how most crashes are received. Most other exception types such\n// as EXC_BAD_ACCESS are delivered to a host-level exception handler in the\n// kernel where they are converted to POSIX signals. See 10.9.5\n// xnu-2422.115.4/bsd/uxkern/ux_exception.c catch_mach_exception_raise(). If a\n// core-generating signal (triggered through this hardware mechanism or a\n// software mechanism such as abort() sending SIGABRT) is unhandled and the\n// process exits, or if the process is killed with SIGKILL for code-signing\n// reasons, an EXC_CRASH exception will be sent. See 10.9.5\n// xnu-2422.115.4/bsd/kern/kern_exit.c proc_prepareexit().\n//\n// EXC_RESOURCE and EXC_GUARD (pre-macOS 13) do not become signals or EXC_CRASH\n// exceptions. The host-level exception handler in the kernel does not receive\n// these exception types, and even if it did, it would not map them to signals.\n// Instead, the first Mach service loaded by the root (process ID 1) launchd\n// with a boolean “ExceptionServer” property in its job dictionary (regardless\n// of its value) or with any subdictionary property will become the host-level\n// exception handler for EXC_CRASH, EXC_RESOURCE, and EXC_GUARD. See 10.9.5\n// launchd-842.92.1/src/core.c job_setup_exception_port(). Normally, this job is\n// com.apple.ReportCrash.Root, the systemwide Apple Crash Reporter. Since it is\n// impossible to receive EXC_RESOURCE and EXC_GUARD exceptions through the\n// EXC_CRASH mechanism, an exception handler must be registered for them by name\n// if it is to receive these exception types. The default task-level handler for\n// these exception types is set by launchd in a similar manner.\n//\n// EXC_MASK_RESOURCE and EXC_MASK_GUARD are not available on all systems, and\n// the kernel will reject attempts to use them if it does not understand them,\n// so AND them with ExcMaskValid(). EXC_MASK_CRASH is always supported.\nbool SetCrashExceptionPorts(exception_handler_t exception_handler) {\n ExceptionPorts exception_ports(ExceptionPorts::kTargetTypeTask, TASK_NULL);\n\n exception_mask_t mask = EXC_MASK_CRASH | EXC_MASK_RESOURCE;\n if (MacOSVersionNumber() < 13'00'00) {\n // EXC_GUARD is delivered as an EXC_CRASH macOS 13 and later.\n mask |= EXC_MASK_GUARD;\n }\n\n return exception_ports.SetExceptionPort(\n mask & ExcMaskValid(),\n exception_handler,\n EXCEPTION_STATE_IDENTITY | MACH_EXCEPTION_CODES,\n MACHINE_THREAD_STATE);\n}\n\nclass ScopedPthreadAttrDestroy {\n public:\n explicit ScopedPthreadAttrDestroy(pthread_attr_t* pthread_attr)\n : pthread_attr_(pthread_attr) {\n }\n\n ScopedPthreadAttrDestroy(const ScopedPthreadAttrDestroy&) = delete;\n ScopedPthreadAttrDestroy& operator=(const ScopedPthreadAttrDestroy&) = delete;\n\n ~ScopedPthreadAttrDestroy() {\n errno = pthread_attr_destroy(pthread_attr_);\n PLOG_IF(WARNING, errno != 0) << \"pthread_attr_destroy\";\n }\n\n private:\n pthread_attr_t* pthread_attr_;\n};\n\n//! \\brief Starts a Crashpad handler, possibly restarting it if it dies.\nclass HandlerStarter final : public NotifyServer::DefaultInterface {\n public:\n HandlerStarter(const HandlerStarter&) = delete;\n HandlerStarter& operator=(const HandlerStarter&) = delete;\n\n ~HandlerStarter() {}\n\n //! \\brief Starts a Crashpad handler initially, as opposed to starting it for\n //! subsequent restarts.\n //!\n //! All parameters are as in CrashpadClient::StartHandler().\n //!\n //! \\return On success, a send right to the Crashpad handler that has been\n //! started. On failure, `MACH_PORT_NULL` with a message logged.\n static base::apple::ScopedMachSendRight InitialStart(\n const base::FilePath& handler,\n const base::FilePath& database,\n const base::FilePath& metrics_dir,\n const std::string& url,\n const std::map& annotations,\n const std::vector& arguments,\n bool restartable,\n const std::vector& attachments) {\n base::apple::ScopedMachReceiveRight receive_right(\n NewMachPort(MACH_PORT_RIGHT_RECEIVE));\n if (!receive_right.is_valid()) {\n return base::apple::ScopedMachSendRight();\n }\n\n mach_port_t port;\n mach_msg_type_name_t right_type;\n kern_return_t kr = mach_port_extract_right(mach_task_self(),\n receive_right.get(),\n MACH_MSG_TYPE_MAKE_SEND,\n &port,\n &right_type);\n if (kr != KERN_SUCCESS) {\n MACH_LOG(ERROR, kr) << \"mach_port_extract_right\";\n return base::apple::ScopedMachSendRight();\n }\n base::apple::ScopedMachSendRight send_right(port);\n DCHECK_EQ(port, receive_right.get());\n DCHECK_EQ(right_type,\n implicit_cast(MACH_MSG_TYPE_PORT_SEND));\n\n std::unique_ptr handler_restarter;\n if (restartable) {\n handler_restarter.reset(new HandlerStarter());\n if (!handler_restarter->notify_port_.is_valid()) {\n // This is an error that NewMachPort() would have logged. Proceed anyway\n // without the ability to restart.\n handler_restarter.reset();\n }\n }\n\n if (!CommonStart(handler,\n database,\n metrics_dir,\n url,\n annotations,\n arguments,\n std::move(receive_right),\n handler_restarter.get(),\n false,\n attachments)) {\n return base::apple::ScopedMachSendRight();\n }\n\n if (handler_restarter && handler_restarter->StartRestartThread(\n handler, database, metrics_dir, url,\n annotations, arguments, attachments)) {\n // The thread owns the object now.\n std::ignore = handler_restarter.release();\n }\n\n // If StartRestartThread() failed, proceed without the ability to restart.\n // handler_restarter will be released when this function returns.\n\n return send_right;\n }\n\n // NotifyServer::DefaultInterface:\n\n kern_return_t DoMachNotifyPortDestroyed(notify_port_t notify,\n mach_port_t rights,\n const mach_msg_trailer_t* trailer,\n bool* destroy_request) override {\n // The receive right corresponding to this process’ crash exception port is\n // now owned by this process. Any crashes that occur before the receive\n // right is moved to a new handler process will cause the process to hang in\n // an unkillable state prior to OS X 10.10.\n\n if (notify != notify_port_) {\n LOG(WARNING) << \"notify port mismatch\";\n return KERN_FAILURE;\n }\n\n // If CommonStart() fails, the receive right will die, and this will just\n // be called again for another try.\n CommonStart(handler_,\n database_,\n metrics_dir_,\n url_,\n annotations_,\n arguments_,\n base::apple::ScopedMachReceiveRight(rights),\n this,\n true,\n attachments_);\n\n return KERN_SUCCESS;\n }\n\n private:\n HandlerStarter()\n : NotifyServer::DefaultInterface(),\n handler_(),\n database_(),\n metrics_dir_(),\n url_(),\n annotations_(),\n arguments_(),\n notify_port_(NewMachPort(MACH_PORT_RIGHT_RECEIVE)),\n last_start_time_(0) {\n }\n\n //! \\brief Starts a Crashpad handler.\n //!\n //! All parameters are as in CrashpadClient::StartHandler(), with these\n //! additions:\n //!\n //! \\param[in] receive_right The receive right to move to the Crashpad\n //! handler. The handler will use this receive right to run its exception\n //! server.\n //! \\param[in] handler_restarter If CrashpadClient::StartHandler() was invoked\n //! with \\a restartable set to `true`, this is the restart state object.\n //! Otherwise, this is `nullptr`.\n //! \\param[in] restart If CrashpadClient::StartHandler() was invoked with \\a\n //! restartable set to `true` and CommonStart() is being called to restart\n //! a previously-started handler, this is `true`. Otherwise, this is\n //! `false`.\n //!\n //! \\return `true` on success, `false` on failure, with a message logged.\n //! Failures include failure to start the handler process and failure to\n //! rendezvous with it via ChildPortHandshake.\n static bool CommonStart(const base::FilePath& handler,\n const base::FilePath& database,\n const base::FilePath& metrics_dir,\n const std::string& url,\n const std::map& annotations,\n const std::vector& arguments,\n base::apple::ScopedMachReceiveRight receive_right,\n HandlerStarter* handler_restarter,\n bool restart,\n const std::vector& attachments) {\n DCHECK(!restart || handler_restarter);\n\n if (handler_restarter) {\n // The port-destroyed notification must be requested each time. It uses\n // a send-once right, so once the notification is received, it won’t be\n // sent again unless re-requested.\n mach_port_t previous;\n kern_return_t kr =\n mach_port_request_notification(mach_task_self(),\n receive_right.get(),\n MACH_NOTIFY_PORT_DESTROYED,\n 0,\n handler_restarter->notify_port_.get(),\n MACH_MSG_TYPE_MAKE_SEND_ONCE,\n &previous);\n if (kr != KERN_SUCCESS) {\n MACH_LOG(WARNING, kr) << \"mach_port_request_notification\";\n\n // This will cause the restart thread to terminate after this restart\n // attempt. There’s no longer any need for it, because no more\n // port-destroyed notifications can be delivered.\n handler_restarter->notify_port_.reset();\n } else {\n base::apple::ScopedMachSendRight previous_owner(previous);\n DCHECK(restart || !previous_owner.is_valid());\n }\n\n if (restart) {\n // If the handler was ever started before, don’t restart it too quickly.\n constexpr uint64_t kNanosecondsPerSecond = 1E9;\n constexpr uint64_t kMinimumStartInterval = 1 * kNanosecondsPerSecond;\n\n const uint64_t earliest_next_start_time =\n handler_restarter->last_start_time_ + kMinimumStartInterval;\n const uint64_t now_time = ClockMonotonicNanoseconds();\n if (earliest_next_start_time > now_time) {\n const uint64_t sleep_time = earliest_next_start_time - now_time;\n LOG(INFO) << \"restarting handler\"\n << base::StringPrintf(\" in %.3fs\",\n static_cast(sleep_time) /\n kNanosecondsPerSecond);\n SleepNanoseconds(earliest_next_start_time - now_time);\n } else {\n LOG(INFO) << \"restarting handler\";\n }\n }\n\n handler_restarter->last_start_time_ = ClockMonotonicNanoseconds();\n }\n\n ChildPortHandshake child_port_handshake;\n base::ScopedFD server_write_fd = child_port_handshake.ServerWriteFD();\n\n // Use handler as argv[0], followed by arguments directed by this method’s\n // parameters and a --handshake-fd argument. |arguments| are added first so\n // that if it erroneously contains an argument such as --url, the actual\n // |url| argument passed to this method will supersede it. In normal\n // command-line processing, the last parameter wins in the case of a\n // conflict.\n std::vector argv(1, handler.value());\n argv.reserve(1 + arguments.size() + 2 + annotations.size() + 1);\n for (const std::string& argument : arguments) {\n argv.push_back(argument);\n }\n if (!database.value().empty()) {\n argv.push_back(FormatArgumentString(\"database\", database.value()));\n }\n if (!metrics_dir.value().empty()) {\n argv.push_back(FormatArgumentString(\"metrics-dir\", metrics_dir.value()));\n }\n if (!url.empty()) {\n argv.push_back(FormatArgumentString(\"url\", url));\n }\n for (const auto& kv : annotations) {\n argv.push_back(\n FormatArgumentString(\"annotation\", kv.first + '=' + kv.second));\n }\n for (const auto& attachment : attachments) {\n argv.push_back(FormatArgumentString(\"attachment\", attachment.value()));\n }\n argv.push_back(FormatArgumentInt(\"handshake-fd\", server_write_fd.get()));\n\n // When restarting, reset the system default crash handler first. Otherwise,\n // the crash exception port in the handler will have been inherited from\n // this parent process, which was probably using the exception server now\n // being restarted. The handler can’t monitor itself for its own crashes via\n // this interface.\n if (!SpawnSubprocess(\n argv,\n nullptr,\n server_write_fd.get(),\n true,\n restart ? CrashpadClient::UseSystemDefaultHandler : nullptr)) {\n return false;\n }\n\n // Close the write side of the pipe, so that the handler process is the only\n // process that can write to it.\n server_write_fd.reset();\n\n // Rendezvous with the handler running in the grandchild process.\n if (!child_port_handshake.RunClient(receive_right.get(),\n MACH_MSG_TYPE_MOVE_RECEIVE)) {\n return false;\n }\n\n std::ignore = receive_right.release();\n return true;\n }\n\n bool StartRestartThread(const base::FilePath& handler,\n const base::FilePath& database,\n const base::FilePath& metrics_dir,\n const std::string& url,\n const std::map& annotations,\n const std::vector& arguments,\n const std::vector& attachments) {\n handler_ = handler;\n database_ = database;\n metrics_dir_ = metrics_dir;\n url_ = url;\n annotations_ = annotations;\n arguments_ = arguments;\n attachments_ = attachments;\n\n pthread_attr_t pthread_attr;\n errno = pthread_attr_init(&pthread_attr);\n if (errno != 0) {\n PLOG(WARNING) << \"pthread_attr_init\";\n return false;\n }\n ScopedPthreadAttrDestroy pthread_attr_owner(&pthread_attr);\n\n errno = pthread_attr_setdetachstate(&pthread_attr, PTHREAD_CREATE_DETACHED);\n if (errno != 0) {\n PLOG(WARNING) << \"pthread_attr_setdetachstate\";\n return false;\n }\n\n pthread_t pthread;\n errno = pthread_create(&pthread, &pthread_attr, RestartThreadMain, this);\n if (errno != 0) {\n PLOG(WARNING) << \"pthread_create\";\n return false;\n }\n\n return true;\n }\n\n static void* RestartThreadMain(void* argument) {\n HandlerStarter* self = reinterpret_cast(argument);\n\n NotifyServer notify_server(self);\n mach_msg_return_t mr;\n do {\n mr = MachMessageServer::Run(¬ify_server,\n self->notify_port_.get(),\n 0,\n MachMessageServer::kPersistent,\n MachMessageServer::kReceiveLargeError,\n kMachMessageTimeoutWaitIndefinitely);\n MACH_LOG_IF(ERROR, mr != MACH_MSG_SUCCESS, mr)\n << \"MachMessageServer::Run\";\n } while (self->notify_port_.is_valid() && mr == MACH_MSG_SUCCESS);\n\n delete self;\n\n return nullptr;\n }\n\n base::FilePath handler_;\n base::FilePath database_;\n base::FilePath metrics_dir_;\n std::string url_;\n std::map annotations_;\n std::vector arguments_;\n std::vector attachments_;\n base::apple::ScopedMachReceiveRight notify_port_;\n uint64_t last_start_time_;\n};\n\n} // namespace\n\nCrashpadClient::CrashpadClient() : exception_port_(MACH_PORT_NULL) {\n}\n\nCrashpadClient::~CrashpadClient() {\n}\n\nbool CrashpadClient::StartHandler(\n const base::FilePath& handler,\n const base::FilePath& database,\n const base::FilePath& metrics_dir,\n const std::string& url,\n const std::map& annotations,\n const std::vector& arguments,\n bool restartable,\n bool asynchronous_start,\n const std::vector& attachments) {\n // The “restartable” behavior can only be selected on OS X 10.10 and later. In\n // previous OS versions, if the initial client were to crash while attempting\n // to restart the handler, it would become an unkillable process.\n base::apple::ScopedMachSendRight exception_port(HandlerStarter::InitialStart(\n handler,\n database,\n metrics_dir,\n url,\n annotations,\n arguments,\n restartable && (__MAC_OS_X_VERSION_MIN_REQUIRED >= __MAC_10_10 ||\n MacOSVersionNumber() >= 10'10'00),\n attachments));\n if (!exception_port.is_valid()) {\n return false;\n }\n\n SetHandlerMachPort(std::move(exception_port));\n return true;\n}\n\nbool CrashpadClient::SetHandlerMachService(const std::string& service_name) {\n base::apple::ScopedMachSendRight exception_port(\n BootstrapLookUp(service_name));\n if (!exception_port.is_valid()) {\n return false;\n }\n\n SetHandlerMachPort(std::move(exception_port));\n return true;\n}\n\nbool CrashpadClient::SetHandlerMachPort(\n base::apple::ScopedMachSendRight exception_port) {\n DCHECK(!exception_port_.is_valid());\n DCHECK(exception_port.is_valid());\n\n if (!SetCrashExceptionPorts(exception_port.get())) {\n return false;\n }\n\n exception_port_.swap(exception_port);\n return true;\n}\n\nbase::apple::ScopedMachSendRight CrashpadClient::GetHandlerMachPort() const {\n DCHECK(exception_port_.is_valid());\n\n // For the purposes of this method, only return a port set by\n // SetHandlerMachPort().\n //\n // It would be possible to use task_get_exception_ports() to look up the\n // EXC_CRASH task exception port, but that’s probably not what users of this\n // interface really want. If CrashpadClient is asked for the handler Mach\n // port, it should only return a port that it knows about by virtue of having\n // set it. It shouldn’t return any EXC_CRASH task exception port in effect if\n // SetHandlerMachPort() was never called, and it shouldn’t return any\n // EXC_CRASH task exception port that might be set by other code after\n // SetHandlerMachPort() is called.\n //\n // The caller is accepting its own new ScopedMachSendRight, so increment the\n // reference count of the underlying right.\n kern_return_t kr = mach_port_mod_refs(\n mach_task_self(), exception_port_.get(), MACH_PORT_RIGHT_SEND, 1);\n if (kr != KERN_SUCCESS) {\n MACH_LOG(ERROR, kr) << \"mach_port_mod_refs\";\n return base::apple::ScopedMachSendRight(MACH_PORT_NULL);\n }\n\n return base::apple::ScopedMachSendRight(exception_port_.get());\n}\n\n// static\nvoid CrashpadClient::UseSystemDefaultHandler() {\n base::apple::ScopedMachSendRight system_crash_reporter_handler(\n SystemCrashReporterHandler());\n\n // Proceed even if SystemCrashReporterHandler() failed, setting MACH_PORT_NULL\n // to clear the current exception ports.\n if (!SetCrashExceptionPorts(system_crash_reporter_handler.get())) {\n SetCrashExceptionPorts(MACH_PORT_NULL);\n }\n}\n\n} // namespace crashpad\n" }, { "path": "client/crashpad_client_win.cc", "content": "// Copyright 2015 The Crashpad Authors\n//\n// Licensed under the Apache License, Version 2.0 (the \"License\");\n// you may not use this file except in compliance with the License.\n// You may obtain a copy of the License at\n//\n// http://www.apache.org/licenses/LICENSE-2.0\n//\n// Unless required by applicable law or agreed to in writing, software\n// distributed under the License is distributed on an \"AS IS\" BASIS,\n// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n// See the License for the specific language governing permissions and\n// limitations under the License.\n\n#include \"client/crashpad_client.h\"\n\n#include \n\n#include \n\n#include \n#include \n#include \n\n#include \n#include \n#include \n\n#include \"base/check_op.h\"\n#include \"base/logging.h\"\n#include \"base/scoped_generic.h\"\n#include \"base/strings/stringprintf.h\"\n#include \"base/strings/utf_string_conversions.h\"\n#include \"base/synchronization/lock.h\"\n#include \"util/file/file_io.h\"\n#include \"util/misc/capture_context.h\"\n#include \"util/misc/from_pointer_cast.h\"\n#include \"util/misc/random_string.h\"\n#include \"util/win/address_types.h\"\n#include \"util/win/command_line.h\"\n#include \"util/win/context_wrappers.h\"\n#include \"util/win/critical_section_with_debug_info.h\"\n#include \"util/win/exception_codes.h\"\n#include \"util/win/get_function.h\"\n#include \"util/win/handle.h\"\n#include \"util/win/initial_client_data.h\"\n#include \"util/win/loader_lock.h\"\n#include \"util/win/nt_internals.h\"\n#include \"util/win/ntstatus_logging.h\"\n#include \"util/win/process_info.h\"\n#include \"util/win/registration_protocol_win.h\"\n#include \"util/win/safe_terminate_process.h\"\n#include \"util/win/scoped_process_suspend.h\"\n#include \"util/win/termination_codes.h\"\n#include \"util/win/xp_compat.h\"\n\nnamespace crashpad {\n\nnamespace {\n\n// This handle is never closed. This is used to signal to the server that a dump\n// should be taken in the event of a crash.\nHANDLE g_signal_exception = INVALID_HANDLE_VALUE;\n\n// Where we store the exception information that the crash handler reads.\nExceptionInformation g_crash_exception_information;\n\n// Guards multiple simultaneous calls to DumpWithoutCrash() in the client.\n// This is leaked.\nbase::Lock* g_non_crash_dump_lock;\n\n// Where we store a pointer to the context information when taking a non-crash\n// dump.\nExceptionInformation g_non_crash_exception_information;\n\n// Context for the out-of-process exception handler module and holds non-crash\n// dump handles. Handles are never closed once created.\nWerRegistration g_wer_registration = {WerRegistration::kWerRegistrationVersion,\n INVALID_HANDLE_VALUE,\n INVALID_HANDLE_VALUE,\n false,\n nullptr,\n {0},\n {0},\n {0}};\n\nenum class StartupState : int {\n kNotReady = 0, // This must be value 0 because it is the initial value of a\n // global AtomicWord.\n kSucceeded = 1, // The CreateProcess() for the handler succeeded.\n kFailed = 2, // The handler failed to start.\n};\n\n// This is a tri-state of type StartupState. It starts at 0 == kNotReady, and\n// when the handler is known to have started successfully, or failed to start\n// the value will be updated. The unhandled exception filter will not proceed\n// until one of those two cases happens.\nstd::atomic g_handler_startup_state;\n\n// A CRITICAL_SECTION initialized with\n// RTL_CRITICAL_SECTION_FLAG_FORCE_DEBUG_INFO to force it to be allocated with a\n// valid .DebugInfo field. The address of this critical section is given to the\n// handler. All critical sections with debug info are linked in a doubly-linked\n// list, so this allows the handler to capture all of them.\nCRITICAL_SECTION g_critical_section_with_debug_info;\n\nvoid SetHandlerStartupState(StartupState state) {\n DCHECK(state == StartupState::kSucceeded || state == StartupState::kFailed);\n g_handler_startup_state.store(state, std::memory_order_release);\n}\n\nStartupState BlockUntilHandlerStartedOrFailed() {\n // Wait until we know the handler has either succeeded or failed to start.\n StartupState startup_state;\n while ((startup_state = g_handler_startup_state.load(\n std::memory_order_acquire)) == StartupState::kNotReady) {\n Sleep(1);\n }\n\n return startup_state;\n}\n\n#if defined(ADDRESS_SANITIZER)\nextern \"C\" LONG __asan_unhandled_exception_filter(EXCEPTION_POINTERS* info);\n#endif\n\nLONG WINAPI UnhandledExceptionHandler(EXCEPTION_POINTERS* exception_pointers) {\n#if defined(ADDRESS_SANITIZER)\n // In ASan builds, delegate to the ASan exception filter.\n LONG status = __asan_unhandled_exception_filter(exception_pointers);\n if (status != EXCEPTION_CONTINUE_SEARCH)\n return status;\n#endif\n\n if (BlockUntilHandlerStartedOrFailed() == StartupState::kFailed) {\n // If we know for certain that the handler has failed to start, then abort\n // here, rather than trying to signal to a handler that will never arrive,\n // and then sleeping unnecessarily.\n LOG(ERROR) << \"crash server failed to launch, self-terminating\";\n SafeTerminateProcess(GetCurrentProcess(), kTerminationCodeCrashNoDump);\n return EXCEPTION_CONTINUE_SEARCH;\n }\n\n // Otherwise, we know the handler startup has succeeded, and we can continue.\n\n // Tracks whether a thread has already entered UnhandledExceptionHandler.\n static std::atomic have_crashed;\n\n // This is a per-process handler. While this handler is being invoked, other\n // threads are still executing as usual, so multiple threads could enter at\n // the same time. Because we're in a crashing state, we shouldn't be doing\n // anything that might cause allocations, call into kernel mode, etc. So, we\n // don't want to take a critical section here to avoid simultaneous access to\n // the global exception pointers in ExceptionInformation. Because the crash\n // handler will record all threads, it's fine to simply have the second and\n // subsequent entrants block here. They will soon be suspended by the crash\n // handler, and then the entire process will be terminated below. This means\n // that we won't save the exception pointers from the second and further\n // crashes, but contention here is very unlikely, and we'll still have a stack\n // that's blocked at this location.\n if (have_crashed.exchange(true)) {\n SleepEx(INFINITE, false);\n }\n\n // Otherwise, we're the first thread, so record the exception pointer and\n // signal the crash handler.\n g_crash_exception_information.thread_id = GetCurrentThreadId();\n g_crash_exception_information.exception_pointers =\n FromPointerCast(exception_pointers);\n\n // Now signal the crash server, which will take a dump and then terminate us\n // when it's complete.\n SetEvent(g_signal_exception);\n\n // Time to wait for the handler to create a dump.\n constexpr DWORD kMillisecondsUntilTerminate = 60 * 1000;\n\n // Sleep for a while to allow it to process us. Eventually, we terminate\n // ourselves in case the crash server is gone, so that we don't leave zombies\n // around. This would ideally never happen.\n Sleep(kMillisecondsUntilTerminate);\n\n LOG(ERROR) << \"crash server did not respond, self-terminating\";\n\n SafeTerminateProcess(GetCurrentProcess(), kTerminationCodeCrashNoDump);\n\n return EXCEPTION_CONTINUE_SEARCH;\n}\n\n#if !defined(ADDRESS_SANITIZER)\nLONG WINAPI HandleHeapCorruption(EXCEPTION_POINTERS* exception_pointers) {\n if (exception_pointers->ExceptionRecord->ExceptionCode ==\n STATUS_HEAP_CORRUPTION) {\n return UnhandledExceptionHandler(exception_pointers);\n }\n\n return EXCEPTION_CONTINUE_SEARCH;\n}\n#endif\n\nvoid HandleAbortSignal(int signum) {\n DCHECK_EQ(signum, SIGABRT);\n\n CONTEXT context;\n CaptureContext(&context);\n\n EXCEPTION_RECORD record = {};\n record.ExceptionCode = STATUS_FATAL_APP_EXIT;\n record.ExceptionFlags = EXCEPTION_NONCONTINUABLE;\n record.ExceptionAddress = ProgramCounterFromCONTEXT(&context);\n\n EXCEPTION_POINTERS exception_pointers;\n exception_pointers.ContextRecord = &context;\n exception_pointers.ExceptionRecord = &record;\n\n UnhandledExceptionHandler(&exception_pointers);\n}\n\nstd::wstring FormatArgumentString(const std::string& name,\n const std::wstring& value) {\n return std::wstring(L\"--\") + base::UTF8ToWide(name) + L\"=\" + value;\n}\n\nstruct ScopedProcThreadAttributeListTraits {\n static PPROC_THREAD_ATTRIBUTE_LIST InvalidValue() { return nullptr; }\n\n static void Free(PPROC_THREAD_ATTRIBUTE_LIST proc_thread_attribute_list) {\n // This is able to use GET_FUNCTION_REQUIRED() instead of GET_FUNCTION()\n // because it will only be called if InitializeProcThreadAttributeList() and\n // UpdateProcThreadAttribute() are present.\n static const auto delete_proc_thread_attribute_list =\n GET_FUNCTION_REQUIRED(L\"kernel32.dll\", ::DeleteProcThreadAttributeList);\n delete_proc_thread_attribute_list(proc_thread_attribute_list);\n }\n};\n\nusing ScopedProcThreadAttributeList =\n base::ScopedGeneric;\n\nbool IsInheritableHandle(HANDLE handle) {\n if (!handle || handle == INVALID_HANDLE_VALUE)\n return false;\n\n // File handles (FILE_TYPE_DISK) and pipe handles (FILE_TYPE_PIPE) are known\n // to be inheritable. Console handles (FILE_TYPE_CHAR) are not inheritable via\n // PROC_THREAD_ATTRIBUTE_HANDLE_LIST. See\n // https://crashpad.chromium.org/bug/77.\n DWORD handle_type = GetFileType(handle);\n return handle_type == FILE_TYPE_DISK || handle_type == FILE_TYPE_PIPE;\n}\n\n// Adds |handle| to |handle_list| if it appears valid, and is not already in\n// |handle_list|.\n//\n// Invalid handles (including INVALID_HANDLE_VALUE and null handles) cannot be\n// added to a PPROC_THREAD_ATTRIBUTE_LIST’s PROC_THREAD_ATTRIBUTE_HANDLE_LIST.\n// If INVALID_HANDLE_VALUE appears, CreateProcess() will fail with\n// ERROR_INVALID_PARAMETER. If a null handle appears, the child process will\n// silently not inherit any handles.\n//\n// Use this function to add handles with uncertain validities.\nvoid AddHandleToListIfValidAndInheritable(std::vector* handle_list,\n HANDLE handle) {\n // There doesn't seem to be any documentation of this, but if there's a handle\n // duplicated in this list, CreateProcess() fails with\n // ERROR_INVALID_PARAMETER.\n if (IsInheritableHandle(handle) &&\n std::find(handle_list->begin(), handle_list->end(), handle) ==\n handle_list->end()) {\n handle_list->push_back(handle);\n }\n}\n\nvoid AddUint32(std::vector* data_vector, uint32_t data) {\n data_vector->push_back(static_cast(data & 0xff));\n data_vector->push_back(static_cast((data & 0xff00) >> 8));\n data_vector->push_back(static_cast((data & 0xff0000) >> 16));\n data_vector->push_back(static_cast((data & 0xff000000) >> 24));\n}\n\nvoid AddUint64(std::vector* data_vector, uint64_t data) {\n AddUint32(data_vector, static_cast(data & 0xffffffffULL));\n AddUint32(data_vector,\n static_cast((data & 0xffffffff00000000ULL) >> 32));\n}\n\n//! \\brief Creates a randomized pipe name to listen for client registrations\n//! on and returns its name.\n//!\n//! \\param[out] pipe_name The pipe name that will be listened on.\n//! \\param[out] pipe_handle The first pipe instance corresponding for the pipe.\nvoid CreatePipe(std::wstring* pipe_name, ScopedFileHANDLE* pipe_instance) {\n int tries = 5;\n std::string pipe_name_base = base::StringPrintf(\n#if defined(WINDOWS_UWP)\n \"\\\\\\\\.\\\\pipe\\\\LOCAL\\\\crashpad_%lu_\",\n#else\n \"\\\\\\\\.\\\\pipe\\\\crashpad_%lu_\",\n#endif\n GetCurrentProcessId());\n do {\n *pipe_name = base::UTF8ToWide(pipe_name_base + RandomString());\n\n pipe_instance->reset(CreateNamedPipeInstance(*pipe_name, true));\n\n // CreateNamedPipe() is documented as setting the error to\n // ERROR_ACCESS_DENIED if FILE_FLAG_FIRST_PIPE_INSTANCE is specified and the\n // pipe name is already in use. However it may set the error to other codes\n // such as ERROR_PIPE_BUSY (if the pipe already exists and has reached its\n // maximum instance count) or ERROR_INVALID_PARAMETER (if the pipe already\n // exists and its attributes differ from those specified to\n // CreateNamedPipe()). Some of these errors may be ambiguous: for example,\n // ERROR_INVALID_PARAMETER may also occur if CreateNamedPipe() is called\n // incorrectly even in the absence of an existing pipe by the same name.\n // Rather than chasing down all of the possible errors that might indicate\n // that a pipe name is already in use, retry up to a few times on any error.\n } while (!pipe_instance->is_valid() && --tries);\n\n PCHECK(pipe_instance->is_valid()) << \"CreateNamedPipe\";\n}\n\nstruct BackgroundHandlerStartThreadData {\n BackgroundHandlerStartThreadData(\n const base::FilePath& handler,\n const base::FilePath& database,\n const base::FilePath& metrics_dir,\n const std::string& url,\n const std::map& annotations,\n const std::vector& arguments,\n const std::vector& attachments,\n const std::wstring& ipc_pipe,\n ScopedFileHANDLE ipc_pipe_handle)\n : handler(handler),\n database(database),\n metrics_dir(metrics_dir),\n url(url),\n annotations(annotations),\n arguments(arguments),\n attachments(attachments),\n ipc_pipe(ipc_pipe),\n ipc_pipe_handle(std::move(ipc_pipe_handle)) {}\n\n base::FilePath handler;\n base::FilePath database;\n base::FilePath metrics_dir;\n std::string url;\n std::map annotations;\n std::vector arguments;\n std::vector attachments;\n std::wstring ipc_pipe;\n ScopedFileHANDLE ipc_pipe_handle;\n};\n\n// Ensures that SetHandlerStartupState() is called on scope exit. Assumes\n// failure, and on success, SetSuccessful() should be called.\nclass ScopedCallSetHandlerStartupState {\n public:\n ScopedCallSetHandlerStartupState() : successful_(false) {}\n\n ScopedCallSetHandlerStartupState(const ScopedCallSetHandlerStartupState&) =\n delete;\n ScopedCallSetHandlerStartupState& operator=(\n const ScopedCallSetHandlerStartupState&) = delete;\n\n ~ScopedCallSetHandlerStartupState() {\n SetHandlerStartupState(successful_ ? StartupState::kSucceeded\n : StartupState::kFailed);\n }\n\n void SetSuccessful() { successful_ = true; }\n\n private:\n bool successful_;\n};\n\nbool StartHandlerProcess(\n std::unique_ptr data) {\n CHECK(!IsThreadInLoaderLock());\n\n ScopedCallSetHandlerStartupState scoped_startup_state_caller;\n\n std::wstring command_line;\n AppendCommandLineArgument(data->handler.value(), &command_line);\n for (const std::string& argument : data->arguments) {\n AppendCommandLineArgument(base::UTF8ToWide(argument), &command_line);\n }\n if (!data->database.value().empty()) {\n AppendCommandLineArgument(\n FormatArgumentString(\"database\", data->database.value()),\n &command_line);\n }\n if (!data->metrics_dir.value().empty()) {\n AppendCommandLineArgument(\n FormatArgumentString(\"metrics-dir\", data->metrics_dir.value()),\n &command_line);\n }\n if (!data->url.empty()) {\n AppendCommandLineArgument(\n FormatArgumentString(\"url\", base::UTF8ToWide(data->url)),\n &command_line);\n }\n for (const auto& kv : data->annotations) {\n AppendCommandLineArgument(\n FormatArgumentString(\"annotation\",\n base::UTF8ToWide(kv.first + '=' + kv.second)),\n &command_line);\n }\n for (const base::FilePath& attachment : data->attachments) {\n AppendCommandLineArgument(\n FormatArgumentString(\"attachment\", attachment.value()),\n &command_line);\n }\n\n ScopedKernelHANDLE this_process(\n OpenProcess(kXPProcessAllAccess, true, GetCurrentProcessId()));\n if (!this_process.is_valid()) {\n PLOG(ERROR) << \"OpenProcess\";\n return false;\n }\n\n InitialClientData initial_client_data(\n g_signal_exception,\n g_wer_registration.dump_without_crashing,\n g_wer_registration.dump_completed,\n data->ipc_pipe_handle.get(),\n this_process.get(),\n FromPointerCast(&g_crash_exception_information),\n FromPointerCast(&g_non_crash_exception_information),\n FromPointerCast(&g_critical_section_with_debug_info));\n AppendCommandLineArgument(\n base::UTF8ToWide(std::string(\"--initial-client-data=\") +\n initial_client_data.StringRepresentation()),\n &command_line);\n\n BOOL rv;\n DWORD creation_flags;\n STARTUPINFOEX startup_info = {};\n startup_info.StartupInfo.dwFlags =\n STARTF_USESTDHANDLES | STARTF_FORCEOFFFEEDBACK;\n startup_info.StartupInfo.hStdInput = GetStdHandle(STD_INPUT_HANDLE);\n startup_info.StartupInfo.hStdOutput = GetStdHandle(STD_OUTPUT_HANDLE);\n startup_info.StartupInfo.hStdError = GetStdHandle(STD_ERROR_HANDLE);\n\n std::vector handle_list;\n std::unique_ptr proc_thread_attribute_list_storage;\n ScopedProcThreadAttributeList proc_thread_attribute_list_owner;\n\n static const auto initialize_proc_thread_attribute_list =\n GET_FUNCTION(L\"kernel32.dll\", ::InitializeProcThreadAttributeList);\n static const auto update_proc_thread_attribute =\n initialize_proc_thread_attribute_list\n ? GET_FUNCTION(L\"kernel32.dll\", ::UpdateProcThreadAttribute)\n : nullptr;\n if (!initialize_proc_thread_attribute_list || !update_proc_thread_attribute) {\n // The OS doesn’t allow handle inheritance to be restricted, so the handler\n // will inherit every inheritable handle.\n creation_flags = 0;\n startup_info.StartupInfo.cb = sizeof(startup_info.StartupInfo);\n } else {\n // Restrict handle inheritance to just those needed in the handler.\n\n creation_flags = EXTENDED_STARTUPINFO_PRESENT;\n startup_info.StartupInfo.cb = sizeof(startup_info);\n SIZE_T size;\n rv = initialize_proc_thread_attribute_list(nullptr, 1, 0, &size);\n if (rv) {\n LOG(ERROR) << \"InitializeProcThreadAttributeList (size) succeeded, \"\n \"expected failure\";\n return false;\n } else if (GetLastError() != ERROR_INSUFFICIENT_BUFFER) {\n PLOG(ERROR) << \"InitializeProcThreadAttributeList (size)\";\n return false;\n }\n\n proc_thread_attribute_list_storage.reset(new uint8_t[size]);\n startup_info.lpAttributeList =\n reinterpret_cast(\n proc_thread_attribute_list_storage.get());\n rv = initialize_proc_thread_attribute_list(\n startup_info.lpAttributeList, 1, 0, &size);\n if (!rv) {\n PLOG(ERROR) << \"InitializeProcThreadAttributeList\";\n return false;\n }\n proc_thread_attribute_list_owner.reset(startup_info.lpAttributeList);\n\n handle_list.reserve(8);\n handle_list.push_back(g_signal_exception);\n handle_list.push_back(g_wer_registration.dump_without_crashing);\n handle_list.push_back(g_wer_registration.dump_completed);\n handle_list.push_back(data->ipc_pipe_handle.get());\n handle_list.push_back(this_process.get());\n AddHandleToListIfValidAndInheritable(&handle_list,\n startup_info.StartupInfo.hStdInput);\n AddHandleToListIfValidAndInheritable(&handle_list,\n startup_info.StartupInfo.hStdOutput);\n AddHandleToListIfValidAndInheritable(&handle_list,\n startup_info.StartupInfo.hStdError);\n rv = update_proc_thread_attribute(\n startup_info.lpAttributeList,\n 0,\n PROC_THREAD_ATTRIBUTE_HANDLE_LIST,\n &handle_list[0],\n handle_list.size() * sizeof(handle_list[0]),\n nullptr,\n nullptr);\n if (!rv) {\n PLOG(ERROR) << \"UpdateProcThreadAttribute\";\n return false;\n }\n }\n\n // If the embedded crashpad handler is being started via an entry point in a\n // DLL (the handler executable is rundll32.exe), then don't pass\n // the application name to CreateProcess as this appears to generate an\n // invalid command line where the first argument needed by rundll32 is not in\n // the correct format as required in:\n // https://support.microsoft.com/en-ca/help/164787/info-windows-rundll-and-rundll32-interface\n const std::wstring_view kRunDll32Exe(L\"rundll32.exe\");\n bool is_embedded_in_dll = false;\n if (data->handler.value().size() >= kRunDll32Exe.size() &&\n _wcsicmp(data->handler.value()\n .substr(data->handler.value().size() - kRunDll32Exe.size())\n .c_str(),\n kRunDll32Exe.data()) == 0) {\n is_embedded_in_dll = true;\n }\n\n PROCESS_INFORMATION process_info;\n rv = CreateProcess(\n is_embedded_in_dll ? nullptr : data->handler.value().c_str(),\n &command_line[0],\n nullptr,\n nullptr,\n true,\n creation_flags,\n nullptr,\n nullptr,\n &startup_info.StartupInfo,\n &process_info);\n if (!rv) {\n PLOG(ERROR) << \"CreateProcess\";\n return false;\n }\n\n rv = CloseHandle(process_info.hThread);\n PLOG_IF(WARNING, !rv) << \"CloseHandle thread\";\n\n rv = CloseHandle(process_info.hProcess);\n PLOG_IF(WARNING, !rv) << \"CloseHandle process\";\n\n // It is important to close our side of the pipe here before confirming that\n // we can communicate with the server. By doing so, the only remaining copy of\n // the server side of the pipe belongs to the exception handler process we\n // just spawned. Otherwise, the pipe will continue to exist indefinitely, so\n // the connection loop will not detect that it will never be serviced.\n data->ipc_pipe_handle.reset();\n\n // Confirm that the server is waiting for connections before continuing.\n ClientToServerMessage message = {};\n message.type = ClientToServerMessage::kPing;\n ServerToClientMessage response = {};\n if (!SendToCrashHandlerServer(data->ipc_pipe, message, &response)) {\n return false;\n }\n\n scoped_startup_state_caller.SetSuccessful();\n return true;\n}\n\nDWORD WINAPI BackgroundHandlerStartThreadProc(void* data) {\n std::unique_ptr data_as_ptr(\n reinterpret_cast(data));\n return StartHandlerProcess(std::move(data_as_ptr)) ? 0 : 1;\n}\n\nvoid CommonInProcessInitialization() {\n // We create this dummy CRITICAL_SECTION with the\n // RTL_CRITICAL_SECTION_FLAG_FORCE_DEBUG_INFO flag set to have an entry point\n // into the doubly-linked list of RTL_CRITICAL_SECTION_DEBUG objects. This\n // allows us to walk the list at crash time to gather data for !locks. A\n // debugger would instead inspect ntdll!RtlCriticalSectionList to get the head\n // of the list. But that is not an exported symbol, so on an arbitrary client\n // machine, we don't have a way of getting that pointer.\n InitializeCriticalSectionWithDebugInfoIfPossible(\n &g_critical_section_with_debug_info);\n\n g_non_crash_dump_lock = new base::Lock();\n}\n\n} // namespace\n\nCrashpadClient::CrashpadClient()\n : ipc_pipe_(), handler_start_thread_(), vectored_handler_() {}\n\nCrashpadClient::~CrashpadClient() {}\n\nbool CrashpadClient::StartHandler(\n const base::FilePath& handler,\n const base::FilePath& database,\n const base::FilePath& metrics_dir,\n const std::string& url,\n const std::map& annotations,\n const std::vector& arguments,\n bool restartable,\n bool asynchronous_start,\n const std::vector& attachments) {\n DCHECK(ipc_pipe_.empty());\n\n // Both the pipe and the signalling events have to be created on the main\n // thread (not the spawning thread) so that they're valid after we return from\n // this function.\n ScopedFileHANDLE ipc_pipe_handle;\n CreatePipe(&ipc_pipe_, &ipc_pipe_handle);\n\n SECURITY_ATTRIBUTES security_attributes = {0};\n security_attributes.nLength = sizeof(SECURITY_ATTRIBUTES);\n security_attributes.bInheritHandle = true;\n\n g_signal_exception =\n CreateEvent(&security_attributes, false /* auto reset */, false, nullptr);\n g_wer_registration.dump_without_crashing =\n CreateEvent(&security_attributes, false /* auto reset */, false, nullptr);\n g_wer_registration.dump_completed =\n CreateEvent(&security_attributes, false /* auto reset */, false, nullptr);\n\n CommonInProcessInitialization();\n\n RegisterHandlers();\n\n auto data = new BackgroundHandlerStartThreadData(handler,\n database,\n metrics_dir,\n url,\n annotations,\n arguments,\n attachments,\n ipc_pipe_,\n std::move(ipc_pipe_handle));\n\n if (asynchronous_start) {\n // It is important that the current thread not be synchronized with the\n // thread that is created here. StartHandler() needs to be callable inside a\n // DllMain(). In that case, the background thread will not start until the\n // current DllMain() completes, which would cause deadlock if it was waited\n // upon.\n handler_start_thread_.reset(CreateThread(nullptr,\n 0,\n &BackgroundHandlerStartThreadProc,\n reinterpret_cast(data),\n 0,\n nullptr));\n if (!handler_start_thread_.is_valid()) {\n PLOG(ERROR) << \"CreateThread\";\n SetHandlerStartupState(StartupState::kFailed);\n return false;\n }\n\n // In asynchronous mode, we can't report on the overall success or failure\n // of initialization at this point.\n return true;\n } else {\n return StartHandlerProcess(\n std::unique_ptr(data));\n }\n}\n\nvoid CrashpadClient::RegisterHandlers() {\n SetUnhandledExceptionFilter(&UnhandledExceptionHandler);\n\n // Windows swallows heap corruption failures but we can intercept them with\n // a vectored exception handler. Note that a vectored exception handler is\n // not compatible with or generally helpful in ASAN builds (ASAN inserts a\n // bad dereference at the beginning of the handler, leading to recursive\n // invocation of the handler).\n#if !defined(ADDRESS_SANITIZER)\n PVOID handler = AddVectoredExceptionHandler(true, HandleHeapCorruption);\n vectored_handler_.reset(handler);\n#endif\n\n // The Windows CRT's signal.h lists:\n // - SIGINT\n // - SIGILL\n // - SIGFPE\n // - SIGSEGV\n // - SIGTERM\n // - SIGBREAK\n // - SIGABRT\n // SIGILL and SIGTERM are documented as not being generated. SIGBREAK and\n // SIGINT are for Ctrl-Break and Ctrl-C, and aren't something for which\n // capturing a dump is warranted. SIGFPE and SIGSEGV are captured as regular\n // exceptions through the unhandled exception filter. This leaves SIGABRT. In\n // the standard CRT, abort() is implemented as a synchronous call to the\n // SIGABRT signal handler if installed, but after doing so, the unhandled\n // exception filter is not triggered (it instead __fastfail()s). So, register\n // to handle SIGABRT to catch abort() calls, as client code might use this and\n // expect it to cause a crash dump. This will only work when the abort()\n // that's called in client code is the same (or has the same behavior) as the\n // one in use here.\n void (*rv)(int) = signal(SIGABRT, HandleAbortSignal);\n DCHECK_NE(rv, SIG_ERR);\n}\n\nbool CrashpadClient::SetHandlerIPCPipe(const std::wstring& ipc_pipe) {\n DCHECK(ipc_pipe_.empty());\n DCHECK(!ipc_pipe.empty());\n\n ipc_pipe_ = ipc_pipe;\n\n DCHECK(!ipc_pipe_.empty());\n DCHECK_EQ(g_signal_exception, INVALID_HANDLE_VALUE);\n DCHECK_EQ(g_wer_registration.dump_without_crashing, INVALID_HANDLE_VALUE);\n DCHECK_EQ(g_wer_registration.dump_completed, INVALID_HANDLE_VALUE);\n DCHECK(!g_critical_section_with_debug_info.DebugInfo);\n DCHECK(!g_non_crash_dump_lock);\n\n ClientToServerMessage message;\n memset(&message, 0, sizeof(message));\n message.type = ClientToServerMessage::kRegister;\n message.registration.version = RegistrationRequest::kMessageVersion;\n message.registration.client_process_id = GetCurrentProcessId();\n message.registration.crash_exception_information =\n FromPointerCast(&g_crash_exception_information);\n message.registration.non_crash_exception_information =\n FromPointerCast(&g_non_crash_exception_information);\n\n CommonInProcessInitialization();\n\n message.registration.critical_section_address =\n FromPointerCast(&g_critical_section_with_debug_info);\n\n ServerToClientMessage response = {};\n\n if (!SendToCrashHandlerServer(ipc_pipe_, message, &response)) {\n return false;\n }\n\n SetHandlerStartupState(StartupState::kSucceeded);\n\n RegisterHandlers();\n\n // The server returns these already duplicated to be valid in this process.\n g_signal_exception =\n IntToHandle(response.registration.request_crash_dump_event);\n g_wer_registration.dump_without_crashing =\n IntToHandle(response.registration.request_non_crash_dump_event);\n g_wer_registration.dump_completed =\n IntToHandle(response.registration.non_crash_dump_completed_event);\n\n return true;\n}\n\nstd::wstring CrashpadClient::GetHandlerIPCPipe() const {\n DCHECK(!ipc_pipe_.empty());\n return ipc_pipe_;\n}\n\nbool CrashpadClient::WaitForHandlerStart(unsigned int timeout_ms) {\n DCHECK(handler_start_thread_.is_valid());\n DWORD result = WaitForSingleObject(handler_start_thread_.get(), timeout_ms);\n if (result == WAIT_TIMEOUT) {\n LOG(ERROR) << \"WaitForSingleObject timed out\";\n return false;\n } else if (result == WAIT_ABANDONED) {\n LOG(ERROR) << \"WaitForSingleObject abandoned\";\n return false;\n } else if (result != WAIT_OBJECT_0) {\n PLOG(ERROR) << \"WaitForSingleObject\";\n return false;\n }\n\n DWORD exit_code;\n if (!GetExitCodeThread(handler_start_thread_.get(), &exit_code)) {\n PLOG(ERROR) << \"GetExitCodeThread\";\n return false;\n }\n\n handler_start_thread_.reset();\n return exit_code == 0;\n}\n\nbool CrashpadClient::RegisterWerModule(const std::wstring& path) {\n if (g_wer_registration.dump_completed == INVALID_HANDLE_VALUE ||\n g_wer_registration.dump_without_crashing == INVALID_HANDLE_VALUE) {\n LOG(ERROR) << \"not connected\";\n return false;\n }\n // We cannot point (*context).exception_pointers to our pointers yet as it\n // might get used for other non-crash dumps.\n g_wer_registration.crashpad_exception_info =\n &g_non_crash_exception_information;\n // we can point these as we are the only users.\n g_wer_registration.pointers.ExceptionRecord = &g_wer_registration.exception;\n g_wer_registration.pointers.ContextRecord = &g_wer_registration.context;\n\n HRESULT res =\n WerRegisterRuntimeExceptionModule(path.c_str(), &g_wer_registration);\n return res == S_OK;\n}\n\n// static\nvoid CrashpadClient::DumpWithoutCrash(const CONTEXT& context) {\n if (g_wer_registration.dump_without_crashing == INVALID_HANDLE_VALUE ||\n g_wer_registration.dump_completed == INVALID_HANDLE_VALUE) {\n LOG(ERROR) << \"not connected\";\n return;\n }\n\n if (BlockUntilHandlerStartedOrFailed() == StartupState::kFailed) {\n // If we know for certain that the handler has failed to start, then abort\n // here, as we would otherwise wait indefinitely for the\n // g_wer_registration.dump_completed event that would never be signalled.\n LOG(ERROR) << \"crash server failed to launch, no dump captured\";\n return;\n }\n\n // In the non-crashing case, we aren't concerned about avoiding calls into\n // Win32 APIs, so just use regular locking here in case of multiple threads\n // calling this function. If a crash occurs while we're in here, the worst\n // that can happen is that the server captures a partial dump for this path\n // because another thread’s crash processing finished and the process was\n // terminated before this thread’s non-crash processing could be completed.\n base::AutoLock lock(*g_non_crash_dump_lock);\n\n // Create a fake EXCEPTION_POINTERS to give the handler something to work\n // with.\n EXCEPTION_POINTERS exception_pointers = {};\n\n // This is logically const, but EXCEPTION_POINTERS does not declare it as\n // const, so we have to cast that away from the argument.\n exception_pointers.ContextRecord = const_cast(&context);\n\n // We include a fake exception and use a code of '0x517a7ed' (something like\n // \"simulated\") so that it's relatively obvious in windbg that it's not\n // actually an exception. Most values in\n // https://msdn.microsoft.com/library/aa363082.aspx have some of the top\n // nibble set, so we make sure to pick a value that doesn't, so as to be\n // unlikely to conflict.\n constexpr uint32_t kSimulatedExceptionCode = 0x517a7ed;\n EXCEPTION_RECORD record = {};\n record.ExceptionCode = kSimulatedExceptionCode;\n record.ExceptionAddress = ProgramCounterFromCONTEXT(&context);\n\n exception_pointers.ExceptionRecord = &record;\n\n g_non_crash_exception_information.thread_id = GetCurrentThreadId();\n g_non_crash_exception_information.exception_pointers =\n FromPointerCast(&exception_pointers);\n\n g_wer_registration.in_dump_without_crashing = true;\n bool set_event_result = !!SetEvent(g_wer_registration.dump_without_crashing);\n PLOG_IF(ERROR, !set_event_result) << \"SetEvent\";\n\n DWORD wfso_result =\n WaitForSingleObject(g_wer_registration.dump_completed, INFINITE);\n PLOG_IF(ERROR, wfso_result != WAIT_OBJECT_0) << \"WaitForSingleObject\";\n g_wer_registration.in_dump_without_crashing = false;\n}\n\n// static\nvoid CrashpadClient::DumpAndCrash(EXCEPTION_POINTERS* exception_pointers) {\n if (g_signal_exception == INVALID_HANDLE_VALUE) {\n LOG(ERROR) << \"not connected\";\n SafeTerminateProcess(GetCurrentProcess(),\n kTerminationCodeNotConnectedToHandler);\n return;\n }\n\n // We don't need to check for handler startup here, as\n // UnhandledExceptionHandler() necessarily does that.\n\n UnhandledExceptionHandler(exception_pointers);\n}\n\n// static\nbool CrashpadClient::DumpAndCrashTargetProcess(HANDLE process,\n HANDLE blame_thread,\n DWORD exception_code) {\n // Confirm we're on Vista or later.\n const DWORD version = GetVersion();\n const DWORD major_version = LOBYTE(LOWORD(version));\n if (major_version < 6) {\n LOG(ERROR) << \"unavailable before Vista\";\n return false;\n }\n\n // Confirm that our bitness is the same as the process we're crashing.\n ProcessInfo process_info;\n if (!process_info.Initialize(process)) {\n LOG(ERROR) << \"ProcessInfo::Initialize\";\n return false;\n }\n#if defined(ARCH_CPU_64_BITS)\n if (!process_info.Is64Bit()) {\n LOG(ERROR) << \"DumpAndCrashTargetProcess currently not supported x64->x86\";\n return false;\n }\n#endif // ARCH_CPU_64_BITS\n\n ScopedProcessSuspend suspend(process);\n\n // If no thread handle was provided, or the thread has already exited, we pass\n // 0 to the handler, which indicates no fake exception record to be created.\n DWORD thread_id = 0;\n if (blame_thread) {\n // Now that we've suspended the process, if our thread hasn't exited, we\n // know we're relatively safe to pass the thread id through.\n if (WaitForSingleObject(blame_thread, 0) == WAIT_TIMEOUT) {\n static const auto get_thread_id =\n GET_FUNCTION_REQUIRED(L\"kernel32.dll\", ::GetThreadId);\n thread_id = get_thread_id(blame_thread);\n }\n }\n\n constexpr size_t kInjectBufferSize = 4 * 1024;\n WinVMAddress inject_memory =\n FromPointerCast(VirtualAllocEx(process,\n nullptr,\n kInjectBufferSize,\n MEM_RESERVE | MEM_COMMIT,\n PAGE_READWRITE));\n if (!inject_memory) {\n PLOG(ERROR) << \"VirtualAllocEx\";\n return false;\n }\n\n // Because we're the same bitness as our target, we can rely kernel32 being\n // loaded at the same address in our process as the target, and just look up\n // its address here.\n WinVMAddress raise_exception_address =\n FromPointerCast(&RaiseException);\n\n WinVMAddress code_entry_point = 0;\n std::vector data_to_write;\n if (process_info.Is64Bit()) {\n // Data written is first, the data for the 4th argument (lpArguments) to\n // RaiseException(). A two element array:\n //\n // DWORD64: thread_id\n // DWORD64: exception_code\n //\n // Following that, code which sets the arguments to RaiseException() and\n // then calls it:\n //\n // mov r9, \n // mov r8d, 2 ; nNumberOfArguments\n // mov edx, 1 ; dwExceptionFlags = EXCEPTION_NONCONTINUABLE\n // mov ecx, 0xcca11ed ; dwExceptionCode, interpreted specially by the\n // ; handler.\n // jmp \n //\n // Note that the first three arguments to RaiseException() are DWORDs even\n // on x64, so only the 4th argument (a pointer) is a full-width register.\n //\n // We also don't need to set up a stack or use call, since the only\n // registers modified are volatile ones, and we can just jmp straight to\n // RaiseException().\n\n // The data array.\n AddUint64(&data_to_write, thread_id);\n AddUint64(&data_to_write, exception_code);\n\n // The thread entry point.\n code_entry_point = inject_memory + data_to_write.size();\n\n // r9 = pointer to data.\n data_to_write.push_back(0x49);\n data_to_write.push_back(0xb9);\n AddUint64(&data_to_write, inject_memory);\n\n // r8d = 2 for nNumberOfArguments.\n data_to_write.push_back(0x41);\n data_to_write.push_back(0xb8);\n AddUint32(&data_to_write, 2);\n\n // edx = 1 for dwExceptionFlags.\n data_to_write.push_back(0xba);\n AddUint32(&data_to_write, 1);\n\n // ecx = kTriggeredExceptionCode for dwExceptionCode.\n data_to_write.push_back(0xb9);\n AddUint32(&data_to_write, ExceptionCodes::kTriggeredExceptionCode);\n\n // jmp to RaiseException() via rax.\n data_to_write.push_back(0x48); // mov rax, imm.\n data_to_write.push_back(0xb8);\n AddUint64(&data_to_write, raise_exception_address);\n data_to_write.push_back(0xff); // jmp rax.\n data_to_write.push_back(0xe0);\n } else {\n // Data written is first, the data for the 4th argument (lpArguments) to\n // RaiseException(). A two element array:\n //\n // DWORD: thread_id\n // DWORD: exception_code\n //\n // Following that, code which pushes our arguments to RaiseException() and\n // then calls it:\n //\n // push \n // push 2 ; nNumberOfArguments\n // push 1 ; dwExceptionFlags = EXCEPTION_NONCONTINUABLE\n // push 0xcca11ed ; dwExceptionCode, interpreted specially by the handler.\n // call \n // ud2 ; Generate invalid opcode to make sure we still crash if we return\n // ; for some reason.\n //\n // No need to clean up the stack, as RaiseException() is __stdcall.\n\n // The data array.\n AddUint32(&data_to_write, thread_id);\n AddUint32(&data_to_write, exception_code);\n\n // The thread entry point.\n code_entry_point = inject_memory + data_to_write.size();\n\n // Push data address.\n data_to_write.push_back(0x68);\n AddUint32(&data_to_write, static_cast(inject_memory));\n\n // Push 2 for nNumberOfArguments.\n data_to_write.push_back(0x6a);\n data_to_write.push_back(2);\n\n // Push 1 for dwExceptionCode.\n data_to_write.push_back(0x6a);\n data_to_write.push_back(1);\n\n // Push dwExceptionFlags.\n data_to_write.push_back(0x68);\n AddUint32(&data_to_write, kTriggeredExceptionCode);\n\n // Relative call to RaiseException().\n int64_t relative_address_to_raise_exception =\n raise_exception_address - (inject_memory + data_to_write.size() + 5);\n data_to_write.push_back(0xe8);\n AddUint32(&data_to_write,\n static_cast(relative_address_to_raise_exception));\n\n // ud2.\n data_to_write.push_back(0x0f);\n data_to_write.push_back(0x0b);\n }\n\n DCHECK_LT(data_to_write.size(), kInjectBufferSize);\n\n SIZE_T bytes_written;\n if (!WriteProcessMemory(process,\n reinterpret_cast(inject_memory),\n data_to_write.data(),\n data_to_write.size(),\n &bytes_written)) {\n PLOG(ERROR) << \"WriteProcessMemory\";\n return false;\n }\n\n if (bytes_written != data_to_write.size()) {\n LOG(ERROR) << \"WriteProcessMemory unexpected number of bytes\";\n return false;\n }\n\n if (!FlushInstructionCache(\n process, reinterpret_cast(inject_memory), bytes_written)) {\n PLOG(ERROR) << \"FlushInstructionCache\";\n return false;\n }\n\n DWORD old_protect;\n if (!VirtualProtectEx(process,\n reinterpret_cast(inject_memory),\n kInjectBufferSize,\n PAGE_EXECUTE_READ,\n &old_protect)) {\n PLOG(ERROR) << \"VirtualProtectEx\";\n return false;\n }\n\n // Cause an exception in the target process by creating a thread which calls\n // RaiseException with our arguments above. Note that we cannot get away with\n // using DebugBreakProcess() (nothing happens unless a debugger is attached)\n // and we cannot get away with CreateRemoteThread() because it doesn't work if\n // the target is hung waiting for the loader lock. We use NtCreateThreadEx()\n // with the SKIP_THREAD_ATTACH flag, which skips various notifications,\n // letting this cause an exception, even when the target is stuck in the\n // loader lock.\n HANDLE injected_thread;\n\n // This is what DebugBreakProcess() uses.\n constexpr size_t kStackSize = 0x4000;\n\n NTSTATUS status = NtCreateThreadEx(&injected_thread,\n STANDARD_RIGHTS_ALL | SPECIFIC_RIGHTS_ALL,\n nullptr,\n process,\n reinterpret_cast(code_entry_point),\n nullptr,\n THREAD_CREATE_FLAGS_SKIP_THREAD_ATTACH,\n 0,\n kStackSize,\n 0,\n nullptr);\n if (!NT_SUCCESS(status)) {\n NTSTATUS_LOG(ERROR, status) << \"NtCreateThreadEx\";\n return false;\n }\n\n // The injected thread raises an exception and ultimately results in process\n // termination. The suspension must be made aware that the process may be\n // terminating, otherwise it’ll log an extraneous error.\n suspend.TolerateTermination();\n\n bool result = true;\n if (WaitForSingleObject(injected_thread, 60 * 1000) != WAIT_OBJECT_0) {\n PLOG(ERROR) << \"WaitForSingleObject\";\n result = false;\n }\n\n status = NtClose(injected_thread);\n if (!NT_SUCCESS(status)) {\n NTSTATUS_LOG(ERROR, status) << \"NtClose\";\n result = false;\n }\n\n return result;\n}\n\n} // namespace crashpad\n" }, { "path": "client/crashpad_client_win_test.cc", "content": "// Copyright 2015 The Crashpad Authors\n//\n// Licensed under the Apache License, Version 2.0 (the \"License\");\n// you may not use this file except in compliance with the License.\n// You may obtain a copy of the License at\n//\n// http://www.apache.org/licenses/LICENSE-2.0\n//\n// Unless required by applicable law or agreed to in writing, software\n// distributed under the License is distributed on an \"AS IS\" BASIS,\n// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n// See the License for the specific language governing permissions and\n// limitations under the License.\n\n#include \"client/crashpad_client.h\"\n\n#include \n\n#include \"base/files/file_path.h\"\n#include \"gtest/gtest.h\"\n#include \"test/test_paths.h\"\n#include \"test/scoped_temp_dir.h\"\n#include \"test/win/win_multiprocess.h\"\n#include \"test/win/win_multiprocess_with_temp_dir.h\"\n#include \"util/win/scoped_handle.h\"\n#include \"util/win/termination_codes.h\"\n\nnamespace crashpad {\nnamespace test {\nnamespace {\n\nvoid StartAndUseHandler(const base::FilePath& temp_dir) {\n base::FilePath handler_path = TestPaths::Executable().DirName().Append(\n FILE_PATH_LITERAL(\"crashpad_handler.com\"));\n\n CrashpadClient client;\n ASSERT_TRUE(client.StartHandler(handler_path,\n temp_dir,\n base::FilePath(),\n \"\",\n std::map(),\n std::vector(),\n true,\n true));\n ASSERT_TRUE(client.WaitForHandlerStart(INFINITE));\n}\n\nclass StartWithInvalidHandles final : public WinMultiprocessWithTempDir {\n public:\n StartWithInvalidHandles() : WinMultiprocessWithTempDir() {}\n ~StartWithInvalidHandles() {}\n\n private:\n void WinMultiprocessParent() override {}\n\n void WinMultiprocessChild() override {\n HANDLE original_stdout = GetStdHandle(STD_OUTPUT_HANDLE);\n HANDLE original_stderr = GetStdHandle(STD_ERROR_HANDLE);\n SetStdHandle(STD_OUTPUT_HANDLE, INVALID_HANDLE_VALUE);\n SetStdHandle(STD_ERROR_HANDLE, INVALID_HANDLE_VALUE);\n\n StartAndUseHandler(GetTempDirPath());\n\n SetStdHandle(STD_OUTPUT_HANDLE, original_stdout);\n SetStdHandle(STD_ERROR_HANDLE, original_stderr);\n }\n};\n\nTEST(CrashpadClient, StartWithInvalidHandles) {\n WinMultiprocessWithTempDir::Run();\n}\n\nclass StartWithSameStdoutStderr final : public WinMultiprocessWithTempDir {\n public:\n StartWithSameStdoutStderr() : WinMultiprocessWithTempDir() {}\n ~StartWithSameStdoutStderr() {}\n\n private:\n void WinMultiprocessParent() override {}\n\n void WinMultiprocessChild() override {\n HANDLE original_stdout = GetStdHandle(STD_OUTPUT_HANDLE);\n HANDLE original_stderr = GetStdHandle(STD_ERROR_HANDLE);\n SetStdHandle(STD_OUTPUT_HANDLE, original_stderr);\n\n StartAndUseHandler(GetTempDirPath());\n\n SetStdHandle(STD_OUTPUT_HANDLE, original_stdout);\n }\n};\n\nTEST(CrashpadClient, StartWithSameStdoutStderr) {\n WinMultiprocessWithTempDir::Run();\n}\n\nvoid StartAndUseBrokenHandler(CrashpadClient* client) {\n ScopedTempDir temp_dir;\n base::FilePath handler_path = TestPaths::Executable().DirName().Append(\n FILE_PATH_LITERAL(\"fake_handler_that_crashes_at_startup.exe\"));\n ASSERT_TRUE(client->StartHandler(handler_path,\n temp_dir.path(),\n base::FilePath(),\n \"\",\n std::map(),\n std::vector(),\n false,\n true));\n}\n\nclass HandlerLaunchFailureCrash : public WinMultiprocess {\n public:\n HandlerLaunchFailureCrash() : WinMultiprocess() {}\n\n private:\n void WinMultiprocessParent() override {\n SetExpectedChildExitCode(crashpad::kTerminationCodeCrashNoDump);\n }\n\n void WinMultiprocessChild() override {\n CrashpadClient client;\n StartAndUseBrokenHandler(&client);\n __debugbreak();\n exit(0);\n }\n};\n\n#if defined(ADDRESS_SANITIZER)\n// https://crbug.com/845011\n#define MAYBE_HandlerLaunchFailureCrash DISABLED_HandlerLaunchFailureCrash\n#else\n#define MAYBE_HandlerLaunchFailureCrash HandlerLaunchFailureCrash\n#endif\nTEST(CrashpadClient, MAYBE_HandlerLaunchFailureCrash) {\n WinMultiprocess::Run();\n}\n\nclass HandlerLaunchFailureDumpAndCrash : public WinMultiprocess {\n public:\n HandlerLaunchFailureDumpAndCrash() : WinMultiprocess() {}\n\n private:\n void WinMultiprocessParent() override {\n SetExpectedChildExitCode(crashpad::kTerminationCodeCrashNoDump);\n }\n\n void WinMultiprocessChild() override {\n CrashpadClient client;\n StartAndUseBrokenHandler(&client);\n // We don't need to fill this out as we're only checking that we're\n // terminated with the correct failure code.\n EXCEPTION_POINTERS info = {};\n client.DumpAndCrash(&info);\n exit(0);\n }\n};\n\n#if defined(ADDRESS_SANITIZER)\n// https://crbug.com/845011\n#define MAYBE_HandlerLaunchFailureDumpAndCrash \\\n DISABLED_HandlerLaunchFailureDumpAndCrash\n#else\n#define MAYBE_HandlerLaunchFailureDumpAndCrash HandlerLaunchFailureDumpAndCrash\n#endif\nTEST(CrashpadClient, MAYBE_HandlerLaunchFailureDumpAndCrash) {\n WinMultiprocess::Run();\n}\n\nclass HandlerLaunchFailureDumpWithoutCrash : public WinMultiprocess {\n public:\n HandlerLaunchFailureDumpWithoutCrash() : WinMultiprocess() {}\n\n private:\n void WinMultiprocessParent() override {\n // DumpWithoutCrash() normally blocks indefinitely. There's no return value,\n // but confirm that it exits cleanly because it'll return right away if the\n // handler didn't start.\n SetExpectedChildExitCode(0);\n }\n\n void WinMultiprocessChild() override {\n CrashpadClient client;\n StartAndUseBrokenHandler(&client);\n // We don't need to fill this out as we're only checking that we're\n // terminated with the correct failure code.\n CONTEXT context = {};\n client.DumpWithoutCrash(context);\n exit(0);\n }\n};\n\nTEST(CrashpadClient, HandlerLaunchFailureDumpWithoutCrash) {\n WinMultiprocess::Run();\n}\n\n} // namespace\n} // namespace test\n} // namespace crashpad\n" }, { "path": "client/crashpad_info.cc", "content": "// Copyright 2014 The Crashpad Authors\n//\n// Licensed under the Apache License, Version 2.0 (the \"License\");\n// you may not use this file except in compliance with the License.\n// You may obtain a copy of the License at\n//\n// http://www.apache.org/licenses/LICENSE-2.0\n//\n// Unless required by applicable law or agreed to in writing, software\n// distributed under the License is distributed on an \"AS IS\" BASIS,\n// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n// See the License for the specific language governing permissions and\n// limitations under the License.\n\n#include \"client/crashpad_info.h\"\n\n#include \n\n#include \"base/numerics/safe_conversions.h\"\n#include \"build/build_config.h\"\n#include \"util/misc/address_sanitizer.h\"\n#include \"util/misc/from_pointer_cast.h\"\n\n#if BUILDFLAG(IS_APPLE)\n#include \n#endif\n\nnamespace {\n\n// Don’t change this when simply adding fields. Readers will size-check the\n// structure and ignore fields they’re aware of when not present, as well as\n// fields they’re not aware of. Only change this when introducing an\n// incompatible layout, with the understanding that existing readers will not\n// understand new versions.\nconstexpr uint32_t kCrashpadInfoVersion = 1;\n\n// Creates a `UserDataMinidumpStreamListEntry` with the given fields, and\n// returns a pointer to it. The caller takes ownership of the returned object.\ncrashpad::internal::UserDataMinidumpStreamListEntry* CreateListEntry(\n uint64_t next,\n uint32_t stream_type,\n const void* data,\n size_t size) {\n auto to_be_added = new crashpad::internal::UserDataMinidumpStreamListEntry();\n to_be_added->next = next;\n to_be_added->stream_type = stream_type;\n to_be_added->base_address = crashpad::FromPointerCast(data);\n to_be_added->size = base::checked_cast(size);\n return to_be_added;\n}\n\n} // namespace\n\nnamespace crashpad {\n\nstatic_assert(std::is_standard_layout::value,\n \"CrashpadInfo must be standard layout\");\n\n// This structure needs to be stored somewhere that is easy to find without\n// external information.\n//\n// It isn’t placed in an unnamed namespace: hopefully, this will catch attempts\n// to place multiple copies of this structure into the same module. If that’s\n// attempted, and the name of the symbol is the same in each translation unit,\n// it will result in a linker error, which is better than having multiple\n// structures show up.\n//\n// This may result in a static module initializer in debug-mode builds, but\n// because it’s POD, no code should need to run to initialize this under\n// release-mode optimization.\n\n#if BUILDFLAG(IS_POSIX)\n__attribute__((\n\n#if BUILDFLAG(IS_APPLE)\n // Put the structure in a well-known section name where it can be easily\n // found without having to consult the symbol table.\n section(SEG_DATA \",crashpad_info\"),\n#endif\n\n#if defined(ADDRESS_SANITIZER)\n // AddressSanitizer would add a trailing red zone of at least 32 bytes,\n // which would be reflected in the size of the custom section. This confuses\n // MachOImageReader::GetCrashpadInfo(), which finds that the section’s size\n // disagrees with the structure’s size_ field. By specifying an alignment\n // greater than the red zone size, the red zone will be suppressed.\n aligned(64),\n#endif // defined(ADDRESS_SANITIZER)\n\n // There's no need to expose this as a public symbol from the symbol table.\n // All accesses from the outside can locate the well-known section name.\n visibility(\"hidden\"),\n\n // The “used” attribute prevents the structure from being dead-stripped.\n used))\n\n#elif BUILDFLAG(IS_WIN)\n\n// Put the struct in a section name CPADinfo where it can be found without the\n// symbol table.\n#pragma section(\"CPADinfo\", read, write)\n__declspec(allocate(\"CPADinfo\"))\n\n#else // !BUILDFLAG(IS_POSIX) && !BUILDFLAG(IS_WIN)\n#error Port\n#endif // !BUILDFLAG(IS_POSIX) && !BUILDFLAG(IS_WIN)\n\nCrashpadInfo g_crashpad_info;\n\nextern \"C\" int* CRASHPAD_NOTE_REFERENCE;\n\n// static\nCrashpadInfo* CrashpadInfo::GetCrashpadInfo() {\n#if BUILDFLAG(IS_LINUX) || BUILDFLAG(IS_CHROMEOS) || BUILDFLAG(IS_ANDROID) || \\\n BUILDFLAG(IS_FUCHSIA)\n // This otherwise-unused reference is used so that any module that\n // references GetCrashpadInfo() will also include the note in the\n // .note.crashpad.info section. That note in turn contains the address of\n // g_crashpad_info. This allows the module reader to find the CrashpadInfo\n // structure without requiring the use of the dynamic symbol table.\n static volatile int* pointer_to_note_section = CRASHPAD_NOTE_REFERENCE;\n (void)pointer_to_note_section;\n#endif\n return &g_crashpad_info;\n}\n\nCrashpadInfo::CrashpadInfo()\n : signature_(kSignature),\n size_(sizeof(*this)),\n version_(kCrashpadInfoVersion),\n indirectly_referenced_memory_cap_(0),\n padding_0_(0),\n crashpad_handler_behavior_(TriState::kUnset),\n system_crash_reporter_forwarding_(TriState::kUnset),\n gather_indirectly_referenced_memory_(TriState::kUnset),\n padding_1_(0),\n extra_memory_ranges_(nullptr),\n simple_annotations_(nullptr),\n user_data_minidump_stream_head_(nullptr),\n annotations_list_(nullptr)\n#if BUILDFLAG(IS_IOS)\n ,\n intermediate_dump_extra_memory_ranges_(nullptr)\n#endif\n{\n}\n\nUserDataMinidumpStreamHandle* CrashpadInfo::AddUserDataMinidumpStream(\n uint32_t stream_type,\n const void* data,\n size_t size) {\n user_data_minidump_stream_head_ = CreateListEntry(\n crashpad::FromPointerCast(user_data_minidump_stream_head_),\n stream_type,\n data,\n size);\n return user_data_minidump_stream_head_;\n}\n\nUserDataMinidumpStreamHandle* CrashpadInfo::UpdateUserDataMinidumpStream(\n UserDataMinidumpStreamHandle* stream_to_update,\n uint32_t stream_type,\n const void* data,\n size_t size) {\n // Create a new stream that points to the node `stream_to_update` points to.\n const auto new_stream =\n CreateListEntry(stream_to_update->next, stream_type, data, size);\n\n // If `stream_to_update` is head of the list, replace the head with\n // `new_stream`.\n if (stream_to_update == user_data_minidump_stream_head_) {\n user_data_minidump_stream_head_ = new_stream;\n } else {\n // Otherwise, find the node before `stream_to_update`, and make it point to\n // `new_stream` instead.\n auto current = user_data_minidump_stream_head_;\n while (current) {\n auto next = reinterpret_cast(\n current->next);\n if (next == stream_to_update) {\n current->next = FromPointerCast(new_stream);\n break;\n }\n current = next;\n }\n CHECK(current)\n << \"Tried to update a UserDataMinidumpStream that doesn't exist\";\n }\n\n delete stream_to_update;\n return new_stream;\n}\n\n} // namespace crashpad\n" }, { "path": "client/crashpad_info.h", "content": "// Copyright 2014 The Crashpad Authors\n//\n// Licensed under the Apache License, Version 2.0 (the \"License\");\n// you may not use this file except in compliance with the License.\n// You may obtain a copy of the License at\n//\n// http://www.apache.org/licenses/LICENSE-2.0\n//\n// Unless required by applicable law or agreed to in writing, software\n// distributed under the License is distributed on an \"AS IS\" BASIS,\n// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n// See the License for the specific language governing permissions and\n// limitations under the License.\n\n#ifndef CRASHPAD_CLIENT_CRASHPAD_INFO_H_\n#define CRASHPAD_CLIENT_CRASHPAD_INFO_H_\n\n#include \n\n#include \"build/build_config.h\"\n#include \"client/annotation_list.h\"\n#include \"client/simple_address_range_bag.h\"\n#include \"client/simple_string_dictionary.h\"\n#include \"util/misc/tri_state.h\"\n\n#if BUILDFLAG(IS_WIN)\n#include \n#endif // BUILDFLAG(IS_WIN)\n\nnamespace crashpad {\n\nnamespace internal {\n\n#if BUILDFLAG(IS_IOS)\nclass InProcessIntermediateDumpHandler;\n#endif\n\n//! \\brief A linked list of blocks representing custom streams in the minidump,\n//! with addresses (and size) stored as uint64_t to simplify reading from\n//! the handler process.\nstruct UserDataMinidumpStreamListEntry {\n //! \\brief The address of the next entry in the linked list.\n uint64_t next;\n\n //! \\brief The base address of the memory block in the target process' address\n //! space that represents the user data stream.\n uint64_t base_address;\n\n //! \\brief The size of memory block in the target process' address space that\n //! represents the user data stream.\n uint64_t size;\n\n //! \\brief The stream type identifier.\n uint32_t stream_type;\n};\n\n} // namespace internal\n\nusing UserDataMinidumpStreamHandle = internal::UserDataMinidumpStreamListEntry;\n\n//! \\brief A structure that can be used by a Crashpad-enabled program to\n//! provide information to the Crashpad crash handler.\n//!\n//! It is possible for one CrashpadInfo structure to appear in each loaded code\n//! module in a process, but from the perspective of the user of the client\n//! interface, there is only one global CrashpadInfo structure, located in the\n//! module that contains the client interface code.\nstruct CrashpadInfo {\n public:\n //! \\brief Returns the global CrashpadInfo structure.\n static CrashpadInfo* GetCrashpadInfo();\n\n CrashpadInfo();\n\n CrashpadInfo(const CrashpadInfo&) = delete;\n CrashpadInfo& operator=(const CrashpadInfo&) = delete;\n\n //! \\brief Sets the bag of extra memory ranges to be included in the snapshot.\n //!\n //! Extra memory ranges may exist in \\a address_range_bag at the time that\n //! this method is called, or they may be added, removed, or modified in \\a\n //! address_range_bag after this method is called.\n //!\n //! TODO(scottmg) This is currently only supported on Windows and iOS.\n //!\n //! \\param[in] address_range_bag A bag of address ranges. The CrashpadInfo\n //! object does not take ownership of the SimpleAddressRangeBag object.\n //! It is the caller’s responsibility to ensure that this pointer remains\n //! valid while it is in effect for a CrashpadInfo object.\n //!\n //! \\sa extra_memory_ranges()\n void set_extra_memory_ranges(SimpleAddressRangeBag* address_range_bag) {\n extra_memory_ranges_ = address_range_bag;\n }\n\n //! \\return The simple extra memory ranges SimpleAddressRangeBag object.\n //!\n //! \\sa set_extra_memory_ranges()\n SimpleAddressRangeBag* extra_memory_ranges() const {\n return extra_memory_ranges_;\n }\n\n#if BUILDFLAG(IS_IOS)\n //! \\brief Sets the bag of extra memory ranges to be included in the iOS\n //! intermediate dump. This memory is not included in the minidump.\n //!\n //! Extra memory ranges may exist in \\a address_range_bag at the time that\n //! this method is called, or they may be added, removed, or modified in \\a\n //! address_range_bag after this method is called.\n //!\n //! This is only supported on iOS.\n //!\n //! \\param[in] address_range_bag A bag of address ranges. The CrashpadInfo\n //! object does not take ownership of the SimpleAddressRangeBag object.\n //! It is the caller’s responsibility to ensure that this pointer remains\n //! valid while it is in effect for a CrashpadInfo object.\n //!\n //! \\sa extra_memory_ranges()\n void set_intermediate_dump_extra_memory_ranges(\n SimpleAddressRangeBag* address_range_bag) {\n intermediate_dump_extra_memory_ranges_ = address_range_bag;\n }\n\n //! \\return The simple extra memory ranges SimpleAddressRangeBag object.\n //!\n //! \\sa set_extra_memory_ranges()\n SimpleAddressRangeBag* intermediate_dump_extra_memory_ranges() const {\n return intermediate_dump_extra_memory_ranges_;\n }\n#endif\n\n //! \\brief Sets the simple annotations dictionary.\n //!\n //! Simple annotations set on a CrashpadInfo structure are interpreted by\n //! Crashpad as module-level annotations.\n //!\n //! Annotations may exist in \\a simple_annotations at the time that this\n //! method is called, or they may be added, removed, or modified in \\a\n //! simple_annotations after this method is called.\n //!\n //! \\param[in] simple_annotations A dictionary that maps string keys to string\n //! values. The CrashpadInfo object does not take ownership of the\n //! SimpleStringDictionary object. It is the caller’s responsibility to\n //! ensure that this pointer remains valid while it is in effect for a\n //! CrashpadInfo object.\n //!\n //! \\sa simple_annotations()\n void set_simple_annotations(SimpleStringDictionary* simple_annotations) {\n simple_annotations_ = simple_annotations;\n }\n\n //! \\return The simple annotations dictionary.\n //!\n //! \\sa set_simple_annotations()\n SimpleStringDictionary* simple_annotations() const {\n return simple_annotations_;\n }\n\n //! \\brief Sets the annotations list.\n //!\n //! Unlike the \\a simple_annotations structure, the \\a annotations can\n //! typed data and it is not limited to a dictionary form. Annotations are\n //! interpreted by Crashpad as module-level annotations.\n //!\n //! Annotations may exist in \\a list at the time that this method is called,\n //! or they may be added, removed, or modified in \\a list after this method is\n //! called.\n //!\n //! \\param[in] list A list of set Annotation objects that maintain arbitrary,\n //! typed key-value state. The CrashpadInfo object does not take ownership\n //! of the AnnotationsList object. It is the caller’s responsibility to\n //! ensure that this pointer remains valid while it is in effect for a\n //! CrashpadInfo object.\n //!\n //! \\sa annotations_list()\n //! \\sa AnnotationList::Register()\n void set_annotations_list(AnnotationList* list) { annotations_list_ = list; }\n\n //! \\return The annotations list.\n //!\n //! \\sa set_annotations_list()\n //! \\sa AnnotationList::Get()\n //! \\sa AnnotationList::Register()\n AnnotationList* annotations_list() const { return annotations_list_; }\n\n //! \\brief Enables or disables Crashpad handler processing.\n //!\n //! When handling an exception, the Crashpad handler will scan all modules in\n //! a process. The first one that has a CrashpadInfo structure populated with\n //! a value other than TriState::kUnset for this field will dictate whether\n //! the handler is functional or not. If all modules with a CrashpadInfo\n //! structure specify TriState::kUnset, the handler will be enabled. If\n //! disabled, the Crashpad handler will still run and receive exceptions, but\n //! will not take any action on an exception on its own behalf, except for the\n //! action necessary to determine that it has been disabled.\n //!\n //! The Crashpad handler should not normally be disabled. More commonly, it is\n //! appropriate to disable crash report upload by calling\n //! Settings::SetUploadsEnabled().\n void set_crashpad_handler_behavior(TriState crashpad_handler_behavior) {\n crashpad_handler_behavior_ = crashpad_handler_behavior;\n }\n\n //! \\brief Enables or disables Crashpad forwarding of exceptions to the\n //! system’s crash reporter.\n //!\n //! When handling an exception, the Crashpad handler will scan all modules in\n //! a process. The first one that has a CrashpadInfo structure populated with\n //! a value other than TriState::kUnset for this field will dictate whether\n //! the exception is forwarded to the system’s crash reporter. If all modules\n //! with a CrashpadInfo structure specify TriState::kUnset, forwarding will be\n //! enabled. Unless disabled, forwarding may still occur if the Crashpad\n //! handler is disabled by SetCrashpadHandlerState(). Even when forwarding is\n //! enabled, the Crashpad handler may choose not to forward all exceptions to\n //! the system’s crash reporter in cases where it has reason to believe that\n //! the system’s crash reporter would not normally have handled the exception\n //! in Crashpad’s absence.\n void set_system_crash_reporter_forwarding(\n TriState system_crash_reporter_forwarding) {\n system_crash_reporter_forwarding_ = system_crash_reporter_forwarding;\n }\n\n //! \\brief Enables or disables Crashpad capturing indirectly referenced memory\n //! in the minidump.\n //!\n //! When handling an exception, the Crashpad handler will scan all modules in\n //! a process. The first one that has a CrashpadInfo structure populated with\n //! a value other than TriState::kUnset for this field will dictate whether\n //! the extra memory is captured.\n //!\n //! This causes Crashpad to include pages of data referenced by locals or\n //! other stack memory. Turning this on can increase the size of the minidump\n //! significantly.\n //!\n //! \\param[in] gather_indirectly_referenced_memory Whether extra memory should\n //! be gathered.\n //! \\param[in] limit The amount of memory in bytes after which no more\n //! indirectly gathered memory should be captured. This value is only used\n //! when \\a gather_indirectly_referenced_memory is TriState::kEnabled.\n void set_gather_indirectly_referenced_memory(\n TriState gather_indirectly_referenced_memory,\n uint32_t limit) {\n gather_indirectly_referenced_memory_ = gather_indirectly_referenced_memory;\n indirectly_referenced_memory_cap_ = limit;\n }\n\n //! \\brief Adds a custom stream to the minidump.\n //!\n //! The memory block referenced by \\a data and \\a size will added to the\n //! minidump as separate stream with type \\a stream_type. The memory referred\n //! to by \\a data and \\a size is owned by the caller and must remain valid\n //! while it is in effect for the CrashpadInfo object.\n //!\n //! Note that streams will appear in the minidump in the reverse order to\n //! which they are added.\n //!\n //! TODO(scottmg) This is currently not supported on Mac.\n //!\n //! \\param[in] stream_type The stream type identifier to use. This should be\n //! normally be larger than `MINIDUMP_STREAM_TYPE::LastReservedStream`\n //! which is `0xffff`.\n //! \\param[in] data The base pointer of the stream data.\n //! \\param[in] size The size of the stream data.\n //! \\return A handle to the added stream, for use in calling\n //! UpdateUserDataMinidumpStream() if needed.\n UserDataMinidumpStreamHandle* AddUserDataMinidumpStream(uint32_t stream_type,\n const void* data,\n size_t size);\n\n //! \\brief Replaces the given stream with an updated stream.\n //!\n //! Creates a new memory block referencing the given \\a data and \\a size with\n //! type \\a stream_type. The memory referred to be \\a data and \\a size is\n //! owned by the caller and must remain valid while it is in effect for the\n //! CrashpadInfo object.\n //!\n //! Frees \\a stream_to_update and returns a new handle to the updated stream.\n //!\n //! \\param[in] stream_to_update A handle to the stream to be updated, received\n //! from either AddUserDataMinidumpStream() or previous calls to this\n //! function.\n //! \\param[in] stream_type The stream type identifier to use. This should be\n //! normally be larger than `MINIDUMP_STREAM_TYPE::LastReservedStream`\n //! which is `0xffff`.\n //! \\param[in] data The base pointer of the stream data.\n //! \\param[in] size The size of the stream data.\n //! \\return A handle to the new memory block that references the updated data,\n //! for use in calling this method again if needed.\n UserDataMinidumpStreamHandle* UpdateUserDataMinidumpStream(\n UserDataMinidumpStreamHandle* stream_to_update,\n uint32_t stream_type,\n const void* data,\n size_t size);\n\n internal::UserDataMinidumpStreamListEntry*\n GetUserDataMinidumpStreamHeadForTesting() {\n return user_data_minidump_stream_head_;\n }\n\n enum : uint32_t {\n kSignature = 'CPad',\n };\n\n protected:\n#if BUILDFLAG(IS_IOS)\n friend class internal::InProcessIntermediateDumpHandler;\n#endif\n\n uint32_t signature() const { return signature_; }\n uint32_t version() const { return version_; }\n uint32_t size() const { return size_; }\n\n private:\n // The compiler won’t necessarily see anyone using these fields, but it\n // shouldn’t warn about that. These fields aren’t intended for use by the\n // process they’re found in, they’re supposed to be read by the crash\n // reporting process.\n#if defined(__clang__)\n#pragma clang diagnostic push\n#pragma clang diagnostic ignored \"-Wunused-private-field\"\n#endif\n\n // Fields present in version 1, subject to a check of the size_ field:\n uint32_t signature_; // kSignature\n uint32_t size_; // The size of the entire CrashpadInfo structure.\n uint32_t version_; // kCrashpadInfoVersion\n uint32_t indirectly_referenced_memory_cap_;\n uint32_t padding_0_;\n TriState crashpad_handler_behavior_;\n TriState system_crash_reporter_forwarding_;\n TriState gather_indirectly_referenced_memory_;\n uint8_t padding_1_;\n SimpleAddressRangeBag* extra_memory_ranges_; // weak\n SimpleStringDictionary* simple_annotations_; // weak\n internal::UserDataMinidumpStreamListEntry* user_data_minidump_stream_head_;\n AnnotationList* annotations_list_; // weak\n#if BUILDFLAG(IS_IOS)\n SimpleAddressRangeBag* intermediate_dump_extra_memory_ranges_; // weak\n#endif\n\n // It’s generally safe to add new fields without changing\n // kCrashpadInfoVersion, because readers should check size_ and ignore fields\n // that aren’t present, as well as unknown fields.\n //\n // Adding fields? Consider snapshot/crashpad_info_size_test_module.cc too.\n\n#if defined(__clang__)\n#pragma clang diagnostic pop\n#endif\n};\n\n} // namespace crashpad\n\n#endif // CRASHPAD_CLIENT_CRASHPAD_INFO_H_\n" }, { "path": "client/crashpad_info_note.S", "content": "// Copyright 2018 The Crashpad Authors\n//\n// Licensed under the Apache License, Version 2.0 (the \"License\");\n// you may not use this file except in compliance with the License.\n// You may obtain a copy of the License at\n//\n// http://www.apache.org/licenses/LICENSE-2.0\n//\n// Unless required by applicable law or agreed to in writing, software\n// distributed under the License is distributed on an \"AS IS\" BASIS,\n// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n// See the License for the specific language governing permissions and\n// limitations under the License.\n\n// This note section is used on ELF platforms to give ElfImageReader a method\n// of finding the instance of CrashpadInfo g_crashpad_info without requiring\n// that symbol to be in the dynamic symbol table.\n\n#include \"util/misc/elf_note_types.h\"\n#include \"util/misc/arm64_pac_bti.S\"\n\n// namespace crashpad {\n// CrashpadInfo g_crashpad_info;\n// } // namespace crashpad\n#define CRASHPAD_INFO_SYMBOL _ZN8crashpad15g_crashpad_infoE\n\n#define NOTE_ALIGN 4\n\n // This section must be \"a\"llocated so that it appears in the final binary at\n // runtime. The reference to CRASHPAD_INFO_SYMBOL uses an offset relative to\n // this note to avoid making this note writable, which triggers a bug in GNU\n // ld, or adding text relocations which require the target system to allow\n // making text segments writable. https://crbug.com/crashpad/260.\n .section .note.crashpad.info,\"a\",%note\n .balign NOTE_ALIGN\nCRASHPAD_NOTE:\n .long name_end - name // namesz\n .long desc_end - desc // descsz\n .long CRASHPAD_ELF_NOTE_TYPE_CRASHPAD_INFO // type\nname:\n .asciz CRASHPAD_ELF_NOTE_NAME\nname_end:\n .balign NOTE_ALIGN\ndesc:\n#if defined(__LP64__)\n .quad CRASHPAD_INFO_SYMBOL - desc\n#else\n .long CRASHPAD_INFO_SYMBOL - desc\n#endif // __LP64__\ndesc_end:\n .size CRASHPAD_NOTE, .-CRASHPAD_NOTE\n\n // CRASHPAD_NOTE can't be referenced directly by GetCrashpadInfo() because the\n // relocation used to make the reference may require that the address be\n // 8-byte aligned and notes must have 4-byte alignment.\n .section .rodata,\"a\",%progbits\n .balign 8\n # .globl indicates that it's available to link against other .o files. .hidden\n # indicates that it will not appear in the executable's symbol table.\n .globl CRASHPAD_NOTE_REFERENCE\n .hidden CRASHPAD_NOTE_REFERENCE\n .type CRASHPAD_NOTE_REFERENCE, %object\nCRASHPAD_NOTE_REFERENCE:\n // The value of this quad isn't important. It exists to reference\n // CRASHPAD_NOTE, causing the linker to include the note into the binary\n // linking Crashpad. The subtraction from |name| is a convenience to allow the\n // value to be computed statically.\n .quad name - CRASHPAD_NOTE\n" }, { "path": "client/crashpad_info_test.cc", "content": "// Copyright 2024 The Crashpad Authors\n//\n// Licensed under the Apache License, Version 2.0 (the \"License\");\n// you may not use this file except in compliance with the License.\n// You may obtain a copy of the License at\n//\n// http://www.apache.org/licenses/LICENSE-2.0\n//\n// Unless required by applicable law or agreed to in writing, software\n// distributed under the License is distributed on an \"AS IS\" BASIS,\n// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n// See the License for the specific language governing permissions and\n// limitations under the License.\n\n#include \"client/crashpad_info.h\"\n\n#include \n\n#include \"gtest/gtest.h\"\n\nnamespace crashpad {\nnamespace test {\nnamespace {\n\nconstexpr uint32_t kTestStreamType = 0x33333;\n\nclass CrashpadInfoTest : public testing::Test {\n protected:\n CrashpadInfo& crashpad_info() { return crashpad_info_; }\n\n // Returns the current head of the list of streams in `crashpad_info_`. Note\n // that the returned pointer is invalidated if a stream is added or updated.\n internal::UserDataMinidumpStreamListEntry* GetCurrentHead() {\n return crashpad_info().GetUserDataMinidumpStreamHeadForTesting();\n }\n\n // Returns a pointer to the next node in the list after the given `node`.\n internal::UserDataMinidumpStreamListEntry* GetNext(\n internal::UserDataMinidumpStreamListEntry* node) {\n return reinterpret_cast(\n node->next);\n }\n\n internal::UserDataMinidumpStreamListEntry* initial_head() {\n return initial_head_;\n }\n\n internal::UserDataMinidumpStreamListEntry* initial_tail() {\n return initial_tail_;\n }\n\n private:\n void SetUp() override {\n ASSERT_EQ(nullptr, GetCurrentHead());\n\n // Create a simple test list with the structure\n // `initial_head_` -> `initial_tail_`.\n initial_tail_ = AddStream(0x11111, kInitialTailData);\n initial_head_ = AddStream(0x22222, kInitialHeadData);\n\n // Validate the list's contents.\n auto current = GetCurrentHead();\n ASSERT_EQ(initial_head_, current);\n ASSERT_EQ(kInitialHeadData, reinterpret_cast(current->base_address));\n current = GetNext(current);\n ASSERT_EQ(initial_tail_, current);\n ASSERT_EQ(nullptr, GetNext(current));\n }\n\n void TearDown() override {\n // Free the list. The list lives until process exit in production, but must\n // be freed in tests as multiple tests run in the same process.\n auto current = GetCurrentHead();\n while (current) {\n auto next = GetNext(current);\n delete current;\n current = next;\n }\n }\n\n internal::UserDataMinidumpStreamListEntry* AddStream(uint32_t stream_type,\n const char* data) {\n return reinterpret_cast(\n crashpad_info().AddUserDataMinidumpStream(\n stream_type, data, strlen(data)));\n }\n\n CrashpadInfo crashpad_info_;\n\n static constexpr char kInitialHeadData[] = \"head\";\n static constexpr char kInitialTailData[] = \"tail\";\n\n internal::UserDataMinidumpStreamListEntry* initial_head_ = nullptr;\n internal::UserDataMinidumpStreamListEntry* initial_tail_ = nullptr;\n};\n\n// Tests that updating the head of the list updates the head pointer, the new\n// head contains the updated data, and the updated node points to the next node.\nTEST_F(CrashpadInfoTest, UpdateUserDataMinidumpStreamHead) {\n const std::string new_data = \"this is a new string\";\n const auto new_entry = crashpad_info().UpdateUserDataMinidumpStream(\n initial_head(), kTestStreamType, new_data.data(), new_data.size());\n const auto head = GetCurrentHead();\n EXPECT_EQ(new_entry, head);\n EXPECT_EQ(new_data.data(), reinterpret_cast(head->base_address));\n EXPECT_EQ(new_data.size(), head->size);\n EXPECT_EQ(kTestStreamType, head->stream_type);\n EXPECT_EQ(initial_tail(), GetNext(head));\n}\n\n// Tests that updating the tail of the list results in a tail pointing to\n// nullptr, and that the node before the updated node points to it.\nTEST_F(CrashpadInfoTest, UpdateUserDataMinidumpStreamTail) {\n const std::string new_data = \"new\";\n const auto new_entry = crashpad_info().UpdateUserDataMinidumpStream(\n initial_tail(), kTestStreamType, new_data.data(), new_data.size());\n const auto tail = GetNext(GetCurrentHead());\n EXPECT_EQ(new_entry, tail);\n EXPECT_EQ(nullptr, GetNext(tail));\n}\n\n// Tests that the handle returned from updating an entry is usable for updating\n// the entry again.\nTEST_F(CrashpadInfoTest, UpdateUserDataMinidumpStreamMultipleTimes) {\n // Update the entry at the head; the updated entry should become the new head.\n const std::string new_data = \"new\";\n const auto new_entry_1 = crashpad_info().UpdateUserDataMinidumpStream(\n initial_head(), kTestStreamType, new_data.data(), new_data.size());\n EXPECT_EQ(new_entry_1, GetCurrentHead());\n\n // Update the updated entry again; another new entry should replace it as\n // head.\n const auto new_entry_2 = crashpad_info().UpdateUserDataMinidumpStream(\n new_entry_1, kTestStreamType, new_data.data(), new_data.size());\n EXPECT_NE(new_entry_1, new_entry_2);\n EXPECT_EQ(new_entry_2, GetCurrentHead());\n EXPECT_EQ(initial_tail(), GetNext(GetCurrentHead()));\n}\n\n} // namespace\n} // namespace test\n} // namespace crashpad\n" }, { "path": "client/ios_handler/exception_processor.h", "content": "// Copyright 2020 The Crashpad Authors\n//\n// Licensed under the Apache License, Version 2.0 (the \"License\");\n// you may not use this file except in compliance with the License.\n// You may obtain a copy of the License at\n//\n// http://www.apache.org/licenses/LICENSE-2.0\n//\n// Unless required by applicable law or agreed to in writing, software\n// distributed under the License is distributed on an \"AS IS\" BASIS,\n// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n// See the License for the specific language governing permissions and\n// limitations under the License.\n\n#ifndef CRASHPAD_UTIL_IOS_EXCEPTION_PROCESSOR_H_\n#define CRASHPAD_UTIL_IOS_EXCEPTION_PROCESSOR_H_\n\n#include \"base/files/file_path.h\"\n#include \"util/misc/capture_context.h\"\n\nnamespace crashpad {\n\n//! \\brief An interface for notifying the CrashpadClient of NSExceptions.\nclass ObjcExceptionDelegate {\n public:\n //! \\brief The exception processor detected an exception as it was thrown and\n //! captured the cpu context.\n //!\n //! \\param context The cpu context of the thread throwing an exception.\n virtual void HandleUncaughtNSExceptionWithContext(\n NativeCPUContext* context) = 0;\n\n //! \\brief The exception processor did not detect the exception as it was\n //! thrown, and instead caught the exception via the\n //! NSUncaughtExceptionHandler.\n //!\n //! \\param frames An array of call stack frame addresses.\n //! \\param num_frames The number of frames in |frames|.\n virtual void HandleUncaughtNSException(const uint64_t* frames,\n const size_t num_frames) = 0;\n\n //! \\brief Generate an intermediate dump from an NSException caught with its\n //! associated CPU context. Because the method for intercepting\n //! exceptions is imperfect, write the the intermediate dump to a\n //! temporary location specified by \\a path. If the NSException matches\n //! the one used in the UncaughtExceptionHandler, call\n //! MoveIntermediateDumpAtPathToPending to move to the proper Crashpad\n //! database pending location.\n //!\n //! \\param[in] context The cpu context of the thread throwing an exception.\n //! \\param[in] path Path to write the intermediate dump.\n virtual void HandleUncaughtNSExceptionWithContextAtPath(\n NativeCPUContext* context,\n const base::FilePath& path) = 0;\n\n //! \\brief Moves an intermediate dump to the pending directory. This is meant\n //! to be used by the UncaughtExceptionHandler, when the NSException\n //! caught by the preprocessor matches the UncaughtExceptionHandler.\n //!\n //! \\param[in] path Path to the specific intermediate dump.\n virtual bool MoveIntermediateDumpAtPathToPending(\n const base::FilePath& path) = 0;\n\n protected:\n ~ObjcExceptionDelegate() {}\n};\n\n//! \\brief Installs the Objective-C exception preprocessor.\n//!\n//! When code raises an Objective-C exception, unwind the stack looking for\n//! any exception handlers. If an exception handler is encountered, test to\n//! see if it is a function known to be a catch-and-rethrow 'sinkhole' exception\n//! handler. Various routines in UIKit do this, and they obscure the\n//! crashing stack, since the original throw location is no longer present\n//! on the stack (just the re-throw) when Crashpad captures the crash\n//! report. In the case of sinkholes, trigger an immediate exception to\n//! capture the original stack.\n//!\n//! This should be installed at the same time the CrashpadClient installs the\n//! signal handler. It should only be installed once.\nvoid InstallObjcExceptionPreprocessor(ObjcExceptionDelegate* delegate);\n\n//! \\brief Uninstalls the Objective-C exception preprocessor. Expected to be\n//! used by tests only.\nvoid UninstallObjcExceptionPreprocessor();\n\n} // namespace crashpad\n\n#endif // CRASHPAD_UTIL_IOS_EXCEPTION_PROCESSOR_H_\n" }, { "path": "client/ios_handler/exception_processor.mm", "content": "// Copyright 2020 The Crashpad Authors\n//\n// Licensed under the Apache License, Version 2.0 (the \"License\");\n// you may not use this file except in compliance with the License.\n// You may obtain a copy of the License at\n//\n// http://www.apache.org/licenses/LICENSE-2.0\n//\n// Unless required by applicable law or agreed to in writing, software\n// distributed under the License is distributed on an \"AS IS\" BASIS,\n// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n// See the License for the specific language governing permissions and\n// limitations under the License.\n\n// std::unexpected_handler is deprecated starting in C++11, and removed in\n// C++17. But macOS versions we run on still ship it. This define makes\n// std::unexpected_handler reappear. If that define ever stops working,\n// we hopefully no longer run on macOS versions that still have it.\n// (...or we'll have to define it in this file instead of getting it from\n// ). This define must before all includes.\n#define _LIBCPP_ENABLE_CXX17_REMOVED_UNEXPECTED_FUNCTIONS\n\n#include \"client/ios_handler/exception_processor.h\"\n\n#include \n#import \n#include \n#include \n#include \n#include \n#include \n#include \n#include \n#include \n#include \n#include \n#include \n#include \n#include \n\n#include \n#include \n#include \n#include \n#include \n\n#include \"base/format_macros.h\"\n#include \"base/logging.h\"\n#include \"base/memory/free_deleter.h\"\n#include \"base/numerics/safe_conversions.h\"\n#include \"base/strings/stringprintf.h\"\n#include \"base/strings/sys_string_conversions.h\"\n#include \"build/build_config.h\"\n#include \"client/annotation.h\"\n\nnamespace crashpad {\n\nnamespace {\n\n// From 10.15.0 objc4-779.1/runtime/objc-exception.mm.\nstruct objc_typeinfo {\n const void* const* vtable;\n const char* name;\n Class cls_unremapped;\n};\nstruct objc_exception {\n id __unsafe_unretained obj;\n objc_typeinfo tinfo;\n};\n\n// From 10.15.0 objc4-779.1/runtime/objc-abi.h.\nextern \"C\" const void* const objc_ehtype_vtable[];\n\n// https://github.com/llvm/llvm-project/blob/09dc884eb2e4/libcxxabi/src/cxa_exception.h\nstatic const uint64_t kOurExceptionClass = 0x434c4e47432b2b00;\nstruct __cxa_exception {\n#if defined(ARCH_CPU_64_BITS)\n void* reserve;\n size_t referenceCount;\n#endif\n std::type_info* exceptionType;\n void (*exceptionDestructor)(void*);\n std::unexpected_handler unexpectedHandler;\n std::terminate_handler terminateHandler;\n __cxa_exception* nextException;\n int handlerCount;\n int handlerSwitchValue;\n const unsigned char* actionRecord;\n const unsigned char* languageSpecificData;\n void* catchTemp;\n void* adjustedPtr;\n#if !defined(ARCH_CPU_64_BITS)\n size_t referenceCount;\n#endif\n _Unwind_Exception unwindHeader;\n};\n\nint LoggingUnwStep(unw_cursor_t* cursor) {\n int rv = unw_step(cursor);\n if (rv < 0) {\n LOG(ERROR) << \"unw_step: \" << rv;\n }\n return rv;\n}\n\nstd::string FormatStackTrace(const std::vector& addresses,\n size_t max_length) {\n std::string stack_string;\n for (uint64_t address : addresses) {\n std::string address_string = base::StringPrintf(\"0x%\" PRIx64, address);\n if (stack_string.size() + address_string.size() > max_length)\n break;\n stack_string += address_string + \" \";\n }\n\n if (!stack_string.empty() && stack_string.back() == ' ') {\n stack_string.resize(stack_string.size() - 1);\n }\n\n return stack_string;\n}\n\nstd::string GetTraceString() {\n std::vector addresses;\n unw_context_t context;\n unw_getcontext(&context);\n unw_cursor_t cursor;\n unw_init_local(&cursor, &context);\n while (LoggingUnwStep(&cursor) > 0) {\n unw_word_t ip = 0;\n unw_get_reg(&cursor, UNW_REG_IP, &ip);\n addresses.push_back(ip);\n }\n return FormatStackTrace(addresses, 1024);\n}\n\nstatic void SetNSExceptionAnnotations(NSException* exception,\n std::string& name,\n std::string& reason) {\n @try {\n name = base::SysNSStringToUTF8(exception.name);\n static StringAnnotation<256> nameKey(\"exceptionName\");\n nameKey.Set(name);\n } @catch (id name_exception) {\n LOG(ERROR) << \"Unable to read uncaught Objective-C exception name.\";\n }\n\n @try {\n reason = base::SysNSStringToUTF8(exception.reason);\n static StringAnnotation<1024> reasonKey(\"exceptionReason\");\n reasonKey.Set(reason);\n } @catch (id reason_exception) {\n LOG(ERROR) << \"Unable to read uncaught Objective-C exception reason.\";\n }\n\n @try {\n if (exception.userInfo) {\n static StringAnnotation<1024> userInfoKey(\"exceptionUserInfo\");\n userInfoKey.Set(base::SysNSStringToUTF8(\n [NSString stringWithFormat:@\"%@\", exception.userInfo]));\n }\n } @catch (id user_info_exception) {\n LOG(ERROR) << \"Unable to read uncaught Objective-C exception user info.\";\n }\n}\n\n//! \\brief Helper class to own the complex types used by the Objective-C\n//! exception preprocessor.\nclass ExceptionPreprocessorState {\n public:\n ExceptionPreprocessorState(const ExceptionPreprocessorState&) = delete;\n ExceptionPreprocessorState& operator=(const ExceptionPreprocessorState&) =\n delete;\n\n static ExceptionPreprocessorState* Get() {\n static ExceptionPreprocessorState* instance = []() {\n return new ExceptionPreprocessorState();\n }();\n return instance;\n }\n\n // Writes an intermediate dumps to a temporary location to be used by the\n // final UncaughtExceptionHandler and notifies the preprocessor chain.\n id HandleUncaughtException(NativeCPUContext* cpu_context, id exception) {\n // If this isn't the first time the preprocessor has detected an uncaught\n // NSException, note this in the second intermediate dump.\n objc_exception_preprocessor next_preprocessor = next_preprocessor_;\n static bool handled_first_exception;\n if (handled_first_exception) {\n static StringAnnotation<5> name_key(\"MultipleHandledUncaughtNSException\");\n name_key.Set(\"true\");\n\n // Unregister so we stop getting in the way of the exception processor if\n // we aren't correctly identifying sinkholes. The final uncaught exception\n // handler is still active.\n objc_setExceptionPreprocessor(next_preprocessor_);\n next_preprocessor_ = nullptr;\n }\n handled_first_exception = true;\n\n // Use tmp/ for this intermediate dump path. Normally these dumps are\n // written to the \"pending-serialized-ios-dump\" folder and are eligable for\n // the next pass to convert pending intermediate dumps to minidump files.\n // Since this intermediate dump isn't eligable until the uncaught handler,\n // use tmp/.\n base::FilePath path(base::SysNSStringToUTF8([NSTemporaryDirectory()\n stringByAppendingPathComponent:[[NSUUID UUID] UUIDString]]));\n exception_delegate_->HandleUncaughtNSExceptionWithContextAtPath(cpu_context,\n path);\n last_handled_intermediate_dump_ = path;\n\n return next_preprocessor ? next_preprocessor(exception) : exception;\n }\n\n // If the PreprocessException already captured this exception via\n // HANDLE_UNCAUGHT_NSEXCEPTION. Move last_handled_intermediate_dump_ to\n // the pending intermediate dump directory and return true. Otherwise the\n // preprocessor didn't catch anything, so pass the frames or just the context\n // to the exception_delegate.\n void FinalizeUncaughtNSException(id exception) {\n if (last_exception() == (__bridge void*)exception &&\n !last_handled_intermediate_dump_.empty() &&\n exception_delegate_->MoveIntermediateDumpAtPathToPending(\n last_handled_intermediate_dump_)) {\n last_handled_intermediate_dump_ = base::FilePath();\n return;\n }\n\n std::string name, reason;\n NSArray* address_array = nil;\n if ([exception isKindOfClass:[NSException class]]) {\n SetNSExceptionAnnotations(exception, name, reason);\n address_array = [exception callStackReturnAddresses];\n }\n\n if ([address_array count] > 0) {\n static StringAnnotation<256> name_key(\"UncaughtNSException\");\n name_key.Set(\"true\");\n std::vector addresses;\n for (NSNumber* address in address_array)\n addresses.push_back([address unsignedLongLongValue]);\n exception_delegate_->HandleUncaughtNSException(&addresses[0],\n addresses.size());\n } else {\n LOG(WARNING) << \"Uncaught Objective-C exception name: \" << name\n << \" reason: \" << reason << \" with no \"\n << \" -callStackReturnAddresses.\";\n NativeCPUContext cpu_context;\n CaptureContext(&cpu_context);\n exception_delegate_->HandleUncaughtNSExceptionWithContext(&cpu_context);\n }\n }\n\n id MaybeCallNextPreprocessor(id exception) {\n return next_preprocessor_ ? next_preprocessor_(exception) : exception;\n }\n\n // Register the objc_setExceptionPreprocessor and NSUncaughtExceptionHandler.\n void Install(ObjcExceptionDelegate* delegate);\n\n // Restore the objc_setExceptionPreprocessor and NSUncaughtExceptionHandler.\n void Uninstall();\n\n void* last_exception() { return last_exception_; }\n void set_last_exception(void* exception) { last_exception_ = exception; }\n\n private:\n ExceptionPreprocessorState() = default;\n ~ExceptionPreprocessorState() = default;\n\n // Location of the intermediate dump generated after an exception triggered\n // HANDLE_UNCAUGHT_NSEXCEPTION.\n base::FilePath last_handled_intermediate_dump_;\n\n // Recorded last NSException pointer in case the exception is caught and\n // thrown again (without using objc_exception_rethrow) as an\n // unsafe_unretained reference. Stored as a void* as the only safe\n // operation is pointer comparison.\n std::atomic last_exception_ = nil;\n\n ObjcExceptionDelegate* exception_delegate_ = nullptr;\n objc_exception_preprocessor next_preprocessor_ = nullptr;\n NSUncaughtExceptionHandler* next_uncaught_exception_handler_ = nullptr;\n};\n\nstatic void ObjcUncaughtExceptionHandler(NSException* exception) {\n ExceptionPreprocessorState::Get()->FinalizeUncaughtNSException(exception);\n}\n\n// This function is used to make it clear to the crash processor that an\n// uncaught NSException was recorded here.\nstatic __attribute__((noinline)) id HANDLE_UNCAUGHT_NSEXCEPTION(\n id exception,\n const char* sinkhole) {\n std::string name, reason;\n if ([exception isKindOfClass:[NSException class]]) {\n SetNSExceptionAnnotations(exception, name, reason);\n }\n LOG(WARNING) << \"Handling Objective-C exception name: \" << name\n << \" reason: \" << reason << \" with sinkhole: \" << sinkhole;\n NativeCPUContext cpu_context{};\n CaptureContext(&cpu_context);\n\n ExceptionPreprocessorState* preprocessor_state =\n ExceptionPreprocessorState::Get();\n return preprocessor_state->HandleUncaughtException(&cpu_context, exception);\n}\n\n// Returns true if |path| equals |sinkhole| on device. Simulator paths prepend\n// much of Xcode's internal structure, so check that |path| ends with |sinkhole|\n// for simulator.\nbool ModulePathMatchesSinkhole(const char* path, const char* sinkhole) {\n#if TARGET_OS_SIMULATOR\n size_t path_length = strlen(path);\n size_t sinkhole_length = strlen(sinkhole);\n if (sinkhole_length > path_length)\n return false;\n return strncmp(path + path_length - sinkhole_length,\n sinkhole,\n sinkhole_length) == 0;\n#else\n return strcmp(path, sinkhole) == 0;\n#endif\n}\n\n//! \\brief Helper to release memory from calls to __cxa_allocate_exception.\nclass ScopedException {\n public:\n explicit ScopedException(objc_exception* exception) : exception_(exception) {}\n\n ScopedException(const ScopedException&) = delete;\n ScopedException& operator=(const ScopedException&) = delete;\n\n ~ScopedException() { __cxxabiv1::__cxa_free_exception(exception_); }\n\n private:\n objc_exception* exception_; // weak\n};\n\nid ObjcExceptionPreprocessor(id exception) {\n // Some sinkholes don't use objc_exception_rethrow when they should, which\n // would otherwise prevent the exception_preprocessor from getting called\n // again. Because of this, track the most recently seen exception and\n // ignore it.\n ExceptionPreprocessorState* preprocessor_state =\n ExceptionPreprocessorState::Get();\n if (preprocessor_state->last_exception() == (__bridge void*)exception) {\n return preprocessor_state->MaybeCallNextPreprocessor(exception);\n }\n preprocessor_state->set_last_exception((__bridge void*)exception);\n\n static bool seen_first_exception;\n\n static StringAnnotation<256> firstexception(\"firstexception\");\n static StringAnnotation<256> lastexception(\"lastexception\");\n static StringAnnotation<1024> firstexception_bt(\"firstexception_bt\");\n static StringAnnotation<1024> lastexception_bt(\"lastexception_bt\");\n auto* key = seen_first_exception ? &lastexception : &firstexception;\n auto* bt_key = seen_first_exception ? &lastexception_bt : &firstexception_bt;\n\n if ([exception isKindOfClass:[NSException class]]) {\n NSString* value = [NSString\n stringWithFormat:@\"%@ reason %@\", [exception name], [exception reason]];\n key->Set(base::SysNSStringToUTF8(value));\n } else {\n key->Set(base::SysNSStringToUTF8([exception description]));\n }\n\n // This exception preprocessor runs prior to the one in libobjc, which sets\n // the -[NSException callStackReturnAddresses].\n bt_key->Set(GetTraceString());\n seen_first_exception = true;\n\n // Unwind the stack looking for any exception handlers. If an exception\n // handler is encountered, test to see if it is a function known to catch-\n // and-rethrow as a \"top-level\" exception handler. Various routines in\n // Cocoa/UIKit do this, and it obscures the crashing stack, since the original\n // throw location is no longer present on the stack (just the re-throw) when\n // Crashpad captures the crash report.\n unw_context_t context;\n unw_getcontext(&context);\n\n unw_cursor_t cursor;\n unw_init_local(&cursor, &context);\n\n static const void* this_base_address = []() -> const void* {\n Dl_info dl_info;\n if (!dladdr(reinterpret_cast(&ObjcExceptionPreprocessor),\n &dl_info)) {\n LOG(ERROR) << \"dladdr: \" << dlerror();\n return nullptr;\n }\n return dl_info.dli_fbase;\n }();\n\n // Generate an exception_header for the __personality_routine.\n // From 10.15.0 objc4-779.1/runtime/objc-exception.mm objc_exception_throw.\n objc_exception* exception_objc = reinterpret_cast(\n __cxxabiv1::__cxa_allocate_exception(sizeof(objc_exception)));\n ScopedException exception_objc_owner(exception_objc);\n exception_objc->obj = exception;\n exception_objc->tinfo.vtable = objc_ehtype_vtable + 2;\n exception_objc->tinfo.name = object_getClassName(exception);\n exception_objc->tinfo.cls_unremapped = object_getClass(exception);\n\n // https://github.com/llvm/llvm-project/blob/c5d2746fbea7/libcxxabi/src/cxa_exception.cpp\n // __cxa_throw\n __cxa_exception* exception_header =\n reinterpret_cast<__cxa_exception*>(exception_objc) - 1;\n exception_header->unexpectedHandler = std::get_unexpected();\n exception_header->terminateHandler = std::get_terminate();\n exception_header->exceptionType =\n reinterpret_cast(&exception_objc->tinfo);\n exception_header->unwindHeader.exception_class = kOurExceptionClass;\n\n bool handler_found = false;\n while (LoggingUnwStep(&cursor) > 0) {\n unw_proc_info_t frame_info;\n if (unw_get_proc_info(&cursor, &frame_info) != UNW_ESUCCESS) {\n continue;\n }\n\n if (frame_info.handler == 0) {\n continue;\n }\n\n // Check to see if the handler is really an exception handler.\n#if defined(__IPHONE_14_5) && __IPHONE_OS_VERSION_MAX_ALLOWED >= __IPHONE_14_5\n using personality_routine = _Unwind_Personality_Fn;\n#else\n using personality_routine = __personality_routine;\n#endif\n personality_routine p =\n reinterpret_cast(frame_info.handler);\n\n // From 10.15.0 libunwind-35.4/src/UnwindLevel1.c.\n _Unwind_Reason_Code personalityResult = (*p)(\n 1,\n _UA_SEARCH_PHASE,\n exception_header->unwindHeader.exception_class,\n reinterpret_cast<_Unwind_Exception*>(&exception_header->unwindHeader),\n reinterpret_cast<_Unwind_Context*>(&cursor));\n switch (personalityResult) {\n case _URC_HANDLER_FOUND:\n break;\n case _URC_CONTINUE_UNWIND:\n continue;\n default:\n break;\n }\n\n char proc_name[512];\n unw_word_t offset;\n if (unw_get_proc_name(&cursor, proc_name, sizeof(proc_name), &offset) !=\n UNW_ESUCCESS) {\n // The symbol has no name, so see if it belongs to the same image as\n // this function.\n Dl_info dl_info;\n if (dladdr(reinterpret_cast(frame_info.start_ip),\n &dl_info)) {\n if (dl_info.dli_fbase == this_base_address) {\n // This is a handler in our image, so allow it to run.\n handler_found = true;\n break;\n }\n }\n\n // This handler does not belong to us, so continue the search.\n continue;\n }\n\n // Check if the function is one that is known to obscure (by way of\n // catch-and-rethrow) exception stack traces. If it is, sinkhole it\n // by crashing here at the point of throw.\n static constexpr const char* kExceptionSymbolNameSinkholes[] = {\n // The two CF symbol names will also be captured by the CoreFoundation\n // library path check below, but for completeness they are listed here,\n // since they appear unredacted.\n \"CFRunLoopRunSpecific\",\n \"_CFXNotificationPost\",\n \"__NSFireDelayedPerform\",\n // If this exception is going to end up at EHFrame, record the uncaught\n // exception instead.\n \"_ZN4base3mac15CallWithEHFrameEU13block_pointerFvvE\",\n };\n for (const char* sinkhole : kExceptionSymbolNameSinkholes) {\n if (strcmp(sinkhole, proc_name) == 0) {\n return HANDLE_UNCAUGHT_NSEXCEPTION(exception, sinkhole);\n }\n }\n\n // On iOS, function names are often reported as \"\", although they\n // do appear when attached to the debugger. When this happens, use the path\n // of the image to determine if the handler is an exception sinkhole.\n static constexpr const char* kExceptionLibraryPathSinkholes[] = {\n // Everything in this library is a sinkhole, specifically\n // _dispatch_client_callout. Both are needed here depending on whether\n // the debugger is attached (introspection only appears when a simulator\n // is attached to a debugger).\n \"/usr/lib/system/introspection/libdispatch.dylib\",\n \"/usr/lib/system/libdispatch.dylib\",\n\n // __CFRunLoopDoTimers and __CFRunLoopRun are sinkholes. Consider also\n // checking that a few frames up is CFRunLoopRunSpecific().\n \"/System/Library/Frameworks/CoreFoundation.framework/CoreFoundation\",\n };\n\n Dl_info dl_info;\n if (dladdr(reinterpret_cast(frame_info.start_ip), &dl_info) !=\n 0) {\n for (const char* sinkhole : kExceptionLibraryPathSinkholes) {\n if (ModulePathMatchesSinkhole(dl_info.dli_fname, sinkhole)) {\n return HANDLE_UNCAUGHT_NSEXCEPTION(exception, sinkhole);\n }\n }\n\n // Another set of iOS redacted sinkholes appear in CoreAutoLayout.\n // However, this is often called by client code, so it's unsafe to simply\n // handle an uncaught nsexception here. Instead, skip the frame and\n // continue searching for either a handler that belongs to us, or another\n // sinkhole. See:\n // -[NSISEngine\n // performModifications:withUnsatisfiableConstraintsHandler:]:\n // -[NSISEngine withBehaviors:performModifications:]\n // +[NSLayoutConstraintParser\n // constraintsWithVisualFormat:options:metrics:views:]:\n static constexpr const char* kCoreAutoLayoutSinkhole =\n \"/System/Library/PrivateFrameworks/CoreAutoLayout.framework/\"\n \"CoreAutoLayout\";\n if (ModulePathMatchesSinkhole(dl_info.dli_fname,\n kCoreAutoLayoutSinkhole)) {\n continue;\n }\n }\n\n // Some sinkholes are harder to find. _UIGestureEnvironmentUpdate\n // in UIKitCore is an example. UIKitCore can't be added to\n // kExceptionLibraryPathSinkholes because it uses Objective-C exceptions\n // internally and also has has non-sinkhole handlers. While all the\n // calling methods in UIKit are marked starting in iOS14, it's\n // currently true that all callers to _UIGestureEnvironmentUpdate are within\n // UIWindow sendEvent -> UIGestureEnvironment. That means a very hacky way\n // to detect this is to check if the calling (2x) method IMP is within the\n // range of all UIWindow methods.\n static constexpr const char kUIKitCorePath[] =\n \"/System/Library/PrivateFrameworks/UIKitCore.framework/UIKitCore\";\n if (ModulePathMatchesSinkhole(dl_info.dli_fname, kUIKitCorePath)) {\n unw_proc_info_t caller_frame_info;\n if (LoggingUnwStep(&cursor) > 0 &&\n unw_get_proc_info(&cursor, &caller_frame_info) == UNW_ESUCCESS &&\n LoggingUnwStep(&cursor) > 0 &&\n unw_get_proc_info(&cursor, &caller_frame_info) == UNW_ESUCCESS) {\n auto uiwindowimp_lambda = [](IMP* max) {\n IMP min = *max = nullptr;\n unsigned int method_count = 0;\n std::unique_ptr method_list(\n class_copyMethodList(NSClassFromString(@\"UIWindow\"),\n &method_count));\n if (method_count > 0) {\n min = *max = method_getImplementation(method_list[0]);\n for (unsigned int method_index = 1; method_index < method_count;\n method_index++) {\n IMP method_imp =\n method_getImplementation(method_list[method_index]);\n *max = std::max(method_imp, *max);\n min = std::min(method_imp, min);\n }\n }\n return min;\n };\n\n static IMP uiwindow_max_imp;\n static IMP uiwindow_min_imp = uiwindowimp_lambda(&uiwindow_max_imp);\n\n if (uiwindow_min_imp && uiwindow_max_imp &&\n caller_frame_info.start_ip >=\n reinterpret_cast(uiwindow_min_imp) &&\n caller_frame_info.start_ip <=\n reinterpret_cast(uiwindow_max_imp)) {\n return HANDLE_UNCAUGHT_NSEXCEPTION(exception,\n \"_UIGestureEnvironmentUpdate\");\n }\n }\n }\n\n handler_found = true;\n\n break;\n }\n\n // If no handler is found, __cxa_throw would call failed_throw and terminate.\n // See:\n // https://github.com/llvm/llvm-project/blob/c5d2746fbea7/libcxxabi/src/cxa_exception.cpp\n // __cxa_throw. Instead, call HANDLE_UNCAUGHT_NSEXCEPTION so the exception\n // name and reason are properly recorded.\n if (!handler_found) {\n return HANDLE_UNCAUGHT_NSEXCEPTION(exception, \"__cxa_throw\");\n }\n\n // Forward to the next preprocessor.\n return preprocessor_state->MaybeCallNextPreprocessor(exception);\n}\n\nvoid ExceptionPreprocessorState::Install(ObjcExceptionDelegate* delegate) {\n DCHECK(!next_preprocessor_);\n exception_delegate_ = delegate;\n\n // Preprocessor.\n next_preprocessor_ =\n objc_setExceptionPreprocessor(&ObjcExceptionPreprocessor);\n\n // Uncaught processor.\n next_uncaught_exception_handler_ = NSGetUncaughtExceptionHandler();\n NSSetUncaughtExceptionHandler(&ObjcUncaughtExceptionHandler);\n}\n\nvoid ExceptionPreprocessorState::Uninstall() {\n DCHECK(next_preprocessor_);\n objc_setExceptionPreprocessor(next_preprocessor_);\n next_preprocessor_ = nullptr;\n\n NSSetUncaughtExceptionHandler(next_uncaught_exception_handler_);\n next_uncaught_exception_handler_ = nullptr;\n\n exception_delegate_ = nullptr;\n}\n\n} // namespace\n\nvoid InstallObjcExceptionPreprocessor(ObjcExceptionDelegate* delegate) {\n ExceptionPreprocessorState::Get()->Install(delegate);\n}\n\nvoid UninstallObjcExceptionPreprocessor() {\n ExceptionPreprocessorState::Get()->Uninstall();\n}\n\n} // namespace crashpad\n" }, { "path": "client/ios_handler/exception_processor_test.mm", "content": "// Copyright 2020 The Crashpad Authors\n//\n// Licensed under the Apache License, Version 2.0 (the \"License\");\n// you may not use this file except in compliance with the License.\n// You may obtain a copy of the License at\n//\n// http://www.apache.org/licenses/LICENSE-2.0\n//\n// Unless required by applicable law or agreed to in writing, software\n// distributed under the License is distributed on an \"AS IS\" BASIS,\n// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n// See the License for the specific language governing permissions and\n// limitations under the License.\n\n#import \n#include \n#include \n\n#include \"gtest/gtest.h\"\n#include \"testing/platform_test.h\"\n\nnamespace crashpad {\nnamespace test {\nnamespace {\n\nusing IOSExceptionProcessor = PlatformTest;\n\nTEST_F(IOSExceptionProcessor, SelectorExists) {\n IMP init_imp =\n class_getMethodImplementation(NSClassFromString(@\"UIGestureEnvironment\"),\n NSSelectorFromString(@\"init\"));\n\n IMP destruct_imp =\n class_getMethodImplementation(NSClassFromString(@\"UIGestureEnvironment\"),\n NSSelectorFromString(@\".cxx_destruct\"));\n\n // From 10.15.0 objc4-779.1/runtime/objc-class.mm\n // class_getMethodImplementation returns nil or _objc_msgForward on failure.\n ASSERT_TRUE(init_imp);\n EXPECT_NE(init_imp, _objc_msgForward);\n ASSERT_TRUE(destruct_imp);\n EXPECT_NE(destruct_imp, _objc_msgForward);\n}\n\n} // namespace\n} // namespace test\n} // namespace crashpad\n" }, { "path": "client/ios_handler/in_process_handler.cc", "content": "// Copyright 2021 The Crashpad Authors\n//\n// Licensed under the Apache License, Version 2.0 (the \"License\");\n// you may not use this file except in compliance with the License.\n// You may obtain a copy of the License at\n//\n// http://www.apache.org/licenses/LICENSE-2.0\n//\n// Unless required by applicable law or agreed to in writing, software\n// distributed under the License is distributed on an \"AS IS\" BASIS,\n// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n// See the License for the specific language governing permissions and\n// limitations under the License.\n\n#include \"client/ios_handler/in_process_handler.h\"\n\n#include \n#include \n\n#include \n\n#include \"base/logging.h\"\n#include \"client/ios_handler/in_process_intermediate_dump_handler.h\"\n#include \"client/prune_crash_reports.h\"\n#include \"client/settings.h\"\n#include \"minidump/minidump_file_writer.h\"\n#include \"util/file/directory_reader.h\"\n#include \"util/file/filesystem.h\"\n#include \"util/ios/raw_logging.h\"\n\nnamespace {\n\n// Creates directory at |path|.\nbool CreateDirectory(const base::FilePath& path) {\n if (mkdir(path.value().c_str(), 0755) == 0) {\n return true;\n }\n if (errno != EEXIST) {\n PLOG(ERROR) << \"mkdir \" << path.value();\n return false;\n }\n return true;\n}\n\n// The file extension used to indicate a file is locked.\nconstexpr char kLockedExtension[] = \".locked\";\n\n// The seperator used to break the bundle id (e.g. com.chromium.ios) from the\n// uuid in the intermediate dump file name.\nconstexpr char kBundleSeperator[] = \"@\";\n\n// Zero-ed codes used by kMachExceptionFromNSException and\n// kMachExceptionSimulated.\nconstexpr mach_exception_data_type_t kEmulatedMachExceptionCodes[2] = {};\n\n} // namespace\n\nnamespace crashpad {\nnamespace internal {\n\nInProcessHandler::InProcessHandler() = default;\n\nInProcessHandler::~InProcessHandler() {\n if (cached_writer_) {\n cached_writer_->Close();\n }\n UpdatePruneAndUploadThreads(false, UploadBehavior::kUploadWhenAppIsActive);\n}\n\nbool InProcessHandler::Initialize(\n const base::FilePath& database,\n const std::string& url,\n const std::map& annotations,\n ProcessPendingReportsObservationCallback callback) {\n INITIALIZATION_STATE_SET_INITIALIZING(initialized_);\n annotations_ = annotations;\n database_ = CrashReportDatabase::Initialize(database);\n if (!database_) {\n return false;\n }\n bundle_identifier_and_seperator_ =\n system_data_.BundleIdentifier() + kBundleSeperator;\n\n if (!url.empty()) {\n // TODO(scottmg): options.rate_limit should be removed when we have a\n // configurable database setting to control upload limiting.\n // See https://crashpad.chromium.org/bug/23.\n CrashReportUploadThread::Options upload_thread_options;\n upload_thread_options.rate_limit = false;\n upload_thread_options.upload_gzip = true;\n upload_thread_options.watch_pending_reports = true;\n upload_thread_options.identify_client_via_url = true;\n\n upload_thread_.reset(new CrashReportUploadThread(\n database_.get(), url, upload_thread_options, callback));\n }\n\n if (!CreateDirectory(database))\n return false;\n static constexpr char kPendingSerializediOSDump[] =\n \"pending-serialized-ios-dump\";\n base_dir_ = database.Append(kPendingSerializediOSDump);\n if (!CreateDirectory(base_dir_))\n return false;\n\n bool is_app_extension = system_data_.IsExtension();\n prune_thread_.reset(new PruneIntermediateDumpsAndCrashReportsThread(\n database_.get(),\n PruneCondition::GetDefault(),\n base_dir_,\n bundle_identifier_and_seperator_,\n is_app_extension));\n if (is_app_extension || system_data_.IsApplicationActive())\n prune_thread_->Start();\n\n if (!is_app_extension) {\n system_data_.SetActiveApplicationCallback([this](bool active) {\n dispatch_async(\n dispatch_get_global_queue(DISPATCH_QUEUE_PRIORITY_DEFAULT, 0), ^{\n UpdatePruneAndUploadThreads(active,\n UploadBehavior::kUploadWhenAppIsActive);\n });\n });\n }\n\n base::FilePath cached_writer_path = NewLockedFilePath();\n cached_writer_ = CreateWriterWithPath(cached_writer_path);\n if (!cached_writer_.get())\n return false;\n\n // Cache the locked and unlocked path here so no allocations are needed during\n // any exceptions.\n cached_writer_path_ = cached_writer_path.value();\n cached_writer_unlocked_path_ =\n cached_writer_path.RemoveFinalExtension().value();\n INITIALIZATION_STATE_SET_VALID(initialized_);\n return true;\n}\n\nvoid InProcessHandler::DumpExceptionFromSignal(siginfo_t* siginfo,\n ucontext_t* context) {\n INITIALIZATION_STATE_DCHECK_VALID(initialized_);\n ScopedLockedWriter writer(GetCachedWriter(),\n cached_writer_path_.c_str(),\n cached_writer_unlocked_path_.c_str());\n if (!writer.GetWriter()) {\n CRASHPAD_RAW_LOG(\"Cannot DumpExceptionFromSignal without writer\");\n return;\n }\n if (exception_callback_for_testing_) {\n exception_callback_for_testing_();\n }\n ScopedReport report(writer.GetWriter(), system_data_, annotations_);\n InProcessIntermediateDumpHandler::WriteExceptionFromSignal(\n writer.GetWriter(), system_data_, siginfo, context);\n}\n\nvoid InProcessHandler::DumpExceptionFromMachException(\n exception_behavior_t behavior,\n thread_t thread,\n exception_type_t exception,\n const mach_exception_data_type_t* code,\n mach_msg_type_number_t code_count,\n thread_state_flavor_t flavor,\n ConstThreadState old_state,\n mach_msg_type_number_t old_state_count) {\n INITIALIZATION_STATE_DCHECK_VALID(initialized_);\n ScopedLockedWriter writer(GetCachedWriter(),\n cached_writer_path_.c_str(),\n cached_writer_unlocked_path_.c_str());\n if (!writer.GetWriter()) {\n CRASHPAD_RAW_LOG(\"Cannot DumpExceptionFromMachException without writer\");\n return;\n }\n\n if (exception_callback_for_testing_) {\n exception_callback_for_testing_();\n }\n\n ScopedReport report(writer.GetWriter(), system_data_, annotations_);\n InProcessIntermediateDumpHandler::WriteExceptionFromMachException(\n writer.GetWriter(),\n behavior,\n thread,\n exception,\n code,\n code_count,\n flavor,\n old_state,\n old_state_count);\n}\n\nvoid InProcessHandler::DumpExceptionFromNSExceptionWithFrames(\n const uint64_t* frames,\n const size_t num_frames) {\n INITIALIZATION_STATE_DCHECK_VALID(initialized_);\n ScopedLockedWriter writer(GetCachedWriter(),\n cached_writer_path_.c_str(),\n cached_writer_unlocked_path_.c_str());\n if (!writer.GetWriter()) {\n CRASHPAD_RAW_LOG(\n \"Cannot DumpExceptionFromNSExceptionWithFrames without writer\");\n return;\n }\n ScopedReport report(\n writer.GetWriter(), system_data_, annotations_, frames, num_frames);\n InProcessIntermediateDumpHandler::WriteExceptionFromNSException(\n writer.GetWriter());\n}\n\nbool InProcessHandler::DumpExceptionFromSimulatedMachException(\n const NativeCPUContext* context,\n exception_type_t exception,\n base::FilePath* path) {\n base::FilePath locked_path = NewLockedFilePath();\n *path = locked_path.RemoveFinalExtension();\n return DumpExceptionFromSimulatedMachExceptionAtPath(\n context, exception, locked_path);\n}\n\nbool InProcessHandler::DumpExceptionFromSimulatedMachExceptionAtPath(\n const NativeCPUContext* context,\n exception_type_t exception,\n const base::FilePath& path) {\n // This does not use the cached writer. It's expected that simulated\n // exceptions can be called multiple times and there is no expectation that\n // the application is in an unsafe state, or will be terminated after this\n // call.\n std::unique_ptr unsafe_writer =\n CreateWriterWithPath(path);\n base::FilePath writer_path_unlocked = path.RemoveFinalExtension();\n ScopedLockedWriter writer(unsafe_writer.get(),\n path.value().c_str(),\n writer_path_unlocked.value().c_str());\n if (!writer.GetWriter()) {\n CRASHPAD_RAW_LOG(\n \"Cannot DumpExceptionFromSimulatedMachExceptionAtPath without writer\");\n return false;\n }\n ScopedReport report(writer.GetWriter(), system_data_, annotations_);\n InProcessIntermediateDumpHandler::WriteExceptionFromMachException(\n writer.GetWriter(),\n MACH_EXCEPTION_CODES,\n mach_thread_self(),\n exception,\n kEmulatedMachExceptionCodes,\n std::size(kEmulatedMachExceptionCodes),\n MACHINE_THREAD_STATE,\n reinterpret_cast(context),\n MACHINE_THREAD_STATE_COUNT);\n return true;\n}\n\nbool InProcessHandler::MoveIntermediateDumpAtPathToPending(\n const base::FilePath& path) {\n base::FilePath new_path_unlocked = NewLockedFilePath().RemoveFinalExtension();\n return MoveFileOrDirectory(path, new_path_unlocked);\n}\nvoid InProcessHandler::ProcessIntermediateDumps(\n const std::map& annotations,\n const UserStreamDataSources* user_stream_sources) {\n INITIALIZATION_STATE_DCHECK_VALID(initialized_);\n\n for (auto& file : PendingFiles())\n ProcessIntermediateDump(file, annotations, user_stream_sources);\n}\n\nvoid InProcessHandler::ProcessIntermediateDump(\n const base::FilePath& file,\n const std::map& annotations,\n const UserStreamDataSources* user_stream_sources) {\n INITIALIZATION_STATE_DCHECK_VALID(initialized_);\n\n ProcessSnapshotIOSIntermediateDump process_snapshot;\n if (process_snapshot.InitializeWithFilePath(file, annotations)) {\n SaveSnapshot(process_snapshot, user_stream_sources);\n }\n}\n\nvoid InProcessHandler::StartProcessingPendingReports(\n UploadBehavior upload_behavior) {\n if (!upload_thread_)\n return;\n\n upload_thread_enabled_ = true;\n\n // This may be a no-op if IsApplicationActive is false, as it is not safe to\n // start the upload thread when in the background (due to the potential for\n // flocked files in shared containers).\n // TODO(crbug.com/crashpad/400): Consider moving prune and upload thread to\n // BackgroundTasks and/or NSURLSession. This might allow uploads to continue\n // in the background.\n UpdatePruneAndUploadThreads(system_data_.IsApplicationActive(),\n upload_behavior);\n}\n\nvoid InProcessHandler::UpdatePruneAndUploadThreads(\n bool active,\n UploadBehavior upload_behavior) {\n base::AutoLock lock_owner(prune_and_upload_lock_);\n // TODO(crbug.com/crashpad/400): Consider moving prune and upload thread to\n // BackgroundTasks and/or NSURLSession. This might allow uploads to continue\n // in the background.\n bool threads_should_run;\n switch (upload_behavior) {\n case UploadBehavior::kUploadWhenAppIsActive:\n threads_should_run = active;\n break;\n case UploadBehavior::kUploadImmediately:\n threads_should_run = true;\n break;\n }\n if (threads_should_run) {\n if (!prune_thread_->is_running())\n prune_thread_->Start();\n if (upload_thread_enabled_ && !upload_thread_->is_running()) {\n upload_thread_->Start();\n }\n } else {\n if (prune_thread_->is_running())\n prune_thread_->Stop();\n if (upload_thread_enabled_ && upload_thread_->is_running())\n upload_thread_->Stop();\n }\n}\n\nvoid InProcessHandler::SaveSnapshot(\n ProcessSnapshotIOSIntermediateDump& process_snapshot,\n const UserStreamDataSources* user_stream_sources) {\n std::unique_ptr new_report;\n CrashReportDatabase::OperationStatus database_status =\n database_->PrepareNewCrashReport(&new_report);\n if (database_status != CrashReportDatabase::kNoError) {\n Metrics::ExceptionCaptureResult(\n Metrics::CaptureResult::kPrepareNewCrashReportFailed);\n return;\n }\n process_snapshot.SetReportID(new_report->ReportID());\n\n UUID client_id;\n Settings* const settings = database_->GetSettings();\n if (settings && settings->GetClientID(&client_id)) {\n process_snapshot.SetClientID(client_id);\n }\n\n MinidumpFileWriter minidump;\n minidump.InitializeFromSnapshot(&process_snapshot);\n AddUserExtensionStreams(user_stream_sources, &process_snapshot, &minidump);\n\n if (!minidump.WriteEverything(new_report->Writer())) {\n Metrics::ExceptionCaptureResult(\n Metrics::CaptureResult::kMinidumpWriteFailed);\n return;\n }\n UUID uuid;\n database_status =\n database_->FinishedWritingCrashReport(std::move(new_report), &uuid);\n if (database_status != CrashReportDatabase::kNoError) {\n Metrics::ExceptionCaptureResult(\n Metrics::CaptureResult::kFinishedWritingCrashReportFailed);\n return;\n }\n\n if (upload_thread_) {\n upload_thread_->ReportPending(uuid);\n }\n}\n\nstd::vector InProcessHandler::PendingFiles() {\n DirectoryReader reader;\n std::vector files;\n if (!reader.Open(base_dir_)) {\n return files;\n }\n base::FilePath file;\n DirectoryReader::Result result;\n\n // Because the intermediate dump directory is expected to be shared,\n // mitigate any spamming by limiting this to |kMaxPendingFiles|.\n constexpr size_t kMaxPendingFiles = 20;\n\n // Track other application bundles separately, so they don't spam our\n // intermediate dumps into never getting processed.\n std::vector other_files;\n\n base::FilePath cached_writer_path(cached_writer_path_);\n while ((result = reader.NextFile(&file)) ==\n DirectoryReader::Result::kSuccess) {\n // Don't try to process files marked as 'locked' from a different bundle id.\n bool bundle_match =\n file.value().compare(0,\n bundle_identifier_and_seperator_.size(),\n bundle_identifier_and_seperator_) == 0;\n if (!bundle_match && file.FinalExtension() == kLockedExtension) {\n continue;\n }\n\n // Never process the current cached writer path.\n file = base_dir_.Append(file);\n if (file == cached_writer_path)\n continue;\n\n // Otherwise, include any other unlocked, or locked files matching\n // |bundle_identifier_and_seperator_|.\n if (bundle_match) {\n files.push_back(file);\n if (files.size() >= kMaxPendingFiles)\n return files;\n } else {\n other_files.push_back(file);\n }\n }\n\n auto end_iterator =\n other_files.begin() +\n std::min(kMaxPendingFiles - files.size(), other_files.size());\n files.insert(files.end(), other_files.begin(), end_iterator);\n return files;\n}\n\nIOSIntermediateDumpWriter* InProcessHandler::GetCachedWriter() {\n static_assert(\n std::atomic::is_always_lock_free,\n \"std::atomic_compare_exchange_strong uint64_t may not be signal-safe\");\n uint64_t thread_self;\n // This is only safe when passing pthread_self(), otherwise this can lock.\n pthread_threadid_np(pthread_self(), &thread_self);\n uint64_t expected = 0;\n if (!std::atomic_compare_exchange_strong(\n &exception_thread_id_, &expected, thread_self)) {\n if (expected == thread_self) {\n // Another exception came in from this thread, which means it's likely\n // that our own handler crashed. We could open up a new intermediate dump\n // and try to save this dump, but we could end up endlessly writing dumps.\n // Instead, give up.\n } else {\n // Another thread is handling a crash. Sleep forever.\n while (1) {\n sleep(std::numeric_limits::max());\n }\n }\n return nullptr;\n }\n\n return cached_writer_.get();\n}\n\nstd::unique_ptr\nInProcessHandler::CreateWriterWithPath(const base::FilePath& writer_path) {\n std::unique_ptr writer =\n std::make_unique();\n if (!writer->Open(writer_path)) {\n DLOG(ERROR) << \"Unable to open intermediate dump file: \"\n << writer_path.value();\n return nullptr;\n }\n return writer;\n}\n\nconst base::FilePath InProcessHandler::NewLockedFilePath() {\n UUID uuid;\n uuid.InitializeWithNew();\n const std::string file_string =\n bundle_identifier_and_seperator_ + uuid.ToString() + kLockedExtension;\n return base_dir_.Append(file_string);\n}\n\nInProcessHandler::ScopedReport::ScopedReport(\n IOSIntermediateDumpWriter* writer,\n const IOSSystemDataCollector& system_data,\n const std::map& annotations,\n const uint64_t* frames,\n const size_t num_frames)\n : writer_(writer),\n frames_(frames),\n num_frames_(num_frames),\n rootMap_(writer) {\n DCHECK(writer);\n // Grab the report creation time before writing the report.\n uint64_t report_time_nanos = ClockMonotonicNanoseconds();\n InProcessIntermediateDumpHandler::WriteHeader(writer);\n InProcessIntermediateDumpHandler::WriteProcessInfo(writer, annotations);\n InProcessIntermediateDumpHandler::WriteSystemInfo(\n writer, system_data, report_time_nanos);\n}\n\nInProcessHandler::ScopedReport::~ScopedReport() {\n // Write threads and modules last (after the exception itself is written by\n // DumpExceptionFrom*.)\n InProcessIntermediateDumpHandler::WriteThreadInfo(\n writer_, frames_, num_frames_);\n InProcessIntermediateDumpHandler::WriteModuleInfo(writer_);\n}\n\nInProcessHandler::ScopedLockedWriter::ScopedLockedWriter(\n IOSIntermediateDumpWriter* writer,\n const char* writer_path,\n const char* writer_unlocked_path)\n : writer_path_(writer_path),\n writer_unlocked_path_(writer_unlocked_path),\n writer_(writer) {}\n\nInProcessHandler::ScopedLockedWriter::~ScopedLockedWriter() {\n if (!writer_)\n return;\n\n writer_->Close();\n if (rename(writer_path_, writer_unlocked_path_) != 0) {\n CRASHPAD_RAW_LOG(\"Could not remove locked extension.\");\n CRASHPAD_RAW_LOG(writer_path_);\n CRASHPAD_RAW_LOG(writer_unlocked_path_);\n }\n}\n\n} // namespace internal\n} // namespace crashpad\n" }, { "path": "client/ios_handler/in_process_handler.h", "content": "// Copyright 2021 The Crashpad Authors\n//\n// Licensed under the Apache License, Version 2.0 (the \"License\");\n// you may not use this file except in compliance with the License.\n// You may obtain a copy of the License at\n//\n// http://www.apache.org/licenses/LICENSE-2.0\n//\n// Unless required by applicable law or agreed to in writing, software\n// distributed under the License is distributed on an \"AS IS\" BASIS,\n// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n// See the License for the specific language governing permissions and\n// limitations under the License.\n\n#ifndef CRASHPAD_CLIENT_IOS_HANDLER_IN_PROCESS_IN_PROCESS_HANDLER_H_\n#define CRASHPAD_CLIENT_IOS_HANDLER_IN_PROCESS_IN_PROCESS_HANDLER_H_\n\n#include \n#include \n\n#include \n#include \n#include \n#include \n#include \n\n#include \"base/files/file_path.h\"\n#include \"base/synchronization/lock.h\"\n#include \"client/ios_handler/prune_intermediate_dumps_and_crash_reports_thread.h\"\n#include \"client/upload_behavior_ios.h\"\n#include \"handler/crash_report_upload_thread.h\"\n#include \"handler/user_stream_data_source.h\"\n#include \"snapshot/ios/process_snapshot_ios_intermediate_dump.h\"\n#include \"util/ios/ios_intermediate_dump_writer.h\"\n#include \"util/ios/ios_system_data_collector.h\"\n#include \"util/mach/mach_extensions.h\"\n#include \"util/misc/capture_context.h\"\n#include \"util/misc/initialization_state_dcheck.h\"\n\nnamespace crashpad {\nnamespace internal {\n\n//! \\brief Manage intermediate minidump generation, and own the crash report\n//! upload thread and database.\nclass InProcessHandler {\n public:\n InProcessHandler();\n ~InProcessHandler();\n InProcessHandler(const InProcessHandler&) = delete;\n InProcessHandler& operator=(const InProcessHandler&) = delete;\n\n //! \\brief Observation callback invoked each time this object finishes\n //! processing and attempting to upload on-disk crash reports (whether or\n //! not the uploads succeeded).\n //!\n //! This callback is copied into this object. Any references or pointers\n //! inside must outlive this object.\n //!\n //! The callback might be invoked on a background thread, so clients must\n //! synchronize appropriately.\n using ProcessPendingReportsObservationCallback = std::function;\n\n //! \\brief Initializes the in-process handler.\n //!\n //! This method must be called only once, and must be successfully called\n //! before any other method in this class may be called.\n //!\n //! \\param[in] database The path to a Crashpad database.\n //! \\param[in] url The URL of an upload server.\n //! \\param[in] annotations Process annotations to set in each crash report.\n //! \\param[in] callback Optional callback invoked zero or more times\n //! on a background thread each time this object finishes\n //! processing and attempting to upload on-disk crash reports.\n //! \\return `true` if a handler to a pending intermediate dump could be\n //! opened.\n bool Initialize(const base::FilePath& database,\n const std::string& url,\n const std::map& annotations,\n ProcessPendingReportsObservationCallback callback =\n ProcessPendingReportsObservationCallback());\n\n //! \\brief Generate an intermediate dump from a signal handler exception.\n //! Writes the dump with the cached writer does not allow concurrent\n //! exceptions to be written. It is expected the system will terminate\n //! the application after this call.\n //!\n //! \\param[in] siginfo A pointer to a `siginfo_t` object received by a signal\n //! handler.\n //! \\param[in] context A pointer to a `ucontext_t` object received by a\n //! signal.\n void DumpExceptionFromSignal(siginfo_t* siginfo, ucontext_t* context);\n\n //! \\brief Generate an intermediate dump from a mach exception. Writes the\n //! dump with the cached writer does not allow concurrent exceptions to be\n //! written. It is expected the system will terminate the application\n //! after this call.\n //!\n //! \\param[in] behavior\n //! \\param[in] thread\n //! \\param[in] exception\n //! \\param[in] code\n //! \\param[in] code_count\n //! \\param[in,out] flavor\n //! \\param[in] old_state\n //! \\param[in] old_state_count\n void DumpExceptionFromMachException(exception_behavior_t behavior,\n thread_t thread,\n exception_type_t exception,\n const mach_exception_data_type_t* code,\n mach_msg_type_number_t code_count,\n thread_state_flavor_t flavor,\n ConstThreadState old_state,\n mach_msg_type_number_t old_state_count);\n\n //! \\brief Generate an intermediate dump from an uncaught NSException.\n //!\n //! When the ObjcExceptionPreprocessor does not detect an NSException as it is\n //! thrown, the last-chance uncaught exception handler passes a list of call\n //! stack frame addresses. Record them in the intermediate dump so a minidump\n //! with a 'fake' call stack is generated. Writes the dump with the cached\n //! writer does not allow concurrent exceptions to be written. It is expected\n //! the system will terminate the application after this call.\n\n //!\n //! \\param[in] frames An array of call stack frame addresses.\n //! \\param[in] num_frames The number of frames in |frames|.\n void DumpExceptionFromNSExceptionWithFrames(const uint64_t* frames,\n const size_t num_frames);\n\n //! \\brief Generate a simulated intermediate dump similar to a Mach exception\n //! in the same base directory as other exceptions. Does not use the\n //! cached writer.\n //!\n //! \\param[in] context A pointer to a NativeCPUContext object for this\n //! simulated exception.\n //! \\param[in] exception\n //! \\param[out] path The path of the intermediate dump generated.\n //! \\return `true` if the pending intermediate dump could be written.\n bool DumpExceptionFromSimulatedMachException(const NativeCPUContext* context,\n exception_type_t exception,\n base::FilePath* path);\n\n //! \\brief Generate a simulated intermediate dump similar to a Mach exception\n //! at a specific path. Does not use the cached writer.\n //!\n //! \\param[in] context A pointer to a NativeCPUContext object for this\n //! simulated exception.\n //! \\param[in] exception\n //! \\param[in] path Path to where the intermediate dump should be written.\n //! \\return `true` if the pending intermediate dump could be written.\n bool DumpExceptionFromSimulatedMachExceptionAtPath(\n const NativeCPUContext* context,\n exception_type_t exception,\n const base::FilePath& path);\n\n //! \\brief Moves an intermediate dump to the pending directory. This is meant\n //! to be used by the UncaughtExceptionHandler, when NSException caught\n //! by the preprocessor matches the UncaughtExceptionHandler.\n //!\n //! \\param[in] path Path to the specific intermediate dump.\n bool MoveIntermediateDumpAtPathToPending(const base::FilePath& path);\n\n //! \\brief Requests that the handler convert all intermediate dumps into\n //! minidumps and trigger an upload if possible.\n //!\n //! \\param[in] annotations Process annotations to set in each crash report.\n //! \\param[in] user_stream_sources An optional vector containing the\n //! extensibility data sources to call on crash. Each time a minidump is\n //! created, the sources are called in turn. Any streams returned are\n //! added to the minidump.\n void ProcessIntermediateDumps(\n const std::map& annotations,\n const UserStreamDataSources* user_stream_sources);\n\n //! \\brief Requests that the handler convert a specific intermediate dump into\n //! a minidump and trigger an upload if possible.\n //!\n //! \\param[in] path Path to the specific intermediate dump.\n //! \\param[in] annotations Process annotations to set in each crash report.\n //! \\param[in] user_stream_sources An optional vector containing the\n //! extensibility data sources to call on crash. Each time a minidump is\n //! created, the sources are called in turn. Any streams returned are\n //! added to the minidump.\n void ProcessIntermediateDump(\n const base::FilePath& path,\n const std::map& annotations = {},\n const UserStreamDataSources* user_stream_sources = {});\n\n //! \\brief Requests that the handler begin in-process uploading of any\n //! pending reports.\n //!\n //! \\param[in] upload_behavior Controls when the upload thread will run and\n //! process pending reports. By default, only uploads pending reports\n //! when the application is active.\n void StartProcessingPendingReports(\n UploadBehavior upload_behavior = UploadBehavior::kUploadWhenAppIsActive);\n\n //! \\brief Inject a callback into the Mach exception and signal handling\n //! mechanisms. Intended to be used by tests to trigger a reentrant\n // exception.\n void SetExceptionCallbackForTesting(void (*callback)()) {\n exception_callback_for_testing_ = callback;\n }\n\n private:\n //! \\brief Helper to start and end intermediate reports.\n class ScopedReport {\n public:\n ScopedReport(IOSIntermediateDumpWriter* writer,\n const IOSSystemDataCollector& system_data,\n const std::map& annotations,\n const uint64_t* frames = nullptr,\n const size_t num_frames = 0);\n ~ScopedReport();\n ScopedReport(const ScopedReport&) = delete;\n ScopedReport& operator=(const ScopedReport&) = delete;\n\n private:\n IOSIntermediateDumpWriter* writer_;\n const uint64_t* frames_;\n const size_t num_frames_;\n IOSIntermediateDumpWriter::ScopedRootMap rootMap_;\n };\n\n //! \\brief Helper to manage closing the intermediate dump writer and unlocking\n //! the dump file (renaming the file) after the report is written.\n class ScopedLockedWriter {\n public:\n ScopedLockedWriter(IOSIntermediateDumpWriter* writer,\n const char* writer_path,\n const char* writer_unlocked_path);\n\n //! \\brief Close the writer_ and rename to the file with path without the\n //! .locked extension.\n ~ScopedLockedWriter();\n\n ScopedLockedWriter(const ScopedLockedWriter&) = delete;\n ScopedLockedWriter& operator=(const ScopedLockedWriter&) = delete;\n\n IOSIntermediateDumpWriter* GetWriter() { return writer_; }\n\n private:\n const char* writer_path_;\n const char* writer_unlocked_path_;\n IOSIntermediateDumpWriter* writer_;\n };\n\n //! \\brief Manage the prune and upload thread when the active state changes.\n //!\n //! \\param[in] active `true` if the application is actively running in the\n //! foreground, `false` otherwise.\n //! \\param[in] upload_behavior Controls when the upload thread will run and\n //! process pending reports.\n void UpdatePruneAndUploadThreads(bool active, UploadBehavior upload_behavior);\n\n //! \\brief Writes a minidump to the Crashpad database from the\n //! \\a process_snapshot, and triggers the upload_thread_ if started.\n //! \\param[in] user_stream_sources An optional vector containing the\n //! extensibility data sources to call on crash. Each time a minidump is\n //! created, the sources are called in turn. Any streams returned are\n //! added to the minidump.\n void SaveSnapshot(ProcessSnapshotIOSIntermediateDump& process_snapshot,\n const UserStreamDataSources* user_stream_sources = {});\n\n //! \\brief Process a maximum of 20 pending intermediate dumps. Dumps named\n //! with our bundle id get first priority to prevent spamming.\n std::vector PendingFiles();\n\n //! \\brief Lock access to the cached intermediate dump writer from\n //! concurrent signal, Mach exception and uncaught NSExceptions so that\n //! the first exception wins. If the same thread triggers another\n //! reentrant exception, ignore it. If a different thread triggers a\n //! concurrent exception, sleep indefinitely.\n IOSIntermediateDumpWriter* GetCachedWriter();\n\n //! \\brief Open a new intermediate dump writer from \\a writer_path.\n std::unique_ptr CreateWriterWithPath(\n const base::FilePath& writer_path);\n\n //! \\brief Generates a new file path to be used by an intermediate dump\n //! writer built from base_dir_,, bundle_identifier_and_seperator_, a new\n //! UUID, with a .locked extension.\n const base::FilePath NewLockedFilePath();\n\n // Intended to be used by tests triggering a reentrant exception. Called\n // in DumpExceptionFromMachException and DumpExceptionFromSignal after\n // acquiring the cached_writer_.\n void (*exception_callback_for_testing_)() = nullptr;\n\n // Used to synchronize access to UpdatePruneAndUploadThreads().\n base::Lock prune_and_upload_lock_;\n std::atomic_bool upload_thread_enabled_ = false;\n std::map annotations_;\n base::FilePath base_dir_;\n std::string cached_writer_path_;\n std::string cached_writer_unlocked_path_;\n std::unique_ptr cached_writer_;\n std::atomic exception_thread_id_ = 0;\n std::unique_ptr upload_thread_;\n std::unique_ptr prune_thread_;\n std::unique_ptr database_;\n std::string bundle_identifier_and_seperator_;\n IOSSystemDataCollector system_data_;\n InitializationStateDcheck initialized_;\n};\n\n} // namespace internal\n} // namespace crashpad\n\n#endif // CRASHPAD_CLIENT_IOS_HANDLER_IN_PROCESS_IN_PROCESS_HANDLER_H_\n" }, { "path": "client/ios_handler/in_process_handler_test.cc", "content": "// Copyright 2021 The Crashpad Authors\n//\n// Licensed under the Apache License, Version 2.0 (the \"License\");\n// you may not use this file except in compliance with the License.\n// You may obtain a copy of the License at\n//\n// http://www.apache.org/licenses/LICENSE-2.0\n//\n// Unless required by applicable law or agreed to in writing, software\n// distributed under the License is distributed on an \"AS IS\" BASIS,\n// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n// See the License for the specific language governing permissions and\n// limitations under the License.\n\n#include \"client/ios_handler/in_process_handler.h\"\n\n#include \"gtest/gtest.h\"\n#include \"test/scoped_temp_dir.h\"\n#include \"test/test_paths.h\"\n#include \"util/file/directory_reader.h\"\n#include \"util/file/filesystem.h\"\n\nnamespace crashpad {\nnamespace test {\nnamespace {\n\nbool CreateFile(const base::FilePath& file) {\n ScopedFileHandle fd(LoggingOpenFileForWrite(\n file, FileWriteMode::kCreateOrFail, FilePermissions::kOwnerOnly));\n EXPECT_TRUE(fd.is_valid());\n return fd.is_valid();\n}\n\nclass InProcessHandlerTest : public testing::Test {\n protected:\n // testing::Test:\n\n void SetUp() override {\n ASSERT_TRUE(in_process_handler_.Initialize(temp_dir_.path(), \"\", {}));\n pending_dir_ = temp_dir_.path().Append(\"pending-serialized-ios-dump\");\n bundle_identifier_and_seperator_ = system_data_.BundleIdentifier() + \"@\";\n }\n\n const auto& path() const { return pending_dir_; }\n auto& handler() { return in_process_handler_; }\n\n void CreateFiles(int files, int other_files) {\n base::FilePath::StringType file_prepend =\n FILE_PATH_LITERAL(bundle_identifier_and_seperator_);\n base::FilePath::StringType file_name = FILE_PATH_LITERAL(\"file\");\n for (int i = 0; i < files; i++) {\n std::string i_str = std::to_string(i);\n base::FilePath file(file_prepend + file_name + i_str);\n CreateFile(path().Append(file));\n }\n\n for (int i = 0; i < other_files; i++) {\n std::string i_str = std::to_string(i);\n base::FilePath file(file_name + i_str);\n CreateFile(path().Append(file));\n }\n }\n\n void VerifyRemainingFileCount(int expected_files_count,\n int expected_other_files_count) {\n DirectoryReader reader;\n ASSERT_TRUE(reader.Open(path()));\n DirectoryReader::Result result;\n base::FilePath filename;\n int files_count = 0;\n int other_files_count = 0;\n while ((result = reader.NextFile(&filename)) ==\n DirectoryReader::Result::kSuccess) {\n bool bundle_match =\n filename.value().compare(0,\n bundle_identifier_and_seperator_.size(),\n bundle_identifier_and_seperator_) == 0;\n if (bundle_match) {\n files_count++;\n } else {\n other_files_count++;\n }\n }\n EXPECT_EQ(expected_files_count, files_count);\n EXPECT_EQ(expected_other_files_count, other_files_count);\n }\n\n void ClearFiles() {\n DirectoryReader reader;\n ASSERT_TRUE(reader.Open(path()));\n DirectoryReader::Result result;\n base::FilePath filename;\n while ((result = reader.NextFile(&filename)) ==\n DirectoryReader::Result::kSuccess) {\n LoggingRemoveFile(path().Append(filename));\n }\n }\n\n private:\n ScopedTempDir temp_dir_;\n base::FilePath pending_dir_;\n std::string bundle_identifier_and_seperator_;\n internal::IOSSystemDataCollector system_data_;\n internal::InProcessHandler in_process_handler_;\n};\n\nTEST_F(InProcessHandlerTest, TestPendingFileLimit) {\n // Clear this first to blow away the pending file held by InProcessHandler.\n ClearFiles();\n\n // Only process other app files.\n CreateFiles(0, 20);\n handler().ProcessIntermediateDumps({}, nullptr);\n VerifyRemainingFileCount(0, 0);\n ClearFiles();\n\n // Only process our app files.\n CreateFiles(20, 20);\n handler().ProcessIntermediateDumps({}, nullptr);\n VerifyRemainingFileCount(0, 20);\n ClearFiles();\n\n // Process all of our files and 10 remaining.\n CreateFiles(10, 30);\n handler().ProcessIntermediateDumps({}, nullptr);\n VerifyRemainingFileCount(0, 20);\n ClearFiles();\n\n // Process 20 our files, leaving 10 remaining, and all other files remaining.\n CreateFiles(30, 10);\n handler().ProcessIntermediateDumps({}, nullptr);\n VerifyRemainingFileCount(10, 10);\n ClearFiles();\n\n CreateFiles(0, 0);\n handler().ProcessIntermediateDumps({}, nullptr);\n VerifyRemainingFileCount(0, 0);\n ClearFiles();\n\n CreateFiles(10, 0);\n handler().ProcessIntermediateDumps({}, nullptr);\n VerifyRemainingFileCount(0, 0);\n ClearFiles();\n}\n\n} // namespace\n} // namespace test\n} // namespace crashpad\n" }, { "path": "client/ios_handler/in_process_intermediate_dump_handler.cc", "content": "// Copyright 2021 The Crashpad Authors\n//\n// Licensed under the Apache License, Version 2.0 (the \"License\");\n// you may not use this file except in compliance with the License.\n// You may obtain a copy of the License at\n//\n// http://www.apache.org/licenses/LICENSE-2.0\n//\n// Unless required by applicable law or agreed to in writing, software\n// distributed under the License is distributed on an \"AS IS\" BASIS,\n// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n// See the License for the specific language governing permissions and\n// limitations under the License.\n\n#include \"client/ios_handler/in_process_intermediate_dump_handler.h\"\n\n#include \n#include \n#include \n#include \n#include \n#include \n\n#include \n#include \n\n#include \"base/check_op.h\"\n#include \"build/build_config.h\"\n#include \"snapshot/snapshot_constants.h\"\n#include \"util/ios/ios_intermediate_dump_writer.h\"\n#include \"util/ios/raw_logging.h\"\n#include \"util/ios/scoped_vm_map.h\"\n#include \"util/ios/scoped_vm_read.h\"\n#include \"util/synchronization/scoped_spin_guard.h\"\n\nnamespace crashpad {\nnamespace internal {\n\nnamespace {\n\n#if defined(ARCH_CPU_X86_64)\nconst thread_state_flavor_t kThreadStateFlavor = x86_THREAD_STATE64;\nconst thread_state_flavor_t kFloatStateFlavor = x86_FLOAT_STATE64;\nconst thread_state_flavor_t kDebugStateFlavor = x86_DEBUG_STATE64;\nusing thread_state_type = x86_thread_state64_t;\n#elif defined(ARCH_CPU_ARM64)\nconst thread_state_flavor_t kThreadStateFlavor = ARM_THREAD_STATE64;\nconst thread_state_flavor_t kFloatStateFlavor = ARM_NEON_STATE64;\nconst thread_state_flavor_t kDebugStateFlavor = ARM_DEBUG_STATE64;\nusing thread_state_type = arm_thread_state64_t;\n#endif\n\n// From snapshot/mac/process_types/crashreporterclient.proctype\nstruct crashreporter_annotations_t {\n // Version 4\n uint64_t version;\n uint64_t message;\n uint64_t signature_string;\n uint64_t backtrace;\n uint64_t message2;\n uint64_t thread;\n uint64_t dialog_mode;\n\n // Version 5\n uint64_t abort_cause;\n\n // The structure here is only defined through version 5, although version 7 is\n // also known, and contains an additional 264 bytes from this point. Version 7\n // was first used in iOS 26. The version 7 extension is not defined here\n // because it would cause the reader to attempt to read the full length of a\n // version 7 structure, even in cases where only a version 5 structure is\n // present at runtime, as it will be in iOS versions before 26.\n //\n // If it ever becomes necessary to read fields beyond version 5 (or whatever\n // the minimum structure version that would be encountered at runtime is at\n // that time in the future), the reader will need to take additional care to\n // consult the `version` field and only read as much of the structure as is\n // appropriate for the indicated version. The macOS implementation implements\n // this logic.\n};\n\n//! \\brief Manage memory and ports after calling `task_threads`.\nclass ScopedTaskThreads {\n public:\n explicit ScopedTaskThreads(thread_act_array_t threads,\n mach_msg_type_number_t thread_count)\n : threads_(threads), thread_count_(thread_count) {}\n\n ScopedTaskThreads(const ScopedTaskThreads&) = delete;\n ScopedTaskThreads& operator=(const ScopedTaskThreads&) = delete;\n\n ~ScopedTaskThreads() {\n for (uint32_t thread_index = 0; thread_index < thread_count_;\n ++thread_index) {\n mach_port_deallocate(mach_task_self(), threads_[thread_index]);\n }\n vm_deallocate(mach_task_self(),\n reinterpret_cast(threads_),\n sizeof(thread_t) * thread_count_);\n }\n\n private:\n thread_act_array_t threads_;\n mach_msg_type_number_t thread_count_;\n};\n\n//! \\brief Log \\a key as a string.\nvoid WriteError(IntermediateDumpKey key) {\n CRASHPAD_RAW_LOG(\"Unable to write key\");\n switch (key) {\n // clang-format off\n#define CASE_KEY(Name, Value) \\\n case IntermediateDumpKey::Name: \\\n CRASHPAD_RAW_LOG(#Name); \\\n break;\n INTERMEDIATE_DUMP_KEYS(CASE_KEY)\n#undef CASE_KEY\n // clang-format on\n }\n}\n\n//! \\brief Call AddProperty with raw error log.\n//!\n//! \\param[in] writer The dump writer\n//! \\param[in] key The key to write.\n//! \\param[in] value Memory to be written.\n//! \\param[in] count Length of \\a value.\ntemplate \nvoid WriteProperty(IOSIntermediateDumpWriter* writer,\n IntermediateDumpKey key,\n const T* value,\n size_t count = 1) {\n if (!writer->AddProperty(key, value, count))\n WriteError(key);\n}\n\n//! \\brief Call AddPropertyBytes with raw error log.\n//!\n//! \\param[in] writer The dump writer\n//! \\param[in] key The key to write.\n//! \\param[in] value Memory to be written.\n//! \\param[in] value_length Length of \\a data.\nvoid WritePropertyBytes(IOSIntermediateDumpWriter* writer,\n IntermediateDumpKey key,\n const void* value,\n size_t value_length) {\n if (!writer->AddPropertyBytes(key, value, value_length))\n WriteError(key);\n}\n\n//! \\brief Call AddPropertyCString with raw error log.\n//!\n//! \\param[in] writer The dump writer\n//! \\param[in] key The key to write.\n//! \\param[in] max_length The maximum string length.\n//! \\param[in] value Memory to be written.\nvoid WritePropertyCString(IOSIntermediateDumpWriter* writer,\n IntermediateDumpKey key,\n size_t max_length,\n const char* value) {\n if (!writer->AddPropertyCString(key, max_length, value))\n WriteError(key);\n}\n\nkern_return_t MachVMRegionRecurseDeepest(task_t task,\n vm_address_t* address,\n vm_size_t* size,\n natural_t* depth,\n vm_prot_t* protection,\n unsigned int* user_tag) {\n vm_region_submap_short_info_64 submap_info;\n mach_msg_type_number_t count = VM_REGION_SUBMAP_SHORT_INFO_COUNT_64;\n while (true) {\n // Note: vm_region_recurse() would be fine here, but it does not provide\n // VM_REGION_SUBMAP_SHORT_INFO_COUNT.\n kern_return_t kr = vm_region_recurse_64(\n task,\n address,\n size,\n depth,\n reinterpret_cast(&submap_info),\n &count);\n if (kr != KERN_SUCCESS) {\n CRASHPAD_RAW_LOG_ERROR(kr, \"vm_region_recurse_64\");\n return kr;\n }\n\n if (!submap_info.is_submap) {\n *protection = submap_info.protection;\n *user_tag = submap_info.user_tag;\n return KERN_SUCCESS;\n }\n\n ++*depth;\n }\n}\n\n//! \\brief Adjusts the region for the red zone, if the ABI requires one.\n//!\n//! This method performs red zone calculation for CalculateStackRegion(). Its\n//! parameters are local variables used within that method, and may be\n//! modified as needed.\n//!\n//! Where a red zone is required, the region of memory captured for a thread’s\n//! stack will be extended to include the red zone below the stack pointer,\n//! provided that such memory is mapped, readable, and has the correct user\n//! tag value. If these conditions cannot be met fully, as much of the red\n//! zone will be captured as is possible while meeting these conditions.\n//!\n//! \\param[in,out] start_address The base address of the region to begin\n//! capturing stack memory from. On entry, \\a start_address is the stack\n//! pointer. On return, \\a start_address may be decreased to encompass a\n//! red zone.\n//! \\param[in,out] region_base The base address of the region that contains\n//! stack memory. This is distinct from \\a start_address in that \\a\n//! region_base will be page-aligned. On entry, \\a region_base is the\n//! base address of a region that contains \\a start_address. On return,\n//! if \\a start_address is decremented and is outside of the region\n//! originally described by \\a region_base, \\a region_base will also be\n//! decremented appropriately.\n//! \\param[in,out] region_size The size of the region that contains stack\n//! memory. This region begins at \\a region_base. On return, if \\a\n//! region_base is decremented, \\a region_size will be incremented\n//! appropriately.\n//! \\param[in] user_tag The Mach VM system’s user tag for the region described\n//! by the initial values of \\a region_base and \\a region_size. The red\n//! zone will only be allowed to extend out of the region described by\n//! these initial values if the user tag is appropriate for stack memory\n//! and the expanded region has the same user tag value.\nvoid LocateRedZone(vm_address_t* const start_address,\n vm_address_t* const region_base,\n vm_address_t* const region_size,\n const unsigned int user_tag) {\n // x86_64 has a red zone. See AMD64 ABI 0.99.8,\n // https://gitlab.com/x86-psABIs/x86-64-ABI/-/wikis/uploads/01de35b2c8adc7545de52604cc45d942/x86-64-psABI-2021-05-20.pdf#page=23.\n // section 3.2.2, “The Stack Frame”.\n // So does ARM64,\n // https://developer.apple.com/documentation/xcode/writing-arm64-code-for-apple-platforms#Respect-the-Stacks-Red-Zone\n // section \"Respect the Stack’s Red Zone\".\n constexpr vm_size_t kRedZoneSize = 128;\n vm_address_t red_zone_base =\n *start_address >= kRedZoneSize ? *start_address - kRedZoneSize : 0;\n bool red_zone_ok = false;\n if (red_zone_base >= *region_base) {\n // The red zone is within the region already discovered.\n red_zone_ok = true;\n } else if (red_zone_base < *region_base && user_tag == VM_MEMORY_STACK) {\n // Probe to see if there’s a region immediately below the one already\n // discovered.\n vm_address_t red_zone_region_base = red_zone_base;\n vm_size_t red_zone_region_size;\n natural_t red_zone_depth = 0;\n vm_prot_t red_zone_protection;\n unsigned int red_zone_user_tag;\n kern_return_t kr = MachVMRegionRecurseDeepest(mach_task_self(),\n &red_zone_region_base,\n &red_zone_region_size,\n &red_zone_depth,\n &red_zone_protection,\n &red_zone_user_tag);\n if (kr != KERN_SUCCESS) {\n *start_address = *region_base;\n } else if (red_zone_region_base + red_zone_region_size == *region_base &&\n (red_zone_protection & VM_PROT_READ) != 0 &&\n red_zone_user_tag == user_tag) {\n // The region containing the red zone is immediately below the region\n // already found, it’s readable (not the guard region), and it has the\n // same user tag as the region already found, so merge them.\n red_zone_ok = true;\n *region_base -= red_zone_region_size;\n *region_size += red_zone_region_size;\n }\n }\n\n if (red_zone_ok) {\n // Begin capturing from the base of the red zone (but not the entire\n // region that encompasses the red zone).\n *start_address = red_zone_base;\n } else {\n // The red zone would go lower into another region in memory, but no\n // region was found. Memory can only be captured to an address as low as\n // the base address of the region already found.\n *start_address = *region_base;\n }\n}\n\n//! \\brief Calculates the base address and size of the region used as a\n//! thread’s stack.\n//!\n//! The region returned by this method may be formed by merging multiple\n//! adjacent regions in a process’ memory map if appropriate. The base address\n//! of the returned region may be lower than the \\a stack_pointer passed in\n//! when the ABI mandates a red zone below the stack pointer.\n//!\n//! \\param[in] stack_pointer The stack pointer, referring to the top (lowest\n//! address) of a thread’s stack.\n//! \\param[out] stack_region_size The size of the memory region used as the\n//! thread’s stack.\n//!\n//! \\return The base address (lowest address) of the memory region used as the\n//! thread’s stack.\nvm_address_t CalculateStackRegion(vm_address_t stack_pointer,\n vm_size_t* stack_region_size) {\n // For pthreads, it may be possible to compute the stack region based on the\n // internal _pthread::stackaddr and _pthread::stacksize. The _pthread struct\n // for a thread can be located at TSD slot 0, or the known offsets of\n // stackaddr and stacksize from the TSD area could be used.\n vm_address_t region_base = stack_pointer;\n vm_size_t region_size;\n natural_t depth = 0;\n vm_prot_t protection;\n unsigned int user_tag;\n kern_return_t kr = MachVMRegionRecurseDeepest(mach_task_self(),\n ®ion_base,\n ®ion_size,\n &depth,\n &protection,\n &user_tag);\n if (kr != KERN_SUCCESS) {\n CRASHPAD_RAW_LOG_ERROR(kr, \"MachVMRegionRecurseDeepest\");\n *stack_region_size = 0;\n return 0;\n }\n\n if (region_base > stack_pointer) {\n // There’s nothing mapped at the stack pointer’s address. Something may have\n // trashed the stack pointer. Note that this shouldn’t happen for a normal\n // stack guard region violation because the guard region is mapped but has\n // VM_PROT_NONE protection.\n *stack_region_size = 0;\n return 0;\n }\n\n vm_address_t start_address = stack_pointer;\n\n if ((protection & VM_PROT_READ) == 0) {\n // If the region isn’t readable, the stack pointer probably points to the\n // guard region. Don’t include it as part of the stack, and don’t include\n // anything at any lower memory address. The code below may still possibly\n // find the real stack region at a memory address higher than this region.\n start_address = region_base + region_size;\n } else {\n // If the ABI requires a red zone, adjust the region to include it if\n // possible.\n LocateRedZone(&start_address, ®ion_base, ®ion_size, user_tag);\n\n // Regardless of whether the ABI requires a red zone, capture up to\n // kExtraCaptureSize additional bytes of stack, but only if present in the\n // region that was already found.\n constexpr vm_size_t kExtraCaptureSize = 128;\n start_address = std::max(start_address >= kExtraCaptureSize\n ? start_address - kExtraCaptureSize\n : start_address,\n region_base);\n\n // Align start_address to a 16-byte boundary, which can help readers by\n // ensuring that data is aligned properly. This could page-align instead,\n // but that might be wasteful.\n constexpr vm_size_t kDesiredAlignment = 16;\n start_address &= ~(kDesiredAlignment - 1);\n DCHECK_GE(start_address, region_base);\n }\n\n region_size -= (start_address - region_base);\n region_base = start_address;\n\n vm_size_t total_region_size = region_size;\n\n // The stack region may have gotten split up into multiple abutting regions.\n // Try to coalesce them. This frequently happens for the main thread’s stack\n // when setrlimit(RLIMIT_STACK, …) is called. It may also happen if a region\n // is split up due to an mprotect() or vm_protect() call.\n //\n // Stack regions created by the kernel and the pthreads library will be marked\n // with the VM_MEMORY_STACK user tag. Scanning for multiple adjacent regions\n // with the same tag should find an entire stack region. Checking that the\n // protection on individual regions is not VM_PROT_NONE should guarantee that\n // this algorithm doesn’t collect map entries belonging to another thread’s\n // stack: well-behaved stacks (such as those created by the kernel and the\n // pthreads library) have VM_PROT_NONE guard regions at their low-address\n // ends.\n //\n // Other stack regions may not be so well-behaved and thus if user_tag is not\n // VM_MEMORY_STACK, the single region that was found is used as-is without\n // trying to merge it with other adjacent regions.\n if (user_tag == VM_MEMORY_STACK) {\n vm_address_t try_address = region_base;\n vm_address_t original_try_address;\n\n while (try_address += region_size,\n original_try_address = try_address,\n (kr = MachVMRegionRecurseDeepest(mach_task_self(),\n &try_address,\n ®ion_size,\n &depth,\n &protection,\n &user_tag) == KERN_SUCCESS) &&\n try_address == original_try_address &&\n (protection & VM_PROT_READ) != 0 &&\n user_tag == VM_MEMORY_STACK) {\n total_region_size += region_size;\n }\n\n if (kr != KERN_SUCCESS && kr != KERN_INVALID_ADDRESS) {\n // Tolerate KERN_INVALID_ADDRESS because it will be returned when there\n // are no more regions in the map at or above the specified |try_address|.\n CRASHPAD_RAW_LOG_ERROR(kr, \"MachVMRegionRecurseDeepest\");\n }\n }\n\n *stack_region_size = total_region_size;\n return region_base;\n}\n\n//! \\brief Write data around \\a address to intermediate dump. Must be called\n//! from within a ScopedArray.\nvoid MaybeCaptureMemoryAround(IOSIntermediateDumpWriter* writer,\n uint64_t address) {\n constexpr uint64_t non_address_offset = 0x10000;\n if (address < non_address_offset)\n return;\n\n constexpr uint64_t max_address = std::numeric_limits::max();\n\n if (address > max_address - non_address_offset)\n return;\n\n constexpr uint64_t kRegisterByteOffset = 128;\n const uint64_t target = address - kRegisterByteOffset;\n constexpr uint64_t size = 512;\n static_assert(kRegisterByteOffset <= size / 2, \"negative offset too large\");\n\n IOSIntermediateDumpWriter::ScopedArrayMap memory_region(writer);\n WriteProperty(\n writer, IntermediateDumpKey::kThreadContextMemoryRegionAddress, &target);\n // Don't use WritePropertyBytes, this one will fail regularly if |target|\n // cannot be read.\n writer->AddPropertyBytes(IntermediateDumpKey::kThreadContextMemoryRegionData,\n reinterpret_cast(target),\n size);\n}\n\nvoid CaptureMemoryPointedToByThreadState(IOSIntermediateDumpWriter* writer,\n thread_state_type thread_state) {\n IOSIntermediateDumpWriter::ScopedArray memory_regions(\n writer, IntermediateDumpKey::kThreadContextMemoryRegions);\n\n#if defined(ARCH_CPU_X86_64)\n MaybeCaptureMemoryAround(writer, thread_state.__rax);\n MaybeCaptureMemoryAround(writer, thread_state.__rbx);\n MaybeCaptureMemoryAround(writer, thread_state.__rcx);\n MaybeCaptureMemoryAround(writer, thread_state.__rdx);\n MaybeCaptureMemoryAround(writer, thread_state.__rdi);\n MaybeCaptureMemoryAround(writer, thread_state.__rsi);\n MaybeCaptureMemoryAround(writer, thread_state.__rbp);\n MaybeCaptureMemoryAround(writer, thread_state.__r8);\n MaybeCaptureMemoryAround(writer, thread_state.__r9);\n MaybeCaptureMemoryAround(writer, thread_state.__r10);\n MaybeCaptureMemoryAround(writer, thread_state.__r11);\n MaybeCaptureMemoryAround(writer, thread_state.__r12);\n MaybeCaptureMemoryAround(writer, thread_state.__r13);\n MaybeCaptureMemoryAround(writer, thread_state.__r14);\n MaybeCaptureMemoryAround(writer, thread_state.__r15);\n MaybeCaptureMemoryAround(writer, thread_state.__rip);\n#elif defined(ARCH_CPU_ARM_FAMILY)\n MaybeCaptureMemoryAround(writer, arm_thread_state64_get_pc(thread_state));\n for (size_t i = 0; i < std::size(thread_state.__x); ++i) {\n MaybeCaptureMemoryAround(writer, thread_state.__x[i]);\n }\n#endif\n}\n\nvoid WriteCrashpadSimpleAnnotationsDictionary(IOSIntermediateDumpWriter* writer,\n CrashpadInfo* crashpad_info) {\n if (!crashpad_info->simple_annotations())\n return;\n\n ScopedVMRead simple_annotations;\n if (!simple_annotations.Read(crashpad_info->simple_annotations())) {\n CRASHPAD_RAW_LOG(\"Unable to read simple annotations.\");\n return;\n }\n\n const size_t count = simple_annotations->GetCount();\n if (!count)\n return;\n\n IOSIntermediateDumpWriter::ScopedArray annotations_array(\n writer, IntermediateDumpKey::kAnnotationsSimpleMap);\n\n SimpleStringDictionary::Entry* entries =\n reinterpret_cast(\n simple_annotations.get());\n for (size_t index = 0; index < count; index++) {\n IOSIntermediateDumpWriter::ScopedArrayMap annotation_map(writer);\n const auto& entry = entries[index];\n size_t key_length = strnlen(entry.key, sizeof(entry.key));\n WritePropertyBytes(writer,\n IntermediateDumpKey::kAnnotationName,\n reinterpret_cast(entry.key),\n key_length);\n size_t value_length = strnlen(entry.value, sizeof(entry.value));\n WritePropertyBytes(writer,\n IntermediateDumpKey::kAnnotationValue,\n reinterpret_cast(entry.value),\n value_length);\n }\n}\n\nvoid WriteAppleCrashReporterAnnotations(\n IOSIntermediateDumpWriter* writer,\n crashreporter_annotations_t* crash_info) {\n // It seems prudent to enforce some limit. Different users of\n // CRSetCrashLogMessage and CRSetCrashLogMessage2, apparently the private\n // functions used to set message and message2, use\n // different buffer lengths. dyld-1231.3 libdyld/dyld_process_info.cpp has\n // `static char sCrashReporterInfo[4096]`, which seems like a reasonable\n // limit.\n constexpr size_t kMaxMessageSize = 4096;\n\n IOSIntermediateDumpWriter::ScopedMap annotation_map(\n writer, IntermediateDumpKey::kAnnotationsCrashInfo);\n if (crash_info->message) {\n const size_t message_len = strnlen(\n reinterpret_cast(crash_info->message), kMaxMessageSize);\n WritePropertyBytes(writer,\n IntermediateDumpKey::kAnnotationsCrashInfoMessage1,\n reinterpret_cast(crash_info->message),\n message_len);\n }\n if (crash_info->message2) {\n const size_t message_len = strnlen(\n reinterpret_cast(crash_info->message2), kMaxMessageSize);\n WritePropertyBytes(writer,\n IntermediateDumpKey::kAnnotationsCrashInfoMessage2,\n reinterpret_cast(crash_info->message2),\n message_len);\n }\n}\n\n} // namespace\n\n// static\nvoid InProcessIntermediateDumpHandler::WriteHeader(\n IOSIntermediateDumpWriter* writer) {\n static constexpr uint8_t version = 1;\n WriteProperty(writer, IntermediateDumpKey::kVersion, &version);\n}\n\n// static\nvoid InProcessIntermediateDumpHandler::WriteProcessInfo(\n IOSIntermediateDumpWriter* writer,\n const std::map& annotations) {\n IOSIntermediateDumpWriter::ScopedMap process_map(\n writer, IntermediateDumpKey::kProcessInfo);\n\n timeval snapshot_time;\n if (gettimeofday(&snapshot_time, nullptr) == 0) {\n WriteProperty(writer, IntermediateDumpKey::kSnapshotTime, &snapshot_time);\n } else {\n CRASHPAD_RAW_LOG(\"gettimeofday\");\n }\n\n // Used by pid, parent pid and snapshot time.\n kinfo_proc kern_proc_info;\n int mib[] = {CTL_KERN, KERN_PROC, KERN_PROC_PID, getpid()};\n size_t len = sizeof(kern_proc_info);\n if (sysctl(mib, std::size(mib), &kern_proc_info, &len, nullptr, 0) == 0) {\n WriteProperty(\n writer, IntermediateDumpKey::kPID, &kern_proc_info.kp_proc.p_pid);\n WriteProperty(writer,\n IntermediateDumpKey::kParentPID,\n &kern_proc_info.kp_eproc.e_ppid);\n WriteProperty(writer,\n IntermediateDumpKey::kStartTime,\n &kern_proc_info.kp_proc.p_starttime);\n } else {\n CRASHPAD_RAW_LOG(\"sysctl kern_proc_info\");\n }\n\n // Used by user time and system time.\n mach_task_basic_info task_basic_info;\n mach_msg_type_number_t task_basic_info_count = MACH_TASK_BASIC_INFO_COUNT;\n kern_return_t kr = task_info(mach_task_self(),\n MACH_TASK_BASIC_INFO,\n reinterpret_cast(&task_basic_info),\n &task_basic_info_count);\n if (kr == KERN_SUCCESS) {\n IOSIntermediateDumpWriter::ScopedMap task_info(\n writer, IntermediateDumpKey::kTaskBasicInfo);\n\n WriteProperty(\n writer, IntermediateDumpKey::kUserTime, &task_basic_info.user_time);\n WriteProperty(\n writer, IntermediateDumpKey::kSystemTime, &task_basic_info.system_time);\n } else {\n CRASHPAD_RAW_LOG(\"task_info task_basic_info\");\n }\n\n task_thread_times_info_data_t task_thread_times;\n mach_msg_type_number_t task_thread_times_count = TASK_THREAD_TIMES_INFO_COUNT;\n kr = task_info(mach_task_self(),\n TASK_THREAD_TIMES_INFO,\n reinterpret_cast(&task_thread_times),\n &task_thread_times_count);\n if (kr == KERN_SUCCESS) {\n IOSIntermediateDumpWriter::ScopedMap task_thread_times_map(\n writer, IntermediateDumpKey::kTaskThreadTimes);\n\n WriteProperty(\n writer, IntermediateDumpKey::kUserTime, &task_thread_times.user_time);\n WriteProperty(writer,\n IntermediateDumpKey::kSystemTime,\n &task_thread_times.system_time);\n } else {\n CRASHPAD_RAW_LOG(\"task_info thread_times_info\");\n }\n\n if (!annotations.empty()) {\n IOSIntermediateDumpWriter::ScopedArray simple_annotations_array(\n writer, IntermediateDumpKey::kAnnotationsSimpleMap);\n for (const auto& annotation_pair : annotations) {\n const std::string& key = annotation_pair.first;\n const std::string& value = annotation_pair.second;\n IOSIntermediateDumpWriter::ScopedArrayMap annotation_map(writer);\n WriteProperty(writer,\n IntermediateDumpKey::kAnnotationName,\n key.c_str(),\n key.length());\n WriteProperty(writer,\n IntermediateDumpKey::kAnnotationValue,\n value.c_str(),\n value.length());\n }\n }\n}\n\n// static\nvoid InProcessIntermediateDumpHandler::WriteSystemInfo(\n IOSIntermediateDumpWriter* writer,\n const IOSSystemDataCollector& system_data,\n uint64_t report_time_nanos) {\n IOSIntermediateDumpWriter::ScopedMap system_map(\n writer, IntermediateDumpKey::kSystemInfo);\n\n const std::string& machine_description = system_data.MachineDescription();\n WriteProperty(writer,\n IntermediateDumpKey::kMachineDescription,\n machine_description.c_str(),\n machine_description.length());\n int os_version_major;\n int os_version_minor;\n int os_version_bugfix;\n system_data.OSVersion(\n &os_version_major, &os_version_minor, &os_version_bugfix);\n WriteProperty(\n writer, IntermediateDumpKey::kOSVersionMajor, &os_version_major);\n WriteProperty(\n writer, IntermediateDumpKey::kOSVersionMinor, &os_version_minor);\n WriteProperty(\n writer, IntermediateDumpKey::kOSVersionBugfix, &os_version_bugfix);\n const std::string& os_version_build = system_data.Build();\n WriteProperty(writer,\n IntermediateDumpKey::kOSVersionBuild,\n os_version_build.c_str(),\n os_version_build.length());\n\n int cpu_count = system_data.ProcessorCount();\n WriteProperty(writer, IntermediateDumpKey::kCpuCount, &cpu_count);\n const std::string& cpu_vendor = system_data.CPUVendor();\n WriteProperty(writer,\n IntermediateDumpKey::kCpuVendor,\n cpu_vendor.c_str(),\n cpu_vendor.length());\n\n bool has_daylight_saving_time = system_data.HasDaylightSavingTime();\n WriteProperty(writer,\n IntermediateDumpKey::kHasDaylightSavingTime,\n &has_daylight_saving_time);\n bool is_daylight_saving_time = system_data.IsDaylightSavingTime();\n WriteProperty(writer,\n IntermediateDumpKey::kIsDaylightSavingTime,\n &is_daylight_saving_time);\n int standard_offset_seconds = system_data.StandardOffsetSeconds();\n WriteProperty(writer,\n IntermediateDumpKey::kStandardOffsetSeconds,\n &standard_offset_seconds);\n int daylight_offset_seconds = system_data.DaylightOffsetSeconds();\n WriteProperty(writer,\n IntermediateDumpKey::kDaylightOffsetSeconds,\n &daylight_offset_seconds);\n const std::string& standard_name = system_data.StandardName();\n WriteProperty(writer,\n IntermediateDumpKey::kStandardName,\n standard_name.c_str(),\n standard_name.length());\n const std::string& daylight_name = system_data.DaylightName();\n WriteProperty(writer,\n IntermediateDumpKey::kDaylightName,\n daylight_name.c_str(),\n daylight_name.length());\n uint64_t address_mask = system_data.AddressMask();\n WriteProperty(writer, IntermediateDumpKey::kAddressMask, &address_mask);\n\n vm_size_t page_size;\n host_page_size(mach_host_self(), &page_size);\n WriteProperty(writer, IntermediateDumpKey::kPageSize, &page_size);\n\n mach_msg_type_number_t host_size =\n sizeof(vm_statistics_data_t) / sizeof(integer_t);\n vm_statistics_data_t vm_stat;\n kern_return_t kr = host_statistics(mach_host_self(),\n HOST_VM_INFO,\n reinterpret_cast(&vm_stat),\n &host_size);\n if (kr == KERN_SUCCESS) {\n IOSIntermediateDumpWriter::ScopedMap vm_stat_map(\n writer, IntermediateDumpKey::kVMStat);\n\n WriteProperty(writer, IntermediateDumpKey::kActive, &vm_stat.active_count);\n WriteProperty(\n writer, IntermediateDumpKey::kInactive, &vm_stat.inactive_count);\n WriteProperty(writer, IntermediateDumpKey::kWired, &vm_stat.wire_count);\n WriteProperty(writer, IntermediateDumpKey::kFree, &vm_stat.free_count);\n } else {\n CRASHPAD_RAW_LOG(\"host_statistics\");\n }\n\n uint64_t crashpad_uptime_nanos =\n report_time_nanos - system_data.InitializationTime();\n WriteProperty(\n writer, IntermediateDumpKey::kCrashpadUptime, &crashpad_uptime_nanos);\n}\n\n// static\nvoid InProcessIntermediateDumpHandler::WriteThreadInfo(\n IOSIntermediateDumpWriter* writer,\n const uint64_t* frames,\n const size_t num_frames) {\n IOSIntermediateDumpWriter::ScopedArray thread_array(\n writer, IntermediateDumpKey::kThreads);\n\n // Exception thread ID.\n#if defined(ARCH_CPU_ARM64)\n uint64_t exception_thread_id = 0;\n#endif\n thread_identifier_info identifier_info;\n mach_msg_type_number_t count = THREAD_IDENTIFIER_INFO_COUNT;\n kern_return_t kr =\n thread_info(mach_thread_self(),\n THREAD_IDENTIFIER_INFO,\n reinterpret_cast(&identifier_info),\n &count);\n if (kr == KERN_SUCCESS) {\n#if defined(ARCH_CPU_ARM64)\n exception_thread_id = identifier_info.thread_id;\n#endif\n } else {\n CRASHPAD_RAW_LOG_ERROR(kr, \"thread_info::THREAD_IDENTIFIER_INFO\");\n }\n\n mach_msg_type_number_t thread_count = 0;\n thread_act_array_t threads;\n kr = task_threads(mach_task_self(), &threads, &thread_count);\n if (kr != KERN_SUCCESS) {\n CRASHPAD_RAW_LOG_ERROR(kr, \"task_threads\");\n }\n ScopedTaskThreads threads_vm_owner(threads, thread_count);\n\n for (uint32_t thread_index = 0; thread_index < thread_count; ++thread_index) {\n IOSIntermediateDumpWriter::ScopedArrayMap thread_map(writer);\n thread_t thread = threads[thread_index];\n\n thread_basic_info basic_info;\n count = THREAD_BASIC_INFO_COUNT;\n kr = thread_info(thread,\n THREAD_BASIC_INFO,\n reinterpret_cast(&basic_info),\n &count);\n if (kr == KERN_SUCCESS) {\n WriteProperty(writer,\n IntermediateDumpKey::kSuspendCount,\n &basic_info.suspend_count);\n } else {\n CRASHPAD_RAW_LOG_ERROR(kr, \"thread_info::THREAD_BASIC_INFO\");\n }\n\n thread_extended_info extended_info;\n count = THREAD_EXTENDED_INFO_COUNT;\n kr = thread_info(thread,\n THREAD_EXTENDED_INFO,\n reinterpret_cast(&extended_info),\n &count);\n if (kr == KERN_SUCCESS) {\n WritePropertyBytes(\n writer,\n IntermediateDumpKey::kThreadName,\n reinterpret_cast(extended_info.pth_name),\n strnlen(extended_info.pth_name, sizeof(extended_info.pth_name)));\n } else {\n CRASHPAD_RAW_LOG_ERROR(kr, \"thread_info::THREAD_EXTENDED_INFO\");\n }\n\n thread_precedence_policy precedence;\n count = THREAD_PRECEDENCE_POLICY_COUNT;\n boolean_t get_default = FALSE;\n kr = thread_policy_get(thread,\n THREAD_PRECEDENCE_POLICY,\n reinterpret_cast(&precedence),\n &count,\n &get_default);\n if (kr == KERN_SUCCESS) {\n WriteProperty(\n writer, IntermediateDumpKey::kPriority, &precedence.importance);\n } else {\n CRASHPAD_RAW_LOG_ERROR(kr, \"thread_policy_get\");\n }\n\n // Thread ID.\n#if defined(ARCH_CPU_ARM64)\n uint64_t thread_id;\n#endif\n count = THREAD_IDENTIFIER_INFO_COUNT;\n kr = thread_info(thread,\n THREAD_IDENTIFIER_INFO,\n reinterpret_cast(&identifier_info),\n &count);\n if (kr == KERN_SUCCESS) {\n#if defined(ARCH_CPU_ARM64)\n thread_id = identifier_info.thread_id;\n#endif\n WriteProperty(\n writer, IntermediateDumpKey::kThreadID, &identifier_info.thread_id);\n WriteProperty(writer,\n IntermediateDumpKey::kThreadDataAddress,\n &identifier_info.thread_handle);\n } else {\n CRASHPAD_RAW_LOG_ERROR(kr, \"thread_info::THREAD_IDENTIFIER_INFO\");\n }\n\n // thread_snapshot_ios_intermediate_dump::GenerateStackMemoryFromFrames is\n // only implemented for arm64, so no x86_64 block here.\n#if defined(ARCH_CPU_ARM64)\n // For uncaught NSExceptions, use the frames passed from the system rather\n // than the current thread state.\n if (num_frames > 0 && exception_thread_id == thread_id) {\n WriteProperty(writer,\n IntermediateDumpKey::kThreadUncaughtNSExceptionFrames,\n frames,\n num_frames);\n continue;\n }\n#endif\n\n#if defined(ARCH_CPU_X86_64)\n x86_thread_state64_t thread_state;\n x86_float_state64_t float_state;\n x86_debug_state64_t debug_state;\n mach_msg_type_number_t thread_state_count = x86_THREAD_STATE64_COUNT;\n mach_msg_type_number_t float_state_count = x86_FLOAT_STATE64_COUNT;\n mach_msg_type_number_t debug_state_count = x86_DEBUG_STATE64_COUNT;\n#elif defined(ARCH_CPU_ARM64)\n arm_thread_state64_t thread_state;\n arm_neon_state64_t float_state;\n arm_debug_state64_t debug_state;\n mach_msg_type_number_t thread_state_count = ARM_THREAD_STATE64_COUNT;\n mach_msg_type_number_t float_state_count = ARM_NEON_STATE64_COUNT;\n mach_msg_type_number_t debug_state_count = ARM_DEBUG_STATE64_COUNT;\n#endif\n\n kr = thread_get_state(thread,\n kThreadStateFlavor,\n reinterpret_cast(&thread_state),\n &thread_state_count);\n if (kr != KERN_SUCCESS) {\n CRASHPAD_RAW_LOG_ERROR(kr, \"thread_get_state::kThreadStateFlavor\");\n }\n WriteProperty(writer, IntermediateDumpKey::kThreadState, &thread_state);\n\n kr = thread_get_state(thread,\n kFloatStateFlavor,\n reinterpret_cast(&float_state),\n &float_state_count);\n if (kr != KERN_SUCCESS) {\n CRASHPAD_RAW_LOG_ERROR(kr, \"thread_get_state::kFloatStateFlavor\");\n }\n WriteProperty(writer, IntermediateDumpKey::kFloatState, &float_state);\n\n kr = thread_get_state(thread,\n kDebugStateFlavor,\n reinterpret_cast(&debug_state),\n &debug_state_count);\n if (kr != KERN_SUCCESS) {\n CRASHPAD_RAW_LOG_ERROR(kr, \"thread_get_state::kDebugStateFlavor\");\n }\n WriteProperty(writer, IntermediateDumpKey::kDebugState, &debug_state);\n\n#if defined(ARCH_CPU_X86_64)\n vm_address_t stack_pointer = thread_state.__rsp;\n#elif defined(ARCH_CPU_ARM64)\n vm_address_t stack_pointer = arm_thread_state64_get_sp(thread_state);\n#endif\n\n vm_size_t stack_region_size;\n const vm_address_t stack_region_address =\n CalculateStackRegion(stack_pointer, &stack_region_size);\n WriteProperty(writer,\n IntermediateDumpKey::kStackRegionAddress,\n &stack_region_address);\n WritePropertyBytes(writer,\n IntermediateDumpKey::kStackRegionData,\n reinterpret_cast(stack_region_address),\n stack_region_size);\n\n // Grab extra memory from context.\n CaptureMemoryPointedToByThreadState(writer, thread_state);\n }\n}\n\n// static\nvoid InProcessIntermediateDumpHandler::WriteModuleInfo(\n IOSIntermediateDumpWriter* writer) {\n#ifndef ARCH_CPU_64_BITS\n#error Only 64-bit Mach-O is supported\n#endif\n\n IOSIntermediateDumpWriter::ScopedArray module_array(\n writer, IntermediateDumpKey::kModules);\n\n task_dyld_info_data_t dyld_info;\n mach_msg_type_number_t count = TASK_DYLD_INFO_COUNT;\n kern_return_t kr = task_info(mach_task_self(),\n TASK_DYLD_INFO,\n reinterpret_cast(&dyld_info),\n &count);\n if (kr != KERN_SUCCESS) {\n CRASHPAD_RAW_LOG_ERROR(kr, \"task_info\");\n }\n\n ScopedVMRead image_infos;\n if (!image_infos.Read(dyld_info.all_image_info_addr)) {\n CRASHPAD_RAW_LOG(\"Unable to dyld_info.all_image_info_addr\");\n return;\n }\n\n uint32_t image_count = image_infos->infoArrayCount;\n const dyld_image_info* image_array = image_infos->infoArray;\n for (int32_t image_index = image_count - 1; image_index >= 0; --image_index) {\n IOSIntermediateDumpWriter::ScopedArrayMap modules(writer);\n ScopedVMRead image;\n if (!image.Read(&image_array[image_index])) {\n CRASHPAD_RAW_LOG(\"Unable to dyld_image_info\");\n continue;\n }\n\n if (image->imageFilePath) {\n WritePropertyCString(\n writer, IntermediateDumpKey::kName, PATH_MAX, image->imageFilePath);\n }\n uint64_t address = FromPointerCast(image->imageLoadAddress);\n WriteProperty(writer, IntermediateDumpKey::kAddress, &address);\n WriteProperty(\n writer, IntermediateDumpKey::kTimestamp, &image->imageFileModDate);\n WriteModuleInfoAtAddress(writer, address, false /*is_dyld=false*/);\n }\n\n {\n IOSIntermediateDumpWriter::ScopedArrayMap modules(writer);\n if (image_infos->dyldPath) {\n WritePropertyCString(\n writer, IntermediateDumpKey::kName, PATH_MAX, image_infos->dyldPath);\n }\n uint64_t address =\n FromPointerCast(image_infos->dyldImageLoadAddress);\n WriteProperty(writer, IntermediateDumpKey::kAddress, &address);\n WriteModuleInfoAtAddress(writer, address, true /*is_dyld=true*/);\n }\n}\n\n// static\nvoid InProcessIntermediateDumpHandler::WriteExceptionFromSignal(\n IOSIntermediateDumpWriter* writer,\n const IOSSystemDataCollector& system_data,\n siginfo_t* siginfo,\n ucontext_t* context) {\n IOSIntermediateDumpWriter::ScopedMap signal_exception_map(\n writer, IntermediateDumpKey::kSignalException);\n\n WriteProperty(writer, IntermediateDumpKey::kSignalNumber, &siginfo->si_signo);\n WriteProperty(writer, IntermediateDumpKey::kSignalCode, &siginfo->si_code);\n WriteProperty(writer, IntermediateDumpKey::kSignalAddress, &siginfo->si_addr);\n\n#if defined(ARCH_CPU_X86_64)\n x86_thread_state64_t thread_state = context->uc_mcontext->__ss;\n x86_float_state64_t float_state = context->uc_mcontext->__fs;\n#elif defined(ARCH_CPU_ARM64)\n arm_thread_state64_t thread_state = context->uc_mcontext->__ss;\n arm_neon_state64_t float_state = context->uc_mcontext->__ns;\n#else\n#error Port to your CPU architecture\n#endif\n WriteProperty(writer, IntermediateDumpKey::kThreadState, &thread_state);\n WriteProperty(writer, IntermediateDumpKey::kFloatState, &float_state);\n CaptureMemoryPointedToByThreadState(writer, thread_state);\n\n // Thread ID.\n thread_identifier_info identifier_info;\n mach_msg_type_number_t count = THREAD_IDENTIFIER_INFO_COUNT;\n kern_return_t kr =\n thread_info(mach_thread_self(),\n THREAD_IDENTIFIER_INFO,\n reinterpret_cast(&identifier_info),\n &count);\n if (kr == KERN_SUCCESS) {\n WriteProperty(\n writer, IntermediateDumpKey::kThreadID, &identifier_info.thread_id);\n } else {\n CRASHPAD_RAW_LOG_ERROR(kr, \"thread_info::self\");\n }\n}\n\n// static\nvoid InProcessIntermediateDumpHandler::WriteExceptionFromMachException(\n IOSIntermediateDumpWriter* writer,\n exception_behavior_t behavior,\n thread_t exception_thread,\n exception_type_t exception,\n const mach_exception_data_type_t* code,\n mach_msg_type_number_t code_count,\n thread_state_flavor_t flavor,\n ConstThreadState state,\n mach_msg_type_number_t state_count) {\n IOSIntermediateDumpWriter::ScopedMap mach_exception_map(\n writer, IntermediateDumpKey::kMachException);\n\n WriteProperty(writer, IntermediateDumpKey::kException, &exception);\n WriteProperty(writer, IntermediateDumpKey::kCodes, code, code_count);\n WriteProperty(writer, IntermediateDumpKey::kFlavor, &flavor);\n WritePropertyBytes(writer,\n IntermediateDumpKey::kState,\n state,\n state_count * sizeof(uint32_t));\n\n thread_identifier_info identifier_info;\n mach_msg_type_number_t count = THREAD_IDENTIFIER_INFO_COUNT;\n kern_return_t kr =\n thread_info(exception_thread,\n THREAD_IDENTIFIER_INFO,\n reinterpret_cast(&identifier_info),\n &count);\n if (kr == KERN_SUCCESS) {\n WriteProperty(\n writer, IntermediateDumpKey::kThreadID, &identifier_info.thread_id);\n } else {\n CRASHPAD_RAW_LOG_ERROR(kr, \"thread_info\");\n }\n}\n\n// static\nvoid InProcessIntermediateDumpHandler::WriteExceptionFromNSException(\n IOSIntermediateDumpWriter* writer) {\n IOSIntermediateDumpWriter::ScopedMap nsexception_map(\n writer, IntermediateDumpKey::kNSException);\n\n thread_identifier_info identifier_info;\n mach_msg_type_number_t count = THREAD_IDENTIFIER_INFO_COUNT;\n kern_return_t kr =\n thread_info(mach_thread_self(),\n THREAD_IDENTIFIER_INFO,\n reinterpret_cast(&identifier_info),\n &count);\n if (kr == KERN_SUCCESS) {\n WriteProperty(\n writer, IntermediateDumpKey::kThreadID, &identifier_info.thread_id);\n } else {\n CRASHPAD_RAW_LOG_ERROR(kr, \"thread_info::self\");\n }\n}\n\nvoid InProcessIntermediateDumpHandler::WriteModuleInfoAtAddress(\n IOSIntermediateDumpWriter* writer,\n uint64_t address,\n bool is_dyld) {\n ScopedVMRead header;\n if (!header.Read(address) || header->magic != MH_MAGIC_64) {\n CRASHPAD_RAW_LOG(\"Invalid module header\");\n return;\n }\n\n const load_command* unsafe_command_ptr =\n reinterpret_cast(\n reinterpret_cast(address) + 1);\n\n // Rather than using an individual ScopedVMRead for each load_command, load\n // the entire block of commands at once.\n ScopedVMRead all_commands;\n if (!all_commands.Read(unsafe_command_ptr, header->sizeofcmds)) {\n CRASHPAD_RAW_LOG(\"Unable to read module load_commands.\");\n return;\n }\n\n // All the *_vm_read_ptr variables in the load_command loop below have been\n // vm_read in `all_commands` above, and may be dereferenced without additional\n // ScopedVMReads.\n const load_command* command_vm_read_ptr =\n reinterpret_cast(all_commands.get());\n\n // Make sure that the basic load command structure doesn’t overflow the\n // space allotted for load commands, as well as iterating through ncmds.\n vm_size_t slide = 0;\n for (uint32_t cmd_index = 0, cumulative_cmd_size = 0;\n cmd_index < header->ncmds && cumulative_cmd_size < header->sizeofcmds;\n ++cmd_index) {\n if (command_vm_read_ptr->cmd == LC_SEGMENT_64) {\n const segment_command_64* segment_vm_read_ptr =\n reinterpret_cast(command_vm_read_ptr);\n if (strcmp(segment_vm_read_ptr->segname, SEG_TEXT) == 0) {\n WriteProperty(\n writer, IntermediateDumpKey::kSize, &segment_vm_read_ptr->vmsize);\n slide = address - segment_vm_read_ptr->vmaddr;\n } else if (strcmp(segment_vm_read_ptr->segname, SEG_DATA) == 0 ||\n // dyld puts __crash_info in __DATA_DIRTY.\n strcmp(segment_vm_read_ptr->segname, \"__DATA_DIRTY\") == 0) {\n WriteDataSegmentAnnotations(writer, segment_vm_read_ptr, slide);\n }\n } else if (command_vm_read_ptr->cmd == LC_ID_DYLIB) {\n const dylib_command* dylib_vm_read_ptr =\n reinterpret_cast(command_vm_read_ptr);\n WriteProperty(writer,\n IntermediateDumpKey::kDylibCurrentVersion,\n &dylib_vm_read_ptr->dylib.current_version);\n } else if (command_vm_read_ptr->cmd == LC_SOURCE_VERSION) {\n const source_version_command* source_version_vm_read_ptr =\n reinterpret_cast(command_vm_read_ptr);\n WriteProperty(writer,\n IntermediateDumpKey::kSourceVersion,\n &source_version_vm_read_ptr->version);\n } else if (command_vm_read_ptr->cmd == LC_UUID) {\n const uuid_command* uuid_vm_read_ptr =\n reinterpret_cast(command_vm_read_ptr);\n WriteProperty(\n writer, IntermediateDumpKey::kUUID, &uuid_vm_read_ptr->uuid);\n }\n\n cumulative_cmd_size += command_vm_read_ptr->cmdsize;\n command_vm_read_ptr = reinterpret_cast(\n reinterpret_cast(command_vm_read_ptr) +\n command_vm_read_ptr->cmdsize);\n }\n\n WriteProperty(writer, IntermediateDumpKey::kFileType, &header->filetype);\n}\n\nvoid InProcessIntermediateDumpHandler::WriteDataSegmentAnnotations(\n IOSIntermediateDumpWriter* writer,\n const segment_command_64* segment_vm_read_ptr,\n vm_size_t slide) {\n const section_64* section_vm_read_ptr = reinterpret_cast(\n reinterpret_cast(segment_vm_read_ptr) +\n sizeof(segment_command_64));\n for (uint32_t sect_index = 0; sect_index <= segment_vm_read_ptr->nsects;\n ++sect_index) {\n if (strcmp(section_vm_read_ptr->sectname, \"crashpad_info\") == 0) {\n if (section_vm_read_ptr->size >= sizeof(CrashpadInfo)) {\n ScopedVMRead crashpad_info;\n if (crashpad_info.Read(section_vm_read_ptr->addr + slide) &&\n crashpad_info->size() <= section_vm_read_ptr->size &&\n crashpad_info->size() >= sizeof(CrashpadInfo) &&\n crashpad_info->signature() == CrashpadInfo::kSignature &&\n crashpad_info->version() == 1) {\n WriteCrashpadAnnotationsList(writer, crashpad_info.get());\n WriteCrashpadSimpleAnnotationsDictionary(writer, crashpad_info.get());\n WriteCrashpadExtraMemoryRanges(writer, crashpad_info.get());\n WriteCrashpadIntermediateDumpExtraMemoryRanges(writer,\n crashpad_info.get());\n }\n }\n } else if (strcmp(section_vm_read_ptr->sectname, \"__crash_info\") == 0) {\n if (section_vm_read_ptr->size >= sizeof(crashreporter_annotations_t)) {\n ScopedVMRead crash_info;\n if (crash_info.Read(section_vm_read_ptr->addr + slide) &&\n (crash_info->version == 4 || crash_info->version == 5 ||\n crash_info->version == 7)) {\n WriteAppleCrashReporterAnnotations(writer, crash_info.get());\n }\n }\n }\n section_vm_read_ptr = reinterpret_cast(\n reinterpret_cast(section_vm_read_ptr) + sizeof(section_64));\n }\n}\n\nvoid InProcessIntermediateDumpHandler::WriteCrashpadAnnotationsList(\n IOSIntermediateDumpWriter* writer,\n CrashpadInfo* crashpad_info) {\n if (!crashpad_info->annotations_list()) {\n return;\n }\n ScopedVMRead annotation_list;\n if (!annotation_list.Read(crashpad_info->annotations_list())) {\n CRASHPAD_RAW_LOG(\"Unable to read annotations list object\");\n return;\n }\n\n IOSIntermediateDumpWriter::ScopedArray annotations_array(\n writer, IntermediateDumpKey::kAnnotationObjects);\n ScopedVMRead current;\n\n // Use vm_read() to ensure that the linked-list AnnotationList head (which is\n // a dummy node of type kInvalid) is valid and copy its memory into a\n // newly-allocated buffer.\n //\n // In the case where the pointer has been clobbered or the memory range is not\n // readable, skip reading all the Annotations.\n if (!current.Read(annotation_list->head())) {\n CRASHPAD_RAW_LOG(\"Unable to read annotation\");\n return;\n }\n\n for (size_t index = 0;\n current->link_node() != annotation_list.get()->tail_pointer() &&\n index < kMaxNumberOfAnnotations;\n ++index) {\n ScopedVMRead node;\n\n // Like above, use vm_read() to ensure that the node in the linked list is\n // valid and copy its memory into a newly-allocated buffer.\n //\n // In the case where the pointer has been clobbered or the memory range is\n // not readable, skip reading this and all further Annotations.\n if (!node.Read(current->link_node())) {\n CRASHPAD_RAW_LOG(\"Unable to read annotation\");\n return;\n }\n current.Read(current->link_node());\n\n if (node->size() == 0)\n continue;\n\n if (node->size() > Annotation::kValueMaxSize) {\n CRASHPAD_RAW_LOG(\"Incorrect annotation length\");\n continue;\n }\n\n // For Annotations which support guarding reads from concurrent writes, map\n // their memory read-write using vm_remap(), then declare a ScopedSpinGuard\n // which lives for the duration of the read.\n ScopedVMMap mapped_node;\n std::optional annotation_guard;\n if (node->concurrent_access_guard_mode() ==\n Annotation::ConcurrentAccessGuardMode::kScopedSpinGuard) {\n constexpr vm_prot_t kDesiredProtection = VM_PROT_WRITE | VM_PROT_READ;\n if (!mapped_node.Map(node.get()) ||\n (mapped_node.CurrentProtection() & kDesiredProtection) !=\n kDesiredProtection) {\n CRASHPAD_RAW_LOG(\"Unable to map annotation\");\n\n // Skip this annotation rather than giving up entirely, since the linked\n // node should still be valid.\n continue;\n }\n\n // TODO(https://crbug.com/crashpad/438): Pass down a `params` object into\n // this method to optionally enable a timeout here.\n constexpr uint64_t kTimeoutNanoseconds = 0;\n annotation_guard =\n mapped_node->TryCreateScopedSpinGuard(kTimeoutNanoseconds);\n if (!annotation_guard) {\n // This is expected if the process is writing to the Annotation, so\n // don't log here and skip the annotation.\n continue;\n }\n }\n\n IOSIntermediateDumpWriter::ScopedArrayMap annotation_map(writer);\n WritePropertyCString(writer,\n IntermediateDumpKey::kAnnotationName,\n Annotation::kNameMaxLength,\n reinterpret_cast(node->name()));\n WritePropertyBytes(writer,\n IntermediateDumpKey::kAnnotationValue,\n reinterpret_cast(node->value()),\n node->size());\n Annotation::Type type = node->type();\n WritePropertyBytes(writer,\n IntermediateDumpKey::kAnnotationType,\n reinterpret_cast(&type),\n sizeof(type));\n }\n}\n\nvoid InProcessIntermediateDumpHandler::WriteCrashpadExtraMemoryRanges(\n IOSIntermediateDumpWriter* writer,\n CrashpadInfo* crashpad_info) {\n if (!crashpad_info->extra_memory_ranges()) {\n return;\n }\n\n ScopedVMRead extra_memory_ranges;\n if (!extra_memory_ranges.Read(crashpad_info->extra_memory_ranges())) {\n CRASHPAD_RAW_LOG(\"Unable to read extra memory ranges object\");\n return;\n }\n\n IOSIntermediateDumpWriter::ScopedArray module_extra_memory_regions_array(\n writer, IntermediateDumpKey::kModuleExtraMemoryRegions);\n\n SimpleAddressRangeBag::Iterator iterator(*(extra_memory_ranges.get()));\n while (const SimpleAddressRangeBag::Entry* entry = iterator.Next()) {\n const uint64_t& address = entry->base;\n const uint64_t& size = entry->size;\n IOSIntermediateDumpWriter::ScopedArrayMap memory_region_map(writer);\n WriteProperty(\n writer, IntermediateDumpKey::kModuleExtraMemoryRegionAddress, &address);\n WritePropertyBytes(writer,\n IntermediateDumpKey::kModuleExtraMemoryRegionData,\n reinterpret_cast(address),\n size);\n }\n}\n\nvoid InProcessIntermediateDumpHandler::\n WriteCrashpadIntermediateDumpExtraMemoryRanges(\n IOSIntermediateDumpWriter* writer,\n CrashpadInfo* crashpad_info) {\n if (!crashpad_info->intermediate_dump_extra_memory_ranges()) {\n return;\n }\n\n ScopedVMRead intermediate_dump_extra_memory;\n if (!intermediate_dump_extra_memory.Read(\n crashpad_info->intermediate_dump_extra_memory_ranges())) {\n CRASHPAD_RAW_LOG(\n \"Unable to read intermediate dump extra memory ranges object\");\n return;\n }\n\n IOSIntermediateDumpWriter::ScopedArray module_extra_memory_regions_array(\n writer, IntermediateDumpKey::kModuleIntermediateDumpExtraMemoryRegions);\n\n SimpleAddressRangeBag::Iterator iterator(\n *(intermediate_dump_extra_memory.get()));\n while (const SimpleAddressRangeBag::Entry* entry = iterator.Next()) {\n const uint64_t& address = entry->base;\n const uint64_t& size = entry->size;\n IOSIntermediateDumpWriter::ScopedArrayMap memory_region_map(writer);\n WriteProperty(\n writer,\n IntermediateDumpKey::kModuleIntermediateDumpExtraMemoryRegionAddress,\n &address);\n WritePropertyBytes(\n writer,\n IntermediateDumpKey::kModuleIntermediateDumpExtraMemoryRegionData,\n reinterpret_cast(address),\n size);\n }\n}\n\n} // namespace internal\n} // namespace crashpad\n" }, { "path": "client/ios_handler/in_process_intermediate_dump_handler.h", "content": "// Copyright 2021 The Crashpad Authors\n//\n// Licensed under the Apache License, Version 2.0 (the \"License\");\n// you may not use this file except in compliance with the License.\n// You may obtain a copy of the License at\n//\n// http://www.apache.org/licenses/LICENSE-2.0\n//\n// Unless required by applicable law or agreed to in writing, software\n// distributed under the License is distributed on an \"AS IS\" BASIS,\n// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n// See the License for the specific language governing permissions and\n// limitations under the License.\n\n#ifndef CRASHPAD_CLIENT_IOS_HANDLER_IN_PROCESS_INTERMEDIATE_DUMP_HANDLER_H_\n#define CRASHPAD_CLIENT_IOS_HANDLER_IN_PROCESS_INTERMEDIATE_DUMP_HANDLER_H_\n\n#include \n#include \n#include \n\n#include \n\n#include \"client/crashpad_info.h\"\n#include \"util/ios/ios_intermediate_dump_writer.h\"\n#include \"util/ios/ios_system_data_collector.h\"\n#include \"util/mach/mach_extensions.h\"\n\nnamespace crashpad {\nnamespace internal {\n\n//! \\brief Dump all in-process data to iOS intermediate dump.\n//! Note: All methods are `RUNS-DURING-CRASH`.\nclass InProcessIntermediateDumpHandler final {\n public:\n InProcessIntermediateDumpHandler() = delete;\n InProcessIntermediateDumpHandler(const InProcessIntermediateDumpHandler&) =\n delete;\n InProcessIntermediateDumpHandler& operator=(\n const InProcessIntermediateDumpHandler&) = delete;\n\n //! \\brief Set kVersion to 1.\n //!\n //! \\param[in] writer The dump writer\n static void WriteHeader(IOSIntermediateDumpWriter* writer);\n\n //! \\brief Write ProcessSnapshot data to the intermediate dump.\n //!\n //! \\param[in] writer The dump writer\n //! \\param[in] annotations The simple map annotations.\n static void WriteProcessInfo(\n IOSIntermediateDumpWriter* writer,\n const std::map& annotations);\n\n //! \\brief Write SystemSnapshot data to the intermediate dump.\n //!\n //! \\param[in] writer The dump writer\n //! \\param[in] system_data An object containing various system data points.\n //! \\param[in] report_time_nanos Report creation time in nanoseconds as\n //! returned by ClockMonotonicNanoseconds().\n static void WriteSystemInfo(IOSIntermediateDumpWriter* writer,\n const IOSSystemDataCollector& system_data,\n uint64_t report_time_nanos);\n\n //! \\brief Write ThreadSnapshot data to the intermediate dump.\n //!\n //! For uncaught NSExceptions, \\a frames and \\a num_frames will be added to\n //! the intermediate dump for the exception thread. Otherwise, or for the\n //! remaining threads, use `thread_get_state`.\n //!\n //! \\param[in] writer The dump writer\n //! \\param[in] frames An array of callstack return addresses.\n //! \\param[in] num_frames The number of callstack return address in \\a frames.\n static void WriteThreadInfo(IOSIntermediateDumpWriter* writer,\n const uint64_t* frames,\n const size_t num_frames);\n\n //! \\brief Write ModuleSnapshot data to the intermediate dump.\n //!\n //! This includes both modules and annotations.\n //!\n //! \\param[in] writer The dump writer\n static void WriteModuleInfo(IOSIntermediateDumpWriter* writer);\n\n //! \\brief Write an ExceptionSnapshot from a signal to the intermediate dump.\n //!\n //! Only one of the WriteExceptionFromSignal, WriteExceptionFromMachException\n //! and WriteExceptionFromNSException should be called per intermediate dump.\n //!\n //! \\param[in] writer The dump writer\n //! \\param[in] system_data An object containing various system data points.\n //! \\param[in] siginfo A pointer to a `siginfo_t` object received by a signal\n //! handler.\n //! \\param[in] context A pointer to a `ucontext_t` object received by a\n //! signal.\n static void WriteExceptionFromSignal(\n IOSIntermediateDumpWriter* writer,\n const IOSSystemDataCollector& system_data,\n siginfo_t* siginfo,\n ucontext_t* context);\n\n //! \\brief Write an ExceptionSnapshot from a mach exception to the\n //! intermediate dump.\n //!\n //! Only one of the WriteExceptionFromSignal, WriteExceptionFromMachException\n //! and WriteExceptionFromNSException should be called per intermediate dump.\n //!\n //! \\param[in] writer The dump writer\n //! \\param[in] behavior\n //! \\param[in] thread\n //! \\param[in] exception\n //! \\param[in] code\n //! \\param[in] code_count\n //! \\param[in] flavor\n //! \\param[in] old_state\n //! \\param[in] old_state_count\n static void WriteExceptionFromMachException(\n IOSIntermediateDumpWriter* writer,\n exception_behavior_t behavior,\n thread_t thread,\n exception_type_t exception,\n const mach_exception_data_type_t* code,\n mach_msg_type_number_t code_count,\n thread_state_flavor_t flavor,\n ConstThreadState old_state,\n mach_msg_type_number_t old_state_count);\n\n //! \\brief Write an ExceptionSnapshot from an NSException to the\n //! intermediate dump.\n //!\n //! Only one of the WriteExceptionFromSignal, WriteExceptionFromMachException\n //! and WriteExceptionFromNSException should be called per intermediate dump.\n //!\n //! \\param[in] writer The dump writer\n static void WriteExceptionFromNSException(IOSIntermediateDumpWriter* writer);\n\n private:\n //! \\brief Parse and extract module and annotation information from header.\n static void WriteModuleInfoAtAddress(IOSIntermediateDumpWriter* writer,\n uint64_t address,\n bool is_dyld);\n\n //! \\brief Extract and write Apple crashreporter_annotations_t data and\n //! Crashpad annotations. Note that \\a segment_vm_read_ptr has already\n //! been read via vm_read and may be dereferenced without a ScopedVMRead.\n static void WriteDataSegmentAnnotations(\n IOSIntermediateDumpWriter* writer,\n const segment_command_64* segment_vm_read_ptr,\n vm_size_t slide);\n\n //! \\brief Write Crashpad annotations list.\n static void WriteCrashpadAnnotationsList(IOSIntermediateDumpWriter* writer,\n CrashpadInfo* crashpad_info);\n\n //! \\brief Write Crashpad extra memory data.\n static void WriteCrashpadExtraMemoryRanges(IOSIntermediateDumpWriter* writer,\n CrashpadInfo* crashpad_info);\n\n //! \\brief Write Crashpad intermediate dump extra memory data.\n static void WriteCrashpadIntermediateDumpExtraMemoryRanges(\n IOSIntermediateDumpWriter* writer,\n CrashpadInfo* crashpad_info);\n};\n\n} // namespace internal\n} // namespace crashpad\n\n#endif // CRASHPAD_CLIENT_IOS_HANDLER_IN_PROCESS_INTERMEDIATE_DUMP_HANDLER_H_\n" }, { "path": "client/ios_handler/in_process_intermediate_dump_handler_test.cc", "content": "// Copyright 2021 The Crashpad Authors\n//\n// Licensed under the Apache License, Version 2.0 (the \"License\");\n// you may not use this file except in compliance with the License.\n// You may obtain a copy of the License at\n//\n// http://www.apache.org/licenses/LICENSE-2.0\n//\n// Unless required by applicable law or agreed to in writing, software\n// distributed under the License is distributed on an \"AS IS\" BASIS,\n// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n// See the License for the specific language governing permissions and\n// limitations under the License.\n\n#include \"client/ios_handler/in_process_intermediate_dump_handler.h\"\n\n#include \n\n#include \n#include \n#include \n\n#include \"base/files/file_path.h\"\n#include \"build/build_config.h\"\n#include \"client/annotation.h\"\n#include \"client/annotation_list.h\"\n#include \"client/crashpad_info.h\"\n#include \"client/simple_string_dictionary.h\"\n#include \"gtest/gtest.h\"\n#include \"minidump/minidump_file_writer.h\"\n#include \"snapshot/ios/process_snapshot_ios_intermediate_dump.h\"\n#include \"snapshot/minidump/process_snapshot_minidump.h\"\n#include \"test/scoped_set_thread_name.h\"\n#include \"test/scoped_temp_dir.h\"\n#include \"test/test_paths.h\"\n#include \"util/file/filesystem.h\"\n#include \"util/misc/capture_context.h\"\n\nnamespace crashpad {\nnamespace test {\nnamespace {\n\nusing internal::InProcessIntermediateDumpHandler;\n\nclass ReadToString : public crashpad::MemorySnapshot::Delegate {\n public:\n std::string result;\n\n bool MemorySnapshotDelegateRead(void* data, size_t size) override {\n result = std::string(reinterpret_cast(data), size);\n return true;\n }\n};\n\nclass InProcessIntermediateDumpHandlerTest : public testing::Test {\n protected:\n // testing::Test:\n\n void SetUp() override {\n path_ = temp_dir_.path().Append(\"dump_file\");\n writer_ = std::make_unique();\n EXPECT_TRUE(writer_->Open(path_));\n ASSERT_TRUE(IsRegularFile(path_));\n }\n\n void TearDown() override {\n EXPECT_TRUE(writer_->Close());\n writer_.reset();\n EXPECT_FALSE(IsRegularFile(path_));\n }\n\n void WriteReportAndCloseWriter() {\n {\n internal::IOSIntermediateDumpWriter::ScopedRootMap rootMap(writer_.get());\n InProcessIntermediateDumpHandler::WriteHeader(writer_.get());\n InProcessIntermediateDumpHandler::WriteProcessInfo(\n writer_.get(), {{\"before_dump\", \"pre\"}});\n InProcessIntermediateDumpHandler::WriteSystemInfo(\n writer_.get(), system_data_, ClockMonotonicNanoseconds());\n InProcessIntermediateDumpHandler::WriteThreadInfo(writer_.get(), 0, 0);\n InProcessIntermediateDumpHandler::WriteModuleInfo(writer_.get());\n }\n EXPECT_TRUE(writer_->Close());\n }\n\n void WriteMachException() {\n crashpad::NativeCPUContext cpu_context;\n crashpad::CaptureContext(&cpu_context);\n const mach_exception_data_type_t code[2] = {};\n static constexpr int kSimulatedException = -1;\n InProcessIntermediateDumpHandler::WriteExceptionFromMachException(\n writer_.get(),\n MACH_EXCEPTION_CODES,\n mach_thread_self(),\n kSimulatedException,\n code,\n std::size(code),\n MACHINE_THREAD_STATE,\n reinterpret_cast(&cpu_context),\n MACHINE_THREAD_STATE_COUNT);\n }\n\n const auto& path() const { return path_; }\n auto writer() const { return writer_.get(); }\n\n#if TARGET_OS_SIMULATOR\n // macOS 14.0 is 23A344, macOS 13.6.5 is 22G621, so if the first two\n // characters in the kern.osversion are > 22, this build will reproduce the\n // simulator bug in crbug.com/328282286\n // This now reproduces on macOS 15.4 24E248 as well for iOS17 simulators.\n bool HasMacOSBrokeDYLDTaskInfo() {\n if (__builtin_available(iOS 18, *)) {\n return false;\n }\n if (std::stoi(system_data_.Build().substr(0, 2)) >= 24) {\n return true;\n }\n if (__builtin_available(iOS 17, *)) {\n return false;\n }\n return std::stoi(system_data_.Build().substr(0, 2)) > 22;\n }\n#endif\n\n private:\n std::unique_ptr writer_;\n internal::IOSSystemDataCollector system_data_;\n ScopedTempDir temp_dir_;\n base::FilePath path_;\n};\n\nTEST_F(InProcessIntermediateDumpHandlerTest, TestSystem) {\n WriteReportAndCloseWriter();\n internal::ProcessSnapshotIOSIntermediateDump process_snapshot;\n ASSERT_TRUE(process_snapshot.InitializeWithFilePath(path(), {}));\n\n // Snpahot\n const SystemSnapshot* system = process_snapshot.System();\n ASSERT_NE(system, nullptr);\n#if defined(ARCH_CPU_X86_64)\n EXPECT_EQ(system->GetCPUArchitecture(), kCPUArchitectureX86_64);\n#elif defined(ARCH_CPU_ARM64)\n EXPECT_EQ(system->GetCPUArchitecture(), kCPUArchitectureARM64);\n#else\n#error Port to your CPU architecture\n#endif\n#if TARGET_OS_SIMULATOR\n EXPECT_EQ(system->MachineDescription().substr(0, 13),\n std::string(\"iOS Simulator\"));\n#elif TARGET_OS_IPHONE\n utsname uts;\n ASSERT_EQ(uname(&uts), 0);\n EXPECT_STREQ(system->MachineDescription().c_str(), uts.machine);\n#endif\n\n EXPECT_EQ(system->GetOperatingSystem(), SystemSnapshot::kOperatingSystemIOS);\n}\n\nTEST_F(InProcessIntermediateDumpHandlerTest, TestAnnotations) {\n#if TARGET_OS_SIMULATOR\n // This test will fail on =14.3 or\n // =15.4 due to a bug in Simulator.\n // crbug.com/328282286\n if (HasMacOSBrokeDYLDTaskInfo()) {\n // For TearDown.\n ASSERT_TRUE(LoggingRemoveFile(path()));\n return;\n }\n#endif\n // This is “leaked” to crashpad_info.\n crashpad::SimpleStringDictionary* simple_annotations =\n new crashpad::SimpleStringDictionary();\n simple_annotations->SetKeyValue(\"#TEST# pad\", \"break\");\n simple_annotations->SetKeyValue(\"#TEST# key\", \"value\");\n simple_annotations->SetKeyValue(\"#TEST# pad\", \"crash\");\n simple_annotations->SetKeyValue(\"#TEST# x\", \"y\");\n simple_annotations->SetKeyValue(\"#TEST# longer\", \"shorter\");\n simple_annotations->SetKeyValue(\"#TEST# empty_value\", \"\");\n\n crashpad::CrashpadInfo* crashpad_info =\n crashpad::CrashpadInfo::GetCrashpadInfo();\n\n crashpad_info->set_simple_annotations(simple_annotations);\n\n crashpad::AnnotationList::Register(); // This is “leaked” to crashpad_info.\n\n static crashpad::StringAnnotation<32> test_annotation_one{\"#TEST# one\"};\n static crashpad::StringAnnotation<32> test_annotation_two{\"#TEST# two\"};\n static crashpad::StringAnnotation<32> test_annotation_three{\n \"#TEST# same-name\"};\n static crashpad::StringAnnotation<32> test_annotation_four{\n \"#TEST# same-name\"};\n\n test_annotation_one.Set(\"moocow\");\n test_annotation_two.Set(\"this will be cleared\");\n test_annotation_three.Set(\"same-name 3\");\n test_annotation_four.Set(\"same-name 4\");\n test_annotation_two.Clear();\n\n WriteReportAndCloseWriter();\n internal::ProcessSnapshotIOSIntermediateDump process_snapshot;\n ASSERT_TRUE(process_snapshot.InitializeWithFilePath(\n path(), {{\"after_dump\", \"post\"}}));\n\n auto process_map = process_snapshot.AnnotationsSimpleMap();\n EXPECT_EQ(process_map.size(), 3u);\n EXPECT_EQ(process_map[\"before_dump\"], \"pre\");\n EXPECT_EQ(process_map[\"after_dump\"], \"post\");\n EXPECT_TRUE(process_map.find(\"crashpad_uptime_ns\") != process_map.end());\n\n std::map all_annotations_simple_map;\n std::vector all_annotations;\n for (const auto* module : process_snapshot.Modules()) {\n std::map module_annotations_simple_map =\n module->AnnotationsSimpleMap();\n all_annotations_simple_map.insert(module_annotations_simple_map.begin(),\n module_annotations_simple_map.end());\n\n std::vector annotations = module->AnnotationObjects();\n all_annotations.insert(\n all_annotations.end(), annotations.begin(), annotations.end());\n }\n\n EXPECT_EQ(all_annotations_simple_map.size(), 5u);\n EXPECT_EQ(all_annotations_simple_map[\"#TEST# pad\"], \"crash\");\n EXPECT_EQ(all_annotations_simple_map[\"#TEST# key\"], \"value\");\n EXPECT_EQ(all_annotations_simple_map[\"#TEST# x\"], \"y\");\n EXPECT_EQ(all_annotations_simple_map[\"#TEST# longer\"], \"shorter\");\n EXPECT_EQ(all_annotations_simple_map[\"#TEST# empty_value\"], \"\");\n\n bool saw_same_name_3 = false, saw_same_name_4 = false;\n for (const auto& annotation : all_annotations) {\n EXPECT_EQ(annotation.type,\n static_cast(Annotation::Type::kString));\n std::string value(reinterpret_cast(annotation.value.data()),\n annotation.value.size());\n if (annotation.name == \"#TEST# one\") {\n EXPECT_EQ(value, \"moocow\");\n } else if (annotation.name == \"#TEST# same-name\") {\n if (value == \"same-name 3\") {\n EXPECT_FALSE(saw_same_name_3);\n saw_same_name_3 = true;\n } else if (value == \"same-name 4\") {\n EXPECT_FALSE(saw_same_name_4);\n saw_same_name_4 = true;\n } else {\n ADD_FAILURE() << \"unexpected annotation value \" << value;\n }\n } else {\n ADD_FAILURE() << \"unexpected annotation \" << annotation.name;\n }\n }\n}\n\nTEST_F(InProcessIntermediateDumpHandlerTest, TestExtraMemoryRanges) {\n#if TARGET_OS_SIMULATOR\n // This test will fail on =14.3 or\n // =15.4 due to a bug in Simulator.\n // crbug.com/328282286\n if (HasMacOSBrokeDYLDTaskInfo()) {\n // For TearDown.\n ASSERT_TRUE(LoggingRemoveFile(path()));\n return;\n }\n#endif\n\n // Put the string on the heap so the memory doesn't coalesce with the stack.\n std::unique_ptr someExtraMemoryString(\n new std::string(\"extra memory range\"));\n crashpad::SimpleAddressRangeBag* ios_extra_ranges =\n new crashpad::SimpleAddressRangeBag();\n crashpad::CrashpadInfo::GetCrashpadInfo()->set_extra_memory_ranges(\n ios_extra_ranges);\n ios_extra_ranges->Insert((void*)someExtraMemoryString->c_str(), 18);\n WriteReportAndCloseWriter();\n crashpad::CrashpadInfo::GetCrashpadInfo()->set_extra_memory_ranges(nullptr);\n internal::ProcessSnapshotIOSIntermediateDump process_snapshot;\n ASSERT_TRUE(process_snapshot.InitializeWithFilePath(path(), {}));\n ASSERT_EQ(process_snapshot.ExtraMemory().size(), 1LU);\n auto memory = process_snapshot.ExtraMemory()[0];\n EXPECT_EQ(memory->Address(),\n reinterpret_cast(someExtraMemoryString->c_str()));\n EXPECT_EQ(memory->Size(), 18LU);\n ReadToString delegate;\n ASSERT_TRUE(memory->Read(&delegate));\n EXPECT_EQ(delegate.result, someExtraMemoryString->c_str());\n\n StringFile string_file;\n MinidumpFileWriter minidump_file_writer;\n minidump_file_writer.InitializeFromSnapshot(&process_snapshot);\n ASSERT_TRUE(minidump_file_writer.WriteEverything(&string_file));\n\n ProcessSnapshotMinidump process_snapshot_minidump;\n EXPECT_TRUE(process_snapshot_minidump.Initialize(&string_file));\n bool found;\n for (auto minidump_memory : process_snapshot_minidump.ExtraMemory()) {\n if (minidump_memory->Address() ==\n reinterpret_cast(someExtraMemoryString->c_str()) &&\n minidump_memory->Size() == 18LU) {\n found = true;\n break;\n }\n }\n EXPECT_TRUE(found);\n}\n\nTEST_F(InProcessIntermediateDumpHandlerTest,\n TestIntermediateDumpExtraMemoryRanges) {\n#if TARGET_OS_SIMULATOR\n // This test will fail on =14.3 or\n // =15.4 due to a bug in Simulator.\n // crbug.com/328282286\n if (HasMacOSBrokeDYLDTaskInfo()) {\n // For TearDown.\n ASSERT_TRUE(LoggingRemoveFile(path()));\n return;\n }\n#endif\n\n // Put the string on the heap so the memory doesn't coalesce with the stack.\n std::unique_ptr someExtraMemoryString(\n new std::string(\"extra memory range\"));\n crashpad::SimpleAddressRangeBag* ios_extra_ranges =\n new crashpad::SimpleAddressRangeBag();\n crashpad::CrashpadInfo::GetCrashpadInfo()\n ->set_intermediate_dump_extra_memory_ranges(ios_extra_ranges);\n ios_extra_ranges->Insert((void*)someExtraMemoryString->c_str(), 18);\n WriteReportAndCloseWriter();\n crashpad::CrashpadInfo::GetCrashpadInfo()\n ->set_intermediate_dump_extra_memory_ranges(nullptr);\n internal::ProcessSnapshotIOSIntermediateDump process_snapshot;\n ASSERT_TRUE(process_snapshot.InitializeWithFilePath(path(), {}));\n ASSERT_EQ(process_snapshot.IntermediateDumpExtraMemory().size(), 1LU);\n auto memory = process_snapshot.IntermediateDumpExtraMemory()[0];\n EXPECT_EQ(memory->Address(),\n reinterpret_cast(someExtraMemoryString->c_str()));\n EXPECT_EQ(memory->Size(), 18LU);\n ReadToString delegate;\n ASSERT_TRUE(memory->Read(&delegate));\n EXPECT_EQ(delegate.result, someExtraMemoryString->c_str());\n\n StringFile string_file;\n MinidumpFileWriter minidump_file_writer;\n minidump_file_writer.InitializeFromSnapshot(&process_snapshot);\n ASSERT_TRUE(minidump_file_writer.WriteEverything(&string_file));\n\n ProcessSnapshotMinidump process_snapshot_minidump;\n EXPECT_TRUE(process_snapshot_minidump.Initialize(&string_file));\n for (auto minidump_memory : process_snapshot_minidump.ExtraMemory()) {\n EXPECT_FALSE(\n minidump_memory->Address() ==\n reinterpret_cast(someExtraMemoryString->c_str()) &&\n minidump_memory->Size() == 18LU);\n }\n}\n\nTEST_F(InProcessIntermediateDumpHandlerTest, TestThreads) {\n const ScopedSetThreadName scoped_set_thread_name(\"TestThreads\");\n\n WriteReportAndCloseWriter();\n internal::ProcessSnapshotIOSIntermediateDump process_snapshot;\n ASSERT_TRUE(process_snapshot.InitializeWithFilePath(path(), {}));\n\n const auto& threads = process_snapshot.Threads();\n ASSERT_GT(threads.size(), 0u);\n\n thread_identifier_info identifier_info;\n mach_msg_type_number_t count = THREAD_IDENTIFIER_INFO_COUNT;\n ASSERT_EQ(thread_info(mach_thread_self(),\n THREAD_IDENTIFIER_INFO,\n reinterpret_cast(&identifier_info),\n &count),\n 0);\n EXPECT_EQ(threads[0]->ThreadID(), identifier_info.thread_id);\n EXPECT_EQ(threads[0]->ThreadName(), \"TestThreads\");\n}\n\nTEST_F(InProcessIntermediateDumpHandlerTest, TestProcess) {\n WriteReportAndCloseWriter();\n internal::ProcessSnapshotIOSIntermediateDump process_snapshot;\n ASSERT_TRUE(process_snapshot.InitializeWithFilePath(path(), {}));\n EXPECT_EQ(process_snapshot.ProcessID(), getpid());\n}\n\nTEST_F(InProcessIntermediateDumpHandlerTest, TestMachException) {\n WriteReportAndCloseWriter();\n internal::ProcessSnapshotIOSIntermediateDump process_snapshot;\n ASSERT_TRUE(process_snapshot.InitializeWithFilePath(path(), {}));\n}\n\nTEST_F(InProcessIntermediateDumpHandlerTest, TestSignalException) {\n WriteReportAndCloseWriter();\n internal::ProcessSnapshotIOSIntermediateDump process_snapshot;\n ASSERT_TRUE(process_snapshot.InitializeWithFilePath(path(), {}));\n}\n\nTEST_F(InProcessIntermediateDumpHandlerTest, TestNSException) {\n WriteReportAndCloseWriter();\n internal::ProcessSnapshotIOSIntermediateDump process_snapshot;\n ASSERT_TRUE(process_snapshot.InitializeWithFilePath(path(), {}));\n}\n\n} // namespace\n\nTEST_F(InProcessIntermediateDumpHandlerTest,\n TestCaptureMemoryPointedToByThreadState) {\n char test_buffer[1024];\n memset(test_buffer, 'A', sizeof(test_buffer));\n test_buffer[128] = 'B';\n\n // Use a std::atomic and a std::thread to simulate an arbitrary thread with a\n // known register state.\n std::atomic wait_for_main_thread(true);\n std::atomic thread_started(false);\n\n std::string thread_name(\"CaptureMemoryThread\");\n std::thread t([&]() {\n pthread_setname_np(thread_name.c_str());\n void* ptr = test_buffer + 128;\n // Force the compiler to store our pointer in a designated register rather\n // than on the stack\n#if defined(ARCH_CPU_ARM64)\n register void* reg_ptr asm(\"x20\") = ptr;\n#elif defined(ARCH_CPU_X86_64)\n register void* reg_ptr asm(\"r12\") = ptr;\n#endif\n thread_started = true;\n while (wait_for_main_thread.load(std::memory_order_relaxed)) {\n // Dummy operation to prevent the optimizer from discarding our register\n // assignment.\n asm volatile(\"\" : : \"r\"(reg_ptr));\n }\n });\n\n while (!thread_started.load(std::memory_order_relaxed)) {\n std::this_thread::yield();\n }\n\n WriteReportAndCloseWriter();\n\n wait_for_main_thread = false;\n t.join();\n\n internal::ProcessSnapshotIOSIntermediateDump process_snapshot;\n ASSERT_TRUE(process_snapshot.InitializeWithFilePath(path(), {}));\n\n bool found_our_buffer = false;\n for (const auto* thread : process_snapshot.Threads()) {\n if (thread->ThreadName() == thread_name) {\n for (const auto* memory : thread->ExtraMemory()) {\n if (memory->Address() == reinterpret_cast(test_buffer)) {\n found_our_buffer = true;\n EXPECT_EQ(memory->Size(), 512u);\n\n ReadToString delegate;\n ASSERT_TRUE(memory->Read(&delegate));\n EXPECT_EQ(delegate.result.size(), 512u);\n EXPECT_EQ(delegate.result[128], 'B');\n EXPECT_EQ(delegate.result[129], 'A');\n }\n }\n }\n }\n EXPECT_TRUE(found_our_buffer);\n}\n\n} // namespace test\n} // namespace crashpad\n" }, { "path": "client/ios_handler/prune_intermediate_dumps_and_crash_reports_thread.cc", "content": "// Copyright 2021 The Crashpad Authors\n//\n// Licensed under the Apache License, Version 2.0 (the \"License\");\n// you may not use this file except in compliance with the License.\n// You may obtain a copy of the License at\n//\n// http://www.apache.org/licenses/LICENSE-2.0\n//\n// Unless required by applicable law or agreed to in writing, software\n// distributed under the License is distributed on an \"AS IS\" BASIS,\n// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n// See the License for the specific language governing permissions and\n// limitations under the License.\n\n#include \"client/ios_handler/prune_intermediate_dumps_and_crash_reports_thread.h\"\n\n#include \n\n#include \"client/prune_crash_reports.h\"\n#include \"util/file/directory_reader.h\"\n#include \"util/file/filesystem.h\"\n#include \"util/ios/scoped_background_task.h\"\n\nnamespace crashpad {\n\nnamespace {\n\n// The file extension used to indicate a file is locked.\nconstexpr char kLockedExtension[] = \".locked\";\n\n// Prune onces a day.\nconstexpr time_t prune_interval = 60 * 60 * 24;\n\n// If the client finds a locked file matching it's own bundle id, unlock it\n// after 24 hours.\nconstexpr time_t matching_bundle_locked_ttl = 60 * 60 * 24;\n\n// Unlock any locked intermediate dump after 60 days.\nconstexpr time_t max_locked_ttl = 60 * 60 * 24 * 60;\n\n// The initial thread delay for applications. Delay the thread's file i/o to\n// not interfere with application startup.\nconstexpr double app_delay = 60;\n\n// The initial thread delay for app extensions. Because iOS extensions are often\n// very short lived, do not wait the full |app_delay|, and instead use a shorter\n// time.\nconstexpr double extension_delay = 5;\n\n\n//! \\brief Unlocks old intermediate dumps.\n//!\n//! This function can unlock (remove the .locked extension) intermediate dumps\n//! that are either too old to be useful, or are likely leftover dumps from\n//! clean app exits.\n//!\n//! \\param[in] pending_path The path to any locked intermediate dump files.\n//! \\param[in] bundle_identifier_and_seperator The identifier for this client,\n//! used to determine when locked files are considered stale.\nvoid UnlockOldIntermediateDumps(base::FilePath pending_path,\n std::string bundle_identifier_and_seperator) {\n DirectoryReader reader;\n std::vector files;\n if (!reader.Open(pending_path)) {\n return;\n }\n base::FilePath file;\n DirectoryReader::Result result;\n while ((result = reader.NextFile(&file)) ==\n DirectoryReader::Result::kSuccess) {\n if (file.FinalExtension() != kLockedExtension)\n continue;\n\n const base::FilePath file_path(pending_path.Append(file));\n timespec file_time;\n time_t now = time(nullptr);\n if (!FileModificationTime(file_path, &file_time)) {\n continue;\n }\n\n if ((file.value().compare(0,\n bundle_identifier_and_seperator.size(),\n bundle_identifier_and_seperator) == 0 &&\n file_time.tv_sec <= now - matching_bundle_locked_ttl) ||\n (file_time.tv_sec <= now - max_locked_ttl)) {\n base::FilePath new_path = file_path.RemoveFinalExtension();\n MoveFileOrDirectory(file_path, new_path);\n continue;\n }\n }\n}\n\n} // namespace\n\nPruneIntermediateDumpsAndCrashReportsThread::\n PruneIntermediateDumpsAndCrashReportsThread(\n CrashReportDatabase* database,\n std::unique_ptr condition,\n base::FilePath pending_path,\n std::string bundle_identifier_and_seperator,\n bool is_extension)\n : thread_(prune_interval, this),\n condition_(std::move(condition)),\n pending_path_(pending_path),\n bundle_identifier_and_seperator_(bundle_identifier_and_seperator),\n initial_work_delay_(is_extension ? extension_delay : app_delay),\n last_start_time_(0),\n database_(database) {}\n\nPruneIntermediateDumpsAndCrashReportsThread::\n ~PruneIntermediateDumpsAndCrashReportsThread() {}\n\nvoid PruneIntermediateDumpsAndCrashReportsThread::Start() {\n thread_.Start(initial_work_delay_);\n}\n\nvoid PruneIntermediateDumpsAndCrashReportsThread::Stop() {\n thread_.Stop();\n}\n\nvoid PruneIntermediateDumpsAndCrashReportsThread::DoWork(\n const WorkerThread* thread) {\n // This thread may be stopped and started a number of times throughout the\n // lifetime of the process to prevent 0xdead10cc kills (see\n // crbug.com/crashpad/400), but it should only run once per prune_interval\n // after initial_work_delay_.\n time_t now = time(nullptr);\n if (now - last_start_time_ < prune_interval)\n return;\n last_start_time_ = now;\n\n internal::ScopedBackgroundTask scoper(\"PruneThread\");\n database_->CleanDatabase(60 * 60 * 24 * 3);\n\n // Here and below, respect Stop() being called after each task.\n if (!thread_.is_running())\n return;\n PruneCrashReportDatabase(database_, condition_.get());\n\n if (!thread_.is_running())\n return;\n if (!clean_old_intermediate_dumps_) {\n clean_old_intermediate_dumps_ = true;\n UnlockOldIntermediateDumps(pending_path_, bundle_identifier_and_seperator_);\n }\n}\n\n} // namespace crashpad\n" }, { "path": "client/ios_handler/prune_intermediate_dumps_and_crash_reports_thread.h", "content": "// Copyright 2021 The Crashpad Authors\n//\n// Licensed under the Apache License, Version 2.0 (the \"License\");\n// you may not use this file except in compliance with the License.\n// You may obtain a copy of the License at\n//\n// http://www.apache.org/licenses/LICENSE-2.0\n//\n// Unless required by applicable law or agreed to in writing, software\n// distributed under the License is distributed on an \"AS IS\" BASIS,\n// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n// See the License for the specific language governing permissions and\n// limitations under the License.\n\n#ifndef CRASHPAD_HANDLER_PRUNE_CRASH_REPORTS_THREAD_H_\n#define CRASHPAD_HANDLER_PRUNE_CRASH_REPORTS_THREAD_H_\n\n#include \n\n#include \"base/files/file_path.h\"\n#include \"util/thread/stoppable.h\"\n#include \"util/thread/worker_thread.h\"\n\nnamespace crashpad {\n\nclass CrashReportDatabase;\nclass PruneCondition;\n\n//! \\brief A thread that periodically prunes crash reports from the database\n//! using the specified condition, and any leftover locked intermediate\n//! dumps.\n//!\n//! After the thread is started, the database is pruned using the condition\n//! every 24 hours. Upon calling Start(), the thread waits before performing\n//! the initial prune operation.\n//!\n//! Locked intermediate dump files are unlocked only once, not periodically.\n//! Locked dumps that match this bundle id can be unlocked if they are over a\n//! day old. Otherwise, unlock dumps that are over 60 days old.\nclass PruneIntermediateDumpsAndCrashReportsThread\n : public WorkerThread::Delegate,\n public Stoppable {\n public:\n //! \\brief Constructs a new object.\n //!\n //! \\param[in] database The database to prune crash reports from.\n //! \\param[in] condition The condition used to evaluate crash reports for\n //! pruning.\n //! \\param[in] pending_path The path to any locked intermediate dump files.\n //! \\param[in] bundle_identifier_and_seperator The identifier for this client,\n //! used to determine when locked files are considered stale, with a\n //! seperator at the end to allow for substring searches.\n //! \\param[in] is_extension Whether the process is an app extension. If\n //! `true`, the inital prune will occur after a 5-second delay. If\n //! `false`, the initial prune will occur after a 60-second delay.\n PruneIntermediateDumpsAndCrashReportsThread(\n CrashReportDatabase* database,\n std::unique_ptr condition,\n base::FilePath pending_path,\n std::string bundle_identifier_and_seperator,\n bool is_extension);\n\n PruneIntermediateDumpsAndCrashReportsThread(\n const PruneIntermediateDumpsAndCrashReportsThread&) = delete;\n PruneIntermediateDumpsAndCrashReportsThread& operator=(\n const PruneIntermediateDumpsAndCrashReportsThread&) = delete;\n\n ~PruneIntermediateDumpsAndCrashReportsThread();\n\n // Stoppable:\n\n //! \\brief Starts a dedicated pruning thread.\n //!\n //! The thread waits before running the initial prune, so as to not interfere\n //! with any startup-related IO performed by the client.\n //!\n //! This method may only be be called on a newly-constructed object or after\n //! a call to Stop().\n void Start() override;\n\n //! \\brief Stops the pruning thread.\n //!\n //! This method must only be called after Start(). If Start() has been called,\n //! this method must be called before destroying an object of this class.\n //!\n //! This method may be called from any thread other than the pruning thread.\n //! It is expected to only be called from the same thread that called Start().\n void Stop() override;\n\n //! \\return `true` if the thread is running, `false` if it is not.\n bool is_running() const { return thread_.is_running(); }\n\n private:\n // WorkerThread::Delegate:\n void DoWork(const WorkerThread* thread) override;\n\n WorkerThread thread_;\n std::unique_ptr condition_;\n base::FilePath pending_path_;\n std::string bundle_identifier_and_seperator_;\n bool clean_old_intermediate_dumps_;\n double initial_work_delay_;\n time_t last_start_time_;\n CrashReportDatabase* database_; // weak\n};\n\n} // namespace crashpad\n\n#endif // CRASHPAD_HANDLER_PRUNE_CRASH_REPORTS_THREAD_H_\n" }, { "path": "client/length_delimited_ring_buffer.h", "content": "// Copyright 2023 The Crashpad Authors\n//\n// Licensed under the Apache License, Version 2.0 (the \"License\");\n// you may not use this file except in compliance with the License.\n// You may obtain a copy of the License at\n//\n// http://www.apache.org/licenses/LICENSE-2.0\n//\n// Unless required by applicable law or agreed to in writing, software\n// distributed under the License is distributed on an \"AS IS\" BASIS,\n// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n// See the License for the specific language governing permissions and\n// limitations under the License.\n\n#ifndef CRASHPAD_CLIENT_LENGTH_DELIMITED_RING_BUFFER_H_\n#define CRASHPAD_CLIENT_LENGTH_DELIMITED_RING_BUFFER_H_\n\n#include \n#include \n\n#include \n#include \n#include \n#include \n#include \n#include \n\n#include \"base/numerics/safe_math.h\"\n\nnamespace crashpad {\n\n//! \\brief Capacity of a `RingBufferData`, in bytes.\nusing RingBufferCapacity = uint32_t;\n\nnamespace internal {\n\n//! \\brief Default capacity of `RingBufferData`, in bytes.\ninline constexpr RingBufferCapacity kDefaultRingBufferDataCapacity = 8192;\n\n//! \\brief A tuple holding the current range of bytes which can be read from or\n//! have been written to.\nstruct Range final {\n //! \\brief The offset into a `RingBufferData` at which a `Range` begins.\n using Offset = uint32_t;\n\n //! \\brief The length inside a `RingBufferData` of a `Range` of data.\n using Length = uint32_t;\n\n Offset offset;\n Length length;\n};\n\n// This struct is persisted to disk, so its size must not change.\nstatic_assert(sizeof(Range) == 8,\n \"struct Range is not packed on this platform\");\n\n//! \\brief The number of bits encoded in each byte of a Base 128-encoded varint.\ninline constexpr int kBase128ByteValueBits = 7;\n\n//! \\!brief Calculates the length in bytes of `value` encoded using\n//! little-endian Base 128 varint encoding.\n//! \\sa https://developers.google.com/protocol-buffers/docs/encoding#varints\n//!\n//! `LengthDelimitedRingBufferWriter` uses varint-encoded delimiters to enable\n//! zero-copy deserialization of the ringbuffer's contents when storing\n//! protobufs inside the ringbuffer, e.g. via\n//! `google::protobuf::util::ParseDelimitedFromZeroCopyStream()` or similar.\n//!\n//! \\sa\n//! https://github.com/protocolbuffers/protobuf/blob/3202b9da88ceb75b65bbabaf4033c95e872f828d/src/google/protobuf/util/delimited_message_util.h#L85\n//! \\sa\n//! https://github.com/protocolbuffers/protobuf/blob/8bd49dea5e167a389d94b71d24c981d8f9fa0c99/src/google/protobuf/io/zero_copy_stream_impl_lite.h#L68\n//! \\sa\n//! https://github.com/protocolbuffers/protobuf/blob/8bd49dea5e167a389d94b71d24c981d8f9fa0c99/src/google/protobuf/io/coded_stream.h#L171\n//!\n//! \\!param[in] value Value to be encoded in Base 128 varint encoding.\n//! \\!return The length in bytes of `value` in Base 128 varint encoding.\ntemplate \nconstexpr Range::Length Base128VarintEncodedLength(IntegerType value) {\n static_assert(std::is_unsigned::value);\n\n Range::Length size = 1;\n while (value >= 0x80) {\n value >>= kBase128ByteValueBits;\n size++;\n }\n return size;\n}\n\n// Note that std::array capacity is a size_t, not a RingBufferCapacity.\ntemplate \nusing RingBufferArray = std::array;\n\n//! \\return The size of the `RingBufferArray` as a `Range::Length`.\ntemplate \nconstexpr Range::Length RingBufferArraySize(\n const RingBufferArray& ring_buffer_data) {\n static_assert(ArrayCapacity <= std::numeric_limits::max());\n return static_cast(ring_buffer_data.size());\n}\n\n//! \\brief Reads data from the ring buffer into a target buffer.\n//! \\param[in] ring_buffer_data The ring buffer to read.\n//! \\param[in,out] ring_buffer_read_range The range of the data available\n//! to read. Upon return, set to the remaining range of data available\n//! to read, if any.\n//! \\param[in] target_buffer Buffer into which data will be written.\n//! \\param[in] target_buffer_length Number of bytes to write into\n//! `target_buffer`.\n//!\n//! \\return `true` if the read succeeded, `false` otherwise. On success, updates\n//! `ring_buffer_read_range` to reflect the bytes consumed.\n//!\n//! The bytes can wrap around the end of the ring buffer, in which case the read\n//! continues at the beginning of the ring buffer (if the ring buffer is long\n//! enough).\ntemplate \nbool ReadBytesFromRingBuffer(const RingBufferArrayType& ring_buffer_data,\n internal::Range& ring_buffer_read_range,\n uint8_t* target_buffer,\n Range::Length target_buffer_length) {\n if (target_buffer_length > ring_buffer_read_range.length) {\n return false;\n }\n if (target_buffer_length == 0) {\n return true;\n }\n const Range::Length initial_read_length = std::min(\n target_buffer_length,\n RingBufferArraySize(ring_buffer_data) - ring_buffer_read_range.offset);\n memcpy(target_buffer,\n &ring_buffer_data[ring_buffer_read_range.offset],\n initial_read_length);\n if (initial_read_length < target_buffer_length) {\n const Range::Length remaining_read_length =\n target_buffer_length - initial_read_length;\n memcpy(target_buffer + initial_read_length,\n &ring_buffer_data[0],\n remaining_read_length);\n }\n ring_buffer_read_range.offset =\n (ring_buffer_read_range.offset + target_buffer_length) %\n RingBufferArraySize(ring_buffer_data);\n ring_buffer_read_range.length -= target_buffer_length;\n return true;\n}\n\n//! \\brief Reads a single little-endian Base 128 varint-encoded integer from\n//! the ring buffer.\n//! \\param[in] ring_buffer_data The ring buffer to read.\n//! \\param[in,out] ring_buffer_read_range The range of the data available\n//! to read. Upon return, set to the remaining range of data available\n//! to read, if any.\n//! \\param[out] result Upon success, set to the decoded value read from the\n//! buffer.\n//!\n//! \\return The length in bytes of the varint if the read succeeded,\n//! `std::nullopt` otherwise. On success, updates `ring_buffer_read_range`\n//! to reflect the bytes available to read.\n//!\n//! The varint can wrap around the end of the ring buffer, in which case the\n//! read continues at the beginning of the ring buffer (if the ring buffer is\n//! long enough).\ntemplate \nstd::optional ReadBase128VarintFromRingBuffer(\n const RingBufferArrayType& ring_buffer_data,\n internal::Range& ring_buffer_read_range,\n IntegerType& result) {\n static_assert(std::is_unsigned::value);\n\n result = 0;\n uint8_t cur_varint_byte = 0;\n constexpr uint8_t kValueMask = 0x7f;\n constexpr uint8_t kContinuationMask = 0x80;\n Range::Length length = 0;\n do {\n if (!ReadBytesFromRingBuffer(\n ring_buffer_data, ring_buffer_read_range, &cur_varint_byte, 1)) {\n // No capacity remaining in `ring_buffer_read_range` to read the varint.\n return std::nullopt;\n }\n IntegerType cur_varint_value =\n static_cast(cur_varint_byte & kValueMask);\n\n // This is equivalent to:\n //\n // result |= (cur_varint_value << (length * kBase128ByteValueBits));\n //\n // but checks the result at each step for overflow, which handles two types\n // of invalid input:\n //\n // 1) Too many bytes with kContinuationMask set (e.g., trying to encode 6\n // bytes worth of data in a 32-bit value)\n // 2) Too many bits in the final byte (e.g., the 5th byte for a 32-bit value\n // has bits 33 and 34 set)\n IntegerType next_result_bits;\n if (!base::CheckLsh(cur_varint_value, length * kBase128ByteValueBits)\n .AssignIfValid(&next_result_bits)) {\n return std::nullopt;\n }\n result |= next_result_bits;\n ++length;\n } while ((cur_varint_byte & kContinuationMask) == kContinuationMask);\n return length;\n}\n\n//! \\brief Writes data from the source buffer into the ring buffer.\n//! \\param[in] source_buffer Buffer from which data will be read.\n//! \\param[in] source_buffer_length The length in bytes of `source_buffer`.\n//! \\param[in] ring_buffer_data The ring buffer into which data will be read.\n//! \\param[in,out] ring_buffer_write_range The range of the data available\n//! to write. Upon return, set to the remaining range of data available\n//! to write, if any.\n//!\n//! \\return `true` if write read succeeded, `false` otherwise. On success,\n//! updates\n//! `ring_buffer_write_range` to reflect the bytes written.\n//!\n//! The bytes can wrap around the end of the ring buffer, in which case the\n//! write continues at the beginning of the ring buffer (if the ring buffer is\n//! long enough).\ntemplate \nbool WriteBytesToRingBuffer(const uint8_t* const source_buffer,\n Range::Length source_buffer_length,\n RingBufferArrayType& ring_buffer_data,\n internal::Range& ring_buffer_write_range) {\n const Range::Length ring_buffer_bytes_remaining =\n RingBufferArraySize(ring_buffer_data) - ring_buffer_write_range.length;\n if (source_buffer_length > ring_buffer_bytes_remaining) {\n return false;\n }\n const Range::Length initial_write_length = std::min(\n source_buffer_length,\n RingBufferArraySize(ring_buffer_data) - ring_buffer_write_range.offset);\n memcpy(&ring_buffer_data[ring_buffer_write_range.offset],\n source_buffer,\n initial_write_length);\n if (initial_write_length < source_buffer_length) {\n const Range::Length remaining_write_length =\n source_buffer_length - initial_write_length;\n memcpy(&ring_buffer_data[0],\n source_buffer + initial_write_length,\n remaining_write_length);\n }\n ring_buffer_write_range.offset =\n (ring_buffer_write_range.offset + source_buffer_length) %\n RingBufferArraySize(ring_buffer_data);\n ring_buffer_write_range.length -= source_buffer_length;\n return true;\n}\n\n//! \\brief Writes a single Base 128 varint-encoded little-endian unsigned\n//! integer into the ring buffer.\n//! \\param[in] value The value to encode and write into the ring buffer.\n//! \\param[in] ring_buffer_data The ring buffer into which to write.\n//! \\param[in,out] ring_buffer_write_range The range of the data available\n//! to write. Upon return, set to the remaining range of data available\n//! to write, if any.\n//!\n//! \\return The length in bytes of the varint if the write succeeded,\n//! `std::nullopt` otherwise. On success, updates `write_buffer_read_range`\n//! to reflect the range available to write, if any.\n//!\n//! The varint can wrap around the end of the ring buffer, in which case the\n//! write continues at the beginning of the ring buffer (if the ring buffer is\n//! long enough).\ntemplate \nstd::optional WriteBase128VarintToRingBuffer(\n IntegerType value,\n RingBufferArrayType& ring_buffer_data,\n internal::Range& ring_buffer_write_range) {\n static_assert(std::is_unsigned::value);\n\n uint8_t cur_varint_byte;\n constexpr uint8_t kValueMask = 0x7f;\n constexpr uint8_t kContinuationMask = 0x80;\n\n // Every varint encodes to at least 1 byte of data.\n int length = 1;\n\n while (value > kValueMask) {\n cur_varint_byte =\n (static_cast(value) & kValueMask) | kContinuationMask;\n if (!WriteBytesToRingBuffer(\n &cur_varint_byte, 1, ring_buffer_data, ring_buffer_write_range)) {\n return std::nullopt;\n }\n value >>= kBase128ByteValueBits;\n ++length;\n }\n cur_varint_byte = static_cast(value);\n if (!WriteBytesToRingBuffer(\n &cur_varint_byte, 1, ring_buffer_data, ring_buffer_write_range)) {\n return std::nullopt;\n }\n return length;\n}\n\n} // namespace internal\n\n//! \\brief Storage for a ring buffer which can hold up to\n//! `RingBufferCapacity`\n//! bytes of Base 128-varint delimited variable-length items.\n//!\n//! This struct contains a header immediately followed by the ring buffer\n//! data. The current read offset and length are stored in `header.data_range`.\n//!\n//! The structure of this object is:\n//!\n//! `|magic|version|data_offset|data_length|ring_buffer_data|`\n//!\n//! To write data to this object, see `LengthDelimitedRingBufferWriter`.\n//! To read data from this object, see `LengthDelimitedRingBufferReader`.\n//!\n//! The bytes of this structure are suitable for direct serialization from\n//! memory to disk, e.g. as a crashpad::Annotation.\ntemplate \nstruct RingBufferData final {\n RingBufferData() = default;\n RingBufferData(RingBufferData&) = delete;\n RingBufferData& operator=(RingBufferData&) = delete;\n\n //! \\brief The type of the array holding the data in this object.\n using RingBufferArrayType = internal::RingBufferArray;\n\n //! \\brief The type of the size in bytes of operations on this object.\n using SizeType = internal::Range::Length;\n\n //! \\brief Attempts to overwrite the contents of this object by deserializing\n //! the buffer into this object.\n //! \\param[in] buffer The bytes to deserialize into this object.\n //! \\param[in] length The length in bytes of `buffer`.\n //!\n //! \\return `true` if the buffer was a valid RingBufferData and this object\n //! has enough capacity to store its bytes, `false` otherwise.\n bool DeserializeFromBuffer(const void* buffer, SizeType length) {\n if (length < sizeof(header) || length > sizeof(header) + sizeof(data)) {\n return false;\n }\n const Header* other_header = reinterpret_cast(buffer);\n if (other_header->magic != kMagic || other_header->version != kVersion) {\n return false;\n }\n header.data_range = other_header->data_range;\n const uint8_t* other_ring_buffer_bytes =\n reinterpret_cast(buffer) + sizeof(*other_header);\n const SizeType other_ring_buffer_len = length - sizeof(*other_header);\n memcpy(&data[0], other_ring_buffer_bytes, other_ring_buffer_len);\n return true;\n }\n\n //! \\return The current length in bytes of the data written to the ring\n //! buffer.\n SizeType GetRingBufferLength() const {\n internal::Range data_range = header.data_range;\n return sizeof(header) + std::min(internal::RingBufferArraySize(data),\n data_range.offset + data_range.length);\n }\n\n //! \\brief Resets the state of the ring buffer (e.g., for testing).\n void ResetForTesting() { header.data_range = {0, 0}; }\n\n //! \\brief The magic signature of the ring buffer.\n static constexpr uint32_t kMagic = 0xcab00d1e;\n //! \\brief The version of the ring buffer.\n static constexpr uint32_t kVersion = 1;\n\n //! \\brief A header containing metadata preceding the ring buffer data.\n struct Header final {\n Header() : magic(kMagic), version(kVersion), data_range({0, 0}) {}\n\n //! \\brief The fixed magic value identifying this as a ring buffer.\n const uint32_t magic;\n\n //! \\brief The version of this ring buffer data.\n const uint32_t version;\n\n //! \\brief The range of readable data in the ring buffer.\n internal::Range data_range;\n };\n\n //! \\brief The header containing ring buffer metadata.\n Header header;\n\n //! \\brief The bytes of the ring buffer data.\n RingBufferArrayType data;\n\n // This struct is persisted to disk, so its size must not change.\n static_assert(sizeof(Header) == 16);\n static_assert(Capacity <= std::numeric_limits::max());\n};\n\n// Ensure the ring buffer is packed correctly at its default capacity.\nstatic_assert(\n sizeof(RingBufferData) ==\n 16 + internal::kDefaultRingBufferDataCapacity);\n\n// Allow just `RingBufferData foo;` to be declared without template arguments\n// using C++17 class template argument deduction.\ntemplate <\n RingBufferCapacity Capacity = internal::kDefaultRingBufferDataCapacity>\nRingBufferData() -> RingBufferData;\n\n//! \\brief Reads variable-length data buffers from a `RingBufferData`,\n//! delimited by Base128 varint-encoded length delimiters.\n//!\n//! Holds a reference to a `RingBufferData` with the capacity to hold\n//! `RingBufferDataType::size()` bytes of variable-length buffers each\n//! preceded by its length (encoded as a Base128 length varint).\n//!\n//! Provides reading capabilities via `Pop()`.\ntemplate \nclass LengthDelimitedRingBufferReader final {\n public:\n //! \\brief Constructs a reader which holds a reference to `ring_buffer`.\n //! \\param[in] ring_buffer The ring buffer from which data will be read.\n //! This object must outlive the lifetime of `ring_buffer`.\n constexpr explicit LengthDelimitedRingBufferReader(\n RingBufferDataType& ring_buffer)\n : ring_buffer_(ring_buffer),\n data_range_(ring_buffer_.header.data_range) {}\n\n LengthDelimitedRingBufferReader(const LengthDelimitedRingBufferReader&) =\n delete;\n LengthDelimitedRingBufferReader& operator=(\n const LengthDelimitedRingBufferReader&) = delete;\n\n //! \\brief Pops off the next buffer from the front of the ring buffer.\n //!\n //! \\param[in] target_buffer On success, the buffer into which data will\n //! be read.\n //! \\return On success, returns `true` and advances `ring_buffer.data_range`\n //! past the end of the buffer read. Otherwise, returns `false`.\n bool Pop(std::vector& target_buffer) {\n return PopWithRange(target_buffer, data_range_);\n }\n\n //! \\brief Resets the state of the reader (e.g., for testing).\n void ResetForTesting() { data_range_ = {0, 0}; }\n\n private:\n //! \\brief Pops off the next buffer from the front of the ring buffer.\n //! \\param[in] target_buffer On success, the buffer into which data will\n //! be read.\n //! \\param[in,out] data_range The range of data available to read.\n //! On success, updated to the remaining range avilable to read.\n //! \\return On success, returns `true` and advances `ring_buffer.data_range`\n //! past the end of the buffer read. Otherwise, returns `false`.\n bool PopWithRange(std::vector& target_buffer,\n internal::Range& data_range) {\n internal::Range::Length buffer_length;\n if (!ReadBase128VarintFromRingBuffer(\n ring_buffer_.data, data_range, buffer_length)) {\n return false;\n }\n if (buffer_length == 0) {\n // A zero-length buffer means the buffer was truncated in the middle of a\n // Push().\n return false;\n }\n const auto previous_target_buffer_size = target_buffer.size();\n target_buffer.resize(previous_target_buffer_size + buffer_length);\n if (!ReadBytesFromRingBuffer(ring_buffer_.data,\n data_range,\n &target_buffer[previous_target_buffer_size],\n buffer_length)) {\n return false;\n }\n return true;\n }\n\n //! \\brief Reference to the ring buffer from which data is read.\n const RingBufferDataType& ring_buffer_;\n //! \\brief Range of data currently available to read.\n internal::Range data_range_;\n};\n\n// Allow just `LengthDelimitedRingBufferReader reader(foo);` to be declared\n// without template arguments using C++17 class template argument deduction.\ntemplate \nLengthDelimitedRingBufferReader(RingBufferDataType&)\n -> LengthDelimitedRingBufferReader;\n\n//! \\brief Writes variable-length data buffers to a `RingBufferData`,\n//! delimited by Base128 varint-encoded length delimiters.\n//!\n//! Holds a reference to a `RingBufferData` with the capacity to hold\n//! `RingBufferDataType::size()` bytes of variable-length buffers each\n//! preceded by its length (encoded as a Base128 length varint).\n//!\n//! Provides writing capabilities via `Push()`.\ntemplate \nclass LengthDelimitedRingBufferWriter final {\n public:\n //! \\brief Constructs a writer which holds a reference to `ring_buffer`.\n //! \\param[in] ring_buffer The ring buffer into which data will be written.\n //! This object must outlive the lifetime of `ring_buffer`.\n constexpr explicit LengthDelimitedRingBufferWriter(\n RingBufferDataType& ring_buffer)\n : ring_buffer_(ring_buffer), ring_buffer_write_offset_(0) {}\n\n LengthDelimitedRingBufferWriter(const LengthDelimitedRingBufferWriter&) =\n delete;\n LengthDelimitedRingBufferWriter& operator=(\n const LengthDelimitedRingBufferWriter&) = delete;\n\n //! \\brief Writes data to the ring buffer.\n //!\n //! If there is not enough room remaining in the ring buffer to store the new\n //! data, old data will be removed from the ring buffer in FIFO order until\n //! there is room for the new data.\n //!\n //! \\param[in] buffer The data to be written.\n //! \\param[in] buffer_length The lengh of `buffer`, in bytes.\n //! \\return On success, returns `true`, updates `ring_buffer.data_range`\n //! to reflect the remaining data available to read, and updates\n //! `ring_buffer_write_offset_` to reflec the current write positionl.\n //! Otherwise, returns `false`.\n bool Push(const void* const buffer,\n typename RingBufferDataType::SizeType buffer_length) {\n if (buffer_length == 0) {\n // Pushing a zero-length buffer is not allowed\n // (`LengthDelimitedRingBufferWriter` reserves that to represent a\n // temporarily truncated item below).\n return false;\n }\n const internal::Range::Length buffer_varint_encoded_length =\n internal::Base128VarintEncodedLength(buffer_length);\n const internal::Range::Length bytes_needed =\n buffer_varint_encoded_length + buffer_length;\n if (bytes_needed > ring_buffer_.data.size()) {\n return false;\n }\n // If needed, move the readable region forward one buffer at a time to make\n // room for `buffer_length` bytes of new data.\n auto readable_data_range = ring_buffer_.header.data_range;\n internal::Range::Length bytes_available =\n internal::RingBufferArraySize(ring_buffer_.data) -\n readable_data_range.length;\n while (bytes_available < bytes_needed) {\n internal::Range::Length bytes_to_skip;\n auto varint_length = ReadBase128VarintFromRingBuffer(\n ring_buffer_.data, readable_data_range, bytes_to_skip);\n if (!varint_length.has_value()) {\n return false;\n }\n // Skip past the next entry including its prepended varint length.\n readable_data_range.offset =\n (readable_data_range.offset + bytes_to_skip) %\n internal::RingBufferArraySize(ring_buffer_.data);\n readable_data_range.length -= bytes_to_skip;\n bytes_available += varint_length.value() + bytes_to_skip;\n }\n // Write the varint containing `buffer_length` to the current write\n // position.\n internal::Range write_range = {\n ring_buffer_write_offset_,\n bytes_needed,\n };\n\n internal::WriteBase128VarintToRingBuffer(\n buffer_length, ring_buffer_.data, write_range);\n // Next, write the bytes from `buffer`.\n internal::WriteBytesToRingBuffer(\n reinterpret_cast(buffer),\n buffer_length,\n ring_buffer_.data,\n write_range);\n // Finally, update the write position and read data range taking into\n // account any items skipped to make room plus the new buffer's varint\n // length and the new buffer's length.\n ring_buffer_write_offset_ = write_range.offset;\n const internal::Range final_data_range = {\n readable_data_range.offset,\n readable_data_range.length + bytes_needed,\n };\n ring_buffer_.header.data_range = final_data_range;\n return true;\n }\n\n //! \\brief Resets the state of the ring buffer and writer (e.g., for testing).\n void ResetForTesting() {\n ring_buffer_.ResetForTesting();\n ring_buffer_write_offset_ = 0;\n }\n\n private:\n //! \\brief Reference to the ring buffer from which data is written.\n RingBufferDataType& ring_buffer_;\n\n // \\brief Current write position next time `Push()` is invoked.\n internal::Range::Offset ring_buffer_write_offset_;\n};\n\n// Allow just `LengthDelimitedRingBufferWriter writer(foo);` to be declared\n// without template arguments using C++17 class template argument deduction.\ntemplate \nLengthDelimitedRingBufferWriter(RingBufferDataType&)\n -> LengthDelimitedRingBufferWriter;\n\n} // namespace crashpad\n\n#endif // CRASHPAD_CLIENT_LENGTH_DELIMITED_RING_BUFFER_H_\n" }, { "path": "client/length_delimited_ring_buffer_test.cc", "content": "// Copyright 2023 The Crashpad Authors\n//\n// Licensed under the Apache License, Version 2.0 (the \"License\");\n// you may not use this file except in compliance with the License.\n// You may obtain a copy of the License at\n//\n// http://www.apache.org/licenses/LICENSE-2.0\n//\n// Unless required by applicable law or agreed to in writing, software\n// distributed under the License is distributed on an \"AS IS\" BASIS,\n// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n// See the License for the specific language governing permissions and\n// limitations under the License.\n\n#include \"client/length_delimited_ring_buffer.h\"\n\n#include \n\n#include \n#include \n#include \n\n#include \"gmock/gmock.h\"\n#include \"gtest/gtest.h\"\n\nnamespace crashpad {\nnamespace test {\nnamespace {\n\nusing testing::Eq;\nusing testing::IsFalse;\nusing testing::IsTrue;\n\n// Buffer with magic 0xcab00d1e, version 1, read_pos 0, length 3, and 3 bytes of\n// data (1 varint length, 2 bytes data)\nconstexpr char kValidBufferSize3[] =\n \"\\x1e\\x0d\\xb0\\xca\\x01\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x03\\x00\\x00\\x00\\x02\\x42\"\n \"\\x23\";\nconstexpr size_t kValidBufferSize3Len =\n sizeof(kValidBufferSize3) - 1; // Remove trailing NUL.\n\n// Buffer with magic 0xcab00d1e, version 8, read_pos 0, length 3, and 3 bytes of\n// data (1 varint length, 2 bytes data).\nconstexpr char kInvalidVersionBuffer[] =\n \"\\x1e\\x0d\\xb0\\xca\\x08\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x03\\x00\\x00\\x00\\x02\\xab\"\n \"\\xcd\";\nconstexpr size_t kInvalidVersionBufferLen =\n sizeof(kInvalidVersionBuffer) - 1; // Remove trailing NUL.\n\n// Buffer representing process which crashed while in the middle of a Push()\n// operation, with a previously-Push()ed buffer whose length was zeroed out at\n// the start.\nconstexpr char kMidCrashBuffer[] =\n \"\\x1e\\x0d\\xb0\\xca\\x01\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x03\\x00\\x00\\x00\\x00\\x42\"\n \"\\x23\";\nconstexpr size_t kMidCrashBufferLen =\n sizeof(kMidCrashBuffer) - 1; // Remove trailing NUL.\n\nconstexpr uint8_t kHello[] = {0x68, 0x65, 0x6c, 0x6c, 0x6f};\n\n// Invalid buffer containing malformed varint in data payload (Base 128 varint\n// with length 6, which would represent a data length > 32 bits).\nconstexpr char kInvalidBase128VarintBuffer[] =\n \"\\x1e\\x0d\\xb0\\xca\\x01\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x06\\x00\\x00\\x00\\x80\\x80\"\n \"\\x80\\x80\\x80\\x01\";\nconstexpr size_t kInvalidBase128VarintBufferLen =\n sizeof(kInvalidBase128VarintBuffer) - 1; // Remove trailing NUL.\n\n// Invalid buffer containing malformed varint in data payload (Base 128 varint\n// with length 5 but bits 33 and 34 set, which would represent a data length >\n// 32 bits).\nconstexpr char kInvalidBase128VarintBits33And34SetBuffer[] =\n \"\\x1e\\x0d\\xb0\\xca\\x01\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x05\\x00\\x00\\x00\\x80\\x80\"\n \"\\x80\\x80\\x60\";\nconstexpr size_t kInvalidBase128VarintBits33And34SetBufferLen =\n sizeof(kInvalidBase128VarintBits33And34SetBuffer) -\n 1; // Remove trailing NUL.\n\n// Invalid buffer containing too-short data payload (varint length indicates\n// payload length is 4 but payload only contains 3 bytes).\nconstexpr char kInvalidPayloadBufferTooShort[] =\n \"\\x1e\\x0d\\xb0\\xca\\x01\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x04\\x00\\x00\\x00\\x04\"\n \"\\x42\\x42\\x42\";\nconstexpr size_t kInvalidPayloadBufferTooShortLen =\n sizeof(kInvalidPayloadBufferTooShort) - 1; // Remove trailing NUL.\n\nTEST(LengthDelimitedRingBufferTest,\n RingBufferDataShouldStartWithMagicAndVersion) {\n RingBufferData ring_buffer;\n const void* ring_buffer_bytes = static_cast(&ring_buffer);\n EXPECT_THAT(memcmp(ring_buffer_bytes, \"\\x1e\\x0d\\xb0\\xca\\x01\\x00\\x00\\x00\", 8),\n Eq(0));\n}\n\nTEST(LengthDelimitedRingBufferTest,\n EmptyBufferSizeShouldIncludeHeaderInRingBufferLength) {\n RingBufferData ring_buffer;\n EXPECT_THAT(ring_buffer.GetRingBufferLength(),\n Eq(16U)); // 4 for uint32 magic, 4 for uint32 version, 4 for\n // uint32 read_pos, 4 for uint32 length\n}\n\nTEST(LengthDelimitedRingBufferTest,\n NonEmptyBufferSizeShouldIncludeHeaderAndData) {\n RingBufferData ring_buffer;\n LengthDelimitedRingBufferWriter writer(ring_buffer);\n ASSERT_THAT(writer.Push(kHello, sizeof(kHello)), IsTrue());\n EXPECT_THAT(ring_buffer.GetRingBufferLength(),\n Eq(22U)); // 16 for header, 1 for varint length, 5 for data\n}\n\nTEST(LengthDelimitedRingBufferTest, PopOnEmptyBufferShouldFail) {\n RingBufferData ring_buffer;\n LengthDelimitedRingBufferReader reader(ring_buffer);\n std::vector result;\n EXPECT_THAT(reader.Pop(result), IsFalse());\n}\n\nTEST(LengthDelimitedRingBufferTest, PushZeroLengthShouldFail) {\n RingBufferData ring_buffer;\n LengthDelimitedRingBufferWriter writer(ring_buffer);\n ASSERT_THAT(writer.Push(nullptr, 0), IsFalse());\n}\n\nTEST(LengthDelimitedRingBufferTest, PushExactlyBufferSizeThenPopShouldSucceed) {\n RingBufferData ring_buffer;\n LengthDelimitedRingBufferWriter writer(ring_buffer);\n ASSERT_THAT(writer.Push(kHello, sizeof(kHello)), IsTrue());\n\n LengthDelimitedRingBufferReader reader(ring_buffer);\n std::vector result;\n EXPECT_THAT(reader.Pop(result), IsTrue());\n const std::vector expected_first = {0x68, 0x65, 0x6c, 0x6c, 0x6f};\n EXPECT_THAT(result, Eq(expected_first));\n}\n\nTEST(LengthDelimitedRingBufferTest, PushLargerThanBufferSizeShouldFail) {\n RingBufferData<4> ring_buffer;\n LengthDelimitedRingBufferWriter writer(ring_buffer);\n EXPECT_THAT(writer.Push(kHello, sizeof(kHello)), IsFalse());\n}\n\nTEST(LengthDelimitedRingBufferTest,\n PushUntilFullThenPopUntilEmptyShouldReturnInFIFOOrder) {\n RingBufferData<4> ring_buffer;\n LengthDelimitedRingBufferWriter writer(ring_buffer);\n constexpr uint8_t a = 0x41;\n EXPECT_THAT(writer.Push(&a, sizeof(a)),\n IsTrue()); // Writes 2 bytes (1 for length)\n constexpr uint8_t b = 0x42;\n EXPECT_THAT(writer.Push(&b, sizeof(b)),\n IsTrue()); // Writes 2 bytes (1 for length)\n\n LengthDelimitedRingBufferReader reader(ring_buffer);\n std::vector first;\n EXPECT_THAT(reader.Pop(first), IsTrue());\n const std::vector expected_first = {0x41};\n EXPECT_THAT(first, Eq(expected_first));\n\n std::vector second;\n EXPECT_THAT(reader.Pop(second), IsTrue());\n const std::vector expected_second = {0x42};\n EXPECT_THAT(second, Eq(expected_second));\n\n std::vector empty;\n EXPECT_THAT(reader.Pop(empty), IsFalse());\n}\n\nTEST(LengthDelimitedRingBufferTest,\n PushThenPopBuffersOfDifferingLengthsShouldReturnBuffers) {\n RingBufferData<5> ring_buffer;\n LengthDelimitedRingBufferWriter writer(ring_buffer);\n constexpr uint8_t ab[2] = {0x41, 0x42};\n EXPECT_THAT(writer.Push(ab, sizeof(ab)),\n IsTrue()); // Writes 3 bytes (1 for length)\n constexpr uint8_t c = 0x43;\n EXPECT_THAT(writer.Push(&c, sizeof(c)),\n IsTrue()); // Writes 2 bytes (1 for length)\n\n LengthDelimitedRingBufferReader reader(ring_buffer);\n std::vector first;\n EXPECT_THAT(reader.Pop(first), IsTrue());\n const std::vector expected_first = {0x41, 0x42};\n EXPECT_THAT(first, Eq(expected_first));\n\n std::vector second;\n EXPECT_THAT(reader.Pop(second), IsTrue());\n const std::vector expected_second = {0x43};\n EXPECT_THAT(second, Eq(expected_second));\n\n std::vector empty;\n EXPECT_THAT(reader.Pop(empty), IsFalse());\n}\n\nTEST(LengthDelimitedRingBufferDataTest, PushOnFullBufferShouldOverwriteOldest) {\n RingBufferData<4> ring_buffer;\n LengthDelimitedRingBufferWriter writer(ring_buffer);\n constexpr uint8_t a = 0x41;\n EXPECT_THAT(writer.Push(&a, sizeof(a)),\n IsTrue()); // Writes 2 bytes (1 for length)\n constexpr uint8_t b = 0x42;\n EXPECT_THAT(writer.Push(&b, sizeof(b)),\n IsTrue()); // Writes 2 bytes (1 for length)\n constexpr uint8_t c = 0x43;\n EXPECT_THAT(writer.Push(&c, sizeof(c)), IsTrue()); // Should overwrite \"A\"\n\n LengthDelimitedRingBufferReader reader(ring_buffer);\n std::vector first;\n EXPECT_THAT(reader.Pop(first), IsTrue());\n const std::vector expected_first = {uint8_t{0x42}};\n EXPECT_THAT(first, Eq(expected_first));\n\n std::vector second;\n EXPECT_THAT(reader.Pop(second), IsTrue());\n const std::vector expected_second = {uint8_t{0x43}};\n EXPECT_THAT(second, Eq(expected_second));\n}\n\nTEST(LengthDelimitedRingBufferDataTest,\n PushOnFullBufferShouldOverwriteMultipleOldest) {\n RingBufferData<4> ring_buffer;\n LengthDelimitedRingBufferWriter writer(ring_buffer);\n constexpr uint8_t a = 0x41;\n EXPECT_THAT(writer.Push(&a, sizeof(a)),\n IsTrue()); // Writes 2 bytes (1 for length)\n constexpr uint8_t b = 0x42;\n EXPECT_THAT(writer.Push(&b, sizeof(b)),\n IsTrue()); // Writes 2 bytes (1 for length)\n constexpr uint8_t cd[] = {0x43, 0x44};\n EXPECT_THAT(writer.Push(cd, sizeof(cd)),\n IsTrue()); // Needs 3 bytes; should overwrite \"A\" and \"B\"\n\n LengthDelimitedRingBufferReader reader(ring_buffer);\n std::vector first;\n EXPECT_THAT(reader.Pop(first), IsTrue());\n const std::vector expected_first = {0x43, 0x44};\n EXPECT_THAT(first, Eq(expected_first));\n\n std::vector empty;\n EXPECT_THAT(reader.Pop(empty), IsFalse());\n}\n\nTEST(LengthDelimitedRingBufferDataTest, PushThenPopWithLengthVarintTwoBytes) {\n RingBufferData ring_buffer;\n decltype(ring_buffer)::SizeType size = 150;\n std::string s(size, 'X');\n LengthDelimitedRingBufferWriter writer(ring_buffer);\n ASSERT_THAT(writer.Push(reinterpret_cast(s.c_str()), size),\n IsTrue());\n\n LengthDelimitedRingBufferReader reader(ring_buffer);\n std::vector first;\n EXPECT_THAT(reader.Pop(first), IsTrue());\n std::string result(reinterpret_cast(first.data()), first.size());\n EXPECT_THAT(result, Eq(s));\n}\n\nTEST(LengthDelimitedRingBufferDataTest, DeserializeFromTooShortShouldFail) {\n RingBufferData<1> ring_buffer;\n EXPECT_THAT(ring_buffer.DeserializeFromBuffer(nullptr, 0), IsFalse());\n}\n\nTEST(LengthDelimitedRingBufferDataTest, DeserializeFromTooLongShouldFail) {\n RingBufferData<1> ring_buffer;\n // This buffer is size 3; it won't fit in the template arg (size 1).\n EXPECT_THAT(ring_buffer.DeserializeFromBuffer(\n reinterpret_cast(kValidBufferSize3),\n kValidBufferSize3Len),\n IsFalse());\n}\n\nTEST(LengthDelimitedRingBufferDataTest,\n DeserializeFromInvalidVersionShouldFail) {\n RingBufferData<3> ring_buffer;\n EXPECT_THAT(ring_buffer.DeserializeFromBuffer(\n reinterpret_cast(kInvalidVersionBuffer),\n kInvalidVersionBufferLen),\n IsFalse());\n}\n\nTEST(LengthDelimitedRingBufferDataTest,\n DeserializeFromInvalidVarintLengthShouldSucceedButPopShouldFail) {\n RingBufferData ring_buffer;\n EXPECT_THAT(ring_buffer.DeserializeFromBuffer(\n reinterpret_cast(kInvalidBase128VarintBuffer),\n kInvalidBase128VarintBufferLen),\n IsTrue());\n LengthDelimitedRingBufferReader reader(ring_buffer);\n std::vector data;\n EXPECT_THAT(reader.Pop(data), IsFalse());\n}\n\nTEST(LengthDelimitedRingBufferDataTest,\n DeserializeFromInvalidVarintBitsShouldSucceedButPopShouldFail) {\n RingBufferData ring_buffer;\n EXPECT_THAT(ring_buffer.DeserializeFromBuffer(\n reinterpret_cast(\n kInvalidBase128VarintBits33And34SetBuffer),\n kInvalidBase128VarintBits33And34SetBufferLen),\n IsTrue());\n LengthDelimitedRingBufferReader reader(ring_buffer);\n std::vector data;\n EXPECT_THAT(reader.Pop(data), IsFalse());\n}\n\nTEST(LengthDelimitedRingBufferDataTest,\n DeserializeFromInvalidPayloadBufferTooShortShouldSucceedButPopShouldFail) {\n RingBufferData ring_buffer;\n EXPECT_THAT(\n ring_buffer.DeserializeFromBuffer(\n reinterpret_cast(kInvalidPayloadBufferTooShort),\n kInvalidPayloadBufferTooShortLen),\n IsTrue());\n LengthDelimitedRingBufferReader reader(ring_buffer);\n std::vector data;\n EXPECT_THAT(reader.Pop(data), IsFalse());\n}\n\nTEST(LengthDelimitedRingBufferDataTest,\n DeserializeFromFullBufferShouldSucceed) {\n RingBufferData<3> ring_buffer;\n EXPECT_THAT(ring_buffer.DeserializeFromBuffer(\n reinterpret_cast(kValidBufferSize3),\n kValidBufferSize3Len),\n IsTrue());\n LengthDelimitedRingBufferReader reader(ring_buffer);\n std::vector data;\n EXPECT_THAT(reader.Pop(data), IsTrue());\n const std::vector expected = {0x42, 0x23};\n EXPECT_THAT(data, Eq(expected));\n}\n\nTEST(LengthDelimitedRingBufferDataTest,\n DeserializeFromMidCrashBufferShouldSucceedButSubsequentPopShouldFail) {\n RingBufferData ring_buffer;\n EXPECT_THAT(ring_buffer.DeserializeFromBuffer(\n reinterpret_cast(kMidCrashBuffer),\n kMidCrashBufferLen),\n IsTrue());\n LengthDelimitedRingBufferReader reader(ring_buffer);\n // Pop should fail since the length was written to be 0.\n std::vector data;\n EXPECT_THAT(reader.Pop(data), IsFalse());\n}\n\n} // namespace\n} // namespace test\n} // namespace crashpad\n" }, { "path": "client/prune_crash_reports.cc", "content": "// Copyright 2015 The Crashpad Authors\n//\n// Licensed under the Apache License, Version 2.0 (the \"License\");\n// you may not use this file except in compliance with the License.\n// You may obtain a copy of the License at\n//\n// http://www.apache.org/licenses/LICENSE-2.0\n//\n// Unless required by applicable law or agreed to in writing, software\n// distributed under the License is distributed on an \"AS IS\" BASIS,\n// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n// See the License for the specific language governing permissions and\n// limitations under the License.\n\n#include \"client/prune_crash_reports.h\"\n\n#include \n#include \n\n#include \n#include \n\n#include \"base/logging.h\"\n#include \"base/notreached.h\"\n#include \"build/build_config.h\"\n\nnamespace crashpad {\n\nsize_t PruneCrashReportDatabase(CrashReportDatabase* database,\n PruneCondition* condition) {\n std::vector all_reports;\n CrashReportDatabase::OperationStatus status;\n\n status = database->GetPendingReports(&all_reports);\n if (status != CrashReportDatabase::kNoError) {\n LOG(ERROR) << \"PruneCrashReportDatabase: Failed to get pending reports\";\n return 0;\n }\n\n std::vector completed_reports;\n status = database->GetCompletedReports(&completed_reports);\n if (status != CrashReportDatabase::kNoError) {\n LOG(ERROR) << \"PruneCrashReportDatabase: Failed to get completed reports\";\n return 0;\n }\n all_reports.insert(all_reports.end(), completed_reports.begin(),\n completed_reports.end());\n\n std::sort(all_reports.begin(), all_reports.end(),\n [](const CrashReportDatabase::Report& lhs,\n const CrashReportDatabase::Report& rhs) {\n return lhs.creation_time > rhs.creation_time;\n });\n\n size_t num_pruned = 0;\n for (const auto& report : all_reports) {\n if (condition->ShouldPruneReport(report)) {\n status = database->DeleteReport(report.uuid);\n if (status != CrashReportDatabase::kNoError) {\n LOG(ERROR) << \"Database Pruning: Failed to remove report \"\n << report.uuid.ToString();\n } else {\n num_pruned++;\n }\n }\n }\n\n return num_pruned;\n\n // TODO(rsesek): For databases that do not use a directory structure, it is\n // possible for the metadata sidecar to become corrupted and thus leave\n // orphaned crash report files on-disk. https://crashpad.chromium.org/bug/66\n}\n\n// static\nstd::unique_ptr PruneCondition::GetDefault() {\n // DatabaseSizePruneCondition must be the LHS so that it is always evaluated,\n // due to the short-circuting behavior of BinaryPruneCondition.\n return std::make_unique(\n BinaryPruneCondition::OR,\n new DatabaseSizePruneCondition(1024 * 128),\n new AgePruneCondition(365));\n}\n\nstatic const time_t kSecondsInDay = 60 * 60 * 24;\n\nAgePruneCondition::AgePruneCondition(int max_age_in_days)\n : oldest_report_time_(\n ((time(nullptr) - (max_age_in_days * kSecondsInDay))\n / kSecondsInDay) * kSecondsInDay) {}\n\nAgePruneCondition::~AgePruneCondition() {}\n\nbool AgePruneCondition::ShouldPruneReport(\n const CrashReportDatabase::Report& report) {\n return report.creation_time < oldest_report_time_;\n}\n\nDatabaseSizePruneCondition::DatabaseSizePruneCondition(size_t max_size_in_kb)\n : max_size_in_kb_(max_size_in_kb), measured_size_in_kb_(0) {}\n\nDatabaseSizePruneCondition::~DatabaseSizePruneCondition() {}\n\nbool DatabaseSizePruneCondition::ShouldPruneReport(\n const CrashReportDatabase::Report& report) {\n // Round up fractional KB to the next 1-KB boundary.\n measured_size_in_kb_ +=\n static_cast((report.total_size + 1023) / 1024);\n return measured_size_in_kb_ > max_size_in_kb_;\n}\n\nBinaryPruneCondition::BinaryPruneCondition(\n Operator op, PruneCondition* lhs, PruneCondition* rhs)\n : op_(op), lhs_(lhs), rhs_(rhs) {}\n\nBinaryPruneCondition::~BinaryPruneCondition() {}\n\nbool BinaryPruneCondition::ShouldPruneReport(\n const CrashReportDatabase::Report& report) {\n switch (op_) {\n case AND:\n return lhs_->ShouldPruneReport(report) && rhs_->ShouldPruneReport(report);\n case OR:\n return lhs_->ShouldPruneReport(report) || rhs_->ShouldPruneReport(report);\n }\n NOTREACHED();\n}\n\n} // namespace crashpad\n" }, { "path": "client/prune_crash_reports.h", "content": "// Copyright 2015 The Crashpad Authors\n//\n// Licensed under the Apache License, Version 2.0 (the \"License\");\n// you may not use this file except in compliance with the License.\n// You may obtain a copy of the License at\n//\n// http://www.apache.org/licenses/LICENSE-2.0\n//\n// Unless required by applicable law or agreed to in writing, software\n// distributed under the License is distributed on an \"AS IS\" BASIS,\n// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n// See the License for the specific language governing permissions and\n// limitations under the License.\n\n#ifndef CRASHPAD_CLIENT_PRUNE_CRASH_REPORTS_H_\n#define CRASHPAD_CLIENT_PRUNE_CRASH_REPORTS_H_\n\n#include \n#include \n\n#include \n\n#include \"client/crash_report_database.h\"\n\nnamespace crashpad {\n\nclass PruneCondition;\n\n//! \\brief Deletes crash reports from \\a database that match \\a condition.\n//!\n//! This function can be used to remove old or large reports from the database.\n//! The \\a condition will be evaluated against each report in the \\a database,\n//! sorted in descending order by CrashReportDatabase::Report::creation_time.\n//! This guarantee allows conditions to be stateful.\n//!\n//! \\param[in] database The database from which crash reports will be deleted.\n//! \\param[in] condition The condition against which all reports in the database\n//! will be evaluated.\n//!\n//! \\return The number of deleted crash reports.\nsize_t PruneCrashReportDatabase(CrashReportDatabase* database,\n PruneCondition* condition);\n\nstd::unique_ptr GetDefaultDatabasePruneCondition();\n\n//! \\brief An abstract base class for evaluating crash reports for deletion.\n//!\n//! When passed to PruneCrashReportDatabase(), each crash report in the\n//! database will be evaluated according to ShouldPruneReport(). The reports\n//! are evaluated serially in descending sort order by\n//! CrashReportDatabase::Report::creation_time.\nclass PruneCondition {\n public:\n //! \\brief Returns a sensible default condition for removing obsolete crash\n //! reports.\n //!\n //! The default is to keep reports for one year or a maximum database size\n //! of 128 MB.\n //!\n //! \\return A PruneCondition for use with PruneCrashReportDatabase().\n static std::unique_ptr GetDefault();\n\n virtual ~PruneCondition() {}\n\n //! \\brief Evaluates a crash report for deletion.\n //!\n //! \\param[in] report The crash report to evaluate.\n //!\n //! \\return `true` if the crash report should be deleted, `false` if it\n //! should be kept.\n virtual bool ShouldPruneReport(const CrashReportDatabase::Report& report) = 0;\n};\n\n//! \\brief A PruneCondition that deletes reports older than the specified number\n//! days.\nclass AgePruneCondition final : public PruneCondition {\n public:\n //! \\brief Creates a PruneCondition based on Report::creation_time.\n //!\n //! \\param[in] max_age_in_days Reports created more than this many days ago\n //! will be deleted.\n explicit AgePruneCondition(int max_age_in_days);\n\n AgePruneCondition(const AgePruneCondition&) = delete;\n AgePruneCondition& operator=(const AgePruneCondition&) = delete;\n\n ~AgePruneCondition();\n\n bool ShouldPruneReport(const CrashReportDatabase::Report& report) override;\n\n private:\n const time_t oldest_report_time_;\n};\n\n//! \\brief A PruneCondition that deletes older reports to keep the total\n//! Crashpad database size under the specified limit.\nclass DatabaseSizePruneCondition final : public PruneCondition {\n public:\n //! \\brief Creates a PruneCondition that will keep newer reports, until the\n //! sum of the size of all reports is not smaller than \\a max_size_in_kb.\n //! After the limit is reached, older reports will be pruned.\n //!\n //! \\param[in] max_size_in_kb The maximum number of kilobytes that all crash\n //! reports should consume.\n explicit DatabaseSizePruneCondition(size_t max_size_in_kb);\n\n DatabaseSizePruneCondition(const DatabaseSizePruneCondition&) = delete;\n DatabaseSizePruneCondition& operator=(const DatabaseSizePruneCondition&) =\n delete;\n\n ~DatabaseSizePruneCondition();\n\n bool ShouldPruneReport(const CrashReportDatabase::Report& report) override;\n\n private:\n const size_t max_size_in_kb_;\n size_t measured_size_in_kb_;\n};\n\n//! \\brief A PruneCondition that conjoins two other PruneConditions.\nclass BinaryPruneCondition final : public PruneCondition {\n public:\n enum Operator {\n AND,\n OR,\n };\n\n //! \\brief Evaluates two sub-conditions according to the specified logical\n //! operator.\n //!\n //! This implements left-to-right evaluation. For Operator::AND, this means\n //! if the \\a lhs is `false`, the \\a rhs will not be consulted. Similarly,\n //! with Operator::OR, if the \\a lhs is `true`, the \\a rhs will not be\n //! consulted.\n //!\n //! \\param[in] op The logical operator to apply on \\a lhs and \\a rhs.\n //! \\param[in] lhs The left-hand side of \\a op. This class takes ownership.\n //! \\param[in] rhs The right-hand side of \\a op. This class takes ownership.\n BinaryPruneCondition(Operator op, PruneCondition* lhs, PruneCondition* rhs);\n\n BinaryPruneCondition(const BinaryPruneCondition&) = delete;\n BinaryPruneCondition& operator=(const BinaryPruneCondition&) = delete;\n\n ~BinaryPruneCondition();\n\n bool ShouldPruneReport(const CrashReportDatabase::Report& report) override;\n\n private:\n const Operator op_;\n std::unique_ptr lhs_;\n std::unique_ptr rhs_;\n};\n\n} // namespace crashpad\n\n#endif // CRASHPAD_CLIENT_PRUNE_CRASH_REPORTS_H_\n" }, { "path": "client/prune_crash_reports_test.cc", "content": "// Copyright 2015 The Crashpad Authors\n//\n// Licensed under the Apache License, Version 2.0 (the \"License\");\n// you may not use this file except in compliance with the License.\n// You may obtain a copy of the License at\n//\n// http://www.apache.org/licenses/LICENSE-2.0\n//\n// Unless required by applicable law or agreed to in writing, software\n// distributed under the License is distributed on an \"AS IS\" BASIS,\n// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n// See the License for the specific language governing permissions and\n// limitations under the License.\n\n#include \"client/prune_crash_reports.h\"\n\n#include \n#include \n#include \n\n#include \n#include \n#include \n#include \n\n#include \"base/numerics/safe_conversions.h\"\n#include \"gmock/gmock.h\"\n#include \"gtest/gtest.h\"\n#include \"test/scoped_temp_dir.h\"\n#include \"util/file/file_io.h\"\n\nnamespace crashpad {\nnamespace test {\nnamespace {\n\nclass MockDatabase : public CrashReportDatabase {\n public:\n // CrashReportDatabase:\n MOCK_METHOD(Settings*, GetSettings, (), (override));\n MOCK_METHOD(OperationStatus,\n PrepareNewCrashReport,\n (std::unique_ptr*),\n (override));\n MOCK_METHOD(OperationStatus,\n LookUpCrashReport,\n (const UUID&, Report*),\n (override));\n MOCK_METHOD(OperationStatus,\n GetPendingReports,\n (std::vector*),\n (override));\n MOCK_METHOD(OperationStatus,\n GetCompletedReports,\n (std::vector*),\n (override));\n MOCK_METHOD(OperationStatus,\n GetReportForUploading,\n (const UUID&,\n std::unique_ptr*,\n bool report_metrics),\n (override));\n MOCK_METHOD(OperationStatus,\n RecordUploadAttempt,\n (UploadReport*, bool, const std::string&),\n (override));\n MOCK_METHOD(OperationStatus,\n SkipReportUpload,\n (const UUID&, Metrics::CrashSkippedReason),\n (override));\n MOCK_METHOD(OperationStatus, DeleteReport, (const UUID&), (override));\n MOCK_METHOD(OperationStatus, RequestUpload, (const UUID&), (override));\n MOCK_METHOD(base::FilePath, DatabasePath, (), (override));\n\n // Google Mock doesn't support mocking methods with non-copyable types such as\n // unique_ptr.\n OperationStatus FinishedWritingCrashReport(std::unique_ptr report,\n UUID* uuid) override {\n return kNoError;\n }\n};\n\ntime_t NDaysAgo(int num_days) {\n return time(nullptr) - (num_days * 60 * 60 * 24);\n}\n\nTEST(PruneCrashReports, AgeCondition) {\n CrashReportDatabase::Report report_80_days;\n report_80_days.creation_time = NDaysAgo(80);\n\n CrashReportDatabase::Report report_10_days;\n report_10_days.creation_time = NDaysAgo(10);\n\n CrashReportDatabase::Report report_30_days;\n report_30_days.creation_time = NDaysAgo(30);\n\n AgePruneCondition condition(30);\n EXPECT_TRUE(condition.ShouldPruneReport(report_80_days));\n EXPECT_FALSE(condition.ShouldPruneReport(report_10_days));\n EXPECT_FALSE(condition.ShouldPruneReport(report_30_days));\n}\n\nTEST(PruneCrashReports, SizeCondition) {\n CrashReportDatabase::Report report_1k;\n report_1k.total_size = 1024u;\n CrashReportDatabase::Report report_3k;\n report_3k.total_size = 1024u * 3u;\n CrashReportDatabase::Report report_unset_size;\n\n {\n DatabaseSizePruneCondition condition(/*max_size_in_kb=*/1);\n // |report_1k| should not be pruned as the cumulated size is not past 1kB\n // yet.\n EXPECT_FALSE(condition.ShouldPruneReport(report_1k));\n // |report_3k| should be pruned as the cumulated size is now past 1kB.\n EXPECT_TRUE(condition.ShouldPruneReport(report_3k));\n }\n\n {\n DatabaseSizePruneCondition condition(/*max_size_in_kb=*/1);\n // |report_3k| should be pruned as the cumulated size is already past 1kB.\n EXPECT_TRUE(condition.ShouldPruneReport(report_3k));\n }\n\n {\n DatabaseSizePruneCondition condition(/*max_size_in_kb=*/6);\n // |report_3k| should not be pruned as the cumulated size is not past 6kB\n // yet.\n EXPECT_FALSE(condition.ShouldPruneReport(report_3k));\n // |report_3k| should not be pruned as the cumulated size is not past 6kB\n // yet.\n EXPECT_FALSE(condition.ShouldPruneReport(report_3k));\n // |report_1k| should be pruned as the cumulated size is now past 6kB.\n EXPECT_TRUE(condition.ShouldPruneReport(report_1k));\n }\n\n {\n DatabaseSizePruneCondition condition(/*max_size_in_kb=*/0);\n // |report_unset_size| should not be pruned as its size is 0, regardless of\n // how many times we try to prune it.\n EXPECT_FALSE(condition.ShouldPruneReport(report_unset_size));\n EXPECT_FALSE(condition.ShouldPruneReport(report_unset_size));\n EXPECT_FALSE(condition.ShouldPruneReport(report_unset_size));\n EXPECT_FALSE(condition.ShouldPruneReport(report_unset_size));\n EXPECT_FALSE(condition.ShouldPruneReport(report_unset_size));\n // |report_1k| should be pruned as the cumulated size is now past 0kB.\n EXPECT_TRUE(condition.ShouldPruneReport(report_1k));\n }\n}\n\nclass StaticCondition final : public PruneCondition {\n public:\n explicit StaticCondition(bool value) : value_(value), did_execute_(false) {}\n\n StaticCondition(const StaticCondition&) = delete;\n StaticCondition& operator=(const StaticCondition&) = delete;\n\n ~StaticCondition() {}\n\n bool ShouldPruneReport(const CrashReportDatabase::Report& report) override {\n did_execute_ = true;\n return value_;\n }\n\n bool did_execute() const { return did_execute_; }\n\n private:\n const bool value_;\n bool did_execute_;\n};\n\nTEST(PruneCrashReports, BinaryCondition) {\n static constexpr struct {\n const char* name;\n BinaryPruneCondition::Operator op;\n bool lhs_value;\n bool rhs_value;\n bool cond_result;\n bool lhs_executed;\n bool rhs_executed;\n } kTests[] = {\n // clang-format off\n {\"false && false\",\n BinaryPruneCondition::AND, false, false,\n false, true, false},\n {\"false && true\",\n BinaryPruneCondition::AND, false, true,\n false, true, false},\n {\"true && false\",\n BinaryPruneCondition::AND, true, false,\n false, true, true},\n {\"true && true\",\n BinaryPruneCondition::AND, true, true,\n true, true, true},\n {\"false || false\",\n BinaryPruneCondition::OR, false, false,\n false, true, true},\n {\"false || true\",\n BinaryPruneCondition::OR, false, true,\n true, true, true},\n {\"true || false\",\n BinaryPruneCondition::OR, true, false,\n true, true, false},\n {\"true || true\",\n BinaryPruneCondition::OR, true, true,\n true, true, false},\n // clang-format on\n };\n for (const auto& test : kTests) {\n SCOPED_TRACE(test.name);\n auto lhs = new StaticCondition(test.lhs_value);\n auto rhs = new StaticCondition(test.rhs_value);\n BinaryPruneCondition condition(test.op, lhs, rhs);\n CrashReportDatabase::Report report;\n EXPECT_EQ(condition.ShouldPruneReport(report), test.cond_result);\n EXPECT_EQ(lhs->did_execute(), test.lhs_executed);\n EXPECT_EQ(rhs->did_execute(), test.rhs_executed);\n }\n}\n\nMATCHER_P(TestUUID, data_1, \"\") {\n return arg.data_1 == data_1;\n}\n\nTEST(PruneCrashReports, PruneOrder) {\n using ::testing::_;\n using ::testing::DoAll;\n using ::testing::Return;\n using ::testing::SetArgPointee;\n\n const size_t kNumReports = 10;\n std::vector reports;\n for (size_t i = 0; i < kNumReports; ++i) {\n CrashReportDatabase::Report temp;\n temp.uuid.data_1 = static_cast(i);\n temp.creation_time = NDaysAgo(static_cast(i) * 10);\n reports.push_back(temp);\n }\n std::mt19937 urng(std::random_device{}());\n std::shuffle(reports.begin(), reports.end(), urng);\n std::vector pending_reports(reports.begin(),\n reports.begin() + 5);\n std::vector completed_reports(\n reports.begin() + 5, reports.end());\n\n MockDatabase db;\n EXPECT_CALL(db, GetPendingReports(_))\n .WillOnce(DoAll(SetArgPointee<0>(pending_reports),\n Return(CrashReportDatabase::kNoError)));\n EXPECT_CALL(db, GetCompletedReports(_))\n .WillOnce(DoAll(SetArgPointee<0>(completed_reports),\n Return(CrashReportDatabase::kNoError)));\n for (size_t i = 0; i < reports.size(); ++i) {\n EXPECT_CALL(db, DeleteReport(TestUUID(i)))\n .WillOnce(Return(CrashReportDatabase::kNoError));\n }\n\n StaticCondition delete_all(true);\n EXPECT_EQ(PruneCrashReportDatabase(&db, &delete_all), kNumReports);\n}\n\n} // namespace\n} // namespace test\n} // namespace crashpad\n" }, { "path": "client/pthread_create_linux.cc", "content": "// Copyright 2020 The Crashpad Authors\n//\n// Licensed under the Apache License, Version 2.0 (the \"License\");\n// you may not use this file except in compliance with the License.\n// You may obtain a copy of the License at\n//\n// http://www.apache.org/licenses/LICENSE-2.0\n//\n// Unless required by applicable law or agreed to in writing, software\n// distributed under the License is distributed on an \"AS IS\" BASIS,\n// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n// See the License for the specific language governing permissions and\n// limitations under the License.\n\n#include \n#include \n\n#include \"base/check.h\"\n#include \"base/logging.h\"\n#include \"client/crashpad_client.h\"\n#include \"util/misc/no_cfi_icall.h\"\n\nnamespace {\n\nusing StartRoutineType = void* (*)(void*);\n\nstruct StartParams {\n StartRoutineType start_routine;\n void* arg;\n};\n\nvoid* InitializeSignalStackAndStart(StartParams* params) {\n crashpad::CrashpadClient::InitializeSignalStackForThread();\n\n crashpad::NoCfiIcall start_routine(params->start_routine);\n void* arg = params->arg;\n delete params;\n\n return start_routine(arg);\n}\n\n} // namespace\n\nextern \"C\" {\n\n__attribute__((visibility(\"default\"))) int pthread_create(\n pthread_t* thread,\n const pthread_attr_t* attr,\n StartRoutineType start_routine,\n void* arg) {\n static const crashpad::NoCfiIcall\n next_pthread_create([]() {\n const auto next_pthread_create = dlsym(RTLD_NEXT, \"pthread_create\");\n CHECK(next_pthread_create) << \"dlsym: \" << dlerror();\n return next_pthread_create;\n }());\n\n StartParams* params = new StartParams;\n params->start_routine = start_routine;\n params->arg = arg;\n\n int result = next_pthread_create(\n thread,\n attr,\n reinterpret_cast(InitializeSignalStackAndStart),\n params);\n if (result != 0) {\n delete params;\n }\n return result;\n}\n\n} // extern \"C\"\n" }, { "path": "client/ring_buffer_annotation.h", "content": "// Copyright 2023 The Crashpad Authors\n//\n// Licensed under the Apache License, Version 2.0 (the \"License\");\n// you may not use this file except in compliance with the License.\n// You may obtain a copy of the License at\n//\n// http://www.apache.org/licenses/LICENSE-2.0\n//\n// Unless required by applicable law or agreed to in writing, software\n// distributed under the License is distributed on an \"AS IS\" BASIS,\n// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n// See the License for the specific language governing permissions and\n// limitations under the License.\n\n#ifndef CRASHPAD_CLIENT_RING_BUFFER_ANNOTATION_H_\n#define CRASHPAD_CLIENT_RING_BUFFER_ANNOTATION_H_\n\n#include \n\n#include \"client/annotation.h\"\n#include \"client/length_delimited_ring_buffer.h\"\n\nnamespace crashpad {\n\n//! \\brief Capacity of `RingBufferAnnotation`, in bytes.\nusing RingBufferAnnotationCapacity = RingBufferCapacity;\n\nnamespace internal {\n\n//! \\brief Default capacity of `RingBufferAnnotation`, in bytes.\ninline constexpr RingBufferAnnotationCapacity\n kDefaultRingBufferAnnotationCapacity = 8192;\n\n} // namespace internal\n\n//! \\brief An `Annotation` which wraps a `LengthDelimitedRingBuffer`\n//! of up to `Capacity` bytes in length.\n//!\n//! Supports writing variable-length data via `Push()`. When the ring buffer is\n//! full, it will drop old data items in FIFO order until enough space is\n//! available for the write.\n//!\n//! Supports guarding concurrent reads from writes via `ScopedSpinGuard`, so\n//! writing to this object is thread-safe.\n//!\n//! Clients which read this `Annotation`'s memory can optionally invoke\n//! `TryCreateScopedSpinGuard()` on this object to ensure any pending write\n//! finishes before the memory is read.\n//!\n//! Each item in this ring buffer is delimited by its length encoded in\n//! little-endian Base 128 varint encoding.\n//!\n//! `RingBufferAnnotation` uses varint-encoded delimiters to enable\n//! zero-copy deserialization of the ringbuffer's contents when storing\n//! protobufs inside the ringbuffer, e.g. via\n//! `google::protobuf::util::ParseDelimitedFromZeroCopyStream()` or similar.\n//!\n//! \\sa\n//! https://github.com/protocolbuffers/protobuf/blob/3202b9da88ceb75b65bbabaf4033c95e872f828d/src/google/protobuf/util/delimited_message_util.h#L85\n//! \\sa\n//! https://github.com/protocolbuffers/protobuf/blob/8bd49dea5e167a389d94b71d24c981d8f9fa0c99/src/google/protobuf/io/zero_copy_stream_impl_lite.h#L68\n//! \\sa\n//! https://github.com/protocolbuffers/protobuf/blob/8bd49dea5e167a389d94b71d24c981d8f9fa0c99/src/google/protobuf/io/coded_stream.h#L171\n//!\n//! To deserialize the items stored in this annotation, use\n//! `LengthDelimitedRingBufferReader`.\ntemplate \nclass RingBufferAnnotation final : public Annotation {\n public:\n //! \\brief Constructs a `RingBufferAnnotation`.\n //! \\param[in] type A unique identifier for the type of data in the ring\n //! buffer.\n //! \\param[in] name The name of the annotation.\n constexpr RingBufferAnnotation(Annotation::Type type, const char name[])\n : Annotation(type,\n name,\n reinterpret_cast(&ring_buffer_data_),\n ConcurrentAccessGuardMode::kScopedSpinGuard),\n ring_buffer_data_(),\n ring_buffer_writer_(ring_buffer_data_) {}\n RingBufferAnnotation(const RingBufferAnnotation&) = delete;\n RingBufferAnnotation& operator=(const RingBufferAnnotation&) = delete;\n RingBufferAnnotation(RingBufferAnnotation&&) = default;\n RingBufferAnnotation& operator=(RingBufferAnnotation&&) = default;\n\n //! \\brief Pushes data onto this annotation's ring buffer.\n //!\n //! If the ring buffer does not have enough space to store `buffer_length`\n //! bytes of data, old data items are dropped in FIFO order until\n //! enough space is available to store the new data.\n bool Push(const void* const buffer,\n RingBufferAnnotationCapacity buffer_length) {\n // Use a zero timeout so the operation immediately fails if another thread\n // or process is currently reading this Annotation.\n constexpr uint64_t kSpinGuardTimeoutNanoseconds = 0;\n\n auto spin_guard = TryCreateScopedSpinGuard(kSpinGuardTimeoutNanoseconds);\n if (!spin_guard) {\n return false;\n }\n bool success = ring_buffer_writer_.Push(buffer, buffer_length);\n if (success) {\n SetSize(ring_buffer_data_.GetRingBufferLength());\n }\n return success;\n }\n\n //! \\brief Reset the annotation (e.g., for testing).\n //! This method is not thread-safe.\n void ResetForTesting() {\n ring_buffer_data_.ResetForTesting();\n ring_buffer_writer_.ResetForTesting();\n }\n\n private:\n using RingBufferWriter =\n LengthDelimitedRingBufferWriter>;\n\n //! \\brief The ring buffer data stored in this Anotation.\n RingBufferData ring_buffer_data_;\n\n //! \\brief The writer which wraps `ring_buffer_data_`.\n RingBufferWriter ring_buffer_writer_;\n};\n\n// Allow just `RingBufferAnnotation foo;` to be declared without template\n// arguments using C++17 class template argument deduction.\ntemplate \nRingBufferAnnotation(Annotation::Type type, const char name[])\n -> RingBufferAnnotation;\n\n} // namespace crashpad\n\n#endif // CRASHPAD_CLIENT_RING_BUFFER_ANNOTATION_H_\n" }, { "path": "client/ring_buffer_annotation_load_test_main.cc", "content": "// Copyright 2023 The Crashpad Authors\n//\n// Licensed under the Apache License, Version 2.0 (the \"License\");\n// you may not use this file except in compliance with the License.\n// You may obtain a copy of the License at\n//\n// http://www.apache.org/licenses/LICENSE-2.0\n//\n// Unless required by applicable law or agreed to in writing, software\n// distributed under the License is distributed on an \"AS IS\" BASIS,\n// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n// See the License for the specific language governing permissions and\n// limitations under the License.\n\n#include \n#include \n#include \n#include \n#include \n\n#include \n#include \n#include \n#include \n#include \n#include \n#include \n#include \n#include \n\n#include \"base/notreached.h\"\n#include \"base/strings/string_number_conversions.h\"\n#include \"base/strings/stringprintf.h\"\n#include \"build/build_config.h\"\n#include \"client/annotation.h\"\n#include \"client/length_delimited_ring_buffer.h\"\n#include \"client/ring_buffer_annotation.h\"\n#include \"tools/tool_support.h\"\n#include \"util/stdlib/string_number_conversion.h\"\n#include \"util/synchronization/scoped_spin_guard.h\"\n#include \"util/thread/thread.h\"\n\n#if BUILDFLAG(IS_WIN)\n#include \n#else\n#include \n#endif // BUILDFLAG(IS_WIN)\n\nnamespace crashpad {\n\nnamespace test {\n\nnamespace {\n\nconstexpr Annotation::Type kRingBufferLoadTestType =\n Annotation::UserDefinedType(0x0042);\nstd::atomic g_should_exit = false;\n\nstruct RingBufferAnnotationSnapshotParams final {\n enum class Mode {\n kUseScopedSpinGuard = 1,\n kDoNotUseSpinGuard = 2,\n };\n Mode mode = Mode::kUseScopedSpinGuard;\n using Duration = std::chrono::duration;\n Duration producer_thread_min_run_duration = std::chrono::milliseconds(1);\n Duration producer_thread_max_run_duration = std::chrono::milliseconds(10);\n Duration producer_thread_sleep_duration = std::chrono::nanoseconds(10);\n Duration consumer_thread_min_run_duration = std::chrono::milliseconds(5);\n Duration consumer_thread_max_run_duration = std::chrono::milliseconds(100);\n Duration quiesce_timeout = std::chrono::microseconds(500);\n uint64_t num_loops = std::numeric_limits::max();\n std::optional main_thread_run_duration = std::nullopt;\n};\n\ntemplate \nclass RingBufferAnnotationSnapshot final {\n using RingBufferAnnotationType = RingBufferAnnotation;\n\n struct State final {\n State()\n : ring_buffer_annotation(kRingBufferLoadTestType,\n \"ring-buffer-load-test\"),\n ring_buffer_ready(false),\n producer_thread_running(false),\n producer_thread_finished(false),\n consumer_thread_finished(false),\n should_exit(false) {}\n\n State(const State&) = delete;\n State& operator=(const State&) = delete;\n\n RingBufferAnnotationType ring_buffer_annotation;\n bool ring_buffer_ready;\n bool producer_thread_running;\n bool producer_thread_finished;\n bool consumer_thread_finished;\n bool should_exit;\n };\n\n class Thread final : public crashpad::Thread {\n public:\n Thread(std::function thread_main)\n : thread_main_(std::move(thread_main)) {}\n\n private:\n void ThreadMain() override { thread_main_(); }\n\n const std::function thread_main_;\n };\n\n public:\n RingBufferAnnotationSnapshot(const RingBufferAnnotationSnapshotParams& params)\n : params_(params),\n main_loop_thread_([this]() { MainLoopThreadMain(); }),\n producer_thread_([this]() { ProducerThreadMain(); }),\n consumer_thread_([this]() { ConsumerThreadMain(); }),\n mutex_(),\n state_changed_condition_(),\n state_() {}\n\n RingBufferAnnotationSnapshot(const RingBufferAnnotationSnapshot&) = delete;\n RingBufferAnnotationSnapshot& operator=(const RingBufferAnnotationSnapshot&) =\n delete;\n\n void Start() {\n main_loop_thread_.Start();\n producer_thread_.Start();\n consumer_thread_.Start();\n }\n\n void Stop() {\n consumer_thread_.Join();\n producer_thread_.Join();\n main_loop_thread_.Join();\n }\n\n private:\n void MainLoopThreadMain() {\n std::chrono::steady_clock::time_point main_thread_end_time;\n if (params_.main_thread_run_duration) {\n main_thread_end_time =\n std::chrono::steady_clock::now() + *params_.main_thread_run_duration;\n } else {\n main_thread_end_time = std::chrono::steady_clock::time_point::max();\n }\n for (uint64_t i = 0;\n i < params_.num_loops &&\n std::chrono::steady_clock::now() < main_thread_end_time;\n i++) {\n {\n std::unique_lock start_lock(mutex_);\n state_.ring_buffer_annotation.ResetForTesting();\n state_.ring_buffer_ready = true;\n state_changed_condition_.notify_all();\n }\n\n {\n std::unique_lock lock(mutex_);\n state_changed_condition_.wait(lock, [this] {\n return state_.producer_thread_finished &&\n state_.consumer_thread_finished;\n });\n state_.ring_buffer_ready = false;\n if (g_should_exit) {\n printf(\"Exiting on Control-C.\\n\");\n break;\n }\n printf(\".\");\n fflush(stdout);\n state_changed_condition_.notify_all();\n }\n }\n state_.should_exit = true;\n state_changed_condition_.notify_all();\n }\n\n void ProducerThreadMain() {\n while (true) {\n {\n std::unique_lock lock(mutex_);\n state_changed_condition_.wait(lock, [this] {\n return state_.should_exit || state_.ring_buffer_ready;\n });\n if (state_.should_exit) {\n return;\n }\n state_.producer_thread_running = true;\n state_.producer_thread_finished = false;\n state_changed_condition_.notify_all();\n }\n\n auto min_run_duration_micros =\n std::chrono::duration_cast(\n params_.producer_thread_min_run_duration);\n auto max_run_duration_micros =\n std::chrono::duration_cast(\n params_.producer_thread_max_run_duration);\n std::uniform_int_distribution\n run_duration_distribution(min_run_duration_micros.count(),\n max_run_duration_micros.count());\n static thread_local std::mt19937 random_number_generator;\n auto run_duration = std::chrono::microseconds(\n run_duration_distribution(random_number_generator));\n auto end_time = std::chrono::steady_clock::now() + run_duration;\n uint64_t next_value = 0;\n while (std::chrono::steady_clock::now() < end_time) {\n if (!Produce(next_value++)) {\n // The consumer thread interrupted this.\n break;\n }\n }\n {\n std::unique_lock lock(mutex_);\n state_changed_condition_.wait(\n lock, [this] { return state_.consumer_thread_finished; });\n state_.producer_thread_running = false;\n state_.producer_thread_finished = true;\n state_changed_condition_.notify_all();\n }\n }\n }\n\n bool Produce(uint64_t value) {\n std::string hex_value = base::StringPrintf(\"0x%08\" PRIx64, value);\n if (!state_.ring_buffer_annotation.Push(\n hex_value.data(), static_cast(hex_value.size()))) {\n fprintf(stderr,\n \"Ignoring failed call to Push(0x%\" PRIx64\n \") (ScopedSpinGuard was held by snapshot thread)\\n\",\n value);\n return false;\n }\n return true;\n }\n\n void ConsumerThreadMain() {\n while (true) {\n {\n std::unique_lock lock(mutex_);\n state_changed_condition_.wait(lock, [this] {\n return state_.should_exit ||\n (state_.ring_buffer_ready && state_.producer_thread_running);\n });\n if (state_.should_exit) {\n return;\n }\n state_.consumer_thread_finished = false;\n state_changed_condition_.notify_all();\n }\n auto min_run_duration_micros =\n std::chrono::duration_cast(\n params_.consumer_thread_min_run_duration);\n auto max_run_duration_micros =\n std::chrono::duration_cast(\n params_.consumer_thread_max_run_duration);\n std::uniform_int_distribution\n run_duration_distribution(min_run_duration_micros.count(),\n max_run_duration_micros.count());\n static thread_local std::mt19937 random_number_generator;\n auto run_duration = std::chrono::microseconds(\n run_duration_distribution(random_number_generator));\n auto end_time = std::chrono::steady_clock::now() + run_duration;\n while (std::chrono::steady_clock::now() < end_time) {\n constexpr uint64_t kSleepTimeNs = 10000; // 10 us\n SleepNanoseconds(kSleepTimeNs);\n }\n Snapshot();\n {\n std::unique_lock lock(mutex_);\n state_.consumer_thread_finished = true;\n state_.ring_buffer_ready = false;\n state_changed_condition_.notify_all();\n }\n }\n }\n\n void Snapshot() {\n int64_t timeout_ns = static_cast(\n std::chrono::duration_cast(\n params_.quiesce_timeout)\n .count());\n uint8_t serialized_ring_buffer[sizeof(state_.ring_buffer_annotation)];\n Annotation::ValueSizeType ring_buffer_size;\n {\n std::optional scoped_spin_guard;\n if (params_.mode ==\n RingBufferAnnotationSnapshotParams::Mode::kUseScopedSpinGuard) {\n scoped_spin_guard =\n state_.ring_buffer_annotation.TryCreateScopedSpinGuard(timeout_ns);\n }\n if (params_.mode ==\n RingBufferAnnotationSnapshotParams::Mode::kUseScopedSpinGuard &&\n !scoped_spin_guard) {\n fprintf(stderr,\n \"Could not quiesce writes within %\" PRIi64 \" ns\\n\",\n timeout_ns);\n abort();\n }\n ring_buffer_size = state_.ring_buffer_annotation.size();\n memcpy(&serialized_ring_buffer[0],\n state_.ring_buffer_annotation.value(),\n ring_buffer_size);\n }\n RingBufferData ring_buffer;\n if (!ring_buffer.DeserializeFromBuffer(serialized_ring_buffer,\n ring_buffer_size)) {\n fprintf(stderr, \"Could not deserialize ring buffer\\n\");\n abort();\n }\n LengthDelimitedRingBufferReader ring_buffer_reader(ring_buffer);\n int value = std::numeric_limits::max();\n std::vector bytes;\n while (ring_buffer_reader.Pop(bytes)) {\n int next_value;\n std::string_view str(reinterpret_cast(&bytes[0]),\n bytes.size());\n if (!base::HexStringToInt(str, &next_value)) {\n fprintf(stderr,\n \"Couldn't parse value: [%.*s]\\n\",\n base::checked_cast(bytes.size()),\n bytes.data());\n abort();\n }\n if (value == std::numeric_limits::max()) {\n // First value in buffer.\n } else if (value + 1 != next_value) {\n fprintf(stderr,\n \"Expected value 0x%08x, got 0x%08x\\n\",\n value + 1,\n next_value);\n abort();\n }\n value = next_value;\n bytes.clear();\n }\n }\n\n const RingBufferAnnotationSnapshotParams params_;\n Thread main_loop_thread_;\n Thread producer_thread_;\n Thread consumer_thread_;\n std::mutex mutex_;\n\n // Fired whenever `state_` changes.\n std::condition_variable state_changed_condition_;\n\n // Protected by `mutex_`.\n State state_;\n};\n\nvoid Usage(const base::FilePath& me) {\n // clang-format off\n fprintf(stderr,\n\"Usage: %\" PRFilePath \" [OPTION]...\\n\"\n\"Runs a load test for concurrent I/O to RingBufferAnnotation.\\n\"\n\"\\n\"\n\"By default, enables the annotation spin guard and runs indefinitely\\n\"\n\"until interrupted (e.g., with Control-C or SIGINT).\\n\"\n\"\\n\"\n\" -d,--disable-spin-guard Disables the annotation spin guard\\n\"\n\" (the test is expected to crash in this case)\\n\"\n\" -n,--num-loops=N Runs the test for N iterations, not indefinitely\\n\"\n\" -s,--duration-secs=SECS Runs the test for SECS seconds, not indefinitely\\n\",\n me.value().c_str());\n // clang-format on\n ToolSupport::UsageTail(me);\n}\n\nint TestMain(int argc, char** argv) {\n const base::FilePath argv0(\n ToolSupport::CommandLineArgumentToFilePathStringType(argv[0]));\n const base::FilePath me(argv0.BaseName());\n\n#if BUILDFLAG(IS_WIN)\n auto handler_routine = [](DWORD type) -> BOOL {\n if (type == CTRL_C_EVENT) {\n g_should_exit = true;\n return TRUE;\n }\n return FALSE;\n };\n if (!SetConsoleCtrlHandler(handler_routine, /*Add=*/TRUE)) {\n fprintf(stderr, \"Couldn't set Control-C handler\\n\");\n return EXIT_FAILURE;\n }\n#else\n signal(SIGINT, [](int signal) { g_should_exit = true; });\n#endif // BUILDFLAG(IS_WIN)\n RingBufferAnnotationSnapshotParams params;\n enum OptionFlags {\n // \"Short\" (single-character) options.\n kOptionDisableSpinGuard = 'd',\n kOptionNumLoops = 'n',\n kOptionDurationSecs = 's',\n\n // Standard options.\n kOptionHelp = -2,\n kOptionVersion = -3,\n };\n static constexpr option long_options[] = {\n {\"disable-spin-guard\", no_argument, nullptr, kOptionDisableSpinGuard},\n {\"num-loops\", required_argument, nullptr, kOptionNumLoops},\n {\"duration-secs\", required_argument, nullptr, kOptionDurationSecs},\n {\"help\", no_argument, nullptr, kOptionHelp},\n {\"version\", no_argument, nullptr, kOptionVersion},\n {nullptr, 0, nullptr, 0},\n };\n\n int opt;\n while ((opt = getopt_long(argc, argv, \"dn:s:\", long_options, nullptr)) !=\n -1) {\n switch (opt) {\n case kOptionDisableSpinGuard:\n printf(\"Disabling spin guard logic (this test will fail!)\\n\");\n params.mode =\n RingBufferAnnotationSnapshotParams::Mode::kDoNotUseSpinGuard;\n break;\n case kOptionNumLoops: {\n std::string num_loops(optarg);\n uint64_t num_loops_value;\n if (!StringToNumber(num_loops, &num_loops_value)) {\n ToolSupport::UsageHint(me, \"--num-loops requires integer value\");\n return EXIT_FAILURE;\n }\n params.num_loops = num_loops_value;\n break;\n }\n case kOptionDurationSecs: {\n std::string duration_secs(optarg);\n uint64_t duration_secs_value;\n if (!StringToNumber(duration_secs, &duration_secs_value)) {\n ToolSupport::UsageHint(me, \"--duration-secs requires integer value\");\n return EXIT_FAILURE;\n }\n params.main_thread_run_duration =\n std::chrono::seconds(duration_secs_value);\n break;\n }\n case kOptionHelp:\n Usage(me);\n return EXIT_SUCCESS;\n case kOptionVersion:\n ToolSupport::Version(me);\n return EXIT_SUCCESS;\n default:\n ToolSupport::UsageHint(me, nullptr);\n return EXIT_FAILURE;\n }\n }\n\n RingBufferAnnotationSnapshot<8192> test_producer_snapshot(params);\n printf(\"Starting test (Control-C to exit)...\\n\");\n test_producer_snapshot.Start();\n test_producer_snapshot.Stop();\n printf(\"Test finished.\\n\");\n return EXIT_SUCCESS;\n}\n\n} // namespace\n} // namespace test\n} // namespace crashpad\n\n#if BUILDFLAG(IS_POSIX)\n\nint main(int argc, char** argv) {\n return crashpad::test::TestMain(argc, argv);\n}\n\n#elif BUILDFLAG(IS_WIN)\n\nint wmain(int argc, wchar_t* argv[]) {\n return crashpad::ToolSupport::Wmain(argc, argv, crashpad::test::TestMain);\n}\n\n#endif\n" }, { "path": "client/ring_buffer_annotation_test.cc", "content": "// Copyright 2023 The Crashpad Authors\n//\n// Licensed under the Apache License, Version 2.0 (the \"License\");\n// you may not use this file except in compliance with the License.\n// You may obtain a copy of the License at\n//\n// http://www.apache.org/licenses/LICENSE-2.0\n//\n// Unless required by applicable law or agreed to in writing, software\n// distributed under the License is distributed on an \"AS IS\" BASIS,\n// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n// See the License for the specific language governing permissions and\n// limitations under the License.\n\n#include \"client/ring_buffer_annotation.h\"\n#include \"client/length_delimited_ring_buffer.h\"\n\n#include \n#include \n\n#include \"client/annotation_list.h\"\n#include \"client/crashpad_info.h\"\n#include \"gtest/gtest.h\"\n#include \"test/gtest_death.h\"\n\nnamespace crashpad {\nnamespace test {\nnamespace {\n\nconstexpr uint32_t kRingBufferHeaderSize = 16;\nconstexpr uint32_t kLengthDelimiter1ByteSize = 1;\n\nclass RingBufferAnnotationTest : public testing::Test {\n public:\n void SetUp() override {\n CrashpadInfo::GetCrashpadInfo()->set_annotations_list(&annotations_);\n }\n\n void TearDown() override {\n CrashpadInfo::GetCrashpadInfo()->set_annotations_list(nullptr);\n }\n\n size_t AnnotationsCount() {\n size_t result = 0;\n for (auto* annotation : annotations_) {\n if (annotation->is_set())\n ++result;\n }\n return result;\n }\n\n protected:\n AnnotationList annotations_;\n};\n\nTEST_F(RingBufferAnnotationTest, Basics) {\n constexpr Annotation::Type kType = Annotation::UserDefinedType(1);\n\n constexpr char kName[] = \"annotation 1\";\n RingBufferAnnotation annotation(kType, kName);\n\n EXPECT_FALSE(annotation.is_set());\n EXPECT_EQ(0u, AnnotationsCount());\n\n EXPECT_EQ(kType, annotation.type());\n EXPECT_EQ(0u, annotation.size());\n EXPECT_EQ(std::string(kName), annotation.name());\n\n EXPECT_TRUE(\n annotation.Push(reinterpret_cast(\"0123456789\"), 10));\n\n EXPECT_TRUE(annotation.is_set());\n EXPECT_EQ(1u, AnnotationsCount());\n\n constexpr Annotation::ValueSizeType kExpectedSize =\n kRingBufferHeaderSize + kLengthDelimiter1ByteSize + 10u;\n EXPECT_EQ(kExpectedSize, annotation.size());\n EXPECT_EQ(&annotation, *annotations_.begin());\n\n RingBufferData data;\n EXPECT_TRUE(\n data.DeserializeFromBuffer(annotation.value(), annotation.size()));\n EXPECT_EQ(kExpectedSize, data.GetRingBufferLength());\n\n std::vector popped_value;\n LengthDelimitedRingBufferReader reader(data);\n EXPECT_TRUE(reader.Pop(popped_value));\n\n const std::vector expected = {\n '0', '1', '2', '3', '4', '5', '6', '7', '8', '9'};\n EXPECT_EQ(expected, popped_value);\n\n annotation.Clear();\n\n EXPECT_FALSE(annotation.is_set());\n EXPECT_EQ(0u, AnnotationsCount());\n\n EXPECT_EQ(0u, annotation.size());\n}\n\nTEST_F(RingBufferAnnotationTest, MultiplePushesWithoutWrapping) {\n constexpr Annotation::Type kType = Annotation::UserDefinedType(1);\n\n constexpr char kName[] = \"annotation 1\";\n RingBufferAnnotation annotation(kType, kName);\n\n EXPECT_TRUE(\n annotation.Push(reinterpret_cast(\"0123456789\"), 10));\n EXPECT_TRUE(annotation.Push(reinterpret_cast(\"ABCDEF\"), 6));\n\n EXPECT_TRUE(annotation.is_set());\n EXPECT_EQ(1u, AnnotationsCount());\n\n constexpr Annotation::ValueSizeType kExpectedSize =\n kRingBufferHeaderSize + kLengthDelimiter1ByteSize + 10u +\n kLengthDelimiter1ByteSize + 6u;\n EXPECT_EQ(kExpectedSize, annotation.size());\n EXPECT_EQ(&annotation, *annotations_.begin());\n\n RingBufferData data;\n EXPECT_TRUE(\n data.DeserializeFromBuffer(annotation.value(), annotation.size()));\n EXPECT_EQ(kExpectedSize, data.GetRingBufferLength());\n\n std::vector popped_value;\n LengthDelimitedRingBufferReader reader(data);\n EXPECT_TRUE(reader.Pop(popped_value));\n\n const std::vector expected1 = {\n '0', '1', '2', '3', '4', '5', '6', '7', '8', '9'};\n EXPECT_EQ(expected1, popped_value);\n\n popped_value.clear();\n EXPECT_TRUE(reader.Pop(popped_value));\n\n const std::vector expected2 = {'A', 'B', 'C', 'D', 'E', 'F'};\n EXPECT_EQ(expected2, popped_value);\n}\n\nTEST_F(RingBufferAnnotationTest,\n MultiplePushCallsWithWrappingShouldOverwriteInFIFOOrder) {\n constexpr Annotation::Type kType = Annotation::UserDefinedType(1);\n\n constexpr char kName[] = \"annotation 1\";\n RingBufferAnnotation<10> annotation(kType, kName);\n\n // Each Push() call will push 1 byte for the varint 128-encoded length,\n // then the number of bytes specified.\n constexpr char kFirst[] = \"AAA\";\n constexpr char kSecond[] = \"BBB\";\n constexpr char kThird[] = \"CCC\";\n\n // This takes up bytes 0-3 of the 10-byte RingBufferAnnotation.\n ASSERT_TRUE(annotation.Push(reinterpret_cast(kFirst), 3));\n\n // This takes up bytes 4-7 of the 10-byte RingBufferAnnotation.\n ASSERT_TRUE(annotation.Push(reinterpret_cast(kSecond), 3));\n\n // This should wrap around the end of the array and overwrite kFirst since it\n // needs 4 bytes but there are only 2 left.\n ASSERT_TRUE(annotation.Push(reinterpret_cast(kThird), 3));\n\n // The size of the annotation should include the header and the full 10 bytes\n // of the ring buffer, since the third write wrapped around the end.\n ASSERT_EQ(kRingBufferHeaderSize + 10u, annotation.size());\n\n // This data size needs to match the size in the RingBufferAnnotation above.\n RingBufferData<10> data;\n ASSERT_TRUE(\n data.DeserializeFromBuffer(annotation.value(), annotation.size()));\n\n std::vector popped_value;\n LengthDelimitedRingBufferReader reader(data);\n ASSERT_TRUE(reader.Pop(popped_value));\n\n // \"AAA\" has been overwritten, so the first thing popped should be \"BBB\".\n const std::vector expected_b = {'B', 'B', 'B'};\n EXPECT_EQ(expected_b, popped_value);\n\n popped_value.clear();\n ASSERT_TRUE(reader.Pop(popped_value));\n const std::vector expected_c = {'C', 'C', 'C'};\n EXPECT_EQ(expected_c, popped_value);\n}\n\n} // namespace\n} // namespace test\n} // namespace crashpad\n" }, { "path": "client/settings.cc", "content": "// Copyright 2015 The Crashpad Authors\n//\n// Licensed under the Apache License, Version 2.0 (the \"License\");\n// you may not use this file except in compliance with the License.\n// You may obtain a copy of the License at\n//\n// http://www.apache.org/licenses/LICENSE-2.0\n//\n// Unless required by applicable law or agreed to in writing, software\n// distributed under the License is distributed on an \"AS IS\" BASIS,\n// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n// See the License for the specific language governing permissions and\n// limitations under the License.\n\n#include \"client/settings.h\"\n\n#include \n#include \n\n#include \n\n#include \"base/logging.h\"\n#include \"base/notreached.h\"\n#include \"base/posix/eintr_wrapper.h\"\n#include \"build/build_config.h\"\n#include \"util/file/filesystem.h\"\n#include \"util/numeric/in_range_cast.h\"\n\nnamespace crashpad {\n\n#if !CRASHPAD_FLOCK_ALWAYS_SUPPORTED\n\nSettings::ScopedLockedFileHandle::ScopedLockedFileHandle()\n : handle_(kInvalidFileHandle), lockfile_path_() {\n }\n\nSettings::ScopedLockedFileHandle::ScopedLockedFileHandle(\n FileHandle handle,\n const base::FilePath& lockfile_path)\n : handle_(handle), lockfile_path_(lockfile_path) {\n}\n\nSettings::ScopedLockedFileHandle::ScopedLockedFileHandle(\n ScopedLockedFileHandle&& other)\n : handle_(other.handle_), lockfile_path_(other.lockfile_path_) {\n other.handle_ = kInvalidFileHandle;\n other.lockfile_path_ = base::FilePath();\n}\n\nSettings::ScopedLockedFileHandle& Settings::ScopedLockedFileHandle::operator=(\n ScopedLockedFileHandle&& other) {\n handle_ = other.handle_;\n lockfile_path_ = other.lockfile_path_;\n\n other.handle_ = kInvalidFileHandle;\n other.lockfile_path_ = base::FilePath();\n return *this;\n}\n\nSettings::ScopedLockedFileHandle::~ScopedLockedFileHandle() {\n Destroy();\n}\n\nvoid Settings::ScopedLockedFileHandle::Destroy() {\n if (handle_ != kInvalidFileHandle) {\n CheckedCloseFile(handle_);\n }\n if (!lockfile_path_.empty()) {\n const bool success = LoggingRemoveFile(lockfile_path_);\n DCHECK(success);\n }\n}\n\n#else // !CRASHPAD_FLOCK_ALWAYS_SUPPORTED\n\n#if BUILDFLAG(IS_IOS)\n\nSettings::ScopedLockedFileHandle::ScopedLockedFileHandle(\n const FileHandle& value)\n : ScopedGeneric(value) {\n ios_background_task_ = std::make_unique(\n \"ScopedLockedFileHandle\");\n}\n\nSettings::ScopedLockedFileHandle::ScopedLockedFileHandle(\n Settings::ScopedLockedFileHandle&& rvalue) {\n ios_background_task_.reset(rvalue.ios_background_task_.release());\n reset(rvalue.release());\n}\n\nSettings::ScopedLockedFileHandle& Settings::ScopedLockedFileHandle::operator=(\n Settings::ScopedLockedFileHandle&& rvalue) {\n ios_background_task_.reset(rvalue.ios_background_task_.release());\n reset(rvalue.release());\n return *this;\n}\n\nSettings::ScopedLockedFileHandle::~ScopedLockedFileHandle() {\n // Call reset() to ensure the lock is released before the ios_background_task.\n reset();\n}\n\n#endif // BUILDFLAG(IS_IOS)\n\nnamespace internal {\n\n// static\nvoid ScopedLockedFileHandleTraits::Free(FileHandle handle) {\n if (handle != kInvalidFileHandle) {\n LoggingUnlockFile(handle);\n CheckedCloseFile(handle);\n }\n}\n\n} // namespace internal\n\n#endif // BUILDFLAG(IS_FUCHSIA)\n\nstruct SettingsReader::Data {\n static constexpr uint32_t kSettingsMagic = 'CPds';\n\n // Version number only used for incompatible changes to Data. Do not change\n // this when adding additional fields at the end. Modifying `kSettingsVersion`\n // will wipe away the entire struct when reading from other versions.\n static constexpr uint32_t kSettingsVersion = 1;\n\n enum Options : uint32_t {\n kUploadsEnabled = 1 << 0,\n };\n\n Data() : magic(kSettingsMagic),\n version(kSettingsVersion),\n options(0),\n padding_0(0),\n last_upload_attempt_time(0),\n client_id() {}\n\n uint32_t magic;\n uint32_t version;\n uint32_t options;\n uint32_t padding_0;\n int64_t last_upload_attempt_time; // time_t\n UUID client_id;\n};\n\nSettingsReader::SettingsReader(const base::FilePath& file_path)\n : SettingsReader(file_path, InitializationState::kStateValid) {}\n\nSettingsReader::SettingsReader(const base::FilePath& file_path,\n InitializationState::State state)\n : file_path_(file_path), initialized_(state) {}\n\nSettingsReader::~SettingsReader() = default;\n\nbool SettingsReader::GetClientID(UUID* client_id) {\n DCHECK(initialized().is_valid());\n\n Data settings;\n if (!OpenAndReadSettings(&settings))\n return false;\n\n *client_id = settings.client_id;\n return true;\n}\n\nbool SettingsReader::GetUploadsEnabled(bool* enabled) {\n DCHECK(initialized().is_valid());\n\n Data settings;\n if (!OpenAndReadSettings(&settings))\n return false;\n\n *enabled = (settings.options & Data::Options::kUploadsEnabled) != 0;\n return true;\n}\n\nbool SettingsReader::GetLastUploadAttemptTime(time_t* time) {\n DCHECK(initialized().is_valid());\n\n Data settings;\n if (!OpenAndReadSettings(&settings))\n return false;\n\n *time = InRangeCast(settings.last_upload_attempt_time,\n std::numeric_limits::max());\n return true;\n}\n\nbool SettingsReader::OpenAndReadSettings(Data* out_data) {\n ScopedFileHandle handle(LoggingOpenFileForRead(file_path_));\n return handle.is_valid() && ReadSettings(handle.get(), out_data, true);\n}\n\nbool SettingsReader::ReadSettings(FileHandle handle,\n Data* out_data,\n bool log_read_error) {\n if (LoggingSeekFile(handle, 0, SEEK_SET) != 0) {\n return false;\n }\n\n // This clears `out_data` so that any bytes not read from disk are zero\n // initialized. This is expected when reading from an older settings file with\n // fewer fields.\n memset(out_data, 0, sizeof(*out_data));\n\n const FileOperationResult read_result =\n log_read_error ? LoggingReadFileUntil(handle, out_data, sizeof(*out_data))\n : ReadFileUntil(handle, out_data, sizeof(*out_data));\n\n if (read_result <= 0) {\n return false;\n }\n\n // Newer versions of crashpad may add fields to Data, but all versions have\n // the data members up to `client_id`. Do not attempt to understand a smaller\n // struct read.\n const size_t min_size =\n offsetof(Data, client_id) + sizeof(out_data->client_id);\n if (static_cast(read_result) < min_size) {\n LOG(ERROR) << \"Settings file too small: minimum \" << min_size\n << \", observed \" << read_result;\n return false;\n }\n\n if (out_data->magic != Data::kSettingsMagic) {\n LOG(ERROR) << \"Settings magic is not \" << Data::kSettingsMagic;\n return false;\n }\n\n if (out_data->version != Data::kSettingsVersion) {\n LOG(ERROR) << \"Settings version is not \" << Data::kSettingsVersion;\n return false;\n }\n\n return true;\n}\n\nSettings::Settings(const base::FilePath& path)\n : SettingsReader(path, InitializationState::kStateUninitialized) {}\n\nSettings::~Settings() = default;\n\nbool Settings::Initialize() {\n DCHECK(initialized().is_uninitialized());\n initialized().set_invalid();\n\n Data settings;\n if (!OpenForWritingAndReadSettings(&settings).is_valid())\n return false;\n\n initialized().set_valid();\n return true;\n}\n\nbool Settings::SetUploadsEnabled(bool enabled) {\n DCHECK(initialized().is_valid());\n\n Data settings;\n ScopedLockedFileHandle handle = OpenForWritingAndReadSettings(&settings);\n if (!handle.is_valid())\n return false;\n\n if (enabled)\n settings.options |= Data::Options::kUploadsEnabled;\n else\n settings.options &= ~Data::Options::kUploadsEnabled;\n\n return WriteSettings(handle.get(), settings);\n}\n\nbool Settings::SetLastUploadAttemptTime(time_t time) {\n DCHECK(initialized().is_valid());\n\n Data settings;\n ScopedLockedFileHandle handle = OpenForWritingAndReadSettings(&settings);\n if (!handle.is_valid())\n return false;\n\n settings.last_upload_attempt_time = InRangeCast(time, 0);\n\n return WriteSettings(handle.get(), settings);\n}\n\n#if !CRASHPAD_FLOCK_ALWAYS_SUPPORTED\n// static\nbool Settings::IsLockExpired(const base::FilePath& file_path,\n time_t lockfile_ttl) {\n time_t now = time(nullptr);\n base::FilePath lock_path(file_path.value() + Settings::kLockfileExtension);\n ScopedFileHandle lock_fd(LoggingOpenFileForRead(lock_path));\n time_t lock_timestamp;\n if (!LoggingReadFileExactly(\n lock_fd.get(), &lock_timestamp, sizeof(lock_timestamp))) {\n return false;\n }\n return now >= lock_timestamp + lockfile_ttl;\n}\n#endif // !CRASHPAD_FLOCK_ALWAYS_SUPPORTED\n\n// static\nSettings::ScopedLockedFileHandle Settings::MakeScopedLockedFileHandle(\n const internal::MakeScopedLockedFileHandleOptions& options,\n FileLocking locking,\n const base::FilePath& file_path) {\n#if !CRASHPAD_FLOCK_ALWAYS_SUPPORTED\n base::FilePath lockfile_path(file_path.value() +\n Settings::kLockfileExtension);\n ScopedFileHandle lockfile_scoped(\n LoggingOpenFileForWrite(lockfile_path,\n FileWriteMode::kCreateOrFail,\n FilePermissions::kWorldReadable));\n if (!lockfile_scoped.is_valid()) {\n return ScopedLockedFileHandle();\n }\n time_t now = time(nullptr);\n if (!LoggingWriteFile(lockfile_scoped.get(), &now, sizeof(now))) {\n return ScopedLockedFileHandle();\n }\n ScopedFileHandle scoped(GetHandleFromOptions(file_path, options));\n if (scoped.is_valid()) {\n return ScopedLockedFileHandle(scoped.release(), lockfile_path);\n }\n bool success = LoggingRemoveFile(lockfile_path);\n DCHECK(success);\n return ScopedLockedFileHandle();\n#else\n ScopedFileHandle scoped(GetHandleFromOptions(file_path, options));\n // It's important to create the ScopedLockedFileHandle before calling\n // LoggingLockFile on iOS, so a ScopedBackgroundTask is created *before*\n // the LoggingLockFile call below.\n ScopedLockedFileHandle handle(kInvalidFileHandle);\n if (scoped.is_valid()) {\n if (LoggingLockFile(\n scoped.get(), locking, FileLockingBlocking::kBlocking) !=\n FileLockingResult::kSuccess) {\n scoped.reset();\n }\n }\n handle.reset(scoped.release());\n return handle;\n#endif // !CRASHPAD_FLOCK_ALWAYS_SUPPORTED\n}\n\n// static\nFileHandle Settings::GetHandleFromOptions(\n const base::FilePath& file_path,\n const internal::MakeScopedLockedFileHandleOptions& options) {\n switch (options.function_enum) {\n case internal::FileOpenFunction::kLoggingOpenFileForRead:\n return LoggingOpenFileForRead(file_path);\n case internal::FileOpenFunction::kLoggingOpenFileForReadAndWrite:\n return LoggingOpenFileForReadAndWrite(\n file_path, options.mode, options.permissions);\n case internal::FileOpenFunction::kOpenFileForReadAndWrite:\n return OpenFileForReadAndWrite(\n file_path, options.mode, options.permissions);\n }\n NOTREACHED();\n}\n\nSettings::ScopedLockedFileHandle Settings::OpenForReading() const {\n internal::MakeScopedLockedFileHandleOptions options;\n options.function_enum = internal::FileOpenFunction::kLoggingOpenFileForRead;\n return MakeScopedLockedFileHandle(options, FileLocking::kShared, file_path());\n}\n\nSettings::ScopedLockedFileHandle Settings::OpenForReadingAndWriting(\n FileWriteMode mode, bool log_open_error) {\n DCHECK(mode != FileWriteMode::kTruncateOrCreate);\n\n internal::MakeScopedLockedFileHandleOptions options;\n options.mode = mode;\n options.permissions = FilePermissions::kOwnerOnly;\n if (log_open_error) {\n options.function_enum =\n internal::FileOpenFunction::kLoggingOpenFileForReadAndWrite;\n } else {\n options.function_enum =\n internal::FileOpenFunction::kOpenFileForReadAndWrite;\n }\n\n return MakeScopedLockedFileHandle(\n options, FileLocking::kExclusive, file_path());\n}\n\nbool Settings::OpenAndReadSettings(Data* out_data) {\n // Because this implementation distinguishes between a failure to open and a\n // failure to read the settings file, it cannot simply invoke\n // SettingsReader::OpenAndReadSettings.\n ScopedLockedFileHandle handle = OpenForReading();\n if (!handle.is_valid())\n return false;\n\n if (ReadSettings(handle.get(), out_data, true))\n return true;\n\n // The settings file is corrupt, so reinitialize it.\n handle.reset();\n\n // The settings failed to be read, so re-initialize them.\n return RecoverSettings(kInvalidFileHandle, out_data);\n}\n\nSettings::ScopedLockedFileHandle Settings::OpenForWritingAndReadSettings(\n Data* out_data) {\n ScopedLockedFileHandle handle;\n bool created = false;\n if (!initialized().is_valid()) {\n // If this object is initializing, it hasn’t seen a settings file already,\n // so go easy on errors. Creating a new settings file for the first time\n // shouldn’t spew log messages.\n //\n // First, try to use an existing settings file.\n handle = OpenForReadingAndWriting(FileWriteMode::kReuseOrFail, false);\n\n if (!handle.is_valid()) {\n // Create a new settings file if it didn’t already exist.\n handle = OpenForReadingAndWriting(FileWriteMode::kCreateOrFail, false);\n\n if (handle.is_valid()) {\n created = true;\n }\n\n // There may have been a race to create the file, and something else may\n // have won. There will be one more attempt to try to open or create the\n // file below.\n }\n }\n\n if (!handle.is_valid()) {\n // Either the object is initialized, meaning it’s already seen a valid\n // settings file, or the object is initializing and none of the above\n // attempts to create the settings file succeeded. Either way, this is the\n // last chance for success, so if this fails, log a message.\n handle = OpenForReadingAndWriting(FileWriteMode::kReuseOrCreate, true);\n }\n\n if (!handle.is_valid())\n return ScopedLockedFileHandle();\n\n // Attempt reading the settings even if the file is known to have just been\n // created. The file-create and file-lock operations don’t occur atomically,\n // and something else may have written the settings before this invocation\n // took the lock. If the settings file was definitely just created, though,\n // don’t log any read errors. The expected non-race behavior in this case is a\n // zero-length read, with ReadSettings() failing.\n if (!ReadSettings(handle.get(), out_data, !created)) {\n if (!RecoverSettings(handle.get(), out_data))\n return ScopedLockedFileHandle();\n }\n\n return handle;\n}\n\nbool Settings::WriteSettings(FileHandle handle, const Data& data) {\n if (LoggingSeekFile(handle, 0, SEEK_SET) != 0)\n return false;\n\n if (!LoggingTruncateFile(handle))\n return false;\n\n return LoggingWriteFile(handle, &data, sizeof(Data));\n}\n\nbool Settings::RecoverSettings(FileHandle handle, Data* out_data) {\n ScopedLockedFileHandle scoped_handle;\n if (handle == kInvalidFileHandle) {\n scoped_handle =\n OpenForReadingAndWriting(FileWriteMode::kReuseOrCreate, true);\n handle = scoped_handle.get();\n\n // Test if the file has already been recovered now that the exclusive lock\n // is held.\n if (ReadSettings(handle, out_data, true))\n return true;\n }\n\n if (handle == kInvalidFileHandle) {\n LOG(ERROR) << \"Invalid file handle\";\n return false;\n }\n\n if (!InitializeSettings(handle))\n return false;\n\n return ReadSettings(handle, out_data, true);\n}\n\nbool Settings::InitializeSettings(FileHandle handle) {\n Data settings;\n if (!settings.client_id.InitializeWithNew())\n return false;\n\n return WriteSettings(handle, settings);\n}\n\n} // namespace crashpad\n" }, { "path": "client/settings.h", "content": "// Copyright 2015 The Crashpad Authors\n//\n// Licensed under the Apache License, Version 2.0 (the \"License\");\n// you may not use this file except in compliance with the License.\n// You may obtain a copy of the License at\n//\n// http://www.apache.org/licenses/LICENSE-2.0\n//\n// Unless required by applicable law or agreed to in writing, software\n// distributed under the License is distributed on an \"AS IS\" BASIS,\n// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n// See the License for the specific language governing permissions and\n// limitations under the License.\n\n#ifndef CRASHPAD_CLIENT_SETTINGS_H_\n#define CRASHPAD_CLIENT_SETTINGS_H_\n\n#include \n\n#include \"base/files/file_path.h\"\n#include \"base/scoped_generic.h\"\n#include \"build/build_config.h\"\n#include \"util/file/file_io.h\"\n#include \"util/misc/initialization_state.h\"\n#include \"util/misc/uuid.h\"\n\n#if BUILDFLAG(IS_IOS)\n#include \"util/ios/scoped_background_task.h\"\n#endif // BUILDFLAG(IS_IOS)\n\nnamespace crashpad {\n\nnamespace internal {\n\nstruct ScopedLockedFileHandleTraits {\n static FileHandle InvalidValue() { return kInvalidFileHandle; }\n static void Free(FileHandle handle);\n};\n\nenum class FileOpenFunction {\n kLoggingOpenFileForRead,\n kLoggingOpenFileForReadAndWrite,\n kOpenFileForReadAndWrite,\n};\n\nstruct MakeScopedLockedFileHandleOptions {\n FileOpenFunction function_enum;\n FileWriteMode mode;\n FilePermissions permissions;\n};\n\n// TODO(mark): The timeout should be configurable by the client.\n#if BUILDFLAG(IS_IOS)\n// iOS background assertions only last 30 seconds, keep the timeout shorter.\nconstexpr double kUploadReportTimeoutSeconds = 20;\n#else\nconstexpr double kUploadReportTimeoutSeconds = 60;\n#endif\n\n} // namespace internal\n\n//! \\brief A class for accessing the settings of a CrashReportDatabase.\n//!\n//! SettingsReader does not participate in file locking.\n//!\n//! This class must not be instantiated directly, but rather an instance of it\n//! should be retrieved via\n//! CrashReportDatabase::GetSettingsReaderForDatabasePath.\nclass SettingsReader {\n public:\n explicit SettingsReader(const base::FilePath& path);\n\n SettingsReader(const SettingsReader&) = delete;\n SettingsReader& operator=(const SettingsReader&) = delete;\n\n virtual ~SettingsReader();\n\n //! \\brief Retrieves the immutable identifier for this client, which is used\n //! on a server to locate all crash reports from a specific Crashpad\n //! database.\n //!\n //! \\param[out] client_id The unique client identifier.\n //!\n //! \\return On success, returns `true`, otherwise returns `false` with an\n //! error logged.\n bool GetClientID(UUID* client_id);\n\n //! \\brief Retrieves the user’s preference for submitting crash reports to a\n //! collection server.\n //!\n //! The default value is `false`.\n //!\n //! \\note\n //! This setting is ignored if --use-cros-crash-reporter is present\n //! (which it will be if invoked by Chrome on ChromeOS).\n //!\n //! \\param[out] enabled Whether crash reports should be uploaded.\n //!\n //! \\return On success, returns `true`, otherwise returns `false` with an\n //! error logged.\n bool GetUploadsEnabled(bool* enabled);\n\n //! \\brief Retrieves the last time at which a report was attempted to be\n //! uploaded.\n //!\n //! The default value is `0` if it has never been set before.\n //!\n //! \\param[out] time The last time at which a report was uploaded.\n //!\n //! \\return On success, returns `true`, otherwise returns `false` with an\n //! error logged.\n bool GetLastUploadAttemptTime(time_t* time);\n\n protected:\n struct Data;\n\n SettingsReader(const base::FilePath& path, InitializationState::State state);\n\n // Opens the settings file and reads the data. If that fails, an error will\n // be logged and the function will return false.\n virtual bool OpenAndReadSettings(Data* out_data);\n\n // Reads the settings from |handle|. Logs an error and returns false on\n // failure.\n //\n // If |log_read_error| is false, nothing will be logged for a read error, but\n // this method will still return false. This is intended to be used to\n // suppress error messages when attempting to read a newly created settings\n // file.\n bool ReadSettings(FileHandle handle, Data* out_data, bool log_read_error);\n\n const base::FilePath& file_path() const { return file_path_; }\n\n InitializationState& initialized() { return initialized_; }\n\n private:\n const base::FilePath file_path_;\n InitializationState initialized_;\n};\n\n//! \\brief An interface for accessing and modifying the settings of a\n//! CrashReportDatabase.\n//!\n//! This class must not be instantiated directly, but rather an instance of it\n//! should be retrieved via CrashReportDatabase::GetSettings().\n//!\n//! Settings will lock files prior to reading or writing them, and respect\n//! existing locks.\nclass Settings final : public SettingsReader {\n public:\n static inline constexpr char kLockfileExtension[] = \".__lock__\";\n\n explicit Settings(const base::FilePath& file_path);\n\n ~Settings();\n\n //! \\brief Initializes the settings data store.\n //!\n //! This method must be called only once, and must be successfully called\n //! before any other method in this class may be called.\n //!\n //! \\return `true` if the data store was initialized successfully, otherwise\n //! `false` with an error logged.\n bool Initialize();\n\n //! \\brief Sets the user’s preference for submitting crash reports to a\n //! collection server.\n //!\n //! \\param[in] enabled Whether crash reports should be uploaded.\n //!\n //! \\return On success, returns `true`, otherwise returns `false` with an\n //! error logged.\n bool SetUploadsEnabled(bool enabled);\n\n //! \\brief Sets the last time at which a report was attempted to be uploaded.\n //!\n //! This is only meant to be used internally by the CrashReportDatabase.\n //!\n //! \\param[in] time The last time at which a report was uploaded.\n //!\n //! \\return On success, returns `true`, otherwise returns `false` with an\n //! error logged.\n bool SetLastUploadAttemptTime(time_t time);\n\n#if !CRASHPAD_FLOCK_ALWAYS_SUPPORTED\n //! \\brief Returns whether the lockfile for a file is expired.\n //!\n //! This could be part of ScopedLockedFileHandle, but this needs to be\n //! public while ScopedLockedFileHandle is private to Settings.\n //!\n //! \\param[in] file_path The path to the file whose lockfile will be checked.\n //! \\param[in] lockfile_ttl How long the lockfile has to live before expiring.\n //!\n //! \\return `true` if the lock for the file is expired, otherwise `false`.\n static bool IsLockExpired(const base::FilePath& file_path,\n time_t lockfile_ttl);\n#endif // !CRASHPAD_FLOCK_ALWAYS_SUPPORTED\n\n private:\n // This must be constructed with MakeScopedLockedFileHandle(). It both unlocks\n // and closes the file on destruction. Note that on Fuchsia, this handle DOES\n // NOT offer correct operation, only an attempt to DCHECK if racy behavior is\n // detected.\n#if !CRASHPAD_FLOCK_ALWAYS_SUPPORTED\n struct ScopedLockedFileHandle {\n public:\n ScopedLockedFileHandle();\n ScopedLockedFileHandle(FileHandle handle,\n const base::FilePath& lockfile_path);\n ScopedLockedFileHandle(ScopedLockedFileHandle&& other);\n ScopedLockedFileHandle& operator=(ScopedLockedFileHandle&& other);\n\n ScopedLockedFileHandle(const ScopedLockedFileHandle&) = delete;\n ScopedLockedFileHandle& operator=(const ScopedLockedFileHandle&) = delete;\n\n ~ScopedLockedFileHandle();\n\n // These mirror the non-Fuchsia ScopedLockedFileHandle via ScopedGeneric so\n // that calling code can pretend this implementation is the same.\n bool is_valid() const { return handle_ != kInvalidFileHandle; }\n FileHandle get() { return handle_; }\n void reset() {\n Destroy();\n handle_ = kInvalidFileHandle;\n lockfile_path_ = base::FilePath();\n }\n\n private:\n void Destroy();\n\n FileHandle handle_;\n base::FilePath lockfile_path_;\n };\n#elif BUILDFLAG(IS_IOS)\n // iOS needs to use ScopedBackgroundTask anytime a file lock is used.\n class ScopedLockedFileHandle\n : public base::ScopedGeneric {\n public:\n using base::ScopedGeneric<\n FileHandle,\n internal::ScopedLockedFileHandleTraits>::ScopedGeneric;\n\n ScopedLockedFileHandle(const FileHandle& value);\n ScopedLockedFileHandle(ScopedLockedFileHandle&& rvalue);\n ScopedLockedFileHandle& operator=(ScopedLockedFileHandle&& rvalue);\n\n ~ScopedLockedFileHandle();\n\n private:\n std::unique_ptr ios_background_task_;\n };\n#else\n using ScopedLockedFileHandle =\n base::ScopedGeneric;\n#endif // !CRASHPAD_FLOCK_ALWAYS_SUPPORTED\n static ScopedLockedFileHandle MakeScopedLockedFileHandle(\n const internal::MakeScopedLockedFileHandleOptions& options,\n FileLocking locking,\n const base::FilePath& file_path);\n\n static FileHandle GetHandleFromOptions(\n const base::FilePath& file_path,\n const internal::MakeScopedLockedFileHandleOptions& options);\n\n // Opens the settings file for reading. On error, logs a message and returns\n // the invalid handle.\n ScopedLockedFileHandle OpenForReading() const;\n\n // Opens the settings file for reading and writing. On error, logs a message\n // and returns the invalid handle. |mode| determines how the file will be\n // opened. |mode| must not be FileWriteMode::kTruncateOrCreate.\n //\n // If |log_open_error| is false, nothing will be logged for an error\n // encountered when attempting to open the file, but this method will still\n // return false. This is intended to be used to suppress error messages when\n // attempting to create a new settings file when multiple attempts are made.\n ScopedLockedFileHandle OpenForReadingAndWriting(FileWriteMode mode,\n bool log_open_error);\n\n // Opens the settings file and reads the data. If that fails, an error will\n // be logged and the settings will be recovered and re-initialized. If that\n // also fails, returns false with additional log data from recovery.\n bool OpenAndReadSettings(Data* out_data) override;\n\n // Opens the settings file for writing and reads the data. If reading fails,\n // recovery is attempted. Returns the opened file handle on success, or the\n // invalid file handle on failure, with an error logged.\n ScopedLockedFileHandle OpenForWritingAndReadSettings(Data* out_data);\n\n // Writes the settings to |handle|. Logs an error and returns false on\n // failure. This does not perform recovery.\n //\n // |handle| must be the result of OpenForReadingAndWriting().\n bool WriteSettings(FileHandle handle, const Data& data);\n\n // Recovers the settings file by re-initializing the data. If |handle| is the\n // invalid handle, this will open the file; if it is not, then it must be the\n // result of OpenForReadingAndWriting(). If the invalid handle is passed, the\n // caller must not be holding the handle. The new settings data are stored in\n // |out_data|. Returns true on success and false on failure, with an error\n // logged.\n bool RecoverSettings(FileHandle handle, Data* out_data);\n\n // Initializes a settings file and writes the data to |handle|. Returns true\n // on success and false on failure, with an error logged.\n //\n // |handle| must be the result of OpenForReadingAndWriting().\n bool InitializeSettings(FileHandle handle);\n};\n\n} // namespace crashpad\n\n#endif // CRASHPAD_CLIENT_SETTINGS_H_\n" }, { "path": "client/settings_test.cc", "content": "// Copyright 2015 The Crashpad Authors\n//\n// Licensed under the Apache License, Version 2.0 (the \"License\");\n// you may not use this file except in compliance with the License.\n// You may obtain a copy of the License at\n//\n// http://www.apache.org/licenses/LICENSE-2.0\n//\n// Unless required by applicable law or agreed to in writing, software\n// distributed under the License is distributed on an \"AS IS\" BASIS,\n// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n// See the License for the specific language governing permissions and\n// limitations under the License.\n\n#include \"client/settings.h\"\n\n#include \"build/build_config.h\"\n#include \"gtest/gtest.h\"\n#include \"test/errors.h\"\n#include \"test/scoped_temp_dir.h\"\n#include \"util/file/file_io.h\"\n\nnamespace crashpad {\nnamespace test {\nnamespace {\n\nclass SettingsTest : public testing::Test {\n public:\n SettingsTest()\n : temp_dir_(),\n settings_path_(temp_dir_.path().Append(FILE_PATH_LITERAL(\"settings\"))),\n settings_(settings_path_) {}\n\n SettingsTest(const SettingsTest&) = delete;\n SettingsTest& operator=(const SettingsTest&) = delete;\n\n base::FilePath settings_path() { return settings_path_; }\n\n Settings* settings() { return &settings_; }\n\n void InitializeBadFile() {\n ScopedFileHandle handle(\n LoggingOpenFileForWrite(settings_path(),\n FileWriteMode::kTruncateOrCreate,\n FilePermissions::kWorldReadable));\n ASSERT_TRUE(handle.is_valid());\n\n static constexpr char kBuf[] = \"test bad file\";\n ASSERT_TRUE(LoggingWriteFile(handle.get(), kBuf, sizeof(kBuf)));\n handle.reset();\n }\n\n protected:\n // testing::Test:\n void SetUp() override { ASSERT_TRUE(settings()->Initialize()); }\n\n private:\n const ScopedTempDir temp_dir_;\n const base::FilePath settings_path_;\n Settings settings_;\n};\n\nTEST_F(SettingsTest, ClientID) {\n UUID client_id;\n EXPECT_TRUE(settings()->GetClientID(&client_id));\n EXPECT_NE(client_id, UUID());\n\n Settings local_settings(settings_path());\n EXPECT_TRUE(local_settings.Initialize());\n UUID actual;\n EXPECT_TRUE(local_settings.GetClientID(&actual));\n EXPECT_EQ(actual, client_id);\n}\n\nTEST_F(SettingsTest, UploadsEnabled) {\n bool enabled = true;\n // Default value is false.\n EXPECT_TRUE(settings()->GetUploadsEnabled(&enabled));\n EXPECT_FALSE(enabled);\n\n EXPECT_TRUE(settings()->SetUploadsEnabled(true));\n EXPECT_TRUE(settings()->GetUploadsEnabled(&enabled));\n EXPECT_TRUE(enabled);\n\n Settings local_settings(settings_path());\n EXPECT_TRUE(local_settings.Initialize());\n enabled = false;\n EXPECT_TRUE(local_settings.GetUploadsEnabled(&enabled));\n EXPECT_TRUE(enabled);\n\n EXPECT_TRUE(settings()->SetUploadsEnabled(false));\n EXPECT_TRUE(settings()->GetUploadsEnabled(&enabled));\n EXPECT_FALSE(enabled);\n\n enabled = true;\n EXPECT_TRUE(local_settings.GetUploadsEnabled(&enabled));\n EXPECT_FALSE(enabled);\n}\n\nTEST_F(SettingsTest, LastUploadAttemptTime) {\n time_t actual = -1;\n EXPECT_TRUE(settings()->GetLastUploadAttemptTime(&actual));\n // Default value is 0.\n EXPECT_EQ(actual, 0);\n\n const time_t expected = time(nullptr);\n EXPECT_TRUE(settings()->SetLastUploadAttemptTime(expected));\n EXPECT_TRUE(settings()->GetLastUploadAttemptTime(&actual));\n EXPECT_EQ(actual, expected);\n\n Settings local_settings(settings_path());\n EXPECT_TRUE(local_settings.Initialize());\n actual = -1;\n EXPECT_TRUE(local_settings.GetLastUploadAttemptTime(&actual));\n EXPECT_EQ(actual, expected);\n}\n\nTEST_F(SettingsTest, ReadOnly) {\n { // A SettingsReader can read an existing setting...\n SettingsReader reader(settings_path());\n bool enabled = true;\n // Default value is false.\n EXPECT_TRUE(reader.GetUploadsEnabled(&enabled));\n EXPECT_FALSE(enabled);\n\n settings()->SetUploadsEnabled(true);\n EXPECT_TRUE(reader.GetUploadsEnabled(&enabled));\n EXPECT_TRUE(enabled);\n }\n\n { // ...but not one that doesn't exist.\n base::FilePath bad_path =\n settings_path().DirName().Append(FILE_PATH_LITERAL(\"does_not_exist\"));\n SettingsReader reader(bad_path);\n bool enabled = true;\n EXPECT_FALSE(reader.GetUploadsEnabled(&enabled));\n }\n}\n\n// The following tests write a corrupt settings file and test the recovery\n// operation.\n\nTEST_F(SettingsTest, BadFileOnInitialize) {\n InitializeBadFile();\n\n Settings settings(settings_path());\n EXPECT_TRUE(settings.Initialize());\n}\n\nTEST_F(SettingsTest, BadFileOnGet) {\n InitializeBadFile();\n\n UUID client_id;\n EXPECT_TRUE(settings()->GetClientID(&client_id));\n EXPECT_NE(client_id, UUID());\n\n Settings local_settings(settings_path());\n EXPECT_TRUE(local_settings.Initialize());\n UUID actual;\n EXPECT_TRUE(local_settings.GetClientID(&actual));\n EXPECT_EQ(actual, client_id);\n}\n\nTEST_F(SettingsTest, BadFileOnSet) {\n InitializeBadFile();\n\n EXPECT_TRUE(settings()->SetUploadsEnabled(true));\n bool enabled = false;\n EXPECT_TRUE(settings()->GetUploadsEnabled(&enabled));\n EXPECT_TRUE(enabled);\n}\n\nTEST_F(SettingsTest, UnlinkFile) {\n UUID client_id;\n EXPECT_TRUE(settings()->GetClientID(&client_id));\n EXPECT_TRUE(settings()->SetUploadsEnabled(true));\n EXPECT_TRUE(settings()->SetLastUploadAttemptTime(time(nullptr)));\n\n#if BUILDFLAG(IS_WIN)\n EXPECT_EQ(_wunlink(settings_path().value().c_str()), 0)\n << ErrnoMessage(\"_wunlink\");\n#else\n EXPECT_EQ(unlink(settings_path().value().c_str()), 0)\n << ErrnoMessage(\"unlink\");\n#endif\n\n Settings local_settings(settings_path());\n EXPECT_TRUE(local_settings.Initialize());\n UUID new_client_id;\n EXPECT_TRUE(local_settings.GetClientID(&new_client_id));\n EXPECT_NE(new_client_id, client_id);\n\n // Check that all values are reset.\n bool enabled = true;\n EXPECT_TRUE(local_settings.GetUploadsEnabled(&enabled));\n EXPECT_FALSE(enabled);\n\n time_t time = -1;\n EXPECT_TRUE(local_settings.GetLastUploadAttemptTime(&time));\n EXPECT_EQ(time, 0);\n}\n\n} // namespace\n} // namespace test\n} // namespace crashpad\n" }, { "path": "client/simple_address_range_bag.h", "content": "// Copyright 2016 The Crashpad Authors\n//\n// Licensed under the Apache License, Version 2.0 (the \"License\");\n// you may not use this file except in compliance with the License.\n// You may obtain a copy of the License at\n//\n// http://www.apache.org/licenses/LICENSE-2.0\n//\n// Unless required by applicable law or agreed to in writing, software\n// distributed under the License is distributed on an \"AS IS\" BASIS,\n// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n// See the License for the specific language governing permissions and\n// limitations under the License.\n\n#ifndef CRASHPAD_CLIENT_SIMPLE_ADDRESS_RANGE_BAG_H_\n#define CRASHPAD_CLIENT_SIMPLE_ADDRESS_RANGE_BAG_H_\n\n#include \n#include \n\n#include \n\n#include \"base/check_op.h\"\n#include \"base/logging.h\"\n#include \"base/numerics/safe_conversions.h\"\n#include \"util/misc/from_pointer_cast.h\"\n#include \"util/numeric/checked_range.h\"\n\nnamespace crashpad {\n\n//! \\brief A bag implementation using a fixed amount of storage, so that it does\n//! not perform any dynamic allocations for its operations.\n//!\n//! The actual bag storage (TSimpleAddressRangeBag::Entry) is POD, so that it\n//! can be transmitted over various IPC mechanisms.\ntemplate \nclass TSimpleAddressRangeBag {\n public:\n //! Constant and publicly accessible version of the template parameter.\n static const size_t num_entries = NumEntries;\n\n //! \\brief A single entry in the bag.\n struct Entry {\n //! \\brief The base address of the range.\n uint64_t base;\n\n //! \\brief The size of the range in bytes.\n uint64_t size;\n\n //! \\brief Returns the validity of the entry.\n //!\n //! If #base and #size are both zero, the entry is considered inactive, and\n //! this method returns `false`. Otherwise, returns `true`.\n bool is_active() const {\n return base != 0 || size != 0;\n }\n };\n\n //! \\brief An iterator to traverse all of the active entries in a\n //! TSimpleAddressRangeBag.\n class Iterator {\n public:\n explicit Iterator(const TSimpleAddressRangeBag& bag)\n : bag_(bag),\n current_(0) {\n }\n\n Iterator(const Iterator&) = delete;\n Iterator& operator=(const Iterator&) = delete;\n\n //! \\brief Returns the next entry in the bag, or `nullptr` if at the end of\n //! the collection.\n const Entry* Next() {\n while (current_ < bag_.num_entries) {\n const Entry* entry = &bag_.entries_[current_++];\n if (entry->is_active()) {\n return entry;\n }\n }\n return nullptr;\n }\n\n private:\n const TSimpleAddressRangeBag& bag_;\n size_t current_;\n };\n\n TSimpleAddressRangeBag()\n : entries_() {\n }\n\n TSimpleAddressRangeBag(const TSimpleAddressRangeBag& other) {\n *this = other;\n }\n\n TSimpleAddressRangeBag& operator=(const TSimpleAddressRangeBag& other) {\n memcpy(entries_, other.entries_, sizeof(entries_));\n return *this;\n }\n\n //! \\brief Returns the number of active entries. The upper limit for this is\n //! \\a NumEntries.\n size_t GetCount() const {\n size_t count = 0;\n for (size_t i = 0; i < num_entries; ++i) {\n if (entries_[i].is_active()) {\n ++count;\n }\n }\n return count;\n }\n\n //! \\brief Inserts the given range into the bag. Duplicates and overlapping\n //! ranges are supported and allowed, but not coalesced.\n //!\n //! \\param[in] range The range to be inserted. The range must have either a\n //! non-zero base address or size.\n //!\n //! \\return `true` if there was space to insert the range into the bag,\n //! otherwise `false` with an error logged.\n bool Insert(CheckedRange range) {\n DCHECK(range.base() != 0 || range.size() != 0);\n\n for (size_t i = 0; i < num_entries; ++i) {\n if (!entries_[i].is_active()) {\n entries_[i].base = range.base();\n entries_[i].size = range.size();\n return true;\n }\n }\n\n LOG(ERROR) << \"no space available to insert range\";\n return false;\n }\n\n //! \\brief Inserts the given range into the bag. Duplicates and overlapping\n //! ranges are supported and allowed, but not coalesced.\n //!\n //! \\param[in] base The base of the range to be inserted. May not be null.\n //! \\param[in] size The size of the range to be inserted. May not be zero.\n //!\n //! \\return `true` if there was space to insert the range into the bag,\n //! otherwise `false` with an error logged.\n bool Insert(void* base, size_t size) {\n DCHECK(base != nullptr);\n DCHECK_NE(0u, size);\n return Insert(CheckedRange(FromPointerCast(base),\n base::checked_cast(size)));\n }\n\n //! \\brief Removes the given range from the bag.\n //!\n //! \\param[in] range The range to be removed. The range must have either a\n //! non-zero base address or size.\n //!\n //! \\return `true` if the range was found and removed, otherwise `false` with\n //! an error logged.\n bool Remove(CheckedRange range) {\n DCHECK(range.base() != 0 || range.size() != 0);\n\n for (size_t i = 0; i < num_entries; ++i) {\n if (entries_[i].base == range.base() &&\n entries_[i].size == range.size()) {\n entries_[i].base = entries_[i].size = 0;\n return true;\n }\n }\n\n LOG(ERROR) << \"did not find range to remove\";\n return false;\n }\n\n //! \\brief Removes the given range from the bag.\n //!\n //! \\param[in] base The base of the range to be removed. May not be null.\n //! \\param[in] size The size of the range to be removed. May not be zero.\n //!\n //! \\return `true` if the range was found and removed, otherwise `false` with\n //! an error logged.\n bool Remove(void* base, size_t size) {\n DCHECK(base != nullptr);\n DCHECK_NE(0u, size);\n return Remove(CheckedRange(FromPointerCast(base),\n base::checked_cast(size)));\n }\n\n\n private:\n Entry entries_[NumEntries];\n};\n\n//! \\brief A TSimpleAddressRangeBag with default template parameters.\nusing SimpleAddressRangeBag = TSimpleAddressRangeBag<64>;\n\nstatic_assert(std::is_standard_layout::value,\n \"SimpleAddressRangeBag must be standard layout\");\n\n} // namespace crashpad\n\n#endif // CRASHPAD_CLIENT_SIMPLE_ADDRESS_RANGE_BAG_H_\n" }, { "path": "client/simple_address_range_bag_test.cc", "content": "// Copyright 2016 The Crashpad Authors\n//\n// Licensed under the Apache License, Version 2.0 (the \"License\");\n// you may not use this file except in compliance with the License.\n// You may obtain a copy of the License at\n//\n// http://www.apache.org/licenses/LICENSE-2.0\n//\n// Unless required by applicable law or agreed to in writing, software\n// distributed under the License is distributed on an \"AS IS\" BASIS,\n// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n// See the License for the specific language governing permissions and\n// limitations under the License.\n\n#include \"client/simple_address_range_bag.h\"\n\n#include \"gtest/gtest.h\"\n#include \"test/gtest_death.h\"\n\nnamespace crashpad {\nnamespace test {\nnamespace {\n\nTEST(SimpleAddressRangeBag, Entry) {\n using TestBag = TSimpleAddressRangeBag<15>;\n TestBag bag;\n\n const TestBag::Entry* entry = TestBag::Iterator(bag).Next();\n EXPECT_FALSE(entry);\n\n bag.Insert(reinterpret_cast(0x1000), 200);\n entry = TestBag::Iterator(bag).Next();\n ASSERT_TRUE(entry);\n EXPECT_EQ(0x1000u, entry->base);\n EXPECT_EQ(200u, entry->size);\n\n bag.Remove(reinterpret_cast(0x1000), 200);\n EXPECT_FALSE(entry->is_active());\n EXPECT_EQ(0u, entry->base);\n EXPECT_EQ(0u, entry->size);\n}\n\nTEST(SimpleAddressRangeBag, SimpleAddressRangeBag) {\n SimpleAddressRangeBag bag;\n\n EXPECT_TRUE(bag.Insert(reinterpret_cast(0x1000), 10));\n EXPECT_TRUE(bag.Insert(reinterpret_cast(0x2000), 20));\n EXPECT_TRUE(bag.Insert(CheckedRange(0x3000, 30)));\n\n EXPECT_EQ(3u, bag.GetCount());\n\n // Duplicates added too.\n EXPECT_TRUE(bag.Insert(CheckedRange(0x3000, 30)));\n EXPECT_TRUE(bag.Insert(CheckedRange(0x3000, 30)));\n EXPECT_EQ(5u, bag.GetCount());\n\n // Can be removed 3 times, but not the 4th time.\n EXPECT_TRUE(bag.Remove(CheckedRange(0x3000, 30)));\n EXPECT_TRUE(bag.Remove(CheckedRange(0x3000, 30)));\n EXPECT_TRUE(bag.Remove(CheckedRange(0x3000, 30)));\n EXPECT_EQ(2u, bag.GetCount());\n EXPECT_FALSE(bag.Remove(CheckedRange(0x3000, 30)));\n EXPECT_EQ(2u, bag.GetCount());\n\n EXPECT_TRUE(bag.Remove(reinterpret_cast(0x1000), 10));\n EXPECT_TRUE(bag.Remove(reinterpret_cast(0x2000), 20));\n EXPECT_EQ(0u, bag.GetCount());\n}\n\nTEST(SimpleAddressRangeBag, CopyAndAssign) {\n TSimpleAddressRangeBag<10> bag;\n EXPECT_TRUE(bag.Insert(CheckedRange(1, 2)));\n EXPECT_TRUE(bag.Insert(CheckedRange(3, 4)));\n EXPECT_TRUE(bag.Insert(CheckedRange(5, 6)));\n EXPECT_TRUE(bag.Remove(CheckedRange(3, 4)));\n EXPECT_EQ(bag.GetCount(), 2u);\n\n // Test copy.\n TSimpleAddressRangeBag<10> bag_copy(bag);\n EXPECT_EQ(bag_copy.GetCount(), 2u);\n EXPECT_TRUE(bag_copy.Remove(CheckedRange(1, 2)));\n EXPECT_TRUE(bag_copy.Remove(CheckedRange(5, 6)));\n EXPECT_EQ(bag_copy.GetCount(), 0u);\n EXPECT_EQ(bag.GetCount(), 2u);\n\n // Test assign.\n TSimpleAddressRangeBag<10> bag_assign;\n bag_assign = bag;\n EXPECT_EQ(bag_assign.GetCount(), 2u);\n EXPECT_TRUE(bag_assign.Remove(CheckedRange(1, 2)));\n EXPECT_TRUE(bag_assign.Remove(CheckedRange(5, 6)));\n EXPECT_EQ(bag_assign.GetCount(), 0u);\n EXPECT_EQ(bag.GetCount(), 2u);\n}\n\n// Running out of space shouldn't crash.\nTEST(SimpleAddressRangeBag, OutOfSpace) {\n TSimpleAddressRangeBag<2> bag;\n EXPECT_TRUE(bag.Insert(CheckedRange(1, 2)));\n EXPECT_TRUE(bag.Insert(CheckedRange(3, 4)));\n EXPECT_FALSE(bag.Insert(CheckedRange(5, 6)));\n EXPECT_EQ(bag.GetCount(), 2u);\n EXPECT_FALSE(bag.Remove(CheckedRange(5, 6)));\n}\n\n} // namespace\n} // namespace test\n} // namespace crashpad\n" }, { "path": "client/simple_string_dictionary.h", "content": "// Copyright 2014 The Crashpad Authors\n//\n// Licensed under the Apache License, Version 2.0 (the \"License\");\n// you may not use this file except in compliance with the License.\n// You may obtain a copy of the License at\n//\n// http://www.apache.org/licenses/LICENSE-2.0\n//\n// Unless required by applicable law or agreed to in writing, software\n// distributed under the License is distributed on an \"AS IS\" BASIS,\n// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n// See the License for the specific language governing permissions and\n// limitations under the License.\n\n#ifndef CRASHPAD_CLIENT_SIMPLE_STRING_DICTIONARY_H_\n#define CRASHPAD_CLIENT_SIMPLE_STRING_DICTIONARY_H_\n\n#include \n#include \n\n#include \n#include \n#include \n\n#include \"base/check_op.h\"\n#include \"util/misc/implicit_cast.h\"\n\nnamespace crashpad {\n\n//! \\brief A map/dictionary collection implementation using a fixed amount of\n//! storage, so that it does not perform any dynamic allocations for its\n//! operations.\n//!\n//! The actual map storage (TSimpleStringDictionary::Entry) is guaranteed to be\n//! POD, so that it can be transmitted over various IPC mechanisms.\n//!\n//! The template parameters control the amount of storage used for the key,\n//! value, and map. The \\a KeySize and \\a ValueSize are measured in bytes, not\n//! glyphs, and include space for a trailing `NUL` byte. This gives space for\n//! `KeySize - 1` and `ValueSize - 1` characters in an entry. \\a NumEntries is\n//! the total number of entries that will fit in the map.\ntemplate \nclass TSimpleStringDictionary {\n public:\n //! \\brief Constant and publicly accessible versions of the template\n //! parameters.\n //! \\{\n static const size_t key_size = KeySize;\n static const size_t value_size = ValueSize;\n static const size_t num_entries = NumEntries;\n //! \\}\n\n //! \\brief A single entry in the map.\n struct Entry {\n //! \\brief The entry’s key.\n //!\n //! This string is always `NUL`-terminated. If this is a 0-length\n //! `NUL`-terminated string, the entry is inactive.\n char key[KeySize];\n\n //! \\brief The entry’s value.\n //!\n //! This string is always `NUL`-terminated.\n char value[ValueSize];\n\n //! \\brief Returns the validity of the entry.\n //!\n //! If #key is an empty string, the entry is considered inactive, and this\n //! method returns `false`. Otherwise, returns `true`.\n bool is_active() const {\n return key[0] != '\\0';\n }\n };\n\n //! \\brief An iterator to traverse all of the active entries in a\n //! TSimpleStringDictionary.\n class Iterator {\n public:\n explicit Iterator(const TSimpleStringDictionary& map)\n : map_(map),\n current_(0) {\n }\n\n Iterator(const Iterator&) = delete;\n Iterator& operator=(const Iterator&) = delete;\n\n //! \\brief Returns the next entry in the map, or `nullptr` if at the end of\n //! the collection.\n const Entry* Next() {\n while (current_ < map_.num_entries) {\n const Entry* entry = &map_.entries_[current_++];\n if (entry->is_active()) {\n return entry;\n }\n }\n return nullptr;\n }\n\n private:\n const TSimpleStringDictionary& map_;\n size_t current_;\n };\n\n TSimpleStringDictionary()\n : entries_() {\n }\n\n TSimpleStringDictionary(const TSimpleStringDictionary& other) {\n *this = other;\n }\n\n TSimpleStringDictionary& operator=(const TSimpleStringDictionary& other) {\n memcpy(entries_, other.entries_, sizeof(entries_));\n return *this;\n }\n\n //! \\brief Returns the number of active key/value pairs. The upper limit for\n //! this is \\a NumEntries.\n size_t GetCount() const {\n size_t count = 0;\n for (size_t i = 0; i < num_entries; ++i) {\n if (entries_[i].is_active()) {\n ++count;\n }\n }\n return count;\n }\n\n //! \\brief Given \\a key, returns its corresponding value.\n //!\n //! \\param[in] key The key to look up. This must not be `nullptr`, nor an\n //! empty string. It must not contain embedded `NUL`s.\n //!\n //! \\return The corresponding value for \\a key, or if \\a key is not found,\n //! `nullptr`.\n const char* GetValueForKey(std::string_view key) const {\n DCHECK(key.data());\n DCHECK(key.size());\n DCHECK_EQ(key.find('\\0', 0), std::string_view::npos);\n if (!key.data() || !key.size()) {\n return nullptr;\n }\n\n const Entry* entry = GetConstEntryForKey(key);\n if (!entry) {\n return nullptr;\n }\n\n return entry->value;\n }\n\n //! \\brief Stores \\a value into \\a key, replacing the existing value if \\a key\n //! is already present.\n //!\n //! If \\a key is not yet in the map and the map is already full (containing\n //! \\a NumEntries active entries), this operation silently fails.\n //!\n //! \\param[in] key The key to store. This must not be `nullptr`, nor an empty\n //! string. It must not contain embedded `NUL`s.\n //! \\param[in] value The value to store. If `nullptr`, \\a key is removed from\n //! the map. Must not contain embedded `NUL`s.\n void SetKeyValue(std::string_view key, std::string_view value) {\n if (!value.data()) {\n RemoveKey(key);\n return;\n }\n\n DCHECK(key.data());\n DCHECK(key.size());\n DCHECK_EQ(key.find('\\0', 0), std::string_view::npos);\n if (!key.data() || !key.size()) {\n return;\n }\n\n // |key| must not be an empty string.\n DCHECK_NE(key[0], '\\0');\n if (key[0] == '\\0') {\n return;\n }\n\n // |value| must not contain embedded NULs.\n DCHECK_EQ(value.find('\\0', 0), std::string_view::npos);\n\n Entry* entry = GetEntryForKey(key);\n\n // If it does not yet exist, attempt to insert it.\n if (!entry) {\n for (size_t i = 0; i < num_entries; ++i) {\n if (!entries_[i].is_active()) {\n entry = &entries_[i];\n SetFromStringView(key, entry->key, key_size);\n break;\n }\n }\n }\n\n // If the map is out of space, |entry| will be nullptr.\n if (!entry) {\n return;\n }\n\n#ifndef NDEBUG\n // Sanity check that the key only appears once.\n int count = 0;\n for (size_t i = 0; i < num_entries; ++i) {\n if (EntryKeyEquals(key, entries_[i])) {\n ++count;\n }\n }\n DCHECK_EQ(count, 1);\n#endif\n\n SetFromStringView(value, entry->value, value_size);\n }\n\n //! \\brief Removes \\a key from the map.\n //!\n //! If \\a key is not found, this is a no-op.\n //!\n //! \\param[in] key The key of the entry to remove. This must not be `nullptr`,\n //! nor an empty string. It must not contain embedded `NUL`s.\n void RemoveKey(std::string_view key) {\n DCHECK(key.data());\n DCHECK(key.size());\n DCHECK_EQ(key.find('\\0', 0), std::string_view::npos);\n if (!key.data() || !key.size()) {\n return;\n }\n\n Entry* entry = GetEntryForKey(key);\n if (entry) {\n entry->key[0] = '\\0';\n entry->value[0] = '\\0';\n }\n\n DCHECK_EQ(GetEntryForKey(key), implicit_cast(nullptr));\n }\n\n private:\n static void SetFromStringView(std::string_view src,\n char* dst,\n size_t dst_size) {\n size_t copy_len = std::min(dst_size - 1, src.size());\n src.copy(dst, copy_len);\n dst[copy_len] = '\\0';\n }\n\n static bool EntryKeyEquals(std::string_view key, const Entry& entry) {\n if (key.size() >= KeySize)\n return false;\n\n // Test for a NUL terminator and early out if it's absent.\n if (entry.key[key.size()] != '\\0')\n return false;\n\n // As there's a NUL terminator at the right position in the entries\n // string, strncmp can do the rest.\n return strncmp(key.data(), entry.key, key.size()) == 0;\n }\n\n const Entry* GetConstEntryForKey(std::string_view key) const {\n for (size_t i = 0; i < num_entries; ++i) {\n if (EntryKeyEquals(key, entries_[i])) {\n return &entries_[i];\n }\n }\n return nullptr;\n }\n\n Entry* GetEntryForKey(std::string_view key) {\n return const_cast(GetConstEntryForKey(key));\n }\n\n Entry entries_[NumEntries];\n};\n\n//! \\brief A TSimpleStringDictionary with default template parameters.\n//!\n//! For historical reasons this specialized version is available with the same\n//! size factors as a previous implementation.\nusing SimpleStringDictionary = TSimpleStringDictionary<256, 256, 64>;\n\nstatic_assert(std::is_standard_layout::value,\n \"SimpleStringDictionary must be standard layout\");\n\n} // namespace crashpad\n\n#endif // CRASHPAD_CLIENT_SIMPLE_STRING_DICTIONARY_H_\n" }, { "path": "client/simple_string_dictionary_test.cc", "content": "// Copyright 2014 The Crashpad Authors\n//\n// Licensed under the Apache License, Version 2.0 (the \"License\");\n// you may not use this file except in compliance with the License.\n// You may obtain a copy of the License at\n//\n// http://www.apache.org/licenses/LICENSE-2.0\n//\n// Unless required by applicable law or agreed to in writing, software\n// distributed under the License is distributed on an \"AS IS\" BASIS,\n// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n// See the License for the specific language governing permissions and\n// limitations under the License.\n\n#include \"client/simple_string_dictionary.h\"\n\n#include \n\n#include \"base/check_op.h\"\n#include \"gtest/gtest.h\"\n#include \"test/gtest_death.h\"\n\nnamespace crashpad {\nnamespace test {\nnamespace {\n\nTEST(SimpleStringDictionary, Entry) {\n using TestMap = TSimpleStringDictionary<5, 9, 15>;\n TestMap map;\n\n const TestMap::Entry* entry = TestMap::Iterator(map).Next();\n EXPECT_FALSE(entry);\n\n // Try setting a key/value and then verify.\n map.SetKeyValue(\"key1\", \"value1\");\n entry = TestMap::Iterator(map).Next();\n ASSERT_TRUE(entry);\n EXPECT_STREQ(entry->key, \"key1\");\n EXPECT_STREQ(entry->value, \"value1\");\n\n // Try setting a new value.\n map.SetKeyValue(\"key1\", \"value3\");\n EXPECT_STREQ(entry->value, \"value3\");\n\n // Make sure the key didn't change.\n EXPECT_STREQ(entry->key, \"key1\");\n\n // Clear the entry and verify the key and value are empty strings.\n map.RemoveKey(\"key1\");\n EXPECT_FALSE(entry->is_active());\n EXPECT_EQ(0u, strlen(entry->key));\n EXPECT_EQ(0u, strlen(entry->value));\n}\n\nTEST(SimpleStringDictionary, SimpleStringDictionary) {\n // Make a new dictionary\n SimpleStringDictionary dict;\n\n // Set three distinct values on three keys\n dict.SetKeyValue(\"key1\", \"value1\");\n dict.SetKeyValue(\"key2\", \"value2\");\n dict.SetKeyValue(\"key3\", \"value3\");\n\n EXPECT_NE(dict.GetValueForKey(\"key1\"), \"value1\");\n EXPECT_NE(dict.GetValueForKey(\"key2\"), \"value2\");\n EXPECT_NE(dict.GetValueForKey(\"key3\"), \"value3\");\n EXPECT_EQ(3u, dict.GetCount());\n // try an unknown key\n EXPECT_FALSE(dict.GetValueForKey(\"key4\"));\n\n // Remove a key\n dict.RemoveKey(\"key3\");\n\n // Now make sure it's not there anymore\n EXPECT_FALSE(dict.GetValueForKey(\"key3\"));\n\n // Remove by setting value to nullptr\n dict.SetKeyValue(\"key2\", std::string_view(nullptr, 0));\n\n // Now make sure it's not there anymore\n EXPECT_FALSE(dict.GetValueForKey(\"key2\"));\n}\n\nTEST(SimpleStringDictionary, CopyAndAssign) {\n TSimpleStringDictionary<10, 10, 10> map;\n map.SetKeyValue(\"one\", \"a\");\n map.SetKeyValue(\"two\", \"b\");\n map.SetKeyValue(\"three\", \"c\");\n map.RemoveKey(\"two\");\n EXPECT_EQ(map.GetCount(), 2u);\n\n // Test copy.\n TSimpleStringDictionary<10, 10, 10> map_copy(map);\n EXPECT_EQ(map_copy.GetCount(), 2u);\n EXPECT_STREQ(\"a\", map_copy.GetValueForKey(\"one\"));\n EXPECT_STREQ(\"c\", map_copy.GetValueForKey(\"three\"));\n map_copy.SetKeyValue(\"four\", \"d\");\n EXPECT_STREQ(\"d\", map_copy.GetValueForKey(\"four\"));\n EXPECT_FALSE(map.GetValueForKey(\"four\"));\n\n // Test assign.\n TSimpleStringDictionary<10, 10, 10> map_assign;\n map_assign = map;\n EXPECT_EQ(map_assign.GetCount(), 2u);\n EXPECT_STREQ(\"a\", map_assign.GetValueForKey(\"one\"));\n EXPECT_STREQ(\"c\", map_assign.GetValueForKey(\"three\"));\n map_assign.SetKeyValue(\"four\", \"d\");\n EXPECT_STREQ(\"d\", map_assign.GetValueForKey(\"four\"));\n EXPECT_FALSE(map.GetValueForKey(\"four\"));\n\n map.RemoveKey(\"one\");\n EXPECT_FALSE(map.GetValueForKey(\"one\"));\n EXPECT_STREQ(\"a\", map_copy.GetValueForKey(\"one\"));\n EXPECT_STREQ(\"a\", map_assign.GetValueForKey(\"one\"));\n}\n\n// Add a bunch of values to the dictionary, remove some entries in the middle,\n// and then add more.\nTEST(SimpleStringDictionary, Iterator) {\n SimpleStringDictionary dict;\n\n char key[SimpleStringDictionary::key_size];\n char value[SimpleStringDictionary::value_size];\n\n constexpr int kDictionaryCapacity = SimpleStringDictionary::num_entries;\n constexpr int kPartitionIndex = kDictionaryCapacity - 5;\n\n // We assume at least this size in the tests below\n ASSERT_GE(kDictionaryCapacity, 64);\n\n // We'll keep track of the number of key/value pairs we think should be in the\n // dictionary\n int expected_dictionary_size = 0;\n\n // Set a bunch of key/value pairs like key0/value0, key1/value1, ...\n for (int i = 0; i < kPartitionIndex; ++i) {\n ASSERT_LT(snprintf(key, sizeof(key), \"key%d\", i),\n static_cast(sizeof(key)));\n ASSERT_LT(snprintf(value, sizeof(value), \"value%d\", i),\n static_cast(sizeof(value)));\n dict.SetKeyValue(key, value);\n }\n expected_dictionary_size = kPartitionIndex;\n\n // set a couple of the keys twice (with the same value) - should be nop\n dict.SetKeyValue(\"key2\", \"value2\");\n dict.SetKeyValue(\"key4\", \"value4\");\n dict.SetKeyValue(\"key15\", \"value15\");\n\n // Remove some random elements in the middle\n dict.RemoveKey(\"key7\");\n dict.RemoveKey(\"key18\");\n dict.RemoveKey(\"key23\");\n dict.RemoveKey(\"key31\");\n expected_dictionary_size -= 4; // we just removed four key/value pairs\n\n // Set some more key/value pairs like key59/value59, key60/value60, ...\n for (int i = kPartitionIndex; i < kDictionaryCapacity; ++i) {\n ASSERT_LT(snprintf(key, sizeof(key), \"key%d\", i),\n static_cast(sizeof(key)));\n ASSERT_LT(snprintf(value, sizeof(value), \"value%d\", i),\n static_cast(sizeof(value)));\n dict.SetKeyValue(key, value);\n }\n expected_dictionary_size += kDictionaryCapacity - kPartitionIndex;\n\n // Now create an iterator on the dictionary\n SimpleStringDictionary::Iterator iter(dict);\n\n // We then verify that it iterates through exactly the number of key/value\n // pairs we expect, and that they match one-for-one with what we would expect.\n // The ordering of the iteration does not matter...\n\n // used to keep track of number of occurrences found for key/value pairs\n int count[kDictionaryCapacity];\n memset(count, 0, sizeof(count));\n\n int total_count = 0;\n\n for (;;) {\n const SimpleStringDictionary::Entry* entry = iter.Next();\n if (!entry)\n break;\n total_count++;\n\n // Extract key_number from a string of the form key\n int key_number;\n sscanf(entry->key, \"key%d\", &key_number);\n\n // Extract value_number from a string of the form value\n int value_number;\n sscanf(entry->value, \"value%d\", &value_number);\n\n // The value number should equal the key number since that's how we set them\n EXPECT_EQ(value_number, key_number);\n\n // Key and value numbers should be in proper range: 0 <= key_number <\n // kDictionaryCapacity\n bool key_in_good_range =\n key_number >= 0 && key_number < kDictionaryCapacity;\n bool value_in_good_range =\n value_number >= 0 && value_number < kDictionaryCapacity;\n EXPECT_TRUE(key_in_good_range);\n EXPECT_TRUE(value_in_good_range);\n\n if (key_in_good_range && value_in_good_range) {\n ++count[key_number];\n }\n }\n\n // Make sure each of the key/value pairs showed up exactly one time, except\n // for the ones which we removed.\n for (size_t i = 0; i < kDictionaryCapacity; ++i) {\n // Skip over key7, key18, key23, and key31, since we removed them\n if (!(i == 7 || i == 18 || i == 23 || i == 31)) {\n EXPECT_EQ(1, count[i]);\n }\n }\n\n // Make sure the number of iterations matches the expected dictionary size.\n EXPECT_EQ(total_count, expected_dictionary_size);\n}\n\nTEST(SimpleStringDictionary, AddRemove) {\n TSimpleStringDictionary<5, 7, 6> map;\n map.SetKeyValue(\"rob\", \"ert\");\n map.SetKeyValue(\"mike\", \"pink\");\n map.SetKeyValue(\"mark\", \"allays\");\n\n EXPECT_EQ(map.GetCount(), 3u);\n EXPECT_STREQ(\"ert\", map.GetValueForKey(\"rob\"));\n EXPECT_STREQ(\"pink\", map.GetValueForKey(\"mike\"));\n EXPECT_STREQ(\"allays\", map.GetValueForKey(\"mark\"));\n\n map.RemoveKey(\"mike\");\n\n EXPECT_EQ(map.GetCount(), 2u);\n EXPECT_FALSE(map.GetValueForKey(\"mike\"));\n\n map.SetKeyValue(\"mark\", \"mal\");\n EXPECT_EQ(map.GetCount(), 2u);\n EXPECT_STREQ(\"mal\", map.GetValueForKey(\"mark\"));\n\n map.RemoveKey(\"mark\");\n EXPECT_EQ(map.GetCount(), 1u);\n EXPECT_FALSE(map.GetValueForKey(\"mark\"));\n}\n\n// Running out of space shouldn't crash.\nTEST(SimpleStringDictionary, OutOfSpace) {\n TSimpleStringDictionary<3, 2, 2> map;\n map.SetKeyValue(\"a\", \"1\");\n map.SetKeyValue(\"b\", \"2\");\n map.SetKeyValue(\"c\", \"3\");\n EXPECT_EQ(map.GetCount(), 2u);\n EXPECT_FALSE(map.GetValueForKey(\"c\"));\n}\n\n#if DCHECK_IS_ON()\n\nTEST(SimpleStringDictionaryDeathTest, SetKeyValueWithNullKey) {\n TSimpleStringDictionary<4, 6, 6> map;\n ASSERT_DEATH_CHECK(map.SetKeyValue(std::string_view(nullptr, 0), \"hello\"),\n \"key\");\n}\n\nTEST(SimpleStringDictionaryDeathTest, GetValueForKeyWithNullKey) {\n TSimpleStringDictionary<4, 6, 6> map;\n map.SetKeyValue(\"hi\", \"there\");\n ASSERT_DEATH_CHECK(map.GetValueForKey(std::string_view(nullptr, 0)), \"key\");\n EXPECT_STREQ(\"there\", map.GetValueForKey(\"hi\"));\n}\n\n#endif\n\n// The tests above, without DEATH_CHECK assertions.\nTEST(SimpleStringDictionaryDeathTest, GetValueForKeyWithoutNullKey) {\n TSimpleStringDictionary<4, 6, 6> map;\n\n map.SetKeyValue(\"hi\", \"there\");\n EXPECT_STREQ(\"there\", map.GetValueForKey(\"hi\"));\n map.RemoveKey(\"hi\");\n EXPECT_EQ(map.GetCount(), 0u);\n}\n\n} // namespace\n} // namespace test\n} // namespace crashpad\n" }, { "path": "client/simulate_crash.h", "content": "// Copyright 2014 The Crashpad Authors\n//\n// Licensed under the Apache License, Version 2.0 (the \"License\");\n// you may not use this file except in compliance with the License.\n// You may obtain a copy of the License at\n//\n// http://www.apache.org/licenses/LICENSE-2.0\n//\n// Unless required by applicable law or agreed to in writing, software\n// distributed under the License is distributed on an \"AS IS\" BASIS,\n// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n// See the License for the specific language governing permissions and\n// limitations under the License.\n\n#ifndef CRASHPAD_CLIENT_SIMULATE_CRASH_H_\n#define CRASHPAD_CLIENT_SIMULATE_CRASH_H_\n\n#include \"build/build_config.h\"\n\n// IWYU pragma: begin_exports\n#if BUILDFLAG(IS_MAC)\n#include \"client/simulate_crash_mac.h\"\n#elif BUILDFLAG(IS_IOS)\n#include \"client/simulate_crash_ios.h\"\n#elif BUILDFLAG(IS_WIN)\n#include \"client/simulate_crash_win.h\"\n#elif BUILDFLAG(IS_LINUX) || BUILDFLAG(IS_CHROMEOS) || BUILDFLAG(IS_ANDROID)\n#include \"client/simulate_crash_linux.h\"\n#endif\n// IWYU pragma: end_exports\n\n#endif // CRASHPAD_CLIENT_SIMULATE_CRASH_H_\n" }, { "path": "client/simulate_crash_ios.h", "content": "// Copyright 2021 The Crashpad Authors\n//\n// Licensed under the Apache License, Version 2.0 (the \"License\");\n// you may not use this file except in compliance with the License.\n// You may obtain a copy of the License at\n//\n// http://www.apache.org/licenses/LICENSE-2.0\n//\n// Unless required by applicable law or agreed to in writing, software\n// distributed under the License is distributed on an \"AS IS\" BASIS,\n// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n// See the License for the specific language governing permissions and\n// limitations under the License.\n\n#ifndef CRASHPAD_CLIENT_SIMULATE_CRASH_IOS_H_\n#define CRASHPAD_CLIENT_SIMULATE_CRASH_IOS_H_\n\n#include \"client/crashpad_client.h\"\n#include \"util/misc/capture_context.h\"\n\n//! \\file\n\n//! \\brief Captures the CPU context and creates a minidump dump without an\n//! exception. The minidump will immediately become eligible for further\n//! processing, including upload.\n//!\n//! \\sa CRASHPAD_SIMULATE_CRASH_AND_DEFER_PROCESSING\n#define CRASHPAD_SIMULATE_CRASH() \\\n do { \\\n crashpad::NativeCPUContext cpu_context; \\\n crashpad::CaptureContext(&cpu_context); \\\n crashpad::CrashpadClient::DumpWithoutCrash(&cpu_context); \\\n } while (false)\n\n//! \\brief Captures the CPU context and captures an intermediate dump without an\n//! exception. Does not convert the intermediate dump into a minidump.\n//!\n//! Deferring processing is useful when the application may be in an unstable\n//! state, such as during a hang.\n//!\n//! \\sa CRASHPAD_SIMULATE_CRASH\n#define CRASHPAD_SIMULATE_CRASH_AND_DEFER_PROCESSING() \\\n do { \\\n crashpad::NativeCPUContext cpu_context; \\\n crashpad::CaptureContext(&cpu_context); \\\n crashpad::CrashpadClient::DumpWithoutCrashAndDeferProcessing( \\\n &cpu_context); \\\n } while (false)\n\n#define CRASHPAD_SIMULATE_CRASH_AND_DEFER_PROCESSING_AT_PATH(path) \\\n do { \\\n crashpad::NativeCPUContext cpu_context; \\\n crashpad::CaptureContext(&cpu_context); \\\n crashpad::CrashpadClient::DumpWithoutCrashAndDeferProcessingAtPath( \\\n &cpu_context, path); \\\n } while (false)\n\n#endif // CRASHPAD_CLIENT_SIMULATE_CRASH_IOS_H_\n" }, { "path": "client/simulate_crash_linux.h", "content": "// Copyright 2018 The Crashpad Authors\n//\n// Licensed under the Apache License, Version 2.0 (the \"License\");\n// you may not use this file except in compliance with the License.\n// You may obtain a copy of the License at\n//\n// http://www.apache.org/licenses/LICENSE-2.0\n//\n// Unless required by applicable law or agreed to in writing, software\n// distributed under the License is distributed on an \"AS IS\" BASIS,\n// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n// See the License for the specific language governing permissions and\n// limitations under the License.\n\n#ifndef CRASHPAD_CLIENT_SIMULATE_CRASH_LINUX_H_\n#define CRASHPAD_CLIENT_SIMULATE_CRASH_LINUX_H_\n\n#include \"client/crashpad_client.h\"\n#include \"util/misc/capture_context.h\"\n\n//! \\file\n\n//! \\brief Captures the CPU context and simulates an exception without crashing.\n#define CRASHPAD_SIMULATE_CRASH() \\\n do { \\\n crashpad::NativeCPUContext simulate_crash_cpu_context; \\\n crashpad::CaptureContext(&simulate_crash_cpu_context); \\\n crashpad::CrashpadClient::DumpWithoutCrash(&simulate_crash_cpu_context); \\\n } while (false)\n\n#endif // CRASHPAD_CLIENT_SIMULATE_CRASH_LINUX_H_\n" }, { "path": "client/simulate_crash_mac.cc", "content": "// Copyright 2014 The Crashpad Authors\n//\n// Licensed under the Apache License, Version 2.0 (the \"License\");\n// you may not use this file except in compliance with the License.\n// You may obtain a copy of the License at\n//\n// http://www.apache.org/licenses/LICENSE-2.0\n//\n// Unless required by applicable law or agreed to in writing, software\n// distributed under the License is distributed on an \"AS IS\" BASIS,\n// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n// See the License for the specific language governing permissions and\n// limitations under the License.\n\n#include \"client/simulate_crash_mac.h\"\n\n#include \n#include \n\n#include \n\n#include \"base/apple/mach_logging.h\"\n#include \"base/apple/scoped_mach_port.h\"\n#include \"base/check_op.h\"\n#include \"base/logging.h\"\n#include \"build/build_config.h\"\n#include \"util/mach/exc_client_variants.h\"\n#include \"util/mach/exception_behaviors.h\"\n#include \"util/mach/exception_ports.h\"\n#include \"util/mach/mach_extensions.h\"\n#include \"util/misc/implicit_cast.h\"\n\nnamespace crashpad {\n\nnamespace {\n\n//! \\brief Sends an exception message to an exception port in accordance with\n//! the behavior and thread state flavor it’s registered to receive.\n//!\n//! \\param[in] thread, task, exception, code, code_count These parameters will\n//! be passed to the exception handler as appropriate.\n//! \\param[in] cpu_context The value to use for the thread state, if \\a behavior\n//! indicates that the handler should receive a thread state and if the\n//! supplied thread state matches or can be converted to \\a flavor. If \\a\n//! behavior requires a thread state but this argument cannot be converted\n//! to match \\a flavor, `thread_get_state()` will be called to obtain a\n//! suitable thread state value.\n//! \\param[in] handler The Mach exception handler to deliver the exception to.\n//! \\param[in] set_state If `true` and \\a behavior indicates that the handler\n//! should receive and return a thread state, a new thread state will be set\n//! by `thread_set_state()` upon successful completion of the exception\n//! handler. If `false`, this will be suppressed, even when \\a behavior\n//! indicates that the handler receives and returns a thread state.\n//!\n//! \\return `true` if the exception was delivered to the handler and the handler\n//! indicated success. `false` otherwise, with a warning message logged.\nbool DeliverException(thread_t thread,\n task_t task,\n exception_type_t exception,\n const mach_exception_data_t code,\n mach_msg_type_number_t code_count,\n const NativeCPUContext& cpu_context,\n const ExceptionPorts::ExceptionHandler& handler,\n bool set_state) {\n kern_return_t kr;\n\n bool handler_wants_state = ExceptionBehaviorHasState(handler.behavior);\n if (!handler_wants_state) {\n // Regardless of the passed-in value of |set_state|, if the handler won’t be\n // dealing with any state at all, no state should be set.\n set_state = false;\n }\n\n // old_state is only used if the context already captured doesn’t match (or\n // can’t be converted to) what’s registered for the handler.\n thread_state_data_t old_state;\n\n thread_state_flavor_t flavor = handler.flavor;\n ConstThreadState state;\n mach_msg_type_number_t state_count;\n switch (flavor) {\n#if defined(ARCH_CPU_X86_FAMILY)\n case x86_THREAD_STATE:\n state = reinterpret_cast(&cpu_context);\n state_count = x86_THREAD_STATE_COUNT;\n break;\n#if defined(ARCH_CPU_X86)\n case x86_THREAD_STATE32:\n state = reinterpret_cast(&cpu_context.uts.ts32);\n state_count = cpu_context.tsh.count;\n break;\n#elif defined(ARCH_CPU_X86_64)\n case x86_THREAD_STATE64:\n state = reinterpret_cast(&cpu_context.uts.ts64);\n state_count = cpu_context.tsh.count;\n break;\n#endif\n#elif defined(ARCH_CPU_ARM64)\n case ARM_UNIFIED_THREAD_STATE:\n state = reinterpret_cast(&cpu_context);\n state_count = ARM_UNIFIED_THREAD_STATE_COUNT;\n break;\n case ARM_THREAD_STATE64:\n state = reinterpret_cast(&cpu_context.ts_64);\n state_count = cpu_context.ash.count;\n break;\n#else\n#error Port to your CPU architecture\n#endif\n\n case THREAD_STATE_NONE:\n // This is only acceptable if the handler doesn’t have one of the “state”\n // behaviors. Otherwise, if the kernel were attempting to send an\n // exception message to this port, it would call thread_getstatus() (known\n // outside the kernel as thread_get_state()) which would fail because\n // THREAD_STATE_NONE is not a valid state to get. See 10.9.5\n // xnu-2422.115.4/osfmk/kern/exception.c exception_deliver() and\n // xnu-2422.115.4/osfmk/i386/pcb.c machine_thread_get_state().\n if (!handler_wants_state) {\n state = nullptr;\n state_count = 0;\n break;\n }\n\n LOG(WARNING) << \"exception handler has unexpected state flavor\" << flavor;\n return false;\n\n default:\n if (!handler_wants_state) {\n // Don’t bother getting any thread state if the handler’s not actually\n // going to use it.\n state = nullptr;\n state_count = 0;\n } else {\n state = old_state;\n state_count = THREAD_STATE_MAX;\n kr = thread_get_state(thread, flavor, old_state, &state_count);\n if (kr != KERN_SUCCESS) {\n MACH_LOG(WARNING, kr) << \"thread_get_state\";\n return false;\n }\n }\n break;\n }\n\n // new_state is supposed to be an out parameter only, but in case the handler\n // doesn't touch it, make sure it's initialized to a valid thread state.\n // Otherwise, the thread_set_state() call below would set a garbage thread\n // state.\n thread_state_data_t new_state;\n size_t state_size =\n sizeof(natural_t) *\n std::min(state_count, implicit_cast(THREAD_STATE_MAX));\n memcpy(new_state, state, state_size);\n mach_msg_type_number_t new_state_count = THREAD_STATE_MAX;\n\n kr = UniversalExceptionRaise(handler.behavior,\n handler.port,\n thread,\n task,\n exception,\n code,\n code_count,\n &flavor,\n state,\n state_count,\n new_state,\n &new_state_count);\n\n // The kernel treats a return value of MACH_RCV_PORT_DIED as successful,\n // although it will not set a new thread state in that case. See 10.9.5\n // xnu-2422.115.4/osfmk/kern/exception.c exception_deliver(), and the more\n // elaborate comment at util/mach/exc_server_variants.h\n // ExcServerSuccessfulReturnValue(). Duplicate that behavior.\n bool success = kr == KERN_SUCCESS || kr == MACH_RCV_PORT_DIED;\n MACH_LOG_IF(WARNING, !success, kr) << \"UniversalExceptionRaise\";\n\n if (kr == KERN_SUCCESS && set_state) {\n kr = thread_set_state(thread, flavor, new_state, new_state_count);\n MACH_LOG_IF(WARNING, kr != KERN_SUCCESS, kr) << \"thread_set_state\";\n }\n\n return success;\n}\n\n} // namespace\n\nvoid SimulateCrash(const NativeCPUContext& cpu_context) {\n#if defined(ARCH_CPU_X86)\n DCHECK_EQ(implicit_cast(cpu_context.tsh.flavor),\n implicit_cast(x86_THREAD_STATE32));\n DCHECK_EQ(implicit_cast(cpu_context.tsh.count),\n x86_THREAD_STATE32_COUNT);\n#elif defined(ARCH_CPU_X86_64)\n DCHECK_EQ(implicit_cast(cpu_context.tsh.flavor),\n implicit_cast(x86_THREAD_STATE64));\n DCHECK_EQ(implicit_cast(cpu_context.tsh.count),\n x86_THREAD_STATE64_COUNT);\n#elif defined(ARCH_CPU_ARM64)\n DCHECK_EQ(implicit_cast(cpu_context.ash.flavor),\n implicit_cast(ARM_THREAD_STATE64));\n DCHECK_EQ(implicit_cast(cpu_context.ash.count),\n ARM_THREAD_STATE64_COUNT);\n#else\n#error Port to your CPU architecture\n#endif\n\n base::apple::ScopedMachSendRight thread(mach_thread_self());\n exception_type_t exception = kMachExceptionSimulated;\n mach_exception_data_type_t codes[] = {0, 0};\n mach_msg_type_number_t code_count = std::size(codes);\n\n // Look up the handler for EXC_CRASH exceptions in the same way that the\n // kernel would: try a thread handler, then a task handler, and finally a host\n // handler. 10.9.5 xnu-2422.115.4/osfmk/kern/exception.c exception_triage().\n static constexpr ExceptionPorts::TargetType kTargetTypes[] = {\n ExceptionPorts::kTargetTypeThread,\n ExceptionPorts::kTargetTypeTask,\n\n // This is not expected to succeed, because mach_host_self() doesn’t\n // return the host_priv port to non-root users, and this is the port\n // that’s required for host_get_exception_ports().\n //\n // See 10.9.5 xnu-2422.115.4/bsd/kern/kern_prot.c set_security_token(),\n // xnu-2422.115.4/osfmk/kern/task.c host_security_set_task_token(), and\n // xnu-2422.115.4/osfmk/kern/ipc_host.c host_get_exception_ports().\n ExceptionPorts::kTargetTypeHost,\n };\n\n bool success = false;\n\n for (size_t target_type_index = 0;\n !success && target_type_index < std::size(kTargetTypes);\n ++target_type_index) {\n ExceptionPorts::ExceptionHandlerVector handlers;\n ExceptionPorts exception_ports(kTargetTypes[target_type_index],\n MACH_PORT_NULL);\n if (exception_ports.GetExceptionPorts(EXC_MASK_CRASH, &handlers)) {\n DCHECK_LE(handlers.size(), 1u);\n if (handlers.size() == 1) {\n DCHECK(handlers[0].mask & EXC_MASK_CRASH);\n success = DeliverException(thread.get(),\n mach_task_self(),\n exception,\n codes,\n code_count,\n cpu_context,\n handlers[0],\n false);\n }\n }\n }\n\n LOG_IF(WARNING, !success)\n << \"SimulateCrash did not find an appropriate exception handler\";\n}\n\n} // namespace crashpad\n" }, { "path": "client/simulate_crash_mac.h", "content": "// Copyright 2014 The Crashpad Authors\n//\n// Licensed under the Apache License, Version 2.0 (the \"License\");\n// you may not use this file except in compliance with the License.\n// You may obtain a copy of the License at\n//\n// http://www.apache.org/licenses/LICENSE-2.0\n//\n// Unless required by applicable law or agreed to in writing, software\n// distributed under the License is distributed on an \"AS IS\" BASIS,\n// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n// See the License for the specific language governing permissions and\n// limitations under the License.\n\n#ifndef CRASHPAD_CLIENT_SIMULATE_CRASH_MAC_H_\n#define CRASHPAD_CLIENT_SIMULATE_CRASH_MAC_H_\n\n#include \n\n#include \"util/misc/capture_context.h\"\n\n//! \\file\n\nnamespace crashpad {\n\n//! \\brief Simulates a exception without crashing.\n//!\n//! This function searches for an `EXC_CRASH` handler in the same manner that\n//! the kernel does, and sends it an exception message to that handler in the\n//! format that the handler expects, considering the behavior and thread state\n//! flavor that are registered for it. The exception sent to the handler will be\n//! ::kMachExceptionSimulated, not `EXC_CRASH`.\n//!\n//! Typically, the CRASHPAD_SIMULATE_CRASH() macro will be used in preference to\n//! this function, because it combines the context-capture operation with the\n//! raising of a simulated exception.\n//!\n//! This function returns normally after the exception message is processed. If\n//! no valid handler was found, or no handler processed the exception\n//! successfully, a warning will be logged, but these conditions are not\n//! considered fatal.\n//!\n//! \\param[in] cpu_context The thread state to pass to the exception handler as\n//! the exception context, provided that it is compatible with the thread\n//! state flavor that the exception handler accepts. If it is not\n//! compatible, the correct thread state for the handler will be obtained by\n//! calling `thread_get_state()`.\nvoid SimulateCrash(const NativeCPUContext& cpu_context);\n\n} // namespace crashpad\n\n//! \\brief Captures the CPU context and simulates an exception without crashing.\n#define CRASHPAD_SIMULATE_CRASH() \\\n do { \\\n crashpad::NativeCPUContext cpu_context; \\\n crashpad::CaptureContext(&cpu_context); \\\n crashpad::SimulateCrash(cpu_context); \\\n } while (false)\n\n#endif // CRASHPAD_CLIENT_SIMULATE_CRASH_MAC_H_\n" }, { "path": "client/simulate_crash_mac_test.cc", "content": "// Copyright 2014 The Crashpad Authors\n//\n// Licensed under the Apache License, Version 2.0 (the \"License\");\n// you may not use this file except in compliance with the License.\n// You may obtain a copy of the License at\n//\n// http://www.apache.org/licenses/LICENSE-2.0\n//\n// Unless required by applicable law or agreed to in writing, software\n// distributed under the License is distributed on an \"AS IS\" BASIS,\n// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n// See the License for the specific language governing permissions and\n// limitations under the License.\n\n#include \"client/simulate_crash.h\"\n\n#include \n#include \n#include \n\n#include \n\n#include \"base/strings/stringprintf.h\"\n#include \"build/build_config.h\"\n#include \"gtest/gtest.h\"\n#include \"test/mac/mach_errors.h\"\n#include \"test/mac/mach_multiprocess.h\"\n#include \"util/mach/exc_server_variants.h\"\n#include \"util/mach/exception_behaviors.h\"\n#include \"util/mach/exception_ports.h\"\n#include \"util/mach/mach_extensions.h\"\n#include \"util/mach/mach_message.h\"\n#include \"util/mach/mach_message_server.h\"\n#include \"util/mach/symbolic_constants_mach.h\"\n#include \"util/misc/implicit_cast.h\"\n\nnamespace crashpad {\nnamespace test {\nnamespace {\n\nclass TestSimulateCrashMac final : public MachMultiprocess,\n public UniversalMachExcServer::Interface {\n public:\n // Defines which targets the child should set an EXC_CRASH exception handler\n // for.\n enum ExceptionPortsTarget {\n // The child should clear its EXC_CRASH handler for both its task and thread\n // targets. SimulateCrash() will attempt to deliver the exception to the\n // host target, which will fail if not running as root. In any case, the\n // parent should not expect to receive any exception message from the child.\n kExceptionPortsTargetNone = 0,\n\n // The child will set an EXC_CRASH handler for its task target, and clear it\n // for its thread target. The parent runs an exception server to receive\n // the child’s simulated crash message.\n kExceptionPortsTargetTask,\n\n // The child will set an EXC_CRASH handler for its thread target, and clear\n // it for its task target. The parent runs an exception server to receive\n // the child’s simulated crash message.\n kExceptionPortsTargetThread,\n\n // The child sets an EXC_CRASH handler for both its task and thread targets.\n // The parent runs an exception server to receive the message expected to be\n // delivered to the thread target, but returns an error code. The child will\n // then fall back to trying the server registered for the task target,\n // sending a second message to the parent. The server in the parent will\n // handle this one successfully.\n kExceptionPortsTargetBoth,\n };\n\n TestSimulateCrashMac(ExceptionPortsTarget target,\n exception_behavior_t behavior,\n thread_state_flavor_t flavor)\n : MachMultiprocess(),\n UniversalMachExcServer::Interface(),\n target_(target),\n behavior_(behavior),\n flavor_(flavor),\n succeed_(true) {\n }\n\n TestSimulateCrashMac(const TestSimulateCrashMac&) = delete;\n TestSimulateCrashMac& operator=(const TestSimulateCrashMac&) = delete;\n\n ~TestSimulateCrashMac() {}\n\n // UniversalMachExcServer::Interface:\n kern_return_t CatchMachException(exception_behavior_t behavior,\n exception_handler_t exception_port,\n thread_t thread,\n task_t task,\n exception_type_t exception,\n const mach_exception_data_type_t* code,\n mach_msg_type_number_t code_count,\n thread_state_flavor_t* flavor,\n ConstThreadState old_state,\n mach_msg_type_number_t old_state_count,\n thread_state_t new_state,\n mach_msg_type_number_t* new_state_count,\n const mach_msg_trailer_t* trailer,\n bool* destroy_complex_request) override {\n *destroy_complex_request = true;\n\n // Check the entire exception message, because most or all of it was\n // generated by SimulateCrash() instead of the kernel.\n\n EXPECT_EQ(behavior, behavior_);\n EXPECT_EQ(exception_port, LocalPort());\n if (ExceptionBehaviorHasIdentity(behavior)) {\n EXPECT_NE(thread, THREAD_NULL);\n EXPECT_EQ(task, ChildTask());\n } else {\n EXPECT_EQ(thread, THREAD_NULL);\n EXPECT_EQ(task, TASK_NULL);\n }\n EXPECT_EQ(exception, kMachExceptionSimulated);\n EXPECT_EQ(code_count, 2u);\n if (code_count >= 1) {\n EXPECT_EQ(code[0], 0);\n }\n if (code_count >= 2) {\n EXPECT_EQ(code[1], 0);\n }\n if (!ExceptionBehaviorHasState(behavior)) {\n EXPECT_EQ(*flavor, THREAD_STATE_NONE);\n } else {\n EXPECT_EQ(*flavor, flavor_);\n switch (*flavor) {\n#if defined(ARCH_CPU_X86_FAMILY)\n case x86_THREAD_STATE: {\n EXPECT_EQ(old_state_count, x86_THREAD_STATE_COUNT);\n const x86_thread_state* state =\n reinterpret_cast(old_state);\n switch (state->tsh.flavor) {\n case x86_THREAD_STATE32:\n EXPECT_EQ(implicit_cast(state->tsh.count),\n implicit_cast(x86_THREAD_STATE32_COUNT));\n break;\n case x86_THREAD_STATE64:\n EXPECT_EQ(implicit_cast(state->tsh.count),\n implicit_cast(x86_THREAD_STATE64_COUNT));\n break;\n default:\n ADD_FAILURE() << \"unexpected tsh.flavor \" << state->tsh.flavor;\n break;\n }\n break;\n }\n case x86_FLOAT_STATE: {\n EXPECT_EQ(old_state_count, x86_FLOAT_STATE_COUNT);\n const x86_float_state* state =\n reinterpret_cast(old_state);\n switch (state->fsh.flavor) {\n case x86_FLOAT_STATE32:\n EXPECT_EQ(implicit_cast(state->fsh.count),\n implicit_cast(x86_FLOAT_STATE32_COUNT));\n break;\n case x86_FLOAT_STATE64:\n EXPECT_EQ(implicit_cast(state->fsh.count),\n implicit_cast(x86_FLOAT_STATE64_COUNT));\n break;\n default:\n ADD_FAILURE() << \"unexpected fsh.flavor \" << state->fsh.flavor;\n break;\n }\n break;\n }\n case x86_DEBUG_STATE: {\n EXPECT_EQ(old_state_count, x86_DEBUG_STATE_COUNT);\n const x86_debug_state* state =\n reinterpret_cast(old_state);\n switch (state->dsh.flavor) {\n case x86_DEBUG_STATE32:\n EXPECT_EQ(implicit_cast(state->dsh.count),\n implicit_cast(x86_DEBUG_STATE32_COUNT));\n break;\n case x86_DEBUG_STATE64:\n EXPECT_EQ(implicit_cast(state->dsh.count),\n implicit_cast(x86_DEBUG_STATE64_COUNT));\n break;\n default:\n ADD_FAILURE() << \"unexpected dsh.flavor \" << state->dsh.flavor;\n break;\n }\n break;\n }\n case x86_THREAD_STATE32:\n EXPECT_EQ(old_state_count, x86_THREAD_STATE32_COUNT);\n break;\n case x86_FLOAT_STATE32:\n EXPECT_EQ(old_state_count, x86_FLOAT_STATE32_COUNT);\n break;\n case x86_DEBUG_STATE32:\n EXPECT_EQ(old_state_count, x86_DEBUG_STATE32_COUNT);\n break;\n case x86_THREAD_STATE64:\n EXPECT_EQ(old_state_count, x86_THREAD_STATE64_COUNT);\n break;\n case x86_FLOAT_STATE64:\n EXPECT_EQ(old_state_count, x86_FLOAT_STATE64_COUNT);\n break;\n case x86_DEBUG_STATE64:\n EXPECT_EQ(old_state_count, x86_DEBUG_STATE64_COUNT);\n break;\n#elif defined(ARCH_CPU_ARM64)\n case ARM_UNIFIED_THREAD_STATE: {\n EXPECT_EQ(old_state_count, ARM_UNIFIED_THREAD_STATE_COUNT);\n const arm_unified_thread_state* state =\n reinterpret_cast(old_state);\n EXPECT_EQ(state->ash.flavor,\n implicit_cast(ARM_THREAD_STATE64));\n if (state->ash.flavor == ARM_THREAD_STATE64) {\n EXPECT_EQ(state->ash.count,\n implicit_cast(ARM_THREAD_STATE64_COUNT));\n }\n break;\n }\n case ARM_THREAD_STATE64:\n EXPECT_EQ(old_state_count, ARM_THREAD_STATE64_COUNT);\n break;\n case ARM_NEON_STATE64:\n EXPECT_EQ(old_state_count, ARM_NEON_STATE64_COUNT);\n break;\n case ARM_DEBUG_STATE64:\n EXPECT_EQ(old_state_count, ARM_DEBUG_STATE64_COUNT);\n break;\n#else\n#error Port to your CPU architecture\n#endif\n default:\n ADD_FAILURE() << \"unexpected flavor \" << *flavor;\n break;\n }\n\n // Attempt to set a garbage thread state, which would cause the child to\n // crash inside SimulateCrash() if it actually succeeded. This tests that\n // SimulateCrash() ignores new_state instead of attempting to set the\n // state as the kernel would do. This operates in conjunction with the\n // |true| argument to ExcServerSuccessfulReturnValue() below.\n *new_state_count = old_state_count;\n size_t new_state_size = sizeof(natural_t) * old_state_count;\n memset(new_state, 0xa5, new_state_size);\n }\n\n if (!succeed_) {\n // The client has registered EXC_CRASH handlers for both its thread and\n // task targets, and sent a simulated exception message to its\n // thread-level EXC_CRASH handler. To test that it will fall back to\n // trying the task-level EXC_CRASH handler, return a failure code, which\n // should cause SimulateCrash() to try the next target.\n EXPECT_EQ(target_, kExceptionPortsTargetBoth);\n return KERN_ABORTED;\n }\n\n ExcServerCopyState(\n behavior, old_state, old_state_count, new_state, new_state_count);\n\n return ExcServerSuccessfulReturnValue(exception, behavior, true);\n }\n\n private:\n // MachMultiprocess:\n\n void MachMultiprocessParent() override {\n if (target_ == kExceptionPortsTargetNone) {\n // The child does not have any EXC_CRASH handlers registered for its\n // thread or task targets, so no exception message is expected to be\n // generated. Don’t run the server at all.\n return;\n }\n\n UniversalMachExcServer universal_mach_exc_server(this);\n\n mach_msg_return_t mr;\n if (target_ == kExceptionPortsTargetBoth) {\n // The client has registered EXC_CRASH handlers for both its thread and\n // task targets. Run a server that will return a failure code when the\n // exception message is sent to the thread target, which will cause the\n // client to fall back to the task target and send another message.\n succeed_ = false;\n mr = MachMessageServer::Run(&universal_mach_exc_server,\n LocalPort(),\n MACH_MSG_OPTION_NONE,\n MachMessageServer::kOneShot,\n MachMessageServer::kReceiveLargeError,\n kMachMessageTimeoutWaitIndefinitely);\n EXPECT_EQ(mr, MACH_MSG_SUCCESS)\n << MachErrorMessage(mr, \"MachMessageServer::Run\");\n }\n\n succeed_ = true;\n mr = MachMessageServer::Run(&universal_mach_exc_server,\n LocalPort(),\n MACH_MSG_OPTION_NONE,\n MachMessageServer::kOneShot,\n MachMessageServer::kReceiveLargeError,\n kMachMessageTimeoutWaitIndefinitely);\n EXPECT_EQ(mr, MACH_MSG_SUCCESS)\n << MachErrorMessage(mr, \"MachMessageServer::Run\");\n }\n\n void MachMultiprocessChild() override {\n bool task_valid = target_ == kExceptionPortsTargetTask ||\n target_ == kExceptionPortsTargetBoth;\n ExceptionPorts task_exception_ports(ExceptionPorts::kTargetTypeTask,\n TASK_NULL);\n ASSERT_TRUE(task_exception_ports.SetExceptionPort(\n EXC_MASK_CRASH,\n task_valid ? RemotePort() : MACH_PORT_NULL,\n behavior_,\n flavor_));\n\n bool thread_valid = target_ == kExceptionPortsTargetThread ||\n target_ == kExceptionPortsTargetBoth;\n ExceptionPorts thread_exception_ports(ExceptionPorts::kTargetTypeThread,\n THREAD_NULL);\n ASSERT_TRUE(thread_exception_ports.SetExceptionPort(\n EXC_MASK_CRASH,\n thread_valid ? RemotePort() : MACH_PORT_NULL,\n behavior_,\n flavor_));\n\n CRASHPAD_SIMULATE_CRASH();\n }\n\n ExceptionPortsTarget target_;\n exception_behavior_t behavior_;\n thread_state_flavor_t flavor_;\n bool succeed_;\n};\n\nTEST(SimulateCrash, SimulateCrash) {\n static constexpr TestSimulateCrashMac::ExceptionPortsTarget kTargets[] = {\n TestSimulateCrashMac::kExceptionPortsTargetNone,\n TestSimulateCrashMac::kExceptionPortsTargetTask,\n TestSimulateCrashMac::kExceptionPortsTargetThread,\n TestSimulateCrashMac::kExceptionPortsTargetBoth,\n };\n\n static constexpr exception_behavior_t kBehaviors[] = {\n EXCEPTION_DEFAULT,\n EXCEPTION_STATE,\n EXCEPTION_STATE_IDENTITY,\n EXCEPTION_DEFAULT | kMachExceptionCodes,\n EXCEPTION_STATE | kMachExceptionCodes,\n EXCEPTION_STATE_IDENTITY | kMachExceptionCodes,\n };\n\n static constexpr thread_state_flavor_t kFlavors[] = {\n#if defined(ARCH_CPU_X86_FAMILY)\n x86_THREAD_STATE,\n x86_FLOAT_STATE,\n x86_DEBUG_STATE,\n#if defined(ARCH_CPU_X86)\n x86_THREAD_STATE32,\n x86_FLOAT_STATE32,\n x86_DEBUG_STATE32,\n#elif defined(ARCH_CPU_X86_64)\n x86_THREAD_STATE64,\n x86_FLOAT_STATE64,\n x86_DEBUG_STATE64,\n#endif\n#elif defined(ARCH_CPU_ARM64)\n ARM_UNIFIED_THREAD_STATE,\n ARM_THREAD_STATE64,\n ARM_NEON_STATE64,\n ARM_DEBUG_STATE64,\n#else\n#error Port to your CPU architecture\n#endif\n };\n\n for (size_t target_index = 0; target_index < std::size(kTargets);\n ++target_index) {\n TestSimulateCrashMac::ExceptionPortsTarget target = kTargets[target_index];\n SCOPED_TRACE(base::StringPrintf(\n \"target_index %zu, target %d\", target_index, target));\n\n for (size_t behavior_index = 0; behavior_index < std::size(kBehaviors);\n ++behavior_index) {\n exception_behavior_t behavior = kBehaviors[behavior_index];\n SCOPED_TRACE(base::StringPrintf(\n \"behavior_index %zu, behavior %s\",\n behavior_index,\n ExceptionBehaviorToString(behavior, kUseFullName | kUnknownIsNumeric)\n .c_str()));\n\n if (!ExceptionBehaviorHasState(behavior)) {\n TestSimulateCrashMac test_simulate_crash_mac(\n target, behavior, THREAD_STATE_NONE);\n test_simulate_crash_mac.Run();\n } else {\n for (size_t flavor_index = 0; flavor_index < std::size(kFlavors);\n ++flavor_index) {\n thread_state_flavor_t flavor = kFlavors[flavor_index];\n SCOPED_TRACE(base::StringPrintf(\n \"flavor_index %zu, flavor %s\",\n flavor_index,\n ThreadStateFlavorToString(\n flavor, kUseFullName | kUnknownIsNumeric).c_str()));\n\n TestSimulateCrashMac test_simulate_crash_mac(\n target, behavior, flavor);\n test_simulate_crash_mac.Run();\n }\n }\n }\n }\n}\n\n} // namespace\n} // namespace test\n} // namespace crashpad\n" }, { "path": "client/simulate_crash_win.h", "content": "// Copyright 2015 The Crashpad Authors\n//\n// Licensed under the Apache License, Version 2.0 (the \"License\");\n// you may not use this file except in compliance with the License.\n// You may obtain a copy of the License at\n//\n// http://www.apache.org/licenses/LICENSE-2.0\n//\n// Unless required by applicable law or agreed to in writing, software\n// distributed under the License is distributed on an \"AS IS\" BASIS,\n// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n// See the License for the specific language governing permissions and\n// limitations under the License.\n\n#ifndef CRASHPAD_CLIENT_SIMULATE_CRASH_WIN_H_\n#define CRASHPAD_CLIENT_SIMULATE_CRASH_WIN_H_\n\n#include \n\n#include \"client/crashpad_client.h\"\n#include \"util/misc/capture_context.h\"\n\n//! \\file\n\n//! \\brief Captures the CPU context and captures a dump without an exception.\n#define CRASHPAD_SIMULATE_CRASH() \\\n do { \\\n /* Not \"context\" to avoid variable shadowing warnings. */ \\\n CONTEXT simulate_crash_cpu_context; \\\n crashpad::CaptureContext(&simulate_crash_cpu_context); \\\n crashpad::CrashpadClient::DumpWithoutCrash(simulate_crash_cpu_context); \\\n } while (false)\n\n#endif // CRASHPAD_CLIENT_SIMULATE_CRASH_WIN_H_\n" }, { "path": "client/upload_behavior_ios.h", "content": "// Copyright 2022 The Crashpad Authors\n//\n// Licensed under the Apache License, Version 2.0 (the \"License\");\n// you may not use this file except in compliance with the License.\n// You may obtain a copy of the License at\n//\n// http://www.apache.org/licenses/LICENSE-2.0\n//\n// Unless required by applicable law or agreed to in writing, software\n// distributed under the License is distributed on an \"AS IS\" BASIS,\n// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n// See the License for the specific language governing permissions and\n// limitations under the License.\n\n#ifndef CRASHPAD_CLIENT_UPLOAD_BEHAVIOR_IOS_H_\n#define CRASHPAD_CLIENT_UPLOAD_BEHAVIOR_IOS_H_\n\nnamespace crashpad {\n\n//! \\brief Enum to control upload behavior when processing pending reports.\nenum class UploadBehavior {\n //! \\brief Only upload reports while the application is active (e.g., in the\n //! foreground).\n kUploadWhenAppIsActive = 1,\n\n //! \\brief Upload reports immediately, regardless of whether or not the\n //! application is active.\n kUploadImmediately = 2,\n};\n\n} // namespace crashpad\n\n#endif // CRASHPAD_CLIENT_UPLOAD_BEHAVIOR_IOS_H_\n" }, { "path": "codereview.settings", "content": "# Copyright 2014 The Crashpad Authors\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n\nGERRIT_HOST: True\nCODE_REVIEW_SERVER: https://chromium-review.googlesource.com/\nVIEW_VC: https://chromium.googlesource.com/crashpad/crashpad/+/\nPROJECT: crashpad\n" }, { "path": "compat/BUILD.gn", "content": "# Copyright 2015 The Crashpad Authors\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n\nimport(\"../build/crashpad_buildconfig.gni\")\n\nconfig(\"compat_config\") {\n include_dirs = []\n\n if (crashpad_is_apple) {\n include_dirs += [ \"mac\" ]\n }\n\n if (crashpad_is_ios) {\n include_dirs += [ \"ios\" ]\n }\n\n if (crashpad_is_linux || crashpad_is_android) {\n include_dirs += [ \"linux\" ]\n }\n\n if (crashpad_is_android) {\n include_dirs += [ \"android\" ]\n }\n\n if (crashpad_is_win) {\n include_dirs += [ \"win\" ]\n } else {\n include_dirs += [ \"non_win\" ]\n }\n}\n\ntemplate(\"compat_target\") {\n if (crashpad_is_apple) {\n # There are no sources to compile, which doesn’t mix will with a\n # static_library.\n group(target_name) {\n forward_variables_from(invoker, \"*\")\n not_needed([ \"configs\" ])\n }\n } else {\n crashpad_static_library(target_name) {\n forward_variables_from(invoker, \"*\", [ \"configs\" ])\n if (!defined(configs)) {\n configs = []\n }\n if (defined(invoker.configs)) {\n configs += invoker.configs\n }\n }\n }\n}\n\ncompat_target(\"compat\") {\n sources = []\n\n if (crashpad_is_apple) {\n sources += [\n \"mac/Availability.h\",\n \"mac/AvailabilityVersions.h\",\n \"mac/kern/exc_resource.h\",\n \"mac/mach-o/loader.h\",\n \"mac/mach/i386/thread_state.h\",\n \"mac/mach/mach.h\",\n \"mac/sys/resource.h\",\n ]\n } else {\n sources += [ \"non_mac/mach/mach.h\" ]\n }\n\n if (crashpad_is_ios) {\n sources += [\n \"ios/mach/exc.defs\",\n \"ios/mach/mach_exc.defs\",\n \"ios/mach/mach_types.defs\",\n \"ios/mach/machine/machine_types.defs\",\n \"ios/mach/std_types.defs\",\n ]\n }\n\n if (crashpad_is_linux || crashpad_is_android) {\n sources += [\n \"linux/signal.h\",\n \"linux/sys/mman.h\",\n \"linux/sys/mman_memfd_create.cc\",\n \"linux/sys/ptrace.h\",\n \"linux/sys/user.h\",\n ]\n }\n\n if (crashpad_is_android) {\n sources += [\n \"android/dlfcn_internal.cc\",\n \"android/dlfcn_internal.h\",\n \"android/elf.h\",\n \"android/linux/elf.h\",\n \"android/linux/prctl.h\",\n \"android/linux/ptrace.h\",\n \"android/sched.h\",\n \"android/sys/epoll.cc\",\n \"android/sys/epoll.h\",\n \"android/sys/mman.h\",\n \"android/sys/mman_mmap.cc\",\n \"android/sys/syscall.h\",\n \"android/sys/user.h\",\n ]\n }\n\n if (crashpad_is_win) {\n sources += [\n \"win/getopt.h\",\n \"win/strings.cc\",\n \"win/strings.h\",\n \"win/sys/types.h\",\n \"win/time.cc\",\n \"win/time.h\",\n \"win/winbase.h\",\n \"win/winnt.h\",\n \"win/winternl.h\",\n ]\n } else {\n sources += [\n \"non_win/dbghelp.h\",\n \"non_win/minwinbase.h\",\n \"non_win/timezoneapi.h\",\n \"non_win/verrsrc.h\",\n \"non_win/windows.h\",\n \"non_win/winnt.h\",\n ]\n }\n\n public_configs = [\n \":compat_config\",\n \"..:crashpad_config\",\n ]\n\n if (!crashpad_is_win) {\n public_deps = [ \"$mini_chromium_source_parent:base\" ]\n }\n\n deps = [ \"../util:no_cfi_icall\" ]\n\n if (crashpad_is_win) {\n deps += [ \"../third_party/getopt\" ]\n }\n}\n" }, { "path": "compat/android/dlfcn_internal.cc", "content": "// Copyright 2017 The Crashpad Authors\n//\n// Licensed under the Apache License, Version 2.0 (the \"License\");\n// you may not use this file except in compliance with the License.\n// You may obtain a copy of the License at\n//\n// http://www.apache.org/licenses/LICENSE-2.0\n//\n// Unless required by applicable law or agreed to in writing, software\n// distributed under the License is distributed on an \"AS IS\" BASIS,\n// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n// See the License for the specific language governing permissions and\n// limitations under the License.\n\n#include \"dlfcn_internal.h\"\n\n#include \n#include \n#include \n#include \n#include \n#include \n#include \n#include \n#include \n#include \n\n#include \n\nnamespace crashpad {\nnamespace internal {\n\n// KitKat supports API levels up to 20.\n#if __ANDROID_API__ < 21\n\nnamespace {\n\nclass ScopedSigactionRestore {\n public:\n ScopedSigactionRestore() : old_action_(), signo_(-1), valid_(false) {}\n\n ~ScopedSigactionRestore() { Reset(); }\n\n bool Reset() {\n bool result = true;\n if (valid_) {\n result = sigaction(signo_, &old_action_, nullptr) == 0;\n if (!result) {\n PrintErrmsg(errno);\n }\n }\n valid_ = false;\n signo_ = -1;\n return result;\n }\n\n bool ResetAndInstallHandler(int signo,\n void (*handler)(int, siginfo_t*, void*)) {\n Reset();\n\n struct sigaction act;\n act.sa_sigaction = handler;\n sigemptyset(&act.sa_mask);\n act.sa_flags = SA_SIGINFO;\n if (sigaction(signo, &act, &old_action_) != 0) {\n PrintErrmsg(errno);\n return false;\n }\n signo_ = signo;\n valid_ = true;\n return true;\n }\n\n private:\n void PrintErrmsg(int err) {\n char errmsg[256];\n\n if (strerror_r(err, errmsg, sizeof(errmsg)) != 0) {\n snprintf(errmsg,\n sizeof(errmsg),\n \"%s:%d: Couldn't set errmsg for %d: %d\",\n __FILE__,\n __LINE__,\n err,\n errno);\n return;\n }\n\n fprintf(stderr, \"%s:%d: sigaction: %s\", __FILE__, __LINE__, errmsg);\n }\n\n struct sigaction old_action_;\n int signo_;\n bool valid_;\n};\n\nbool IsKitKat() {\n char prop_buf[PROP_VALUE_MAX];\n int length = __system_property_get(\"ro.build.version.sdk\", prop_buf);\n if (length <= 0) {\n fprintf(stderr, \"%s:%d: Couldn't get version\", __FILE__, __LINE__);\n // It's safer to assume this is KitKat and execute dlsym with a signal\n // handler installed.\n return true;\n }\n if (strcmp(prop_buf, \"19\") == 0 || strcmp(prop_buf, \"20\") == 0) {\n return true;\n }\n return false;\n}\n\nclass ScopedSetTID {\n public:\n explicit ScopedSetTID(pid_t* tid) : tid_(tid) { *tid_ = syscall(SYS_gettid); }\n\n ~ScopedSetTID() { *tid_ = -1; }\n\n private:\n pid_t* tid_;\n};\n\nsigjmp_buf dlsym_sigjmp_env;\n\npid_t dlsym_tid = -1;\n\nvoid HandleSIGFPE(int signo, siginfo_t* siginfo, void* context) {\n if (siginfo->si_code != FPE_INTDIV || syscall(SYS_gettid) != dlsym_tid) {\n return;\n }\n siglongjmp(dlsym_sigjmp_env, 1);\n}\n\n} // namespace\n\nvoid* Dlsym(void* handle, const char* symbol) {\n if (!IsKitKat()) {\n return dlsym(handle, symbol);\n }\n\n static std::mutex* signal_handler_mutex = new std::mutex();\n std::lock_guard lock(*signal_handler_mutex);\n\n ScopedSetTID set_tid(&dlsym_tid);\n\n ScopedSigactionRestore sig_restore;\n if (!sig_restore.ResetAndInstallHandler(SIGFPE, HandleSIGFPE)) {\n return nullptr;\n }\n\n if (sigsetjmp(dlsym_sigjmp_env, 1) != 0) {\n return nullptr;\n }\n\n return dlsym(handle, symbol);\n}\n\n#else\n\nvoid* Dlsym(void* handle, const char* symbol) {\n return dlsym(handle, symbol);\n}\n\n#endif // __ANDROID_API__ < 21\n\n} // namespace internal\n} // namespace crashpad\n" }, { "path": "compat/android/dlfcn_internal.h", "content": "// Copyright 2017 The Crashpad Authors\n//\n// Licensed under the Apache License, Version 2.0 (the \"License\");\n// you may not use this file except in compliance with the License.\n// You may obtain a copy of the License at\n//\n// http://www.apache.org/licenses/LICENSE-2.0\n//\n// Unless required by applicable law or agreed to in writing, software\n// distributed under the License is distributed on an \"AS IS\" BASIS,\n// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n// See the License for the specific language governing permissions and\n// limitations under the License.\n\n#ifndef CRASHPAD_COMPAT_ANDROID_DLFCN_INTERNAL_H_\n#define CRASHPAD_COMPAT_ANDROID_DLFCN_INTERNAL_H_\n\nnamespace crashpad {\nnamespace internal {\n\n//! \\brief Provide a wrapper for `dlsym`.\n//!\n//! dlsym on Android KitKat (4.4.*) raises SIGFPE when searching for a\n//! non-existent symbol. This wrapper avoids crashing in this circumstance.\n//! https://code.google.com/p/android/issues/detail?id=61799\n//!\n//! The parameters and return value for this function are the same as for\n//! `dlsym`, but a return value for `dlerror` may not be set in the event of an\n//! error.\nvoid* Dlsym(void* handle, const char* symbol);\n\n} // namespace internal\n} // namespace crashpad\n\n#endif // CRASHPAD_COMPAT_ANDROID_DLFCN_INTERNAL_H_\n" }, { "path": "compat/android/elf.h", "content": "// Copyright 2017 The Crashpad Authors\n//\n// Licensed under the Apache License, Version 2.0 (the \"License\");\n// you may not use this file except in compliance with the License.\n// You may obtain a copy of the License at\n//\n// http://www.apache.org/licenses/LICENSE-2.0\n//\n// Unless required by applicable law or agreed to in writing, software\n// distributed under the License is distributed on an \"AS IS\" BASIS,\n// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n// See the License for the specific language governing permissions and\n// limitations under the License.\n\n#ifndef CRASHPAD_COMPAT_ANDROID_ELF_H_\n#define CRASHPAD_COMPAT_ANDROID_ELF_H_\n\n#include_next \n\n#include \n\n#if !defined(ELF32_ST_VISIBILITY)\n#define ELF32_ST_VISIBILITY(other) ((other) & 0x3)\n#endif\n\n#if !defined(ELF64_ST_VISIBILITY)\n#define ELF64_ST_VISIBILITY(other) ELF32_ST_VISIBILITY(other)\n#endif\n\n// Android 5.0.0 (API 21) NDK\n\n#if !defined(STT_COMMON)\n#define STT_COMMON 5\n#endif\n\n#if !defined(STT_TLS)\n#define STT_TLS 6\n#endif\n\n// ELF note header types are normally provided by . While unified\n// headers include in , traditional headers do not, prior\n// to API 21. and can't both be included in the same\n// translation unit due to collisions, so we provide these types here.\n#if __ANDROID_API__ < 21 && !defined(__ANDROID_API_N__)\ntypedef struct {\n Elf32_Word n_namesz;\n Elf32_Word n_descsz;\n Elf32_Word n_type;\n} Elf32_Nhdr;\n\ntypedef struct {\n Elf64_Word n_namesz;\n Elf64_Word n_descsz;\n Elf64_Word n_type;\n} Elf64_Nhdr;\n#endif // __ANDROID_API__ < 21 && !defined(NT_PRSTATUS)\n\n#endif // CRASHPAD_COMPAT_ANDROID_ELF_H_\n" }, { "path": "compat/android/linux/elf.h", "content": "// Copyright 2017 The Crashpad Authors\n//\n// Licensed under the Apache License, Version 2.0 (the \"License\");\n// you may not use this file except in compliance with the License.\n// You may obtain a copy of the License at\n//\n// http://www.apache.org/licenses/LICENSE-2.0\n//\n// Unless required by applicable law or agreed to in writing, software\n// distributed under the License is distributed on an \"AS IS\" BASIS,\n// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n// See the License for the specific language governing permissions and\n// limitations under the License.\n\n#ifndef CRASHPAD_COMPAT_ANDROID_LINUX_ELF_H_\n#define CRASHPAD_COMPAT_ANDROID_LINUX_ELF_H_\n\n#include_next \n\n// Android 5.0.0 (API 21) NDK\n\n#if defined(__i386__) || defined(__x86_64__)\n#if !defined(NT_386_TLS)\n#define NT_386_TLS 0x200\n#endif\n#endif // __i386__ || __x86_64__\n\n#if defined(__ARMEL__) || defined(__aarch64__)\n#if !defined(NT_ARM_VFP)\n#define NT_ARM_VFP 0x400\n#endif\n\n#if !defined(NT_ARM_TLS)\n#define NT_ARM_TLS 0x401\n#endif\n#endif // __ARMEL__ || __aarch64__\n\n#endif // CRASHPAD_COMPAT_ANDROID_LINUX_ELF_H_\n" }, { "path": "compat/android/linux/prctl.h", "content": "// Copyright 2017 The Crashpad Authors\n//\n// Licensed under the Apache License, Version 2.0 (the \"License\");\n// you may not use this file except in compliance with the License.\n// You may obtain a copy of the License at\n//\n// http://www.apache.org/licenses/LICENSE-2.0\n//\n// Unless required by applicable law or agreed to in writing, software\n// distributed under the License is distributed on an \"AS IS\" BASIS,\n// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n// See the License for the specific language governing permissions and\n// limitations under the License.\n\n#ifndef CRASHPAD_COMPAT_ANDROID_LINUX_PRCTL_H_\n#define CRASHPAD_COMPAT_ANDROID_LINUX_PRCTL_H_\n\n#include_next \n\n// Android 5.0.0 (API 21) NDK\n#if !defined(PR_SET_PTRACER)\n#define PR_SET_PTRACER 0x59616d61\n#endif\n\n#endif // CRASHPAD_COMPAT_ANDROID_LINUX_PRCTL_H_\n" }, { "path": "compat/android/linux/ptrace.h", "content": "// Copyright 2017 The Crashpad Authors\n//\n// Licensed under the Apache License, Version 2.0 (the \"License\");\n// you may not use this file except in compliance with the License.\n// You may obtain a copy of the License at\n//\n// http://www.apache.org/licenses/LICENSE-2.0\n//\n// Unless required by applicable law or agreed to in writing, software\n// distributed under the License is distributed on an \"AS IS\" BASIS,\n// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n// See the License for the specific language governing permissions and\n// limitations under the License.\n\n#ifndef CRASHPAD_COMPAT_ANDROID_LINUX_PTRACE_H_\n#define CRASHPAD_COMPAT_ANDROID_LINUX_PTRACE_H_\n\n#include_next \n\n// Android 5.0.0 (API 21) NDK\n#if !defined(PTRACE_GETREGSET)\n#define PTRACE_GETREGSET 0x4204\n#endif\n\n#endif // CRASHPAD_COMPAT_ANDROID_LINUX_PTRACE_H_\n" }, { "path": "compat/android/sched.h", "content": "// Copyright 2017 The Crashpad Authors\n//\n// Licensed under the Apache License, Version 2.0 (the \"License\");\n// you may not use this file except in compliance with the License.\n// You may obtain a copy of the License at\n//\n// http://www.apache.org/licenses/LICENSE-2.0\n//\n// Unless required by applicable law or agreed to in writing, software\n// distributed under the License is distributed on an \"AS IS\" BASIS,\n// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n// See the License for the specific language governing permissions and\n// limitations under the License.\n\n#ifndef CRASHPAD_COMPAT_ANDROID_SCHED_H_\n#define CRASHPAD_COMPAT_ANDROID_SCHED_H_\n\n#include_next \n\n// Android 5.0.0 (API 21) NDK\n\n#if !defined(SCHED_BATCH)\n#define SCHED_BATCH 3\n#endif\n\n#if !defined(SCHED_IDLE)\n#define SCHED_IDLE 5\n#endif\n\n#endif // CRASHPAD_COMPAT_ANDROID_SCHED_H_\n" }, { "path": "compat/android/sys/epoll.cc", "content": "// Copyright 2017 The Crashpad Authors\n//\n// Licensed under the Apache License, Version 2.0 (the \"License\");\n// you may not use this file except in compliance with the License.\n// You may obtain a copy of the License at\n//\n// http://www.apache.org/licenses/LICENSE-2.0\n//\n// Unless required by applicable law or agreed to in writing, software\n// distributed under the License is distributed on an \"AS IS\" BASIS,\n// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n// See the License for the specific language governing permissions and\n// limitations under the License.\n\n#include \n\n#include \n#include \n#include \n\n#include \"dlfcn_internal.h\"\n#include \"util/misc/no_cfi_icall.h\"\n\n#if __ANDROID_API__ < 21\n\nextern \"C\" {\n\nint epoll_create1(int flags) {\n static const crashpad::NoCfiIcall epoll_create1_p(\n crashpad::internal::Dlsym(RTLD_DEFAULT, \"epoll_create1\"));\n return epoll_create1_p ? epoll_create1_p(flags)\n : syscall(SYS_epoll_create1, flags);\n}\n\n} // extern \"C\"\n\n#endif // __ANDROID_API__ < 21\n" }, { "path": "compat/android/sys/epoll.h", "content": "// Copyright 2017 The Crashpad Authors\n//\n// Licensed under the Apache License, Version 2.0 (the \"License\");\n// you may not use this file except in compliance with the License.\n// You may obtain a copy of the License at\n//\n// http://www.apache.org/licenses/LICENSE-2.0\n//\n// Unless required by applicable law or agreed to in writing, software\n// distributed under the License is distributed on an \"AS IS\" BASIS,\n// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n// See the License for the specific language governing permissions and\n// limitations under the License.\n\n#ifndef CRASHPAD_COMPAT_ANDROID_SYS_EPOLL_H_\n#define CRASHPAD_COMPAT_ANDROID_SYS_EPOLL_H_\n\n#include_next \n\n#include \n#include \n\n// This is missing from traditional headers before API 21.\n#if !defined(EPOLLRDHUP)\n#define EPOLLRDHUP 0x00002000\n#endif\n\n// EPOLL_CLOEXEC is undefined in traditional headers before API 21 and removed\n// from unified headers at API levels < 21 as a means to indicate that\n// epoll_create1 is missing from the C library, but the raw system call should\n// still be available.\n#if !defined(EPOLL_CLOEXEC)\n#define EPOLL_CLOEXEC O_CLOEXEC\n#endif\n\n#if __ANDROID_API__ < 21\n\n#ifdef __cplusplus\nextern \"C\" {\n#endif\n\nint epoll_create1(int flags);\n\n#ifdef __cplusplus\n} // extern \"C\"\n#endif\n\n#endif // __ANDROID_API__ < 21\n\n#endif // CRASHPAD_COMPAT_ANDROID_SYS_EPOLL_H_\n" }, { "path": "compat/android/sys/mman.h", "content": "// Copyright 2017 The Crashpad Authors\n//\n// Licensed under the Apache License, Version 2.0 (the \"License\");\n// you may not use this file except in compliance with the License.\n// You may obtain a copy of the License at\n//\n// http://www.apache.org/licenses/LICENSE-2.0\n//\n// Unless required by applicable law or agreed to in writing, software\n// distributed under the License is distributed on an \"AS IS\" BASIS,\n// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n// See the License for the specific language governing permissions and\n// limitations under the License.\n\n#ifndef CRASHPAD_COMPAT_ANDROID_SYS_MMAN_H_\n#define CRASHPAD_COMPAT_ANDROID_SYS_MMAN_H_\n\n#include_next \n\n#include \n#include \n\n// There’s no mmap() wrapper compatible with a 64-bit off_t for 32-bit code\n// until API 21 (Android 5.0/“Lollipop”). A custom mmap() wrapper is provided\n// here. Note that this scenario is only possible with NDK unified headers.\n//\n// https://android.googlesource.com/platform/bionic/+/0bfcbaf4d069e005d6e959d97f8d11c77722b70d/docs/32-bit-abi.md#is-32_bit-1\n\n#if defined(__USE_FILE_OFFSET64) && __ANDROID_API__ < 21\n\n#ifdef __cplusplus\nextern \"C\" {\n#endif\n\nvoid* mmap(void* addr, size_t size, int prot, int flags, int fd, off_t offset);\n\n#ifdef __cplusplus\n} // extern \"C\"\n#endif\n\n#endif // defined(__USE_FILE_OFFSET64) && __ANDROID_API__ < 21\n\n#endif // CRASHPAD_COMPAT_ANDROID_SYS_MMAN_H_\n" }, { "path": "compat/android/sys/mman_mmap.cc", "content": "// Copyright 2017 The Crashpad Authors\n//\n// Licensed under the Apache License, Version 2.0 (the \"License\");\n// you may not use this file except in compliance with the License.\n// You may obtain a copy of the License at\n//\n// http://www.apache.org/licenses/LICENSE-2.0\n//\n// Unless required by applicable law or agreed to in writing, software\n// distributed under the License is distributed on an \"AS IS\" BASIS,\n// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n// See the License for the specific language governing permissions and\n// limitations under the License.\n\n#include \n\n#include \n#include \n#include \n#include \n\n#include \"dlfcn_internal.h\"\n#include \"util/misc/no_cfi_icall.h\"\n\n#if defined(__USE_FILE_OFFSET64) && __ANDROID_API__ < 21\n\n// Bionic has provided a wrapper for __mmap2() since the beginning of time. See\n// bionic/libc/SYSCALLS.TXT in any Android version.\nextern \"C\" void* __mmap2(void* addr,\n size_t size,\n int prot,\n int flags,\n int fd,\n size_t pgoff);\n\nnamespace {\n\ntemplate \nT Align(T value, size_t alignment) {\n return (value + alignment - 1) & ~(alignment - 1);\n}\n\n// Adapted from Android 8.0.0 bionic/libc/bionic/mmap.cpp.\nvoid* LocalMmap64(void* addr,\n size_t size,\n int prot,\n int flags,\n int fd,\n off64_t offset) {\n constexpr int kMmap2Shift = 12;\n\n if (offset < 0 || (offset & ((1UL << kMmap2Shift) - 1)) != 0) {\n errno = EINVAL;\n return MAP_FAILED;\n }\n\n const size_t rounded = Align(size, getpagesize());\n if (rounded < size || rounded > PTRDIFF_MAX) {\n errno = ENOMEM;\n return MAP_FAILED;\n }\n\n const bool is_private_anonymous =\n (flags & (MAP_PRIVATE | MAP_ANONYMOUS)) == (MAP_PRIVATE | MAP_ANONYMOUS);\n const bool is_stack_or_grows_down =\n (flags & (MAP_STACK | MAP_GROWSDOWN)) != 0;\n\n void* const result =\n __mmap2(addr, size, prot, flags, fd, offset >> kMmap2Shift);\n\n static bool kernel_has_MADV_MERGEABLE = true;\n if (result != MAP_FAILED && kernel_has_MADV_MERGEABLE &&\n is_private_anonymous && !is_stack_or_grows_down) {\n const int saved_errno = errno;\n const int rc = madvise(result, size, MADV_MERGEABLE);\n if (rc == -1 && errno == EINVAL) {\n kernel_has_MADV_MERGEABLE = false;\n }\n errno = saved_errno;\n }\n\n return result;\n}\n\n} // namespace\n\nextern \"C\" {\n\nvoid* mmap(void* addr, size_t size, int prot, int flags, int fd, off_t offset) {\n // Use the system’s mmap64() wrapper if available. It will be available on\n // Android 5.0 (“Lollipop”) and later.\n static const crashpad::NoCfiIcall mmap64(\n crashpad::internal::Dlsym(RTLD_DEFAULT, \"mmap64\"));\n if (mmap64) {\n return mmap64(addr, size, prot, flags, fd, offset);\n }\n\n // Otherwise, use the local implementation, which should amount to exactly the\n // same thing.\n return LocalMmap64(addr, size, prot, flags, fd, offset);\n}\n\n} // extern \"C\"\n\n#endif // defined(__USE_FILE_OFFSET64) && __ANDROID_API__ < 21\n" }, { "path": "compat/android/sys/syscall.h", "content": "// Copyright 2017 The Crashpad Authors\n//\n// Licensed under the Apache License, Version 2.0 (the \"License\");\n// you may not use this file except in compliance with the License.\n// You may obtain a copy of the License at\n//\n// http://www.apache.org/licenses/LICENSE-2.0\n//\n// Unless required by applicable law or agreed to in writing, software\n// distributed under the License is distributed on an \"AS IS\" BASIS,\n// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n// See the License for the specific language governing permissions and\n// limitations under the License.\n\n#ifndef CRASHPAD_COMPAT_ANDROID_SYS_SYSCALL_H_\n#define CRASHPAD_COMPAT_ANDROID_SYS_SYSCALL_H_\n\n#include_next \n\n// Android 5.0.0 (API 21) NDK\n\n#if !defined(SYS_epoll_create1)\n#define SYS_epoll_create1 __NR_epoll_create1\n#endif\n\n#if !defined(SYS_gettid)\n#define SYS_gettid __NR_gettid\n#endif\n\n#if !defined(SYS_timer_create)\n#define SYS_timer_create __NR_timer_create\n#endif\n\n#if !defined(SYS_timer_getoverrun)\n#define SYS_timer_getoverrun __NR_timer_getoverrun\n#endif\n\n#if !defined(SYS_timer_settime)\n#define SYS_timer_settime __NR_timer_settime\n#endif\n\n#endif // CRASHPAD_COMPAT_ANDROID_SYS_SYSCALL_H_\n" }, { "path": "compat/android/sys/user.h", "content": "// Copyright 2017 The Crashpad Authors\n//\n// Licensed under the Apache License, Version 2.0 (the \"License\");\n// you may not use this file except in compliance with the License.\n// You may obtain a copy of the License at\n//\n// http://www.apache.org/licenses/LICENSE-2.0\n//\n// Unless required by applicable law or agreed to in writing, software\n// distributed under the License is distributed on an \"AS IS\" BASIS,\n// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n// See the License for the specific language governing permissions and\n// limitations under the License.\n\n#ifndef CRASHPAD_COMPAT_ANDROID_SYS_USER_H_\n#define CRASHPAD_COMPAT_ANDROID_SYS_USER_H_\n\n// This is needed for traditional headers.\n#include \n\n#include_next \n\n#endif // CRASHPAD_COMPAT_ANDROID_SYS_USER_H_\n" }, { "path": "compat/ios/mach/exc.defs", "content": "// Copyright 2020 The Crashpad Authors\n//\n// Licensed under the Apache License, Version 2.0 (the \"License\");\n// you may not use this file except in compliance with the License.\n// You may obtain a copy of the License at\n//\n// http://www.apache.org/licenses/LICENSE-2.0\n//\n// Unless required by applicable law or agreed to in writing, software\n// distributed under the License is distributed on an \"AS IS\" BASIS,\n// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n// See the License for the specific language governing permissions and\n// limitations under the License.\n\n#ifndef CRASHPAD_COMPAT_IOS_MACH_EXC_DEFS_\n#define CRASHPAD_COMPAT_IOS_MACH_EXC_DEFS_\n\n#include \"third_party/xnu/osfmk/mach/exc.defs\"\n\n#endif // CRASHPAD_COMPAT_IOS_MACH_EXC_DEFS_\n" }, { "path": "compat/ios/mach/mach_exc.defs", "content": "// Copyright 2020 The Crashpad Authors\n//\n// Licensed under the Apache License, Version 2.0 (the \"License\");\n// you may not use this file except in compliance with the License.\n// You may obtain a copy of the License at\n//\n// http://www.apache.org/licenses/LICENSE-2.0\n//\n// Unless required by applicable law or agreed to in writing, software\n// distributed under the License is distributed on an \"AS IS\" BASIS,\n// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n// See the License for the specific language governing permissions and\n// limitations under the License.\n\n#ifndef CRASHPAD_COMPAT_IOS_MACH_MACH_EXC_DEFS_\n#define CRASHPAD_COMPAT_IOS_MACH_MACH_EXC_DEFS_\n\n#include \"third_party/xnu/osfmk/mach/mach_exc.defs\"\n\n#endif // CRASHPAD_COMPAT_IOS_MACH_MACH_EXC_DEFS_\n" }, { "path": "compat/ios/mach/mach_types.defs", "content": "// Copyright 2020 The Crashpad Authors\n//\n// Licensed under the Apache License, Version 2.0 (the \"License\");\n// you may not use this file except in compliance with the License.\n// You may obtain a copy of the License at\n//\n// http://www.apache.org/licenses/LICENSE-2.0\n//\n// Unless required by applicable law or agreed to in writing, software\n// distributed under the License is distributed on an \"AS IS\" BASIS,\n// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n// See the License for the specific language governing permissions and\n// limitations under the License.\n\n#ifndef CRASHPAD_COMPAT_IOS_MACH_MACH_TYPES_DEFS_\n#define CRASHPAD_COMPAT_IOS_MACH_MACH_TYPES_DEFS_\n\n#include \"third_party/xnu/osfmk/mach/mach_types.defs\"\n\n#endif // CRASHPAD_COMPAT_IOS_MACH_MACH_TYPES_DEFS_\n" }, { "path": "compat/ios/mach/machine/machine_types.defs", "content": "// Copyright 2020 The Crashpad Authors\n//\n// Licensed under the Apache License, Version 2.0 (the \"License\");\n// you may not use this file except in compliance with the License.\n// You may obtain a copy of the License at\n//\n// http://www.apache.org/licenses/LICENSE-2.0\n//\n// Unless required by applicable law or agreed to in writing, software\n// distributed under the License is distributed on an \"AS IS\" BASIS,\n// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n// See the License for the specific language governing permissions and\n// limitations under the License.\n\n#ifndef CRASHPAD_COMPAT_IOS_MACH_MACHINE_MACHINE_TYPES_DEFS_\n#define CRASHPAD_COMPAT_IOS_MACH_MACHINE_MACHINE_TYPES_DEFS_\n\n#include \"third_party/xnu/osfmk/mach/machine/machine_types.defs\"\n\n#endif // CRASHPAD_COMPAT_IOS_MACH_MACHINE_MACHINE_TYPES_DEFS_\n" }, { "path": "compat/ios/mach/std_types.defs", "content": "// Copyright 2020 The Crashpad Authors\n//\n// Licensed under the Apache License, Version 2.0 (the \"License\");\n// you may not use this file except in compliance with the License.\n// You may obtain a copy of the License at\n//\n// http://www.apache.org/licenses/LICENSE-2.0\n//\n// Unless required by applicable law or agreed to in writing, software\n// distributed under the License is distributed on an \"AS IS\" BASIS,\n// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n// See the License for the specific language governing permissions and\n// limitations under the License.\n\n#ifndef CRASHPAD_COMPAT_IOS_MACH_STD_TYPES_DEFS_\n#define CRASHPAD_COMPAT_IOS_MACH_STD_TYPES_DEFS_\n\n#include \"third_party/xnu/osfmk/mach/std_types.defs\"\n\n#endif // CRASHPAD_COMPAT_IOS_MACH_STD_TYPES_DEFS_\n" }, { "path": "compat/linux/signal.h", "content": "// Copyright 2017 The Crashpad Authors\n//\n// Licensed under the Apache License, Version 2.0 (the \"License\");\n// you may not use this file except in compliance with the License.\n// You may obtain a copy of the License at\n//\n// http://www.apache.org/licenses/LICENSE-2.0\n//\n// Unless required by applicable law or agreed to in writing, software\n// distributed under the License is distributed on an \"AS IS\" BASIS,\n// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n// See the License for the specific language governing permissions and\n// limitations under the License.\n\n#ifndef CRASHPAD_COMPAT_LINUX_SIGNAL_H_\n#define CRASHPAD_COMPAT_LINUX_SIGNAL_H_\n\n#include_next \n\n// Missing from glibc and bionic\n#if !defined(SS_AUTODISARM)\n#define SS_AUTODISARM (1u << 31)\n#endif\n\n// Linux Kernel >= 5.11 flag for `sigaction::sa_flags`. Missing in headers from\n// earlier versions of Linux.\n#if !defined(SA_EXPOSE_TAGBITS)\n#define SA_EXPOSE_TAGBITS 0x00000800\n#endif\n\n// Missing from glibc and bionic-x86_64\n\n#if defined(__x86_64__) || defined(__i386__)\n#if !defined(X86_FXSR_MAGIC)\n#define X86_FXSR_MAGIC 0x0000\n#endif\n#endif // __x86_64__ || __i386__\n\n#if defined(__aarch64__) || defined(__arm__)\n\n#if !defined(FPSIMD_MAGIC)\n#define FPSIMD_MAGIC 0x46508001\n#endif\n\n#if !defined(ESR_MAGIC)\n#define ESR_MAGIC 0x45535201\n#endif\n\n#if !defined(EXTRA_MAGIC)\n#define EXTRA_MAGIC 0x45585401\n#endif\n\n#if !defined(VFP_MAGIC)\n#define VFP_MAGIC 0x56465001\n#endif\n\n#if !defined(CRUNCH_MAGIC)\n#define CRUNCH_MAGIC 0x5065cf03\n#endif\n\n#if !defined(DUMMY_MAGIC)\n#define DUMMY_MAGIC 0xb0d9ed01\n#endif\n\n#if !defined(IWMMXT_MAGIC)\n#define IWMMXT_MAGIC 0x12ef842a\n#endif\n\n#endif // __aarch64__ || __arm__\n\n#endif // CRASHPAD_COMPAT_LINUX_SIGNAL_H_\n" }, { "path": "compat/linux/sys/mman.h", "content": "// Copyright 2019 The Crashpad Authors\n//\n// Licensed under the Apache License, Version 2.0 (the \"License\");\n// you may not use this file except in compliance with the License.\n// You may obtain a copy of the License at\n//\n// http://www.apache.org/licenses/LICENSE-2.0\n//\n// Unless required by applicable law or agreed to in writing, software\n// distributed under the License is distributed on an \"AS IS\" BASIS,\n// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n// See the License for the specific language governing permissions and\n// limitations under the License.\n\n#ifndef CRASHPAD_COMPAT_LINUX_SYS_MMAN_H_\n#define CRASHPAD_COMPAT_LINUX_SYS_MMAN_H_\n\n#include_next \n\n#include \n\n// There's no memfd_create() wrapper before glibc 2.27.\n// This can't select for glibc < 2.27 because linux-chromeos-rel bots build this\n// code using a sysroot which has glibc 2.27, but then run it on Ubuntu 16.04,\n// which doesn't.\n#if defined(__GLIBC__)\n\n#ifdef __cplusplus\nextern \"C\" {\n#endif\n\nint memfd_create(const char* name, unsigned int flags) __THROW;\n\n#ifdef __cplusplus\n} // extern \"C\"\n#endif\n\n#endif // __GLIBC__\n\n#endif // CRASHPAD_COMPAT_LINUX_SYS_MMAN_H_\n" }, { "path": "compat/linux/sys/mman_memfd_create.cc", "content": "// Copyright 2019 The Crashpad Authors\n//\n// Licensed under the Apache License, Version 2.0 (the \"License\");\n// you may not use this file except in compliance with the License.\n// You may obtain a copy of the License at\n//\n// http://www.apache.org/licenses/LICENSE-2.0\n//\n// Unless required by applicable law or agreed to in writing, software\n// distributed under the License is distributed on an \"AS IS\" BASIS,\n// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n// See the License for the specific language governing permissions and\n// limitations under the License.\n\n#include \n\n#include \n#include \n#include \n\n#include \"util/misc/no_cfi_icall.h\"\n\n#if defined(__GLIBC__)\n\nextern \"C\" {\n\nint memfd_create(const char* name, unsigned int flags) __THROW {\n static const crashpad::NoCfiIcall next_memfd_create(\n dlsym(RTLD_NEXT, \"memfd_create\"));\n return next_memfd_create ? next_memfd_create(name, flags)\n : syscall(SYS_memfd_create, name, flags);\n}\n\n} // extern \"C\"\n\n#endif // __GLIBC__\n" }, { "path": "compat/linux/sys/ptrace.h", "content": "// Copyright 2017 The Crashpad Authors\n//\n// Licensed under the Apache License, Version 2.0 (the \"License\");\n// you may not use this file except in compliance with the License.\n// You may obtain a copy of the License at\n//\n// http://www.apache.org/licenses/LICENSE-2.0\n//\n// Unless required by applicable law or agreed to in writing, software\n// distributed under the License is distributed on an \"AS IS\" BASIS,\n// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n// See the License for the specific language governing permissions and\n// limitations under the License.\n\n#ifndef CRASHPAD_COMPAT_LINUX_SYS_PTRACE_H_\n#define CRASHPAD_COMPAT_LINUX_SYS_PTRACE_H_\n\n#include_next \n\n#include \n\n// https://sourceware.org/bugzilla/show_bug.cgi?id=22433\n#if !defined(PTRACE_GET_THREAD_AREA) && !defined(PT_GET_THREAD_AREA) && \\\n defined(__GLIBC__)\n#if defined(__i386__) || defined(__x86_64__)\nstatic constexpr __ptrace_request PTRACE_GET_THREAD_AREA =\n static_cast<__ptrace_request>(25);\n#define PTRACE_GET_THREAD_AREA PTRACE_GET_THREAD_AREA\n// https://bugs.chromium.org/p/chromium/issues/detail?id=873168\n#elif defined(__arm__) || (defined(__aarch64__) && __GLIBC_PREREQ(2,28))\nstatic constexpr __ptrace_request PTRACE_GET_THREAD_AREA =\n static_cast<__ptrace_request>(22);\n#define PTRACE_GET_THREAD_AREA PTRACE_GET_THREAD_AREA\n#elif defined(__mips__)\nstatic constexpr __ptrace_request PTRACE_GET_THREAD_AREA =\n static_cast<__ptrace_request>(25);\n#define PTRACE_GET_THREAD_AREA PTRACE_GET_THREAD_AREA\nstatic constexpr __ptrace_request PTRACE_GET_THREAD_AREA_3264 =\n static_cast<__ptrace_request>(0xc4);\n#define PTRACE_GET_THREAD_AREA_3264 PTRACE_GET_THREAD_AREA_3264\n#endif\n#endif // !PTRACE_GET_THREAD_AREA && !PT_GET_THREAD_AREA && defined(__GLIBC__)\n\n// https://sourceware.org/bugzilla/show_bug.cgi?id=22433\n#if !defined(PTRACE_GETVFPREGS) && !defined(PT_GETVFPREGS) && \\\n defined(__GLIBC__) && (defined(__arm__) || defined(__aarch64__))\nstatic constexpr __ptrace_request PTRACE_GETVFPREGS =\n static_cast<__ptrace_request>(27);\n#define PTRACE_GETVFPREGS PTRACE_GETVFPREGS\n#endif\n\n#endif // CRASHPAD_COMPAT_LINUX_SYS_PTRACE_H_\n" }, { "path": "compat/linux/sys/user.h", "content": "// Copyright 2018 The Crashpad Authors\n//\n// Licensed under the Apache License, Version 2.0 (the \"License\");\n// you may not use this file except in compliance with the License.\n// You may obtain a copy of the License at\n//\n// http://www.apache.org/licenses/LICENSE-2.0\n//\n// Unless required by applicable law or agreed to in writing, software\n// distributed under the License is distributed on an \"AS IS\" BASIS,\n// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n// See the License for the specific language governing permissions and\n// limitations under the License.\n\n#ifndef CRASHPAD_COMPAT_LINUX_SYS_USER_H_\n#define CRASHPAD_COMPAT_LINUX_SYS_USER_H_\n\n#include_next \n\n#include \n\n// glibc for 64-bit ARM uses different names for these structs prior to 2.20.\n// However, Debian's glibc 2.19-8 backported the change so it's not sufficient\n// to only test the version. user_pt_regs and user_fpsimd_state are actually\n// defined in so we use the include guard here.\n#if defined(__aarch64__) && defined(__GLIBC__)\n#if !__GLIBC_PREREQ(2, 20) && defined(__ASM_PTRACE_H)\nusing user_regs_struct = user_pt_regs;\nusing user_fpsimd_struct = user_fpsimd_state;\n#endif\n#endif\n\n#endif // CRASHPAD_COMPAT_LINUX_SYS_USER_H_\n" }, { "path": "compat/mac/Availability.h", "content": "// Copyright 2020 The Crashpad Authors\n//\n// Licensed under the Apache License, Version 2.0 (the \"License\");\n// you may not use this file except in compliance with the License.\n// You may obtain a copy of the License at\n//\n// http://www.apache.org/licenses/LICENSE-2.0\n//\n// Unless required by applicable law or agreed to in writing, software\n// distributed under the License is distributed on an \"AS IS\" BASIS,\n// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n// See the License for the specific language governing permissions and\n// limitations under the License.\n\n#ifndef CRASHPAD_COMPAT_MAC_AVAILABILITY_H_\n#define CRASHPAD_COMPAT_MAC_AVAILABILITY_H_\n\n// Until the 10.15 SDK, the contents of was in-line in\n// , but since then, it was broken out into its own header.\n// This compat version of allows these macros to always appear\n// to be provided by the new header, , even when an\n// older SDK is in use.\n\n#include_next \n\n#include \n\n#endif // CRASHPAD_COMPAT_MAC_AVAILABILITY_H_\n" }, { "path": "compat/mac/AvailabilityVersions.h", "content": "// Copyright 2020 The Crashpad Authors\n//\n// Licensed under the Apache License, Version 2.0 (the \"License\");\n// you may not use this file except in compliance with the License.\n// You may obtain a copy of the License at\n//\n// http://www.apache.org/licenses/LICENSE-2.0\n//\n// Unless required by applicable law or agreed to in writing, software\n// distributed under the License is distributed on an \"AS IS\" BASIS,\n// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n// See the License for the specific language governing permissions and\n// limitations under the License.\n\n#ifndef CRASHPAD_COMPAT_MAC_AVAILABILITYVERSIONS_H_\n#define CRASHPAD_COMPAT_MAC_AVAILABILITYVERSIONS_H_\n\n#if __has_include_next()\n#include_next \n#endif\n\n// 10.7 SDK\n\n#ifndef __MAC_10_7\n#define __MAC_10_7 1070\n#endif\n\n// 10.8 SDK\n\n#ifndef __MAC_10_8\n#define __MAC_10_8 1080\n#endif\n\n// 10.9 SDK\n\n#ifndef __MAC_10_9\n#define __MAC_10_9 1090\n#endif\n\n// 10.10 SDK\n\n#ifndef __MAC_10_10\n#define __MAC_10_10 101000\n#endif\n\n// 10.11 SDK\n\n#ifndef __MAC_10_11\n#define __MAC_10_11 101100\n#endif\n\n// 10.12 SDK\n\n#ifndef __MAC_10_12\n#define __MAC_10_12 101200\n#endif\n\n// 10.13 SDK\n\n#ifndef __MAC_10_13\n#define __MAC_10_13 101300\n#endif\n\n#ifndef __MAC_10_13_4\n#define __MAC_10_13_4 101304\n#endif\n\n// 10.14 SDK\n\n#ifndef __MAC_10_14\n#define __MAC_10_14 101400\n#endif\n\n// 10.15 SDK\n\n#ifndef __MAC_10_15\n#define __MAC_10_15 101500\n#endif\n\n// 11.0 SDK\n\n#ifndef __MAC_10_16\n#define __MAC_10_16 101600\n#endif\n\n#ifndef __MAC_11_0\n#define __MAC_11_0 110000\n#endif\n\n// 12.0 SDK\n\n#ifndef __MAC_12_0\n#define __MAC_12_0 120000\n#endif\n\n#endif // CRASHPAD_COMPAT_MAC_AVAILABILITYVERSIONS_H_\n" }, { "path": "compat/mac/kern/exc_resource.h", "content": "// Copyright 2015 The Crashpad Authors\n//\n// Licensed under the Apache License, Version 2.0 (the \"License\");\n// you may not use this file except in compliance with the License.\n// You may obtain a copy of the License at\n//\n// http://www.apache.org/licenses/LICENSE-2.0\n//\n// Unless required by applicable law or agreed to in writing, software\n// distributed under the License is distributed on an \"AS IS\" BASIS,\n// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n// See the License for the specific language governing permissions and\n// limitations under the License.\n\n#ifndef CRASHPAD_COMPAT_MAC_KERN_EXC_RESOURCE_H_\n#define CRASHPAD_COMPAT_MAC_KERN_EXC_RESOURCE_H_\n\n#if __has_include_next()\n#include_next \n#endif\n\n// 10.9 SDK\n\n#ifndef EXC_RESOURCE_DECODE_RESOURCE_TYPE\n#define EXC_RESOURCE_DECODE_RESOURCE_TYPE(code) (((code) >> 61) & 0x7ull)\n#endif\n\n#ifndef EXC_RESOURCE_DECODE_FLAVOR\n#define EXC_RESOURCE_DECODE_FLAVOR(code) (((code) >> 58) & 0x7ull)\n#endif\n\n#ifndef RESOURCE_TYPE_CPU\n#define RESOURCE_TYPE_CPU 1\n#endif\n\n#ifndef RESOURCE_TYPE_WAKEUPS\n#define RESOURCE_TYPE_WAKEUPS 2\n#endif\n\n#ifndef RESOURCE_TYPE_MEMORY\n#define RESOURCE_TYPE_MEMORY 3\n#endif\n\n#ifndef FLAVOR_CPU_MONITOR\n#define FLAVOR_CPU_MONITOR 1\n#endif\n\n#ifndef FLAVOR_WAKEUPS_MONITOR\n#define FLAVOR_WAKEUPS_MONITOR 1\n#endif\n\n#ifndef FLAVOR_HIGH_WATERMARK\n#define FLAVOR_HIGH_WATERMARK 1\n#endif\n\n// 10.10 SDK\n\n#ifndef FLAVOR_CPU_MONITOR_FATAL\n#define FLAVOR_CPU_MONITOR_FATAL 2\n#endif\n\n// 10.12 SDK\n\n#ifndef RESOURCE_TYPE_IO\n#define RESOURCE_TYPE_IO 4\n#endif\n\n#ifndef FLAVOR_IO_PHYSICAL_WRITES\n#define FLAVOR_IO_PHYSICAL_WRITES 1\n#endif\n\n#ifndef FLAVOR_IO_LOGICAL_WRITES\n#define FLAVOR_IO_LOGICAL_WRITES 2\n#endif\n\n#endif // CRASHPAD_COMPAT_MAC_KERN_EXC_RESOURCE_H_\n" }, { "path": "compat/mac/mach/i386/thread_state.h", "content": "// Copyright 2017 The Crashpad Authors\n//\n// Licensed under the Apache License, Version 2.0 (the \"License\");\n// you may not use this file except in compliance with the License.\n// You may obtain a copy of the License at\n//\n// http://www.apache.org/licenses/LICENSE-2.0\n//\n// Unless required by applicable law or agreed to in writing, software\n// distributed under the License is distributed on an \"AS IS\" BASIS,\n// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n// See the License for the specific language governing permissions and\n// limitations under the License.\n\n#ifndef CRASHPAD_COMPAT_MAC_MACH_I386_THREAD_STATE_H_\n#define CRASHPAD_COMPAT_MAC_MACH_I386_THREAD_STATE_H_\n\n#include_next \n\n// 10.13 SDK\n//\n// This was defined as 244 in the 10.7 through 10.12 SDKs, and 144 previously.\n#if I386_THREAD_STATE_MAX < 614\n#undef I386_THREAD_STATE_MAX\n#define I386_THREAD_STATE_MAX (614)\n#endif\n\n#endif // CRASHPAD_COMPAT_MAC_MACH_I386_THREAD_STATE_H_\n" }, { "path": "compat/mac/mach/mach.h", "content": "// Copyright 2014 The Crashpad Authors\n//\n// Licensed under the Apache License, Version 2.0 (the \"License\");\n// you may not use this file except in compliance with the License.\n// You may obtain a copy of the License at\n//\n// http://www.apache.org/licenses/LICENSE-2.0\n//\n// Unless required by applicable law or agreed to in writing, software\n// distributed under the License is distributed on an \"AS IS\" BASIS,\n// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n// See the License for the specific language governing permissions and\n// limitations under the License.\n\n#ifndef CRASHPAD_COMPAT_MAC_MACH_MACH_H_\n#define CRASHPAD_COMPAT_MAC_MACH_MACH_H_\n\n#include_next \n\n// \n\n// 10.8 SDK\n\n#ifndef EXC_RESOURCE\n#define EXC_RESOURCE 11\n#endif\n\n#ifndef EXC_MASK_RESOURCE\n#define EXC_MASK_RESOURCE (1 << EXC_RESOURCE)\n#endif\n\n// 10.9 SDK\n\n#ifndef EXC_GUARD\n#define EXC_GUARD 12\n#endif\n\n#ifndef EXC_MASK_GUARD\n#define EXC_MASK_GUARD (1 << EXC_GUARD)\n#endif\n\n// 10.11 SDK\n\n#ifndef EXC_CORPSE_NOTIFY\n#define EXC_CORPSE_NOTIFY 13\n#endif\n\n#ifndef EXC_MASK_CORPSE_NOTIFY\n#define EXC_MASK_CORPSE_NOTIFY (1 << EXC_CORPSE_NOTIFY)\n#endif\n\n// Don’t expose EXC_MASK_ALL at all, because its definition varies with SDK, and\n// older kernels will reject values that they don’t understand. Instead, use\n// crashpad::ExcMaskAll(), which computes the correct value of EXC_MASK_ALL for\n// the running system.\n#undef EXC_MASK_ALL\n\n#if defined(__i386__) || defined(__x86_64__)\n\n// \n\n// 10.11 SDK\n\n#if EXC_TYPES_COUNT > 14 // Definition varies with SDK\n#error Update this file for new exception types\n#elif EXC_TYPES_COUNT != 14\n#undef EXC_TYPES_COUNT\n#define EXC_TYPES_COUNT 14\n#endif\n\n// \n\n// 10.6 SDK\n//\n// Earlier versions of this SDK didn’t have AVX definitions. They didn’t appear\n// until the version of the 10.6 SDK that shipped with Xcode 4.2, although\n// versions of this SDK appeared with Xcode releases as early as Xcode 3.2.\n// Similarly, the kernel didn’t handle AVX state until Mac OS X 10.6.8\n// (xnu-1504.15.3) and presumably the hardware-specific versions of Mac OS X\n// 10.6.7 intended to run on processors with AVX.\n\n#ifndef x86_AVX_STATE32\n#define x86_AVX_STATE32 16\n#endif\n\n#ifndef x86_AVX_STATE64\n#define x86_AVX_STATE64 17\n#endif\n\n// 10.8 SDK\n\n#ifndef x86_AVX_STATE\n#define x86_AVX_STATE 18\n#endif\n\n// 10.13 SDK\n\n#ifndef x86_AVX512_STATE32\n#define x86_AVX512_STATE32 19\n#endif\n\n#ifndef x86_AVX512_STATE64\n#define x86_AVX512_STATE64 20\n#endif\n\n#ifndef x86_AVX512_STATE\n#define x86_AVX512_STATE 21\n#endif\n\n#endif // defined(__i386__) || defined(__x86_64__)\n\n// \n\n// 10.8 SDK\n\n#ifndef THREAD_STATE_FLAVOR_LIST_10_9\n#define THREAD_STATE_FLAVOR_LIST_10_9 129\n#endif\n\n#endif // CRASHPAD_COMPAT_MAC_MACH_MACH_H_\n" }, { "path": "compat/mac/mach-o/loader.h", "content": "// Copyright 2014 The Crashpad Authors\n//\n// Licensed under the Apache License, Version 2.0 (the \"License\");\n// you may not use this file except in compliance with the License.\n// You may obtain a copy of the License at\n//\n// http://www.apache.org/licenses/LICENSE-2.0\n//\n// Unless required by applicable law or agreed to in writing, software\n// distributed under the License is distributed on an \"AS IS\" BASIS,\n// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n// See the License for the specific language governing permissions and\n// limitations under the License.\n\n#ifndef CRASHPAD_COMPAT_MAC_MACH_O_LOADER_H_\n#define CRASHPAD_COMPAT_MAC_MACH_O_LOADER_H_\n\n#include_next \n\n// 10.7 SDK\n\n#ifndef S_THREAD_LOCAL_ZEROFILL\n#define S_THREAD_LOCAL_ZEROFILL 0x12\n#endif\n\n// 10.8 SDK\n\n#ifndef LC_SOURCE_VERSION\n#define LC_SOURCE_VERSION 0x2a\n#endif\n\n#endif // CRASHPAD_COMPAT_MAC_MACH_O_LOADER_H_\n" }, { "path": "compat/mac/sys/resource.h", "content": "// Copyright 2015 The Crashpad Authors\n//\n// Licensed under the Apache License, Version 2.0 (the \"License\");\n// you may not use this file except in compliance with the License.\n// You may obtain a copy of the License at\n//\n// http://www.apache.org/licenses/LICENSE-2.0\n//\n// Unless required by applicable law or agreed to in writing, software\n// distributed under the License is distributed on an \"AS IS\" BASIS,\n// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n// See the License for the specific language governing permissions and\n// limitations under the License.\n\n#ifndef CRASHPAD_COMPAT_MAC_SYS_RESOURCE_H_\n#define CRASHPAD_COMPAT_MAC_SYS_RESOURCE_H_\n\n#include_next \n\n// 10.9 SDK\n\n#ifndef WAKEMON_MAKE_FATAL\n#define WAKEMON_MAKE_FATAL 0x10\n#endif\n\n#endif // CRASHPAD_COMPAT_MAC_SYS_RESOURCE_H_\n" }, { "path": "compat/non_mac/mach/mach.h", "content": "// Copyright 2014 The Crashpad Authors\n//\n// Licensed under the Apache License, Version 2.0 (the \"License\");\n// you may not use this file except in compliance with the License.\n// You may obtain a copy of the License at\n//\n// http://www.apache.org/licenses/LICENSE-2.0\n//\n// Unless required by applicable law or agreed to in writing, software\n// distributed under the License is distributed on an \"AS IS\" BASIS,\n// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n// See the License for the specific language governing permissions and\n// limitations under the License.\n\n#ifndef CRASHPAD_COMPAT_NON_MAC_MACH_MACH_H_\n#define CRASHPAD_COMPAT_NON_MAC_MACH_MACH_H_\n\n//! \\file\n\n// \n\n//! \\anchor EXC_x\n//! \\name EXC_*\n//!\n//! \\brief Mach exception type definitions.\n//! \\{\n#define EXC_BAD_ACCESS 1\n#define EXC_BAD_INSTRUCTION 2\n#define EXC_ARITHMETIC 3\n#define EXC_EMULATION 4\n#define EXC_SOFTWARE 5\n#define EXC_BREAKPOINT 6\n#define EXC_SYSCALL 7\n#define EXC_MACH_SYSCALL 8\n#define EXC_RPC_ALERT 9\n#define EXC_CRASH 10\n#define EXC_RESOURCE 11\n#define EXC_GUARD 12\n#define EXC_CORPSE_NOTIFY 13\n\n#define EXC_TYPES_COUNT 14\n//! \\}\n\n#endif // CRASHPAD_COMPAT_NON_MAC_MACH_MACH_H_\n" }, { "path": "compat/non_mac/mach/machine.h", "content": "// Copyright 2019 The Crashpad Authors\n//\n// Licensed under the Apache License, Version 2.0 (the \"License\");\n// you may not use this file except in compliance with the License.\n// You may obtain a copy of the License at\n//\n// http://www.apache.org/licenses/LICENSE-2.0\n//\n// Unless required by applicable law or agreed to in writing, software\n// distributed under the License is distributed on an \"AS IS\" BASIS,\n// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n// See the License for the specific language governing permissions and\n// limitations under the License.\n\n#ifndef CRASHPAD_COMPAT_NON_MAC_MACH_MACHINE_H_\n#define CRASHPAD_COMPAT_NON_MAC_MACH_MACHINE_H_\n\ntypedef int cpu_type_t;\ntypedef int cpu_subtype_t;\n\n#endif // CRASHPAD_COMPAT_NON_MAC_MACH_MACHINE_H_\n" }, { "path": "compat/non_mac/mach/vm_prot.h", "content": "// Copyright 2019 The Crashpad Authors\n//\n// Licensed under the Apache License, Version 2.0 (the \"License\");\n// you may not use this file except in compliance with the License.\n// You may obtain a copy of the License at\n//\n// http://www.apache.org/licenses/LICENSE-2.0\n//\n// Unless required by applicable law or agreed to in writing, software\n// distributed under the License is distributed on an \"AS IS\" BASIS,\n// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n// See the License for the specific language governing permissions and\n// limitations under the License.\n\n#ifndef CRASHPAD_COMPAT_NON_MAC_MACH_VM_PROT_H_\n#define CRASHPAD_COMPAT_NON_MAC_MACH_VM_PROT_H_\n\ntypedef int vm_prot_t;\n\n#endif // CRASHPAD_COMPAT_NON_MAC_MACH_VM_PROT_H_\n" }, { "path": "compat/non_mac/mach-o/loader.h", "content": "// Copyright 2019 The Crashpad Authors\n//\n// Licensed under the Apache License, Version 2.0 (the \"License\");\n// you may not use this file except in compliance with the License.\n// You may obtain a copy of the License at\n//\n// http://www.apache.org/licenses/LICENSE-2.0\n//\n// Unless required by applicable law or agreed to in writing, software\n// distributed under the License is distributed on an \"AS IS\" BASIS,\n// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n// See the License for the specific language governing permissions and\n// limitations under the License.\n\n#ifndef CRASHPAD_COMPAT_NON_MAC_MACH_O_LOADER_H_\n#define CRASHPAD_COMPAT_NON_MAC_MACH_O_LOADER_H_\n\n#include \"third_party/xnu/EXTERNAL_HEADERS/mach-o/loader.h\"\n\n#endif // CRASHPAD_COMPAT_NON_MAC_MACH_O_LOADER_H_\n" }, { "path": "compat/non_win/dbghelp.h", "content": "// Copyright 2014 The Crashpad Authors\n//\n// Licensed under the Apache License, Version 2.0 (the \"License\");\n// you may not use this file except in compliance with the License.\n// You may obtain a copy of the License at\n//\n// http://www.apache.org/licenses/LICENSE-2.0\n//\n// Unless required by applicable law or agreed to in writing, software\n// distributed under the License is distributed on an \"AS IS\" BASIS,\n// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n// See the License for the specific language governing permissions and\n// limitations under the License.\n\n#ifndef CRASHPAD_COMPAT_NON_WIN_DBGHELP_H_\n#define CRASHPAD_COMPAT_NON_WIN_DBGHELP_H_\n\n#include \n\n#include \"compat/non_win/timezoneapi.h\"\n#include \"compat/non_win/verrsrc.h\"\n#include \"compat/non_win/winnt.h\"\n\n//! \\file\n\n//! \\brief The magic number for a minidump file, stored in\n//! MINIDUMP_HEADER::Signature.\n//!\n//! A hex dump of a little-endian minidump file will begin with the string\n//! “MDMP”.\n#define MINIDUMP_SIGNATURE ('PMDM') // 0x4d444d50\n\n//! \\brief The version of a minidump file, stored in MINIDUMP_HEADER::Version.\n#define MINIDUMP_VERSION (42899)\n\n//! \\brief An offset within a minidump file, relative to the start of its\n//! MINIDUMP_HEADER.\n//!\n//! RVA stands for “relative virtual address”. Within a minidump file, RVAs are\n//! used as pointers to link structures together.\n//!\n//! \\sa MINIDUMP_LOCATION_DESCRIPTOR\ntypedef uint32_t RVA;\n\n//! \\brief A 64-bit offset within a minidump file, relative to the start of its\n//! MINIDUMP_HEADER.\n//!\n//! RVA stands for “relative virtual address”. Within a minidump file, RVAs are\n//! used as pointers to link structures together.\n//!\n//! \\sa MINIDUMP_LOCATION_DESCRIPTOR64\ntypedef uint64_t RVA64;\n\n//! \\brief A pointer to a structure or union within a minidump file.\nstruct __attribute__((packed, aligned(4))) MINIDUMP_LOCATION_DESCRIPTOR {\n //! \\brief The size of the referenced structure or union, in bytes.\n uint32_t DataSize;\n\n //! \\brief The relative virtual address of the structure or union within the\n //! minidump file.\n RVA Rva;\n};\n\n//! \\brief A 64-bit pointer to a structure or union within a minidump file.\nstruct __attribute__((packed, aligned(4))) MINIDUMP_LOCATION_DESCRIPTOR64 {\n //! \\brief The size of the referenced structure or union, in bytes.\n uint64_t DataSize;\n\n //! \\brief The 64-bit relative virtual address of the structure or union\n //! within the minidump file.\n RVA64 Rva;\n};\n\n//! \\brief A pointer to a snapshot of a region of memory contained within a\n//! minidump file.\n//!\n//! \\sa MINIDUMP_MEMORY_LIST\nstruct __attribute__((packed, aligned(4))) MINIDUMP_MEMORY_DESCRIPTOR {\n //! \\brief The base address of the memory region in the address space of the\n //! process that the minidump file contains a snapshot of.\n uint64_t StartOfMemoryRange;\n\n //! \\brief The contents of the memory region.\n MINIDUMP_LOCATION_DESCRIPTOR Memory;\n};\n\n//! \\brief The top-level structure identifying a minidump file.\n//!\n//! This structure contains a pointer to the stream directory, a second-level\n//! structure which in turn contains pointers to third-level structures\n//! (“streams”) containing the data within the minidump file. This structure\n//! also contains the minidump file’s magic numbers, and other bookkeeping data.\n//!\n//! This structure must be present at the beginning of a minidump file (at ::RVA\n//! 0).\nstruct __attribute__((packed, aligned(4))) MINIDUMP_HEADER {\n //! \\brief The minidump file format magic number, ::MINIDUMP_SIGNATURE.\n uint32_t Signature;\n\n //! \\brief The minidump file format version number, ::MINIDUMP_VERSION.\n uint32_t Version;\n\n //! \\brief The number of MINIDUMP_DIRECTORY elements present in the directory\n //! referenced by #StreamDirectoryRva.\n uint32_t NumberOfStreams;\n\n //! \\brief A pointer to an array of MINIDUMP_DIRECTORY structures that\n //! identify all of the streams within this minidump file. The array has\n //! #NumberOfStreams elements present.\n RVA StreamDirectoryRva;\n\n //! \\brief The minidump file’s checksum. This can be `0`, and in practice, `0`\n //! is the only value that has ever been seen in this field.\n uint32_t CheckSum;\n\n //! \\brief The time that the minidump file was generated, in `time_t` format,\n //! the number of seconds since the POSIX epoch.\n uint32_t TimeDateStamp;\n\n //! \\brief A bitfield containing members of ::MINIDUMP_TYPE, describing the\n //! types of data carried within this minidump file.\n uint64_t Flags;\n};\n\n//! \\brief A pointer to a stream within a minidump file.\n//!\n//! Each stream present in a minidump file will have a corresponding\n//! MINIDUMP_DIRECTORY entry in the stream directory referenced by\n//! MINIDUMP_HEADER::StreamDirectoryRva.\nstruct __attribute__((packed, aligned(4))) MINIDUMP_DIRECTORY {\n //! \\brief The type of stream referenced, a value of ::MINIDUMP_STREAM_TYPE.\n uint32_t StreamType;\n\n //! \\brief A pointer to the stream data within the minidump file.\n MINIDUMP_LOCATION_DESCRIPTOR Location;\n};\n\n//! \\brief A variable-length UTF-16-encoded string carried within a minidump\n//! file.\n//!\n//! The UTF-16 string is stored as UTF-16LE or UTF-16BE according to the byte\n//! ordering of the minidump file itself.\n//!\n//! \\sa crashpad::MinidumpUTF8String\nstruct __attribute__((packed, aligned(4))) MINIDUMP_STRING {\n //! \\brief The length of the #Buffer field in bytes, not including the `NUL`\n //! terminator.\n //!\n //! \\note This field is interpreted as a byte count, not a count of UTF-16\n //! code units or Unicode code points.\n uint32_t Length;\n\n //! \\brief The string, encoded in UTF-16, and terminated with a UTF-16 `NUL`\n //! code unit (two `NUL` bytes).\n char16_t Buffer[0];\n};\n\n//! \\brief Minidump stream type values for MINIDUMP_DIRECTORY::StreamType. Each\n//! stream structure has a corresponding stream type value to identify it.\n//!\n//! \\sa crashpad::MinidumpStreamType\nenum MINIDUMP_STREAM_TYPE {\n //! \\brief The stream type for MINIDUMP_THREAD_LIST.\n ThreadListStream = 3,\n\n //! \\brief The stream type for MINIDUMP_MODULE_LIST.\n ModuleListStream = 4,\n\n //! \\brief The stream type for MINIDUMP_MEMORY_LIST.\n MemoryListStream = 5,\n\n //! \\brief The stream type for MINIDUMP_EXCEPTION_STREAM.\n ExceptionStream = 6,\n\n //! \\brief The stream type for MINIDUMP_SYSTEM_INFO.\n SystemInfoStream = 7,\n\n //! \\brief The stream contains information about active `HANDLE`s.\n HandleDataStream = 12,\n\n //! \\brief The stream type for MINIDUMP_UNLOADED_MODULE_LIST.\n UnloadedModuleListStream = 14,\n\n //! \\brief The stream type for MINIDUMP_MISC_INFO, MINIDUMP_MISC_INFO_2,\n //! MINIDUMP_MISC_INFO_3, MINIDUMP_MISC_INFO_4, and MINIDUMP_MISC_INFO_5.\n //!\n //! More recent versions of this stream are supersets of earlier versions.\n //!\n //! The exact version of the stream that is present is implied by the stream’s\n //! size. Furthermore, this stream contains a field,\n //! MINIDUMP_MISC_INFO::Flags1, that indicates which data is present and\n //! valid.\n MiscInfoStream = 15,\n\n //! \\brief The stream type for MINIDUMP_MEMORY_INFO_LIST.\n MemoryInfoListStream = 16,\n\n //! \\brief The stream type for MINIDUMP_THREAD_NAME_LIST.\n ThreadNamesStream = 24,\n\n //! \\brief Values greater than this value will not be used by the system\n //! and can be used for custom user data streams.\n LastReservedStream = 0xffff,\n};\n\n//! \\brief Information about the CPU (or CPUs) that ran the process that the\n//! minidump file contains a snapshot of.\n//!\n//! This union only appears as MINIDUMP_SYSTEM_INFO::Cpu. Its interpretation is\n//! controlled by MINIDUMP_SYSTEM_INFO::ProcessorArchitecture.\nunion __attribute__((packed, aligned(4))) CPU_INFORMATION {\n //! \\brief Information about 32-bit x86 CPUs, or x86_64 CPUs when running\n //! 32-bit x86 processes.\n struct __attribute__((packed, aligned(4))) {\n //! \\brief The CPU’s vendor identification string as encoded in `cpuid 0`\n //! `ebx`, `edx`, and `ecx`, represented as it appears in these\n //! registers.\n //!\n //! For Intel CPUs, `[0]` will encode “Genu”, `[1]` will encode “ineI”, and\n //! `[2]` will encode “ntel”, for a vendor ID string “GenuineIntel”.\n //!\n //! \\note The Windows documentation incorrectly states that these fields are\n //! to be interpreted as `cpuid 0` `eax`, `ebx`, and `ecx`.\n uint32_t VendorId[3];\n\n //! \\brief Family, model, and stepping ID values as encoded in `cpuid 1`\n //! `eax`.\n uint32_t VersionInformation;\n\n //! \\brief A bitfield containing supported CPU capabilities as encoded in\n //! `cpuid 1` `edx`.\n uint32_t FeatureInformation;\n\n //! \\brief A bitfield containing supported CPU capabalities as encoded in\n //! `cpuid 0x80000001` `edx`.\n //!\n //! This field is only valid if #VendorId identifies the CPU vendor as\n //! “AuthenticAMD” or \"HygonGenuine\".\n uint32_t AMDExtendedCpuFeatures;\n } X86CpuInfo;\n\n //! \\brief Information about non-x86 CPUs, and x86_64 CPUs when not running\n //! 32-bit x86 processes.\n struct __attribute__((packed, aligned(4))) {\n //! \\brief Bitfields containing supported CPU capabilities as identified by\n //! bits corresponding to \\ref PF_x \"PF_*\" values passed to\n //! `IsProcessorFeaturePresent()`.\n uint64_t ProcessorFeatures[2];\n } OtherCpuInfo;\n};\n\n//! \\brief Information about the system that hosted the process that the\n//! minidump file contains a snapshot of.\nstruct __attribute__((packed, aligned(4))) MINIDUMP_SYSTEM_INFO {\n // The next 4 fields are from the SYSTEM_INFO structure returned by\n // GetSystemInfo().\n\n //! \\brief The system’s CPU architecture. This may be a \\ref\n //! PROCESSOR_ARCHITECTURE_x \"PROCESSOR_ARCHITECTURE_*\" value, or a member\n //! of crashpad::MinidumpCPUArchitecture.\n //!\n //! In some cases, a system may be able to run processes of multiple specific\n //! architecture types. For example, systems based on 64-bit architectures\n //! such as x86_64 are often able to run 32-bit code of another architecture\n //! in the same family, such as 32-bit x86. On these systems, this field will\n //! identify the architecture of the process that the minidump file contains a\n //! snapshot of.\n uint16_t ProcessorArchitecture;\n\n //! \\brief General CPU version information.\n //!\n //! The precise interpretation of this field is specific to each CPU\n //! architecture. For x86-family CPUs (including x86_64 and 32-bit x86), this\n //! field contains the CPU family ID value from `cpuid 1` `eax`, adjusted to\n //! take the extended family ID into account.\n uint16_t ProcessorLevel;\n\n //! \\brief Specific CPU version information.\n //!\n //! The precise interpretation of this field is specific to each CPU\n //! architecture. For x86-family CPUs (including x86_64 and 32-bit x86), this\n //! field contains values obtained from `cpuid 1` `eax`: the high byte\n //! contains the CPU model ID value adjusted to take the extended model ID\n //! into account, and the low byte contains the CPU stepping ID value.\n uint16_t ProcessorRevision;\n\n //! \\brief The total number of CPUs present in the system.\n uint8_t NumberOfProcessors;\n\n // The next 7 fields are from the OSVERSIONINFOEX structure returned by\n // GetVersionEx().\n\n //! \\brief The system’s operating system type, which distinguishes between\n //! “desktop” or “workstation” systems and “server” systems. This may be a\n //! \\ref VER_NT_x \"VER_NT_*\" value, or a member of\n //! crashpad::MinidumpOSType.\n uint8_t ProductType;\n\n //! \\brief The system’s operating system version number’s first (major)\n //! component.\n //!\n //! - For Windows 7 (NT 6.1) SP1, version 6.1.7601, this would be `6`.\n //! - For macOS 10.12.1, this would be `10`.\n uint32_t MajorVersion;\n\n //! \\brief The system’s operating system version number’s second (minor)\n //! component.\n //!\n //! - For Windows 7 (NT 6.1) SP1, version 6.1.7601, this would be `1`.\n //! - For macOS 10.12.1, this would be `12`.\n uint32_t MinorVersion;\n\n //! \\brief The system’s operating system version number’s third (build or\n //! patch) component.\n //!\n //! - For Windows 7 (NT 6.1) SP1, version 6.1.7601, this would be `7601`.\n //! - For macOS 10.12.1, this would be `1`.\n uint32_t BuildNumber;\n\n //! \\brief The system’s operating system family. This may be a \\ref\n //! VER_PLATFORM_x \"VER_PLATFORM_*\" value, or a member of\n //! crashpad::MinidumpOS.\n uint32_t PlatformId;\n\n //! \\brief ::RVA of a MINIDUMP_STRING containing operating system-specific\n //! version information.\n //!\n //! This field further identifies an operating system version beyond its\n //! version number fields. Historically, “CSD” stands for “corrective service\n //! diskette.”\n //!\n //! - On Windows, this is the name of the installed operating system service\n //! pack, such as “Service Pack 1”. If no service pack is installed, this\n //! field references an empty string.\n //! - On macOS, this is the operating system build number from `sw_vers\n //! -buildVersion`. For macOS 10.12.1 on most hardware types, this would\n //! be `16B2657`.\n //! - On Linux and other Unix-like systems, this is the kernel version from\n //! `uname -srvm`, possibly with additional information appended. On\n //! Android, the `ro.build.fingerprint` system property is appended.\n RVA CSDVersionRva;\n\n //! \\brief A bitfield identifying products installed on the system. This is\n //! composed of \\ref VER_SUITE_x \"VER_SUITE_*\" values.\n //!\n //! This field is Windows-specific, and has no meaning on other operating\n //! systems.\n uint16_t SuiteMask;\n\n uint16_t Reserved2;\n\n //! \\brief Information about the system’s CPUs.\n //!\n //! This field is a union. Which of its members should be expressed is\n //! controlled by the #ProcessorArchitecture field. If it is set to\n //! crashpad::kMinidumpCPUArchitectureX86, the CPU_INFORMATION::X86CpuInfo\n //! field is expressed. Otherwise, the CPU_INFORMATION::OtherCpuInfo field is\n //! expressed.\n //!\n //! \\note Older Breakpad implementations produce minidump files that express\n //! CPU_INFORMATION::X86CpuInfo when #ProcessorArchitecture is set to\n //! crashpad::kMinidumpCPUArchitectureAMD64. Minidump files produced by\n //! `dbghelp.dll` on Windows express CPU_INFORMATION::OtherCpuInfo in this\n //! case.\n CPU_INFORMATION Cpu;\n};\n\n//! \\brief Information about a specific thread within the process.\n//!\n//! \\sa MINIDUMP_THREAD_LIST\nstruct __attribute__((packed, aligned(4))) MINIDUMP_THREAD {\n //! \\brief The thread’s ID. This may be referenced by\n //! MINIDUMP_EXCEPTION_STREAM::ThreadId.\n uint32_t ThreadId;\n\n //! \\brief The thread’s suspend count.\n //!\n //! This field will be `0` if the thread is schedulable (not suspended).\n uint32_t SuspendCount;\n\n //! \\brief The thread’s priority class.\n //!\n //! On Windows, this is a `*_PRIORITY_CLASS` value. `NORMAL_PRIORITY_CLASS`\n //! has value `0x20`; higher priority classes have higher values.\n uint32_t PriorityClass;\n\n //! \\brief The thread’s priority level.\n //!\n //! On Windows, this is a `THREAD_PRIORITY_*` value. `THREAD_PRIORITY_NORMAL`\n //! has value `0`; higher priorities have higher values, and lower priorities\n //! have lower (negative) values.\n uint32_t Priority;\n\n //! \\brief The address of the thread’s thread environment block in the address\n //! space of the process that the minidump file contains a snapshot of.\n //!\n //! The thread environment block contains thread-local data.\n //!\n //! A MINIDUMP_MEMORY_DESCRIPTOR may be present in the MINIDUMP_MEMORY_LIST\n //! stream containing the thread-local data pointed to by this field.\n uint64_t Teb;\n\n //! \\brief A snapshot of the thread’s stack.\n //!\n //! A MINIDUMP_MEMORY_DESCRIPTOR may be present in the MINIDUMP_MEMORY_LIST\n //! stream containing a pointer to the same memory range referenced by this\n //! field.\n MINIDUMP_MEMORY_DESCRIPTOR Stack;\n\n //! \\brief A pointer to a CPU-specific CONTEXT structure containing the\n //! thread’s context at the time the snapshot was taken.\n //!\n //! If the minidump file was generated as a result of an exception taken on\n //! this thread, this field may identify a different context than the\n //! exception context. For these minidump files, a MINIDUMP_EXCEPTION_STREAM\n //! stream will be present, and the context contained within that stream will\n //! be the exception context.\n //!\n //! The interpretation of the context structure is dependent on the CPU\n //! architecture identified by MINIDUMP_SYSTEM_INFO::ProcessorArchitecture.\n //! For crashpad::kMinidumpCPUArchitectureX86, this will be\n //! crashpad::MinidumpContextX86. For crashpad::kMinidumpCPUArchitectureAMD64,\n //! this will be crashpad::MinidumpContextAMD64.\n MINIDUMP_LOCATION_DESCRIPTOR ThreadContext;\n};\n\n//! \\brief Information about all threads within the process.\nstruct __attribute__((packed, aligned(4))) MINIDUMP_THREAD_LIST {\n //! \\brief The number of threads present in the #Threads array.\n uint32_t NumberOfThreads;\n\n //! \\brief Structures identifying each thread within the process.\n MINIDUMP_THREAD Threads[0];\n};\n\n//! \\brief Information about an exception that occurred in the process.\nstruct __attribute__((packed, aligned(4))) MINIDUMP_EXCEPTION {\n //! \\brief The top-level exception code identifying the exception, in\n //! operating system-specific values.\n //!\n //! For macOS minidumps, this will be an \\ref EXC_x \"EXC_*\" exception type,\n //! such as `EXC_BAD_ACCESS`. `EXC_CRASH` will not appear here for exceptions\n //! processed as `EXC_CRASH` when generated from another preceding exception:\n //! the original exception code will appear instead. The exception type as it\n //! was received will appear at index 0 of #ExceptionInformation.\n //!\n //! For Windows minidumps, this will be an `EXCEPTION_*` exception type, such\n //! as `EXCEPTION_ACCESS_VIOLATION`.\n //!\n //! \\note This field is named ExceptionCode, but what is known as the\n //! “exception code” on macOS/Mach is actually stored in the\n //! #ExceptionFlags field of a minidump file.\n //!\n //! \\todo Document the possible values by OS. There may be OS-specific enums\n //! in minidump_extensions.h.\n uint32_t ExceptionCode;\n\n //! \\brief Additional exception flags that further identify the exception, in\n //! operating system-specific values.\n //!\n //! For macOS minidumps, this will be the value of the exception code at index\n //! 0 as received by a Mach exception handler, except:\n //! * For exception type `EXC_CRASH` generated from another preceding\n //! exception, the original exception code will appear here, not the code\n //! as received by the Mach exception handler.\n //! * For exception types `EXC_RESOURCE` and `EXC_GUARD`, the high 32 bits of\n //! the code received by the Mach exception handler will appear here.\n //!\n //! In all cases for macOS minidumps, the code as it was received by the Mach\n //! exception handler will appear at index 1 of #ExceptionInformation.\n //!\n //! For Windows minidumps, this will either be `0` if the exception is\n //! continuable, or `EXCEPTION_NONCONTINUABLE` to indicate a noncontinuable\n //! exception.\n //!\n //! \\todo Document the possible values by OS. There may be OS-specific enums\n //! in minidump_extensions.h.\n uint32_t ExceptionFlags;\n\n //! \\brief An address, in the address space of the process that this minidump\n //! file contains a snapshot of, of another MINIDUMP_EXCEPTION. This field\n //! is used for nested exceptions.\n uint64_t ExceptionRecord;\n\n //! \\brief The address that caused the exception.\n //!\n //! This may be the address that caused a fault on data access, or it may be\n //! the instruction pointer that contained an offending instruction.\n uint64_t ExceptionAddress;\n\n //! \\brief The number of valid elements in #ExceptionInformation.\n uint32_t NumberParameters;\n\n uint32_t __unusedAlignment;\n\n //! \\brief Additional information about the exception, specific to the\n //! operating system and possibly the #ExceptionCode.\n //!\n //! For macOS minidumps, this will contain the exception type as received by a\n //! Mach exception handler and the values of the `codes[0]` and `codes[1]`\n //! (exception code and subcode) parameters supplied to the Mach exception\n //! handler. Unlike #ExceptionCode and #ExceptionFlags, the values received by\n //! a Mach exception handler are used directly here even for the `EXC_CRASH`,\n //! `EXC_RESOURCE`, and `EXC_GUARD` exception types.\n\n //! For Windows, these are additional arguments (if any) as provided to\n //! `RaiseException()`.\n uint64_t ExceptionInformation[EXCEPTION_MAXIMUM_PARAMETERS];\n};\n\n//! \\brief Information about the exception that triggered a minidump file’s\n//! generation.\nstruct __attribute__((packed, aligned(4))) MINIDUMP_EXCEPTION_STREAM {\n //! \\brief The ID of the thread that caused the exception.\n //!\n //! \\sa MINIDUMP_THREAD::ThreadId\n uint32_t ThreadId;\n\n uint32_t __alignment;\n\n //! \\brief Information about the exception.\n MINIDUMP_EXCEPTION ExceptionRecord;\n\n //! \\brief A pointer to a CPU-specific CONTEXT structure containing the\n //! thread’s context at the time the exception was caused.\n //!\n //! The interpretation of the context structure is dependent on the CPU\n //! architecture identified by MINIDUMP_SYSTEM_INFO::ProcessorArchitecture.\n //! For crashpad::kMinidumpCPUArchitectureX86, this will be\n //! crashpad::MinidumpContextX86. For crashpad::kMinidumpCPUArchitectureAMD64,\n //! this will be crashpad::MinidumpContextAMD64.\n MINIDUMP_LOCATION_DESCRIPTOR ThreadContext;\n};\n\n//! \\brief Information about a specific module loaded within the process at the\n//! time the snapshot was taken.\n//!\n//! A module may be the main executable, a shared library, or a loadable module.\n//!\n//! \\sa MINIDUMP_MODULE_LIST\nstruct __attribute__((packed, aligned(4))) MINIDUMP_MODULE {\n //! \\brief The base address of the loaded module in the address space of the\n //! process that the minidump file contains a snapshot of.\n uint64_t BaseOfImage;\n\n //! \\brief The size of the loaded module.\n uint32_t SizeOfImage;\n\n //! \\brief The loaded module’s checksum, or `0` if unknown.\n //!\n //! On Windows, this field comes from the `CheckSum` field of the module’s\n //! `IMAGE_OPTIONAL_HEADER` structure, if present. It reflects the checksum at\n //! the time the module was linked.\n uint32_t CheckSum;\n\n //! \\brief The module’s timestamp, in `time_t` units, seconds since the POSIX\n //! epoch, or `0` if unknown.\n //!\n //! On Windows, this field comes from the `TimeDateStamp` field of the\n //! module’s `IMAGE_FILE_HEADER` structure. It reflects the timestamp at the\n //! time the module was linked.\n uint32_t TimeDateStamp;\n\n //! \\brief ::RVA of a MINIDUMP_STRING containing the module’s path or file\n //! name.\n RVA ModuleNameRva;\n\n //! \\brief The module’s version information.\n VS_FIXEDFILEINFO VersionInfo;\n\n //! \\brief A pointer to the module’s CodeView record, typically a link to its\n //! debugging information in crashpad::CodeViewRecordPDB70 format.\n //!\n //! The specific format of the CodeView record is indicated by its signature,\n //! the first 32-bit value in the structure. For links to debugging\n //! information in contemporary usage, this is normally a\n //! crashpad::CodeViewRecordPDB70 structure, but may be a\n //! crashpad::CodeViewRecordPDB20 structure instead. These structures identify\n //! a link to debugging data within a `.pdb` (Program Database) file. See Matching\n //! Debug Information, PDB Files.\n //!\n //! On Windows, it is also possible for the CodeView record to contain\n //! debugging information itself, as opposed to a link to a `.pdb` file. See\n //! Microsoft\n //! Symbol and Type Information, section 7.2, “Debug Information Format”\n //! for a list of debug information formats, and Undocumented Windows 2000\n //! Secrets, Windows 2000 Debugging Support/Microsoft Symbol File\n //! Internals/CodeView Subsections for an in-depth description of the CodeView\n //! 4.1 format. Signatures seen in the wild include “NB09” (0x3930424e) for\n //! CodeView 4.1 and “NB11” (0x3131424e) for CodeView 5.0. This form of\n //! debugging information within the module, as opposed to a link to an\n //! external `.pdb` file, is chosen by building with `/Z7` in Visual Studio\n //! 6.0 (1998) and earlier. This embedded form of debugging information is now\n //! considered obsolete.\n //!\n //! On Windows, the CodeView record is taken from a module’s\n //! IMAGE_DEBUG_DIRECTORY entry whose Type field has the value\n //! IMAGE_DEBUG_TYPE_CODEVIEW (`2`), if any. Records in\n //! crashpad::CodeViewRecordPDB70 format are generated by Visual Studio .NET\n //! (2002) (version 7.0) and later.\n //!\n //! When the CodeView record is not present, the fields of this\n //! MINIDUMP_LOCATION_DESCRIPTOR will be `0`.\n MINIDUMP_LOCATION_DESCRIPTOR CvRecord;\n\n //! \\brief A pointer to the module’s miscellaneous debugging record, a\n //! structure of type IMAGE_DEBUG_MISC.\n //!\n //! This field is Windows-specific, and has no meaning on other operating\n //! systems. It is largely obsolete on Windows, where it was used to link to\n //! debugging information stored in a `.dbg` file. `.dbg` files have been\n //! superseded by `.pdb` files.\n //!\n //! On Windows, the miscellaneous debugging record is taken from module’s\n //! IMAGE_DEBUG_DIRECTORY entry whose Type field has the value\n //! IMAGE_DEBUG_TYPE_MISC (`4`), if any.\n //!\n //! When the miscellaneous debugging record is not present, the fields of this\n //! MINIDUMP_LOCATION_DESCRIPTOR will be `0`.\n //!\n //! \\sa #CvRecord\n MINIDUMP_LOCATION_DESCRIPTOR MiscRecord;\n\n uint64_t Reserved0;\n uint64_t Reserved1;\n};\n\n//! \\brief Information about all modules loaded within the process at the time\n//! the snapshot was taken.\nstruct __attribute__((packed, aligned(4))) MINIDUMP_MODULE_LIST {\n //! \\brief The number of modules present in the #Modules array.\n uint32_t NumberOfModules;\n\n //! \\brief Structures identifying each module present in the minidump file.\n MINIDUMP_MODULE Modules[0];\n};\n\n//! \\brief Information about memory regions within the process.\n//!\n//! Typically, a minidump file will not contain a snapshot of a process’ entire\n//! memory image. For minidump files identified as ::MiniDumpNormal in\n//! MINIDUMP_HEADER::Flags, memory regions are limited to those referenced by\n//! MINIDUMP_THREAD::Stack fields, and a small number of others possibly related\n//! to the exception that triggered the snapshot to be taken.\nstruct __attribute__((packed, aligned(4))) MINIDUMP_MEMORY_LIST {\n //! \\brief The number of memory regions present in the #MemoryRanges array.\n uint32_t NumberOfMemoryRanges;\n\n //! \\brief Structures identifying each memory region present in the minidump\n //! file.\n MINIDUMP_MEMORY_DESCRIPTOR MemoryRanges[0];\n};\n\n//! \\brief Contains the state of an individual system handle at the time the\n//! snapshot was taken. This structure is Windows-specific.\n//!\n//! \\sa MINIDUMP_HANDLE_DESCRIPTOR_2\nstruct __attribute__((packed, aligned(4))) MINIDUMP_HANDLE_DESCRIPTOR {\n //! \\brief The Windows `HANDLE` value.\n uint64_t Handle;\n\n //! \\brief An RVA to a MINIDUMP_STRING structure that specifies the object\n //! type of the handle. This member can be zero.\n RVA TypeNameRva;\n\n //! \\brief An RVA to a MINIDUMP_STRING structure that specifies the object\n //! name of the handle. This member can be zero.\n RVA ObjectNameRva;\n\n //! \\brief The attributes for the handle, this corresponds to `OBJ_INHERIT`,\n //! `OBJ_CASE_INSENSITIVE`, etc.\n uint32_t Attributes;\n\n //! \\brief The `ACCESS_MASK` for the handle.\n uint32_t GrantedAccess;\n\n //! \\brief This is the number of open handles to the object that this handle\n //! refers to.\n uint32_t HandleCount;\n\n //! \\brief This is the number kernel references to the object that this\n //! handle refers to.\n uint32_t PointerCount;\n};\n\n//! \\brief Contains the state of an individual system handle at the time the\n//! snapshot was taken. This structure is Windows-specific.\n//!\n//! \\sa MINIDUMP_HANDLE_DESCRIPTOR\nstruct __attribute__((packed, aligned(4))) MINIDUMP_HANDLE_DESCRIPTOR_2\n : public MINIDUMP_HANDLE_DESCRIPTOR {\n //! \\brief An RVA to a MINIDUMP_HANDLE_OBJECT_INFORMATION structure that\n //! specifies object-specific information. This member can be zero if\n //! there is no extra information.\n RVA ObjectInfoRva;\n\n //! \\brief Must be zero.\n uint32_t Reserved0;\n};\n\n//! \\brief Represents the header for a handle data stream.\n//!\n//! A list of MINIDUMP_HANDLE_DESCRIPTOR or MINIDUMP_HANDLE_DESCRIPTOR_2\n//! structures will immediately follow in the stream.\nstruct __attribute((packed, aligned(4))) MINIDUMP_HANDLE_DATA_STREAM {\n //! \\brief The size of the header information for the stream, in bytes. This\n //! value is `sizeof(MINIDUMP_HANDLE_DATA_STREAM)`.\n uint32_t SizeOfHeader;\n\n //! \\brief The size of a descriptor in the stream, in bytes. This value is\n //! `sizeof(MINIDUMP_HANDLE_DESCRIPTOR)` or\n //! `sizeof(MINIDUMP_HANDLE_DESCRIPTOR_2)`.\n uint32_t SizeOfDescriptor;\n\n //! \\brief The number of descriptors in the stream.\n uint32_t NumberOfDescriptors;\n\n //! \\brief Must be zero.\n uint32_t Reserved;\n};\n\n//! \\brief Information about a specific module that was recorded as being\n//! unloaded at the time the snapshot was taken.\n//!\n//! An unloaded module may be a shared library or a loadable module.\n//!\n//! \\sa MINIDUMP_UNLOADED_MODULE_LIST\nstruct __attribute__((packed, aligned(4))) MINIDUMP_UNLOADED_MODULE {\n //! \\brief The base address where the module was loaded in the address space\n //! of the process that the minidump file contains a snapshot of.\n uint64_t BaseOfImage;\n\n //! \\brief The size of the unloaded module.\n uint32_t SizeOfImage;\n\n //! \\brief The module’s checksum, or `0` if unknown.\n //!\n //! On Windows, this field comes from the `CheckSum` field of the module’s\n //! `IMAGE_OPTIONAL_HEADER` structure, if present. It reflects the checksum at\n //! the time the module was linked.\n uint32_t CheckSum;\n\n //! \\brief The module’s timestamp, in `time_t` units, seconds since the POSIX\n //! epoch, or `0` if unknown.\n //!\n //! On Windows, this field comes from the `TimeDateStamp` field of the\n //! module’s `IMAGE_FILE_HEADER` structure. It reflects the timestamp at the\n //! time the module was linked.\n uint32_t TimeDateStamp;\n\n //! \\brief ::RVA of a MINIDUMP_STRING containing the module’s path or file\n //! name.\n RVA ModuleNameRva;\n};\n\n//! \\brief Information about all modules recorded as unloaded when the snapshot\n//! was taken.\n//!\n//! A list of MINIDUMP_UNLOADED_MODULE structures will immediately follow in the\n//! stream.\nstruct __attribute__((packed, aligned(4))) MINIDUMP_UNLOADED_MODULE_LIST {\n //! \\brief The size of the header information for the stream, in bytes. This\n //! value is `sizeof(MINIDUMP_UNLOADED_MODULE_LIST)`.\n uint32_t SizeOfHeader;\n\n //! \\brief The size of a descriptor in the stream, in bytes. This value is\n //! `sizeof(MINIDUMP_UNLOADED_MODULE)`.\n uint32_t SizeOfEntry;\n\n //! \\brief The number of entries in the stream.\n uint32_t NumberOfEntries;\n};\n\n//! \\brief Information about XSAVE-managed state stored within CPU-specific\n//! context structures.\nstruct __attribute__((packed, aligned(4))) XSTATE_CONFIG_FEATURE_MSC_INFO {\n //! \\brief The size of this structure, in bytes. This value is\n //! `sizeof(XSTATE_CONFIG_FEATURE_MSC_INFO)`.\n uint32_t SizeOfInfo;\n\n //! \\brief The size of a CPU-specific context structure carrying all XSAVE\n //! state components described by this structure.\n //!\n //! Equivalent to the value returned by `InitializeContext()` in \\a\n //! ContextLength.\n uint32_t ContextSize;\n\n //! \\brief The XSAVE state-component bitmap, XSAVE_BV.\n //!\n //! See Intel Software Developer’s Manual, Volume 1: Basic Architecture\n //! (253665-060), 13.4.2 “XSAVE Header”.\n uint64_t EnabledFeatures;\n\n //! \\brief The location of each state component within a CPU-specific context\n //! structure.\n //!\n //! This array is indexed by bit position numbers used in #EnabledFeatures.\n XSTATE_FEATURE Features[MAXIMUM_XSTATE_FEATURES];\n};\n\n//! \\anchor MINIDUMP_MISCx\n//! \\name MINIDUMP_MISC*\n//!\n//! \\brief Field validity flag values for MINIDUMP_MISC_INFO::Flags1.\n//! \\{\n\n//! \\brief MINIDUMP_MISC_INFO::ProcessId is valid.\n#define MINIDUMP_MISC1_PROCESS_ID 0x00000001\n\n//! \\brief The time-related fields in MINIDUMP_MISC_INFO are valid.\n//!\n//! The following fields are valid:\n//! - MINIDUMP_MISC_INFO::ProcessCreateTime\n//! - MINIDUMP_MISC_INFO::ProcessUserTime\n//! - MINIDUMP_MISC_INFO::ProcessKernelTime\n#define MINIDUMP_MISC1_PROCESS_TIMES 0x00000002\n\n//! \\brief The CPU-related fields in MINIDUMP_MISC_INFO_2 are valid.\n//!\n//! The following fields are valid:\n//! - MINIDUMP_MISC_INFO_2::ProcessorMaxMhz\n//! - MINIDUMP_MISC_INFO_2::ProcessorCurrentMhz\n//! - MINIDUMP_MISC_INFO_2::ProcessorMhzLimit\n//! - MINIDUMP_MISC_INFO_2::ProcessorMaxIdleState\n//! - MINIDUMP_MISC_INFO_2::ProcessorCurrentIdleState\n//!\n//! \\note This macro should likely have been named\n//! MINIDUMP_MISC2_PROCESSOR_POWER_INFO.\n#define MINIDUMP_MISC1_PROCESSOR_POWER_INFO 0x00000004\n\n//! \\brief MINIDUMP_MISC_INFO_3::ProcessIntegrityLevel is valid.\n#define MINIDUMP_MISC3_PROCESS_INTEGRITY 0x00000010\n\n//! \\brief MINIDUMP_MISC_INFO_3::ProcessExecuteFlags is valid.\n#define MINIDUMP_MISC3_PROCESS_EXECUTE_FLAGS 0x00000020\n\n//! \\brief The time zone-related fields in MINIDUMP_MISC_INFO_3 are valid.\n//!\n//! The following fields are valid:\n//! - MINIDUMP_MISC_INFO_3::TimeZoneId\n//! - MINIDUMP_MISC_INFO_3::TimeZone\n#define MINIDUMP_MISC3_TIMEZONE 0x00000040\n\n//! \\brief MINIDUMP_MISC_INFO_3::ProtectedProcess is valid.\n#define MINIDUMP_MISC3_PROTECTED_PROCESS 0x00000080\n\n//! \\brief The build string-related fields in MINIDUMP_MISC_INFO_4 are valid.\n//!\n//! The following fields are valid:\n//! - MINIDUMP_MISC_INFO_4::BuildString\n//! - MINIDUMP_MISC_INFO_4::DbgBldStr\n#define MINIDUMP_MISC4_BUILDSTRING 0x00000100\n\n//! \\brief MINIDUMP_MISC_INFO_5::ProcessCookie is valid.\n#define MINIDUMP_MISC5_PROCESS_COOKIE 0x00000200\n\n//! \\}\n\n//! \\brief Information about the process that the minidump file contains a\n//! snapshot of, as well as the system that hosted that process.\n//!\n//! \\sa \\ref MINIDUMP_MISCx \"MINIDUMP_MISC*\"\n//! \\sa MINIDUMP_MISC_INFO_2\n//! \\sa MINIDUMP_MISC_INFO_3\n//! \\sa MINIDUMP_MISC_INFO_4\n//! \\sa MINIDUMP_MISC_INFO_5\n//! \\sa MINIDUMP_MISC_INFO_N\nstruct __attribute__((packed, aligned(4))) MINIDUMP_MISC_INFO {\n //! \\brief The size of the structure.\n //!\n //! This field can be used to distinguish between different versions of this\n //! structure: MINIDUMP_MISC_INFO, MINIDUMP_MISC_INFO_2, MINIDUMP_MISC_INFO_3,\n //! and MINIDUMP_MISC_INFO_4.\n //!\n //! \\sa Flags1\n uint32_t SizeOfInfo;\n\n //! \\brief A bit field of \\ref MINIDUMP_MISCx \"MINIDUMP_MISC*\" values\n //! indicating which fields of this structure contain valid data.\n uint32_t Flags1;\n\n //! \\brief The process ID of the process.\n uint32_t ProcessId;\n\n //! \\brief The time that the process started, in `time_t` units, seconds since\n //! the POSIX epoch.\n uint32_t ProcessCreateTime;\n\n //! \\brief The amount of user-mode CPU time used by the process, in seconds,\n //! at the time of the snapshot.\n uint32_t ProcessUserTime;\n\n //! \\brief The amount of system-mode (kernel) CPU time used by the process, in\n //! seconds, at the time of the snapshot.\n uint32_t ProcessKernelTime;\n};\n\n//! \\brief Information about the process that the minidump file contains a\n//! snapshot of, as well as the system that hosted that process.\n//!\n//! This structure variant is used on Windows Vista (NT 6.0) and later.\n//!\n//! \\sa \\ref MINIDUMP_MISCx \"MINIDUMP_MISC*\"\n//! \\sa MINIDUMP_MISC_INFO\n//! \\sa MINIDUMP_MISC_INFO_3\n//! \\sa MINIDUMP_MISC_INFO_4\n//! \\sa MINIDUMP_MISC_INFO_5\n//! \\sa MINIDUMP_MISC_INFO_N\nstruct __attribute__((packed, aligned(4))) MINIDUMP_MISC_INFO_2\n : public MINIDUMP_MISC_INFO {\n //! \\brief The maximum clock rate of the system’s CPU or CPUs, in MHz.\n uint32_t ProcessorMaxMhz;\n\n //! \\brief The clock rate of the system’s CPU or CPUs, in MHz, at the time of\n //! the snapshot.\n uint32_t ProcessorCurrentMhz;\n\n //! \\brief The maximum clock rate of the system’s CPU or CPUs, in MHz, reduced\n //! by any thermal limitations, at the time of the snapshot.\n uint32_t ProcessorMhzLimit;\n\n //! \\brief The maximum idle state of the system’s CPU or CPUs.\n uint32_t ProcessorMaxIdleState;\n\n //! \\brief The idle state of the system’s CPU or CPUs at the time of the\n //! snapshot.\n uint32_t ProcessorCurrentIdleState;\n};\n\n//! \\brief Information about the process that the minidump file contains a\n//! snapshot of, as well as the system that hosted that process.\n//!\n//! This structure variant is used on Windows 7 (NT 6.1) and later.\n//!\n//! \\sa \\ref MINIDUMP_MISCx \"MINIDUMP_MISC*\"\n//! \\sa MINIDUMP_MISC_INFO\n//! \\sa MINIDUMP_MISC_INFO_2\n//! \\sa MINIDUMP_MISC_INFO_4\n//! \\sa MINIDUMP_MISC_INFO_5\n//! \\sa MINIDUMP_MISC_INFO_N\nstruct __attribute__((packed, aligned(4))) MINIDUMP_MISC_INFO_3\n : public MINIDUMP_MISC_INFO_2 {\n //! \\brief The process’ integrity level.\n //!\n //! Windows typically uses `SECURITY_MANDATORY_MEDIUM_RID` (0x2000) for\n //! processes belonging to normal authenticated users and\n //! `SECURITY_MANDATORY_HIGH_RID` (0x3000) for elevated processes.\n //!\n //! This field is Windows-specific, and has no meaning on other operating\n //! systems.\n uint32_t ProcessIntegrityLevel;\n\n //! \\brief The process’ execute flags.\n //!\n //! On Windows, this appears to be returned by `NtQueryInformationProcess()`\n //! with an argument of `ProcessExecuteFlags` (34).\n //!\n //! This field is Windows-specific, and has no meaning on other operating\n //! systems.\n uint32_t ProcessExecuteFlags;\n\n //! \\brief Whether the process is protected.\n //!\n //! This field is Windows-specific, and has no meaning on other operating\n //! systems.\n uint32_t ProtectedProcess;\n\n //! \\brief Whether daylight saving time was being observed in the system’s\n //! location at the time of the snapshot.\n //!\n //! This field can contain the following values:\n //! - `0` if the location does not observe daylight saving time at all. The\n //! TIME_ZONE_INFORMATION::StandardName field of #TimeZoneId contains the\n //! time zone name.\n //! - `1` if the location observes daylight saving time, but standard time\n //! was in effect at the time of the snapshot. The\n //! TIME_ZONE_INFORMATION::StandardName field of #TimeZoneId contains the\n //! time zone name.\n //! - `2` if the location observes daylight saving time, and it was in effect\n //! at the time of the snapshot. The TIME_ZONE_INFORMATION::DaylightName\n //! field of #TimeZoneId contains the time zone name.\n //!\n //! \\sa #TimeZone\n uint32_t TimeZoneId;\n\n //! \\brief Information about the time zone at the system’s location.\n //!\n //! \\sa #TimeZoneId\n TIME_ZONE_INFORMATION TimeZone;\n};\n\n//! \\brief Information about the process that the minidump file contains a\n//! snapshot of, as well as the system that hosted that process.\n//!\n//! This structure variant is used on Windows 8 (NT 6.2) and later.\n//!\n//! \\sa \\ref MINIDUMP_MISCx \"MINIDUMP_MISC*\"\n//! \\sa MINIDUMP_MISC_INFO\n//! \\sa MINIDUMP_MISC_INFO_2\n//! \\sa MINIDUMP_MISC_INFO_3\n//! \\sa MINIDUMP_MISC_INFO_5\n//! \\sa MINIDUMP_MISC_INFO_N\nstruct __attribute__((packed, aligned(4))) MINIDUMP_MISC_INFO_4\n : public MINIDUMP_MISC_INFO_3 {\n //! \\brief The operating system’s “build string”, a string identifying a\n //! specific build of the operating system.\n //!\n //! This string is UTF-16-encoded and terminated by a UTF-16 `NUL` code unit.\n //!\n //! On Windows 8.1 (NT 6.3), this is “6.3.9600.17031\n //! (winblue_gdr.140221-1952)”.\n char16_t BuildString[260];\n\n //! \\brief The minidump producer’s “build string”, a string identifying the\n //! module that produced a minidump file.\n //!\n //! This string is UTF-16-encoded and terminated by a UTF-16 `NUL` code unit.\n //!\n //! On Windows 8.1 (NT 6.3), this may be “dbghelp.i386,6.3.9600.16520” or\n //! “dbghelp.amd64,6.3.9600.16520” depending on CPU architecture.\n char16_t DbgBldStr[40];\n};\n\n//! \\brief Information about the process that the minidump file contains a\n//! snapshot of, as well as the system that hosted that process.\n//!\n//! This structure variant is used on Windows 10 and later.\n//!\n//! \\sa \\ref MINIDUMP_MISCx \"MINIDUMP_MISC*\"\n//! \\sa MINIDUMP_MISC_INFO\n//! \\sa MINIDUMP_MISC_INFO_2\n//! \\sa MINIDUMP_MISC_INFO_3\n//! \\sa MINIDUMP_MISC_INFO_4\n//! \\sa MINIDUMP_MISC_INFO_N\nstruct __attribute__((packed, aligned(4))) MINIDUMP_MISC_INFO_5\n : public MINIDUMP_MISC_INFO_4 {\n //! \\brief Information about XSAVE-managed state stored within CPU-specific\n //! context structures.\n //!\n //! This information can be used to locate state components within\n //! CPU-specific context structures.\n XSTATE_CONFIG_FEATURE_MSC_INFO XStateData;\n\n uint32_t ProcessCookie;\n};\n\n//! \\brief The latest known version of the MINIDUMP_MISC_INFO structure.\ntypedef MINIDUMP_MISC_INFO_5 MINIDUMP_MISC_INFO_N;\n\n//! \\brief Describes a region of memory.\nstruct __attribute__((packed, aligned(4))) MINIDUMP_MEMORY_INFO {\n //! \\brief The base address of the region of pages.\n uint64_t BaseAddress;\n\n //! \\brief The base address of a range of pages in this region. The page is\n //! contained within this memory region.\n uint64_t AllocationBase;\n\n //! \\brief The memory protection when the region was initially allocated. This\n //! member can be one of the memory protection options (such as\n //! \\ref PAGE_x \"PAGE_EXECUTE\", \\ref PAGE_x \"PAGE_NOACCESS\", etc.), along\n //! with \\ref PAGE_x \"PAGE_GUARD\" or \\ref PAGE_x \"PAGE_NOCACHE\", as\n //! needed.\n uint32_t AllocationProtect;\n\n uint32_t __alignment1;\n\n //! \\brief The size of the region beginning at the base address in which all\n //! pages have identical attributes, in bytes.\n uint64_t RegionSize;\n\n //! \\brief The state of the pages in the region. This can be one of\n //! \\ref MEM_x \"MEM_COMMIT\", \\ref MEM_x \"MEM_FREE\", or \\ref MEM_x\n //! \"MEM_RESERVE\".\n uint32_t State;\n\n //! \\brief The access protection of the pages in the region. This member is\n //! one of the values listed for the #AllocationProtect member.\n uint32_t Protect;\n\n //! \\brief The type of pages in the region. This can be one of \\ref MEM_x\n //! \"MEM_IMAGE\", \\ref MEM_x \"MEM_MAPPED\", or \\ref MEM_x \"MEM_PRIVATE\".\n uint32_t Type;\n\n uint32_t __alignment2;\n};\n\n//! \\brief Contains a list of memory regions.\nstruct __attribute__((packed, aligned(4))) MINIDUMP_MEMORY_INFO_LIST {\n //! \\brief The size of the header data for the stream, in bytes. This is\n //! generally sizeof(MINIDUMP_MEMORY_INFO_LIST).\n uint32_t SizeOfHeader;\n\n //! \\brief The size of each entry following the header, in bytes. This is\n //! generally sizeof(MINIDUMP_MEMORY_INFO).\n uint32_t SizeOfEntry;\n\n //! \\brief The number of entries in the stream. These are generally\n //! MINIDUMP_MEMORY_INFO structures. The entries follow the header.\n uint64_t NumberOfEntries;\n};\n\n//! \\brief Contains the name of the thread with the given thread ID.\nstruct __attribute__((packed, aligned(4))) MINIDUMP_THREAD_NAME {\n //! \\brief The identifier of the thread.\n uint32_t ThreadId;\n\n //! \\brief RVA64 of a MINIDUMP_STRING containing the name of the thread.\n RVA64 RvaOfThreadName;\n};\n\n//! \\brief Variable-sized struct which contains a list of MINIDUMP_THREAD_NAME\n//! structs.\nstruct __attribute__((packed, aligned(4))) MINIDUMP_THREAD_NAME_LIST {\n //! \\brief The number of MINIDUMP_THREAD_NAME structs following this field.\n uint32_t NumberOfThreadNames;\n\n //! \\brief A variably-sized array containing zero or more\n //! MINIDUMP_THREAD_NAME structs. The length of the array is indicated by\n //! the NumberOfThreadNames field in this struct.\n struct MINIDUMP_THREAD_NAME ThreadNames[0];\n};\n\n//! \\brief Minidump file type values for MINIDUMP_HEADER::Flags. These bits\n//! describe the types of data carried within a minidump file.\nenum MINIDUMP_TYPE {\n //! \\brief A minidump file without any additional data.\n //!\n //! This type of minidump file contains:\n //! - A MINIDUMP_SYSTEM_INFO stream.\n //! - A MINIDUMP_MISC_INFO, MINIDUMP_MISC_INFO_2, MINIDUMP_MISC_INFO_3, or\n //! MINIDUMP_MISC_INFO_4 stream, depending on which fields are present.\n //! - A MINIDUMP_THREAD_LIST stream. All threads are present, along with a\n //! snapshot of each thread’s stack memory sufficient to obtain backtraces.\n //! - If the minidump file was generated as a result of an exception, a\n //! MINIDUMP_EXCEPTION_STREAM describing the exception.\n //! - A MINIDUMP_MODULE_LIST stream. All loaded modules are present.\n //! - Typically, a MINIDUMP_MEMORY_LIST stream containing duplicate pointers\n //! to the stack memory regions also referenced by the MINIDUMP_THREAD_LIST\n //! stream. This type of minidump file also includes a\n //! MINIDUMP_MEMORY_DESCRIPTOR containing the 256 bytes centered around\n //! the exception address or the instruction pointer.\n MiniDumpNormal = 0x00000000,\n\n //! \\brief A minidump with extended contexts.\n //!\n //! Contains Normal plus a MISC_INFO_5 structure describing the contexts.\n MiniDumpWithAvxXStateContext = 0x00200000,\n};\n\n#endif // CRASHPAD_COMPAT_NON_WIN_DBGHELP_H_\n" }, { "path": "compat/non_win/minwinbase.h", "content": "// Copyright 2014 The Crashpad Authors\n//\n// Licensed under the Apache License, Version 2.0 (the \"License\");\n// you may not use this file except in compliance with the License.\n// You may obtain a copy of the License at\n//\n// http://www.apache.org/licenses/LICENSE-2.0\n//\n// Unless required by applicable law or agreed to in writing, software\n// distributed under the License is distributed on an \"AS IS\" BASIS,\n// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n// See the License for the specific language governing permissions and\n// limitations under the License.\n\n#ifndef CRASHPAD_COMPAT_NON_WIN_MINWINBASE_H_\n#define CRASHPAD_COMPAT_NON_WIN_MINWINBASE_H_\n\n#include \n\n//! \\brief Represents a date and time.\nstruct SYSTEMTIME {\n //! \\brief The year, represented fully.\n //!\n //! The year 2014 would be represented in this field as `2014`.\n uint16_t wYear;\n\n //! \\brief The month of the year, `1` for January and `12` for December.\n uint16_t wMonth;\n\n //! \\brief The day of the week, `0` for Sunday and `6` for Saturday.\n uint16_t wDayOfWeek;\n\n //! \\brief The day of the month, `1` through `31`.\n uint16_t wDay;\n\n //! \\brief The hour of the day, `0` through `23`.\n uint16_t wHour;\n\n //! \\brief The minute of the hour, `0` through `59`.\n uint16_t wMinute;\n\n //! \\brief The second of the minute, `0` through `60`.\n uint16_t wSecond;\n\n //! \\brief The millisecond of the second, `0` through `999`.\n uint16_t wMilliseconds;\n};\n\n#endif // CRASHPAD_COMPAT_NON_WIN_MINWINBASE_H_\n" }, { "path": "compat/non_win/timezoneapi.h", "content": "// Copyright 2014 The Crashpad Authors\n//\n// Licensed under the Apache License, Version 2.0 (the \"License\");\n// you may not use this file except in compliance with the License.\n// You may obtain a copy of the License at\n//\n// http://www.apache.org/licenses/LICENSE-2.0\n//\n// Unless required by applicable law or agreed to in writing, software\n// distributed under the License is distributed on an \"AS IS\" BASIS,\n// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n// See the License for the specific language governing permissions and\n// limitations under the License.\n\n#ifndef CRASHPAD_COMPAT_NON_WIN_TIMEZONEAPI_H_\n#define CRASHPAD_COMPAT_NON_WIN_TIMEZONEAPI_H_\n\n#include \n\n#include \"compat/non_win/minwinbase.h\"\n\n//! \\brief Information about a time zone and its daylight saving rules.\nstruct TIME_ZONE_INFORMATION {\n //! \\brief The number of minutes west of UTC.\n int32_t Bias;\n\n //! \\brief The UTF-16-encoded name of the time zone when observing standard\n //! time.\n char16_t StandardName[32];\n\n //! \\brief The date and time to switch from daylight saving time to standard\n //! time.\n //!\n //! This can be a specific time, or with SYSTEMTIME::wYear set to `0`, it can\n //! reflect an annual recurring transition. In that case, SYSTEMTIME::wDay in\n //! the range `1` to `5` is interpreted as the given occurrence of\n //! SYSTEMTIME::wDayOfWeek within the month, `1` being the first occurrence\n //! and `5` being the last (even if there are fewer than 5).\n SYSTEMTIME StandardDate;\n\n //! \\brief The bias relative to #Bias to be applied when observing standard\n //! time.\n int32_t StandardBias;\n\n //! \\brief The UTF-16-encoded name of the time zone when observing daylight\n //! saving time.\n char16_t DaylightName[32];\n\n //! \\brief The date and time to switch from standard time to daylight saving\n //! time.\n //!\n //! This field is specified in the same manner as #StandardDate.\n SYSTEMTIME DaylightDate;\n\n //! \\brief The bias relative to #Bias to be applied when observing daylight\n //! saving time.\n int32_t DaylightBias;\n};\n\n#endif // CRASHPAD_COMPAT_NON_WIN_TIMEZONEAPI_H_\n" }, { "path": "compat/non_win/verrsrc.h", "content": "// Copyright 2014 The Crashpad Authors\n//\n// Licensed under the Apache License, Version 2.0 (the \"License\");\n// you may not use this file except in compliance with the License.\n// You may obtain a copy of the License at\n//\n// http://www.apache.org/licenses/LICENSE-2.0\n//\n// Unless required by applicable law or agreed to in writing, software\n// distributed under the License is distributed on an \"AS IS\" BASIS,\n// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n// See the License for the specific language governing permissions and\n// limitations under the License.\n\n#ifndef CRASHPAD_COMPAT_NON_WIN_VERRSRC_H_\n#define CRASHPAD_COMPAT_NON_WIN_VERRSRC_H_\n\n#include \n\n//! \\file\n\n//! \\brief The magic number for a VS_FIXEDFILEINFO structure, stored in\n//! VS_FIXEDFILEINFO::dwSignature.\n#define VS_FFI_SIGNATURE 0xfeef04bd\n\n//! \\brief The version of a VS_FIXEDFILEINFO structure, stored in\n//! VS_FIXEDFILEINFO::dwStrucVersion.\n#define VS_FFI_STRUCVERSION 0x00010000\n\n//! \\anchor VS_FF_x\n//! \\name VS_FF_*\n//!\n//! \\brief File attribute values for VS_FIXEDFILEINFO::dwFileFlags and\n//! VS_FIXEDFILEINFO::dwFileFlagsMask.\n//! \\{\n#define VS_FF_DEBUG 0x00000001\n#define VS_FF_PRERELEASE 0x00000002\n#define VS_FF_PATCHED 0x00000004\n#define VS_FF_PRIVATEBUILD 0x00000008\n#define VS_FF_INFOINFERRED 0x00000010\n#define VS_FF_SPECIALBUILD 0x00000020\n//! \\}\n\n//! \\anchor VOS_x\n//! \\name VOS_*\n//!\n//! \\brief Operating system values for VS_FIXEDFILEINFO::dwFileOS.\n//! \\{\n#define VOS_UNKNOWN 0x00000000\n#define VOS_DOS 0x00010000\n#define VOS_OS216 0x00020000\n#define VOS_OS232 0x00030000\n#define VOS_NT 0x00040000\n#define VOS_WINCE 0x00050000\n#define VOS__BASE 0x00000000\n#define VOS__WINDOWS16 0x00000001\n#define VOS__PM16 0x00000002\n#define VOS__PM32 0x00000003\n#define VOS__WINDOWS32 0x00000004\n#define VOS_DOS_WINDOWS16 0x00010001\n#define VOS_DOS_WINDOWS32 0x00010004\n#define VOS_OS216_PM16 0x00020002\n#define VOS_OS232_PM32 0x00030003\n#define VOS_NT_WINDOWS32 0x00040004\n//! \\}\n\n//! \\anchor VFT_x\n//! \\name VFT_*\n//!\n//! \\brief File type values for VS_FIXEDFILEINFO::dwFileType.\n//! \\{\n#define VFT_UNKNOWN 0x00000000\n#define VFT_APP 0x00000001\n#define VFT_DLL 0x00000002\n#define VFT_DRV 0x00000003\n#define VFT_FONT 0x00000004\n#define VFT_VXD 0x00000005\n#define VFT_STATIC_LIB 0x00000007\n//! \\}\n\n//! \\anchor VFT2_x\n//! \\name VFT2_*\n//!\n//! \\brief File subtype values for VS_FIXEDFILEINFO::dwFileSubtype.\n//! \\{\n#define VFT2_UNKNOWN 0x00000000\n#define VFT2_DRV_PRINTER 0x00000001\n#define VFT2_DRV_KEYBOARD 0x00000002\n#define VFT2_DRV_LANGUAGE 0x00000003\n#define VFT2_DRV_DISPLAY 0x00000004\n#define VFT2_DRV_MOUSE 0x00000005\n#define VFT2_DRV_NETWORK 0x00000006\n#define VFT2_DRV_SYSTEM 0x00000007\n#define VFT2_DRV_INSTALLABLE 0x00000008\n#define VFT2_DRV_SOUND 0x00000009\n#define VFT2_DRV_COMM 0x0000000A\n#define VFT2_DRV_INPUTMETHOD 0x0000000B\n#define VFT2_DRV_VERSIONED_PRINTER 0x0000000C\n#define VFT2_FONT_RASTER 0x00000001\n#define VFT2_FONT_VECTOR 0x00000002\n#define VFT2_FONT_TRUETYPE 0x00000003\n//! \\}\n\n//! \\brief Version information for a file.\n//!\n//! On Windows, this information is derived from a file’s version information\n//! resource, and is obtained by calling `VerQueryValue()` with an `lpSubBlock`\n//! argument of `\"\\\"` (a single backslash).\nstruct VS_FIXEDFILEINFO {\n //! \\brief The structure’s magic number, ::VS_FFI_SIGNATURE.\n uint32_t dwSignature;\n\n //! \\brief The structure’s version, ::VS_FFI_STRUCVERSION.\n uint32_t dwStrucVersion;\n\n //! \\brief The more-significant portion of the file’s version number.\n //!\n //! This field contains the first two components of a four-component version\n //! number. For a file whose version is 1.2.3.4, this field would be\n //! `0x00010002`.\n //!\n //! \\sa dwFileVersionLS\n uint32_t dwFileVersionMS;\n\n //! \\brief The less-significant portion of the file’s version number.\n //!\n //! This field contains the last two components of a four-component version\n //! number. For a file whose version is 1.2.3.4, this field would be\n //! `0x00030004`.\n //!\n //! \\sa dwFileVersionMS\n uint32_t dwFileVersionLS;\n\n //! \\brief The more-significant portion of the product’s version number.\n //!\n //! This field contains the first two components of a four-component version\n //! number. For a product whose version is 1.2.3.4, this field would be\n //! `0x00010002`.\n //!\n //! \\sa dwProductVersionLS\n uint32_t dwProductVersionMS;\n\n //! \\brief The less-significant portion of the product’s version number.\n //!\n //! This field contains the last two components of a four-component version\n //! number. For a product whose version is 1.2.3.4, this field would be\n //! `0x00030004`.\n //!\n //! \\sa dwProductVersionMS\n uint32_t dwProductVersionLS;\n\n //! \\brief A bitmask of \\ref VS_FF_x \"VS_FF_*\" values indicating which bits in\n //! #dwFileFlags are valid.\n uint32_t dwFileFlagsMask;\n\n //! \\brief A bitmask of \\ref VS_FF_x \"VS_FF_*\" values identifying attributes\n //! of the file. Only bits present in #dwFileFlagsMask are valid.\n uint32_t dwFileFlags;\n\n //! \\brief The file’s intended operating system, a value of \\ref VOS_x\n //! \"VOS_*\".\n uint32_t dwFileOS;\n\n //! \\brief The file’s type, a value of \\ref VFT_x \"VFT_*\".\n uint32_t dwFileType;\n\n //! \\brief The file’s subtype, a value of \\ref VFT2_x \"VFT2_*\" corresponding\n //! to its #dwFileType, if the file type has subtypes.\n uint32_t dwFileSubtype;\n\n //! \\brief The more-significant portion of the file’s creation date.\n //!\n //! The intended encoding of this field is unknown. This field is unused and\n //! always has the value `0`.\n uint32_t dwFileDateMS;\n\n //! \\brief The less-significant portion of the file’s creation date.\n //!\n //! The intended encoding of this field is unknown. This field is unused and\n //! always has the value `0`.\n uint32_t dwFileDateLS;\n};\n\n#endif // CRASHPAD_COMPAT_NON_WIN_VERRSRC_H_\n" }, { "path": "compat/non_win/windows.h", "content": "// Copyright 2015 The Crashpad Authors\n//\n// Licensed under the Apache License, Version 2.0 (the \"License\");\n// you may not use this file except in compliance with the License.\n// You may obtain a copy of the License at\n//\n// http://www.apache.org/licenses/LICENSE-2.0\n//\n// Unless required by applicable law or agreed to in writing, software\n// distributed under the License is distributed on an \"AS IS\" BASIS,\n// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n// See the License for the specific language governing permissions and\n// limitations under the License.\n\n// dbghelp.h on Windows requires inclusion of windows.h before it. To avoid\n// cluttering all inclusions of dbghelp.h with #ifdefs, always include windows.h\n// and have an empty one on non-Windows platforms.\n" }, { "path": "compat/non_win/winnt.h", "content": "// Copyright 2014 The Crashpad Authors\n//\n// Licensed under the Apache License, Version 2.0 (the \"License\");\n// you may not use this file except in compliance with the License.\n// You may obtain a copy of the License at\n//\n// http://www.apache.org/licenses/LICENSE-2.0\n//\n// Unless required by applicable law or agreed to in writing, software\n// distributed under the License is distributed on an \"AS IS\" BASIS,\n// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n// See the License for the specific language governing permissions and\n// limitations under the License.\n\n#ifndef CRASHPAD_COMPAT_NON_WIN_WINNT_H_\n#define CRASHPAD_COMPAT_NON_WIN_WINNT_H_\n\n#include \n\n//! \\file\n\n//! \\anchor VER_SUITE_x\n//! \\name VER_SUITE_*\n//!\n//! \\brief Installable product values for MINIDUMP_SYSTEM_INFO::SuiteMask.\n//! \\{\n#define VER_SUITE_SMALLBUSINESS 0x0001\n#define VER_SUITE_ENTERPRISE 0x0002\n#define VER_SUITE_BACKOFFICE 0x0004\n#define VER_SUITE_COMMUNICATIONS 0x0008\n#define VER_SUITE_TERMINAL 0x0010\n#define VER_SUITE_SMALLBUSINESS_RESTRICTED 0x0020\n#define VER_SUITE_EMBEDDEDNT 0x0040\n#define VER_SUITE_DATACENTER 0x0080\n#define VER_SUITE_SINGLEUSERTS 0x0100\n#define VER_SUITE_PERSONAL 0x0200\n#define VER_SUITE_BLADE 0x0400\n#define VER_SUITE_EMBEDDED_RESTRICTED 0x0800\n#define VER_SUITE_SECURITY_APPLIANCE 0x1000\n#define VER_SUITE_STORAGE_SERVER 0x2000\n#define VER_SUITE_COMPUTE_SERVER 0x4000\n#define VER_SUITE_WH_SERVER 0x8000\n//! \\}\n\n//! \\brief The maximum number of exception parameters present in the\n//! MINIDUMP_EXCEPTION::ExceptionInformation array.\n#define EXCEPTION_MAXIMUM_PARAMETERS 15\n\n//! \\anchor PROCESSOR_ARCHITECTURE_x\n//! \\name PROCESSOR_ARCHITECTURE_*\n//!\n//! \\brief CPU type values for MINIDUMP_SYSTEM_INFO::ProcessorArchitecture.\n//!\n//! \\sa crashpad::MinidumpCPUArchitecture\n//! \\{\n#define PROCESSOR_ARCHITECTURE_INTEL 0\n#define PROCESSOR_ARCHITECTURE_MIPS 1\n#define PROCESSOR_ARCHITECTURE_ALPHA 2\n#define PROCESSOR_ARCHITECTURE_PPC 3\n#define PROCESSOR_ARCHITECTURE_SHX 4\n#define PROCESSOR_ARCHITECTURE_ARM 5\n#define PROCESSOR_ARCHITECTURE_IA64 6\n#define PROCESSOR_ARCHITECTURE_ALPHA64 7\n#define PROCESSOR_ARCHITECTURE_MSIL 8\n#define PROCESSOR_ARCHITECTURE_AMD64 9\n#define PROCESSOR_ARCHITECTURE_IA32_ON_WIN64 10\n#define PROCESSOR_ARCHITECTURE_NEUTRAL 11\n#define PROCESSOR_ARCHITECTURE_ARM64 12\n#define PROCESSOR_ARCHITECTURE_ARM32_ON_WIN64 13\n#define PROCESSOR_ARCHITECTURE_UNKNOWN 0xffff\n//! \\}\n\n//! \\anchor PF_x\n//! \\name PF_*\n//!\n//! \\brief CPU feature values for \\ref CPU_INFORMATION::ProcessorFeatures\n//! \"CPU_INFORMATION::OtherCpuInfo::ProcessorFeatures\".\n//!\n//! \\{\n#define PF_FLOATING_POINT_PRECISION_ERRATA 0\n#define PF_FLOATING_POINT_EMULATED 1\n#define PF_COMPARE_EXCHANGE_DOUBLE 2\n#define PF_MMX_INSTRUCTIONS_AVAILABLE 3\n#define PF_PPC_MOVEMEM_64BIT_OK 4\n#define PF_ALPHA_BYTE_INSTRUCTIONS 5\n#define PF_XMMI_INSTRUCTIONS_AVAILABLE 6\n#define PF_3DNOW_INSTRUCTIONS_AVAILABLE 7\n#define PF_RDTSC_INSTRUCTION_AVAILABLE 8\n#define PF_PAE_ENABLED 9\n#define PF_XMMI64_INSTRUCTIONS_AVAILABLE 10\n#define PF_SSE_DAZ_MODE_AVAILABLE 11\n#define PF_NX_ENABLED 12\n#define PF_SSE3_INSTRUCTIONS_AVAILABLE 13\n#define PF_COMPARE_EXCHANGE128 14\n#define PF_COMPARE64_EXCHANGE128 15\n#define PF_CHANNELS_ENABLED 16\n#define PF_XSAVE_ENABLED 17\n#define PF_ARM_VFP_32_REGISTERS_AVAILABLE 18\n#define PF_ARM_NEON_INSTRUCTIONS_AVAILABLE 19\n#define PF_SECOND_LEVEL_ADDRESS_TRANSLATION 20\n#define PF_VIRT_FIRMWARE_ENABLED 21\n#define PF_RDWRFSGSBASE_AVAILABLE 22\n#define PF_FASTFAIL_AVAILABLE 23\n#define PF_ARM_DIVIDE_INSTRUCTION_AVAILABLE 24\n#define PF_ARM_64BIT_LOADSTORE_ATOMIC 25\n#define PF_ARM_EXTERNAL_CACHE_AVAILABLE 26\n#define PF_ARM_FMAC_INSTRUCTIONS_AVAILABLE 27\n#define PF_RDRAND_INSTRUCTION_AVAILABLE 28\n#define PF_ARM_V8_INSTRUCTIONS_AVAILABLE 29\n#define PF_ARM_V8_CRYPTO_INSTRUCTIONS_AVAILABLE 30\n#define PF_ARM_V8_CRC32_INSTRUCTIONS_AVAILABLE 31\n#define PF_RDTSCP_INSTRUCTION_AVAILABLE 32\n//! \\}\n\n//! \\anchor PAGE_x\n//! \\name PAGE_*\n//!\n//! \\brief Memory protection constants for MINIDUMP_MEMORY_INFO::Protect and\n//! MINIDUMP_MEMORY_INFO::AllocationProtect.\n//! \\{\n#define PAGE_NOACCESS 0x1\n#define PAGE_READONLY 0x2\n#define PAGE_READWRITE 0x4\n#define PAGE_WRITECOPY 0x8\n#define PAGE_EXECUTE 0x10\n#define PAGE_EXECUTE_READ 0x20\n#define PAGE_EXECUTE_READWRITE 0x40\n#define PAGE_EXECUTE_WRITECOPY 0x80\n#define PAGE_GUARD 0x100\n#define PAGE_NOCACHE 0x200\n#define PAGE_WRITECOMBINE 0x400\n//! \\}\n\n//! \\anchor MEM_x\n//! \\name MEM_*\n//!\n//! \\brief Memory state and type constants for MINIDUMP_MEMORY_INFO::State and\n//! MINIDUMP_MEMORY_INFO::Type.\n//! \\{\n#define MEM_COMMIT 0x1000\n#define MEM_RESERVE 0x2000\n#define MEM_DECOMMIT 0x4000\n#define MEM_RELEASE 0x8000\n#define MEM_FREE 0x10000\n#define MEM_PRIVATE 0x20000\n#define MEM_MAPPED 0x40000\n#define MEM_RESET 0x80000\n//! \\}\n\n//! \\brief The maximum number of distinct identifiable features that could\n//! possibly be carried in an XSAVE area.\n//!\n//! This corresponds to the number of bits in the XSAVE state-component bitmap,\n//! XSAVE_BV. See Intel Software Developer’s Manual, Volume 1: Basic\n//! Architecture (253665-060), 13.4.2 “XSAVE Header”.\n#define MAXIMUM_XSTATE_FEATURES (64)\n\n//! \\anchor XSTATE_x\n//! \\name XSTATE_*\n//!\n//! \\brief Offsets and constants for extended state.\n//! \\{\n#define XSTATE_COMPACTION_ENABLE (63)\n#define XSTATE_COMPACTION_ENABLE_MASK (1ull << XSTATE_COMPACTION_ENABLE)\n#define XSTATE_CET_U (11)\n#define XSTATE_MASK_CET_U (1ull << XSTATE_CET_U)\n//! \\}\n\n//! \\brief The location of a single state component within an XSAVE area.\nstruct XSTATE_FEATURE {\n //! \\brief The location of a state component within a CPU-specific context\n //! structure.\n //!\n //! This is equivalent to the difference (`ptrdiff_t`) between the return\n //! value of `LocateXStateFeature()` and its \\a Context argument.\n uint32_t Offset;\n\n //! \\brief The size of a state component with a CPU-specific context\n //! structure.\n //!\n //! This is equivalent to the size returned by `LocateXStateFeature()` in \\a\n //! Length.\n uint32_t Size;\n};\n\n//! \\anchor IMAGE_DEBUG_MISC_x\n//! \\name IMAGE_DEBUG_MISC_*\n//!\n//! Data type values for IMAGE_DEBUG_MISC::DataType.\n//! \\{\n\n//! \\brief A pointer to a `.dbg` file.\n//!\n//! IMAGE_DEBUG_MISC::Data will contain the path or file name of the `.dbg` file\n//! associated with the module.\n#define IMAGE_DEBUG_MISC_EXENAME 1\n\n//! \\}\n\n//! \\brief Miscellaneous debugging record.\n//!\n//! This structure is referenced by MINIDUMP_MODULE::MiscRecord. It is obsolete,\n//! superseded by the CodeView record.\nstruct IMAGE_DEBUG_MISC {\n //! \\brief The type of data carried in the #Data field.\n //!\n //! This is a value of \\ref IMAGE_DEBUG_MISC_x \"IMAGE_DEBUG_MISC_*\".\n uint32_t DataType;\n\n //! \\brief The length of this structure in bytes, including the entire #Data\n //! field and its `NUL` terminator.\n //!\n //! \\note The Windows documentation states that this field is rounded up to\n //! nearest nearest 4-byte multiple.\n uint32_t Length;\n\n //! \\brief The encoding of the #Data field.\n //!\n //! If this field is `0`, #Data contains narrow or multibyte character data.\n //! If this field is `1`, #Data is UTF-16-encoded.\n //!\n //! On Windows, with this field set to `0`, #Data will be encoded in the code\n //! page of the system that linked the module. On other operating systems,\n //! UTF-8 may be used.\n uint8_t Unicode;\n\n uint8_t Reserved[3];\n\n //! \\brief The data carried within this structure.\n //!\n //! For string data, this field will be `NUL`-terminated. If #Unicode is `1`,\n //! this field is UTF-16-encoded, and will be terminated by a UTF-16 `NUL`\n //! code unit (two `NUL` bytes).\n uint8_t Data[1];\n};\n\n//! \\anchor VER_NT_x\n//! \\name VER_NT_*\n//!\n//! \\brief Operating system type values for MINIDUMP_SYSTEM_INFO::ProductType.\n//!\n//! \\sa crashpad::MinidumpOSType\n//! \\{\n#define VER_NT_WORKSTATION 1\n#define VER_NT_DOMAIN_CONTROLLER 2\n#define VER_NT_SERVER 3\n//! \\}\n\n//! \\anchor VER_PLATFORM_x\n//! \\name VER_PLATFORM_*\n//!\n//! \\brief Operating system family values for MINIDUMP_SYSTEM_INFO::PlatformId.\n//!\n//! \\sa crashpad::MinidumpOS\n//! \\{\n#define VER_PLATFORM_WIN32s 0\n#define VER_PLATFORM_WIN32_WINDOWS 1\n#define VER_PLATFORM_WIN32_NT 2\n//! \\}\n\n#endif // CRASHPAD_COMPAT_NON_WIN_WINNT_H_\n" }, { "path": "compat/win/getopt.h", "content": "// Copyright 2015 The Crashpad Authors\n//\n// Licensed under the Apache License, Version 2.0 (the \"License\");\n// you may not use this file except in compliance with the License.\n// You may obtain a copy of the License at\n//\n// http://www.apache.org/licenses/LICENSE-2.0\n//\n// Unless required by applicable law or agreed to in writing, software\n// distributed under the License is distributed on an \"AS IS\" BASIS,\n// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n// See the License for the specific language governing permissions and\n// limitations under the License.\n\n#ifndef CRASHPAD_COMPAT_WIN_GETOPT_H_\n#define CRASHPAD_COMPAT_WIN_GETOPT_H_\n\n#include \"third_party/getopt/getopt.h\"\n\n#endif // CRASHPAD_COMPAT_WIN_GETOPT_H_\n" }, { "path": "compat/win/strings.cc", "content": "// Copyright 2015 The Crashpad Authors\n//\n// Licensed under the Apache License, Version 2.0 (the \"License\");\n// you may not use this file except in compliance with the License.\n// You may obtain a copy of the License at\n//\n// http://www.apache.org/licenses/LICENSE-2.0\n//\n// Unless required by applicable law or agreed to in writing, software\n// distributed under the License is distributed on an \"AS IS\" BASIS,\n// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n// See the License for the specific language governing permissions and\n// limitations under the License.\n\n#include \n\n#include \n\nextern \"C\" {\n\nint strcasecmp(const char* s1, const char* s2) {\n return _stricmp(s1, s2);\n}\n\n} // extern \"C\"\n" }, { "path": "compat/win/strings.h", "content": "// Copyright 2015 The Crashpad Authors\n//\n// Licensed under the Apache License, Version 2.0 (the \"License\");\n// you may not use this file except in compliance with the License.\n// You may obtain a copy of the License at\n//\n// http://www.apache.org/licenses/LICENSE-2.0\n//\n// Unless required by applicable law or agreed to in writing, software\n// distributed under the License is distributed on an \"AS IS\" BASIS,\n// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n// See the License for the specific language governing permissions and\n// limitations under the License.\n\n#ifndef CRASHPAD_COMPAT_WIN_STRINGS_H_\n#define CRASHPAD_COMPAT_WIN_STRINGS_H_\n\n#ifdef __cplusplus\nextern \"C\" {\n#endif\n\nint strcasecmp(const char* s1, const char* s2);\n\n#ifdef __cplusplus\n} // extern \"C\"\n#endif\n\n#endif // CRASHPAD_COMPAT_WIN_STRINGS_H_\n" }, { "path": "compat/win/sys/time.h", "content": "// Copyright 2015 The Crashpad Authors\n//\n// Licensed under the Apache License, Version 2.0 (the \"License\");\n// you may not use this file except in compliance with the License.\n// You may obtain a copy of the License at\n//\n// http://www.apache.org/licenses/LICENSE-2.0\n//\n// Unless required by applicable law or agreed to in writing, software\n// distributed under the License is distributed on an \"AS IS\" BASIS,\n// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n// See the License for the specific language governing permissions and\n// limitations under the License.\n\n#ifndef CRASHPAD_COMPAT_WIN_SYS_TIME_H_\n#define CRASHPAD_COMPAT_WIN_SYS_TIME_H_\n\n#include \n\n#endif // CRASHPAD_COMPAT_WIN_SYS_TIME_H_\n" }, { "path": "compat/win/sys/types.h", "content": "// Copyright 2014 The Crashpad Authors\n//\n// Licensed under the Apache License, Version 2.0 (the \"License\");\n// you may not use this file except in compliance with the License.\n// You may obtain a copy of the License at\n//\n// http://www.apache.org/licenses/LICENSE-2.0\n//\n// Unless required by applicable law or agreed to in writing, software\n// distributed under the License is distributed on an \"AS IS\" BASIS,\n// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n// See the License for the specific language governing permissions and\n// limitations under the License.\n\n#ifndef CRASHPAD_COMPAT_WIN_SYS_TYPES_H_\n#define CRASHPAD_COMPAT_WIN_SYS_TYPES_H_\n\n// This is intended to be roughly equivalent to #include_next.\n#include <../ucrt/sys/types.h>\n\n#include \n\n#endif // CRASHPAD_COMPAT_WIN_SYS_TYPES_H_\n" }, { "path": "compat/win/time.cc", "content": "// Copyright 2015 The Crashpad Authors\n//\n// Licensed under the Apache License, Version 2.0 (the \"License\");\n// you may not use this file except in compliance with the License.\n// You may obtain a copy of the License at\n//\n// http://www.apache.org/licenses/LICENSE-2.0\n//\n// Unless required by applicable law or agreed to in writing, software\n// distributed under the License is distributed on an \"AS IS\" BASIS,\n// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n// See the License for the specific language governing permissions and\n// limitations under the License.\n\n#include \n\nextern \"C\" {\n\nstruct tm* gmtime_r(const time_t* timep, struct tm* result) {\n if (gmtime_s(result, timep) != 0)\n return nullptr;\n return result;\n}\n\nstruct tm* localtime_r(const time_t* timep, struct tm* result) {\n if (localtime_s(result, timep) != 0)\n return nullptr;\n return result;\n}\n\nconst char* strptime(const char* buf, const char* format, struct tm* tm) {\n // TODO(scottmg): strptime implementation.\n return nullptr;\n}\n\ntime_t timegm(struct tm* tm) {\n return _mkgmtime(tm);\n}\n\n} // extern \"C\"\n" }, { "path": "compat/win/time.h", "content": "// Copyright 2015 The Crashpad Authors\n//\n// Licensed under the Apache License, Version 2.0 (the \"License\");\n// you may not use this file except in compliance with the License.\n// You may obtain a copy of the License at\n//\n// http://www.apache.org/licenses/LICENSE-2.0\n//\n// Unless required by applicable law or agreed to in writing, software\n// distributed under the License is distributed on an \"AS IS\" BASIS,\n// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n// See the License for the specific language governing permissions and\n// limitations under the License.\n\n#ifndef CRASHPAD_COMPAT_WIN_TIME_H_\n#define CRASHPAD_COMPAT_WIN_TIME_H_\n\n// This is intended to be roughly equivalent to #include_next.\n#include <../ucrt/time.h>\n\n#ifdef __cplusplus\nextern \"C\" {\n#endif\n\nstruct tm* gmtime_r(const time_t* timep, struct tm* result);\n\nstruct tm* localtime_r(const time_t* timep, struct tm* result);\n\nconst char* strptime(const char* buf, const char* format, struct tm* tm);\n\ntime_t timegm(struct tm* tm);\n\n#ifdef __cplusplus\n} // extern \"C\"\n#endif\n\n#endif // CRASHPAD_COMPAT_WIN_TIME_H_\n" }, { "path": "compat/win/winbase.h", "content": "// Copyright 2017 The Crashpad Authors\n//\n// Licensed under the Apache License, Version 2.0 (the \"License\");\n// you may not use this file except in compliance with the License.\n// You may obtain a copy of the License at\n//\n// http://www.apache.org/licenses/LICENSE-2.0\n//\n// Unless required by applicable law or agreed to in writing, software\n// distributed under the License is distributed on an \"AS IS\" BASIS,\n// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n// See the License for the specific language governing permissions and\n// limitations under the License.\n\n#ifndef CRASHPAD_COMPAT_WIN_WINBASE_H_\n#define CRASHPAD_COMPAT_WIN_WINBASE_H_\n\n// include_next \n#include <../um/winbase.h>\n\n// 10.0.15063.0 SDK\n\n#ifndef SYMBOLIC_LINK_FLAG_ALLOW_UNPRIVILEGED_CREATE\n#define SYMBOLIC_LINK_FLAG_ALLOW_UNPRIVILEGED_CREATE (0x2)\n#endif\n\n#endif // CRASHPAD_COMPAT_WIN_WINBASE_H_\n" }, { "path": "compat/win/winnt.h", "content": "// Copyright 2015 The Crashpad Authors\n//\n// Licensed under the Apache License, Version 2.0 (the \"License\");\n// you may not use this file except in compliance with the License.\n// You may obtain a copy of the License at\n//\n// http://www.apache.org/licenses/LICENSE-2.0\n//\n// Unless required by applicable law or agreed to in writing, software\n// distributed under the License is distributed on an \"AS IS\" BASIS,\n// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n// See the License for the specific language governing permissions and\n// limitations under the License.\n\n#ifndef CRASHPAD_COMPAT_WIN_WINNT_H_\n#define CRASHPAD_COMPAT_WIN_WINNT_H_\n\n// include_next \n#include <../um/winnt.h>\n\n// https://msdn.microsoft.com/library/aa373184.aspx: \"Note that this structure\n// definition was accidentally omitted from WinNT.h.\"\nstruct PROCESSOR_POWER_INFORMATION {\n ULONG Number;\n ULONG MaxMhz;\n ULONG CurrentMhz;\n ULONG MhzLimit;\n ULONG MaxIdleState;\n ULONG CurrentIdleState;\n};\n\n// 10.0.10240.0 SDK\n\n#ifndef PROCESSOR_ARCHITECTURE_ARM64\n#define PROCESSOR_ARCHITECTURE_ARM64 12\n#endif\n\n#ifndef PF_ARM_V8_INSTRUCTIONS_AVAILABLE\n#define PF_ARM_V8_INSTRUCTIONS_AVAILABLE 29\n#endif\n\n#ifndef PF_ARM_V8_CRYPTO_INSTRUCTIONS_AVAILABLE\n#define PF_ARM_V8_CRYPTO_INSTRUCTIONS_AVAILABLE 30\n#endif\n\n#ifndef PF_ARM_V8_CRC32_INSTRUCTIONS_AVAILABLE\n#define PF_ARM_V8_CRC32_INSTRUCTIONS_AVAILABLE 31\n#endif\n\n#ifndef PF_RDTSCP_INSTRUCTION_AVAILABLE\n#define PF_RDTSCP_INSTRUCTION_AVAILABLE 32\n#endif\n\n// 10.0.14393.0 SDK\n\n#ifndef PROCESSOR_ARCHITECTURE_ARM32_ON_WIN64\n#define PROCESSOR_ARCHITECTURE_ARM32_ON_WIN64 13\n#endif\n\n#endif // CRASHPAD_COMPAT_WIN_WINNT_H_\n" }, { "path": "compat/win/winternl.h", "content": "// Copyright 2017 The Crashpad Authors\n//\n// Licensed under the Apache License, Version 2.0 (the \"License\");\n// you may not use this file except in compliance with the License.\n// You may obtain a copy of the License at\n//\n// http://www.apache.org/licenses/LICENSE-2.0\n//\n// Unless required by applicable law or agreed to in writing, software\n// distributed under the License is distributed on an \"AS IS\" BASIS,\n// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n// See the License for the specific language governing permissions and\n// limitations under the License.\n\n#ifndef CRASHPAD_COMPAT_WIN_WINTERNL_H_\n#define CRASHPAD_COMPAT_WIN_WINTERNL_H_\n\n// include_next \n#include <../um/winternl.h>\n\n// 10.0.16299.0 SDK\n\ntypedef struct _CLIENT_ID CLIENT_ID;\n\n#endif // CRASHPAD_COMPAT_WIN_WINTERNL_H_\n" }, { "path": "doc/.gitignore", "content": "/generated\n" }, { "path": "doc/appengine/README", "content": "This is the App Engine app that serves https://crashpad.chromium.org/.\n\nTo work on this app, obtain the following packages:\n\n - Go, from https://golang.org/dl/. This is only necessary for local development\n and testing. The directory containing the “go” executable, such as\n /usr/local/go/bin, must appear in $PATH. It does not appear critical for the\n Go version used to match the Go runtime version used (for example, these\n instructions were tested with Go 1.14 locally but a Go 1.11 runtime when\n deployed), but if problems are encountered, it would be wise to use the same\n version for both local development and AppEngine deployment.\n - The Google Cloud SDK (gcloud CLI) from\n https://cloud.google.com/sdk/docs/install-sdk. This is necessary for both\n local development and for AppEngine deployment. Unpacking this package\n produces a google-cloud-sdk directory, whose bin child directory may be\n added to $PATH for convenience, although this is not strictly necessary.\n\nThe commands in this README are expected to be run from the directory containing\nit.\n\nTo test locally:\n\n% go get -d ./src/crashpad-home\n% python3 …/google-cloud-sdk/bin/dev_appserver.py src/crashpad-home\n\ndev_appserver.py must be invoked using Python 3, but internally will use Python\n2, and a Python 2 interpreter must be available in the PATH as python2.\n\nLook for the “Starting module \"default\" running at: http://localhost:8080” line,\nwhich tells you the URL of the local running instance of the app. Test\nhttp://localhost:8080/ to ensure that it works.\n\nIt would be good to test http://localhost:8080/doxygen as well, but it may fail\nwith HTTP status 500 and the following error returned as the HTTP response body\nbecause memcache seems to not be available in the local dev_appserver\nenvironment:\n\nservice bridge HTTP failed: Post \"http://appengine.googleapis.internal:10001/rpc_http\": dial tcp: lookup appengine.googleapis.internal: no such host\n\nThe /doxygen URL can be tested in a verison of the app that’s been deployed\nbefore traffic has been migrated to it by visiting the staged deployed version\nfrom the App Engine console.\n\nTo deploy:\n\n% version=$(git rev-parse --short=12 HEAD)\n% [[ -n \"$(git status --porcelain)\" ]] && version+=-dirty\n% …/google-cloud-sdk/bin/gcloud app deploy \\\n --project=crashpad-home --version=\"${version}\" --no-promote \\\n \"$(pwd)/src/crashpad-home\"\n\n(Note: the $(pwd) is necessary for “gcloud app deploy” to recognize that the\napplication is in GOPATH, putting it into “GOPATH mode”. This normally happens\ncorrectly on its own even with a relative path, but will fail for relative\npaths when $(pwd) is a symbolic link. Using an absolute path here will save you\nfrom this frustration, freeing you up to undoubtedly experience other\nfrustrations.)\n\nActivate a newly-deployed version by visiting the App Engine console at\nhttps://console.cloud.google.com/appengine/versions?project=crashpad-home,\nselecting it, and choosing “Migrate Traffic”. It is also possible to delete old\nversions from this page when they are no longer needed.\n" }, { "path": "doc/appengine/go.mod", "content": "module src/crashpad-home\n\ngo 1.21.6\n\nrequire google.golang.org/appengine/v2 v2.0.5\n\nrequire (\n\tgithub.com/golang/protobuf v1.5.2 // indirect\n\tgoogle.golang.org/protobuf v1.30.0 // indirect\n)\n" }, { "path": "doc/appengine/go.sum", "content": "github.com/golang/protobuf v1.5.0/go.mod h1:FsONVRAS9T7sI+LIUmWTfcYkHO4aIWwzhcaSAoJOfIk=\ngithub.com/golang/protobuf v1.5.2 h1:ROPKBNFfQgOUMifHyP+KYbvpjbdoFNs+aK7DXlji0Tw=\ngithub.com/golang/protobuf v1.5.2/go.mod h1:XVQd3VNwM+JqD3oG2Ue2ip4fOMUkwXdXDdiuN0vRsmY=\ngithub.com/google/go-cmp v0.5.5 h1:Khx7svrCpmxxtHBq5j2mp/xVjsi8hQMfNLvJFAlrGgU=\ngithub.com/google/go-cmp v0.5.5/go.mod h1:v8dTdLbMG2kIc/vJvl+f65V22dbkXbowE6jgT/gNBxE=\ngithub.com/yuin/goldmark v1.4.13/go.mod h1:6yULJ656Px+3vBD8DxQVa3kxgyrAnzto9xy5taEt/CY=\ngolang.org/x/crypto v0.0.0-20190308221718-c2843e01d9a2/go.mod h1:djNgcEr1/C05ACkg1iLfiJU5Ep61QUkGW8qpdssI0+w=\ngolang.org/x/crypto v0.0.0-20210921155107-089bfa567519/go.mod h1:GvvjBRRGRdwPK5ydBHafDWAxML/pGHZbMvKqRZ5+Abc=\ngolang.org/x/mod v0.6.0-dev.0.20220419223038-86c51ed26bb4/go.mod h1:jJ57K6gSWd91VN4djpZkiMVwK6gcyfeH4XE8wZrZaV4=\ngolang.org/x/net v0.0.0-20190620200207-3b0461eec859/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s=\ngolang.org/x/net v0.0.0-20210226172049-e18ecbb05110/go.mod h1:m0MpNAwzfU5UDzcl9v0D8zg8gWTRqZa9RBIspLL5mdg=\ngolang.org/x/net v0.0.0-20220722155237-a158d28d115b/go.mod h1:XRhObCWvk6IyKnWLug+ECip1KBveYUHfp+8e9klMJ9c=\ngolang.org/x/sync v0.0.0-20190423024810-112230192c58/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=\ngolang.org/x/sync v0.0.0-20220722155255-886fb9371eb4/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=\ngolang.org/x/sys v0.0.0-20190215142949-d0b11bdaac8a/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY=\ngolang.org/x/sys v0.0.0-20201119102817-f84b799fce68/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=\ngolang.org/x/sys v0.0.0-20210615035016-665e8c7367d1/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=\ngolang.org/x/sys v0.0.0-20220520151302-bc2c85ada10a/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=\ngolang.org/x/sys v0.0.0-20220722155257-8c9f86f7a55f/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=\ngolang.org/x/term v0.0.0-20201126162022-7de9c90e9dd1/go.mod h1:bj7SfCRtBDWHUb9snDiAeCFNEtKQo2Wmx5Cou7ajbmo=\ngolang.org/x/term v0.0.0-20210927222741-03fcf44c2211/go.mod h1:jbD1KX2456YbFQfuXm/mYQcufACuNUgVhRMnK/tPxf8=\ngolang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ=\ngolang.org/x/text v0.3.3/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ=\ngolang.org/x/text v0.3.7/go.mod h1:u+2+/6zg+i71rQMx5EYifcz6MCKuco9NR6JIITiCfzQ=\ngolang.org/x/text v0.3.8/go.mod h1:E6s5w1FMmriuDzIBO73fBruAKo1PCIq6d2Q6DHfQ8WQ=\ngolang.org/x/tools v0.0.0-20180917221912-90fa682c2a6e/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ=\ngolang.org/x/tools v0.0.0-20191119224855-298f0cb1881e/go.mod h1:b+2E5dAYhXwXZwtnZ6UAqBI28+e2cm9otk0dWdXHAEo=\ngolang.org/x/tools v0.1.12/go.mod h1:hNGJHUnrk76NpqgfD5Aqm5Crs+Hm0VOH/i9J2+nxYbc=\ngolang.org/x/xerrors v0.0.0-20190717185122-a985d3407aa7/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=\ngolang.org/x/xerrors v0.0.0-20191204190536-9bdfabe68543 h1:E7g+9GITq07hpfrRu66IVDexMakfv52eLZ2CXBWiKr4=\ngolang.org/x/xerrors v0.0.0-20191204190536-9bdfabe68543/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=\ngoogle.golang.org/appengine/v2 v2.0.5 h1:4C+F3Cd3L2nWEfSmFEZDPjQvDwL8T0YCeZBysZifP3k=\ngoogle.golang.org/appengine/v2 v2.0.5/go.mod h1:WoEXGoXNfa0mLvaH5sV3ZSGXwVmy8yf7Z1JKf3J3wLI=\ngoogle.golang.org/protobuf v1.26.0-rc.1/go.mod h1:jlhhOSvTdKEhbULTjvd4ARK9grFBp09yW+WbY/TyQbw=\ngoogle.golang.org/protobuf v1.26.0/go.mod h1:9q0QmTI4eRPtz6boOQmLYwt+qCgq0jsYwAQnmE0givc=\ngoogle.golang.org/protobuf v1.30.0 h1:kPPoIgf3TsEvrm0PFe15JQ+570QVxYzEvvHqChK+cng=\ngoogle.golang.org/protobuf v1.30.0/go.mod h1:HV8QOd/L58Z+nl8r43ehVNZIU/HEI6OcFqwMG9pJV4I=\n" }, { "path": "doc/appengine/src/crashpad-home/app.yaml", "content": "# Copyright 2015 The Crashpad Authors\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n\nruntime: go121\napp_engine_apis: true\n\nhandlers:\n- url: /.*\n script: auto\n secure: always\n" }, { "path": "doc/appengine/src/crashpad-home/main.go", "content": "// Copyright 2015 The Crashpad Authors\n//\n// Licensed under the Apache License, Version 2.0 (the \"License\");\n// you may not use this file except in compliance with the License.\n// You may obtain a copy of the License at\n//\n// http://www.apache.org/licenses/LICENSE-2.0\n//\n// Unless required by applicable law or agreed to in writing, software\n// distributed under the License is distributed on an \"AS IS\" BASIS,\n// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n// See the License for the specific language governing permissions and\n// limitations under the License.\n\npackage main\n\nimport (\n\t\"encoding/base64\"\n\t\"fmt\"\n\t\"io\"\n\t\"io/ioutil\"\n\t\"net/http\"\n\t\"net/url\"\n\t\"path\"\n\t\"strings\"\n\t\"time\"\n\n\t\"google.golang.org/appengine/v2\"\n\t\"google.golang.org/appengine/v2/memcache\"\n\t\"google.golang.org/appengine/v2/urlfetch\"\n)\n\nfunc main() {\n\tappengine.Main()\n}\n\nfunc init() {\n\thttp.HandleFunc(\"/\", handler)\n}\n\nfunc handler(w http.ResponseWriter, r *http.Request) {\n\tconst (\n\t\tbaseURL = \"https://chromium.googlesource.com/crashpad/crashpad/+/\"\n\t\tmainBaseURL = baseURL + \"main/\"\n\t\tgeneratedDocBaseURL = baseURL + \"doc/doc/generated/?format=TEXT\"\n\t\tbugBaseURL = \"https://bugs.chromium.org/p/crashpad/\"\n\t)\n\n\tredirectMap := map[string]string{\n\t\t\"/\": mainBaseURL + \"README.md\",\n\t\t\"/bug\": bugBaseURL,\n\t\t\"/bug/\": bugBaseURL,\n\t\t\"/bug/new\": bugBaseURL + \"issues/entry\",\n\t\t\"/doc/developing.html\": mainBaseURL + \"/doc/developing.md\",\n\t\t\"/doc/status.html\": mainBaseURL + \"/doc/status.md\",\n\t\t\"/index.html\": mainBaseURL + \"README.md\",\n\t\t\"/man\": mainBaseURL + \"doc/man.md\",\n\t\t\"/man/\": mainBaseURL + \"doc/man.md\",\n\t\t\"/man/catch_exception_tool.html\": mainBaseURL + \"tools/mac/catch_exception_tool.md\",\n\t\t\"/man/crashpad_database_util.html\": mainBaseURL + \"tools/crashpad_database_util.md\",\n\t\t\"/man/crashpad_handler.html\": mainBaseURL + \"handler/crashpad_handler.md\",\n\t\t\"/man/exception_port_tool.html\": mainBaseURL + \"tools/mac/exception_port_tool.md\",\n\t\t\"/man/generate_dump.html\": mainBaseURL + \"tools/generate_dump.md\",\n\t\t\"/man/index.html\": mainBaseURL + \"doc/man.md\",\n\t\t\"/man/on_demand_service_tool.html\": mainBaseURL + \"tools/mac/on_demand_service_tool.md\",\n\t\t\"/man/run_with_crashpad.html\": mainBaseURL + \"tools/run_with_crashpad.md\",\n\t}\n\n\tctx := appengine.NewContext(r)\n\tclient := urlfetch.Client(ctx)\n\n\tdestinationURL, exists := redirectMap[r.URL.Path]\n\tif exists {\n\t\thttp.Redirect(w, r, destinationURL, http.StatusFound)\n\t\treturn\n\t}\n\n\tif strings.HasPrefix(r.URL.Path, \"/bug/\") {\n\t\thttp.Redirect(w, r, bugBaseURL+\"issues/detail?id=\"+r.URL.Path[5:], http.StatusFound)\n\t\treturn\n\t}\n\n\t// Don’t show dotfiles.\n\tif strings.HasPrefix(path.Base(r.URL.Path), \".\") {\n\t\thttp.Error(w, http.StatusText(http.StatusNotFound), http.StatusNotFound)\n\t\treturn\n\t}\n\n\tu, err := url.Parse(generatedDocBaseURL)\n\tif err != nil {\n\t\thttp.Error(w, err.Error(), http.StatusInternalServerError)\n\t\treturn\n\t}\n\n\tu.Path = path.Join(u.Path, r.URL.Path)\n\turlStr := u.String()\n\n\titem, err := memcache.Get(ctx, urlStr)\n\tif err == memcache.ErrCacheMiss {\n\t\tresp, err := client.Get(urlStr)\n\t\tif err != nil {\n\t\t\thttp.Error(w, err.Error(), http.StatusInternalServerError)\n\t\t\treturn\n\t\t}\n\t\tdefer resp.Body.Close()\n\n\t\tif resp.StatusCode != http.StatusOK {\n\t\t\tw.WriteHeader(resp.StatusCode)\n\t\t\tfor k, v := range w.Header() {\n\t\t\t\tw.Header()[k] = v\n\t\t\t}\n\t\t\tio.Copy(w, resp.Body)\n\t\t\treturn\n\t\t}\n\n\t\t// Redirect directories to their index pages (/doc/ -> /doc/index.html).\n\t\tif resp.Header.Get(\"X-Gitiles-Object-Type\") == \"tree\" {\n\t\t\thttp.Redirect(w, r, path.Join(r.URL.Path, \"/index.html\"), http.StatusFound)\n\t\t\treturn\n\t\t}\n\n\t\tdecoder := base64.NewDecoder(base64.StdEncoding, resp.Body)\n\t\tb, err := ioutil.ReadAll(decoder)\n\t\tif err != nil {\n\t\t\thttp.Error(w, err.Error(), http.StatusInternalServerError)\n\t\t\treturn\n\t\t}\n\t\titem = &memcache.Item{\n\t\t\tKey: urlStr,\n\t\t\tValue: b,\n\t\t\tExpiration: 1 * time.Hour,\n\t\t}\n\t\tif err := memcache.Set(ctx, item); err != nil {\n\t\t\thttp.Error(w, err.Error(), http.StatusInternalServerError)\n\t\t\treturn\n\t\t}\n\t} else if err != nil {\n\t\thttp.Error(w, err.Error(), http.StatusInternalServerError)\n\t\treturn\n\t}\n\n\tw.Header().Set(\"Content-Type\", contentType(path.Base(u.Path)))\n\tfmt.Fprintf(w, \"%s\", item.Value)\n}\n\n// contentType returns the appropriate content type header for file.\nfunc contentType(file string) string {\n\tcontentTypes := map[string]string{\n\t\t\".css\": \"text/css; charset=UTF-8\",\n\t\t\".html\": \"text/html; charset=UTF-8\",\n\t\t\".ico\": \"image/x-icon\",\n\t\t\".js\": \"text/javascript; charset=UTF-8\",\n\t\t\".png\": \"image/png\",\n\t\t\".svg\": \"image/svg+xml\",\n\t}\n\tfor suffix, typ := range contentTypes {\n\t\tif strings.HasSuffix(file, suffix) {\n\t\t\treturn typ\n\t\t}\n\t}\n\treturn \"text/plain; charset=UTF-8\"\n}\n" }, { "path": "doc/developing.md", "content": "\n\n# Developing Crashpad\n\n## Status\n\n[Project status](status.md) information has moved to its own page.\n\n## Introduction\n\nCrashpad is a [Chromium project](https://www.chromium.org/Home). Most of its\ndevelopment practices follow Chromium’s. In order to function on its own in\nother projects, Crashpad uses\n[mini_chromium](https://chromium.googlesource.com/chromium/mini_chromium/), a\nsmall, self-contained library that provides many of Chromium’s useful low-level\nbase routines. [mini_chromium’s\nREADME](https://chromium.googlesource.com/chromium/mini_chromium/+/main/README.md)\nprovides more detail.\n\n## Prerequisites\n\nTo develop Crashpad, the following tools are necessary, and must be present in\nthe `$PATH` environment variable:\n\n * Appropriate development tools.\n * On macOS, install [Xcode](https://developer.apple.com/xcode/). The latest\n version is generally recommended.\n * On Windows, install [Visual Studio](https://www.visualstudio.com/) with\n C++ support and the Windows SDK. The latest version is generally\n recommended. Some tests also require the CDB debugger, installed with\n [Debugging Tools for\n Windows](https://docs.microsoft.com/en-us/windows-hardware/drivers/debugger/).\n * On Linux, obtain appropriate tools for C++ development through any\n appropriate means including the system’s package manager. On Debian and\n Debian-based distributions, the `build-essential`, `zlib1g-dev`, and any\n one of the `libcurl4-*-dev` packages such as `libcurl4-openssl-dev` should\n suffice.\n * Chromium’s\n [depot_tools](https://www.chromium.org/developers/how-tos/depottools).\n * [Git](https://git-scm.com/). This is provided by Xcode on macOS, by\n depot_tools on Windows, and through any appropriate means including the\n system’s package manager on Linux.\n * [Python](https://www.python.org/). This is provided by the operating system\n on macOS, by depot_tools on Windows, and through any appropriate means\n including the system’s package manager on Linux.\n\n## Getting the Source Code\n\nThe main source code repository is a Git repository hosted at\nhttps://chromium.googlesource.com/crashpad/crashpad. Although it is possible to\ncheck out this repository directly with `git clone`, Crashpad’s dependencies are\nmanaged by\n[`gclient`](https://www.chromium.org/developers/how-tos/depottools#TOC-gclient)\ninstead of Git submodules, so to work on Crashpad, it is best to use `fetch` to\nget the source code.\n\n`fetch` and `gclient` are part of the\n[depot_tools](https://www.chromium.org/developers/how-tos/depottools). There’s\nno need to install them separately.\n\n### Initial Checkout\n\n```\n$ mkdir ~/crashpad\n$ cd ~/crashpad\n$ fetch crashpad\n```\n\n`fetch crashpad` performs the initial `git clone` and `gclient sync`,\nestablishing a fully-functional local checkout.\n\n### Subsequent Checkouts\n\n```\n$ cd ~/crashpad/crashpad\n$ git pull -r\n$ gclient sync\n```\n\n## Building\n\n### Windows, Mac, Linux, Fuchsia\n\nOn Windows, Mac, Linux, and Fuchsia, Crashpad uses\n[GN](https://gn.googlesource.com/gn) to generate\n[Ninja](https://ninja-build.org/) build files. For example,\n\n```\n$ cd ~/crashpad/crashpad\n$ gn gen out/Default\n$ ninja -C out/Default\n```\n\nYou can then use `gn args out/Default` or edit `out/Default/args.gn` to\nconfigure the build, for example things like `is_debug=true` or\n`target_cpu=\"x86\"`.\n\nGN and Ninja are part of the\n[depot_tools](https://www.chromium.org/developers/how-tos/depottools). There’s\nno need to install them separately.\n\n#### Fuchsia\n\nIn order to instruct gclient to download the Fuchsia SDK, you need to add the\nfollowing to `~/crashpad/.gclient`:\n\n```\ntarget_os=[\"fuchsia\"]\n```\n\nIf you're using this tree to develop for multiple targets, you can also add\nother entries to the the list (e.g. `target_os=[\"fuchsia\", \"mac\"]`).\n\n#### Optional Linux Configs\n\nTo pull and use Crashpad's version of clang and sysroot, make the following\nchanges.\n\nAdd the following to `~/crashpad/.gclient`.\n```\n\"custom_vars\": { \"pull_linux_clang\": True },\n```\nAdd these args to `out/Default/args.gn`.\n```\nclang_path = \"//third_party/linux/clang/linux-amd64\"\ntarget_sysroot = \"//third_party/linux/sysroot\"\n```\n\n### Android\n\nThis build relies on cross-compilation. It’s possible to develop Crashpad for\nAndroid on any platform that the [Android NDK (Native Development\nKit)](https://developer.android.com/ndk/) runs on.\n\nIf it’s not already present on your system, [download the NDK package for your\nsystem](https://developer.android.com/ndk/downloads/) and expand it to a\nsuitable location. These instructions assume that it’s been expanded to\n`~/android-ndk-r21b`.\n\nNote that Chrome uses Android API level 21 for both 64-bit platforms and\n32-bit platforms. See Chrome’s\n[`build/config/android/config.gni`](https://chromium.googlesource.com/chromium/src/+/main/build/config/android/config.gni)\nwhich sets `android32_ndk_api_level` and `android64_ndk_api_level`.\n\nSet these gn args\n```\ntarget_os = \"android\"\nandroid_ndk_root = ~/android-ndk-r21b\nandroid_api_level = 21\n```\n\n## Testing\n\nCrashpad uses [Google Test](https://github.com/google/googletest/) as its\nunit-testing framework, and some tests use [Google\nMock](https://github.com/google/googletest/tree/master/googlemock/) as well. Its\ntests are currently split up into several test executables, each dedicated to\ntesting a different component. This may change in the future. After a successful\nbuild, the test executables will be found at `out/Debug/crashpad_*_test`.\n\n```\n$ cd ~/crashpad/crashpad\n$ out/Debug/crashpad_minidump_test\n$ out/Debug/crashpad_util_test\n```\n\nA script is provided to run all of Crashpad’s tests. It accepts a single\nargument, a path to the directory containing the test executables.\n\n```\n$ cd ~/crashpad/crashpad\n$ python build/run_tests.py out/Debug\n```\n\nTo run a subset of the tests, use the `--gtest_filter` flag, e.g., to run all\nthe tests for MinidumpStringWriter:\n\n```\n$ python build/run_tests.py out/Debug --gtest_filter MinidumpStringWriter\\*\n```\n\n### Windows\n\nOn Windows, `end_to_end_test.py` requires the CDB debugger, installed with\n[Debugging Tools for\nWindows](https://docs.microsoft.com/windows-hardware/drivers/debugger/). This\ncan be installed either as part of the [Windows Driver\nKit](https://docs.microsoft.com/windows-hardware/drivers/download-the-wdk) or\nthe [Windows\nSDK](https://developer.microsoft.com/windows/downloads/windows-10-sdk/). If the\nWindows SDK has already been installed (possibly with Visual Studio) but\nDebugging Tools for Windows is not present, it can be installed from Add or\nremove programs→Windows Software Development Kit.\n\n### Android\n\nTo test on Android, [ADB (Android Debug\nBridge)](https://developer.android.com/studio/command-line/adb.html) from the\n[Android SDK](https://developer.android.com/sdk/) must be in the `PATH`. Note\nthat it is sufficient to install just the command-line tools from the Android\nSDK. The entire Android Studio IDE is not necessary to obtain ADB.\n\nWhen asked to test an Android build directory, `run_tests.py` will detect a\nsingle connected Android device (including an emulator). If multiple devices are\nconnected, one may be chosen explicitly with the `ANDROID_DEVICE` environment\nvariable. `run_tests.py` will upload test executables and data to a temporary\nlocation on the detected or selected device, run them, and clean up after itself\nwhen done.\n\n### Fuchsia\n\nTo test on Fuchsia, you need a connected device running Fuchsia. Run:\n\n```\n$ gn gen out/fuchsia --args 'target_os=\"fuchsia\" target_cpu=\"x64\" is_debug=true'\n$ ninja -C out/fuchsia\n$ python build/run_tests.py out/fuchsia\n```\n\nIf you have multiple devices running, you will need to specify which device you\nwant using their hostname, for instance:\n\n```\n$ ZIRCON_NODENAME=scare-brook-skip-dried python build/run_tests.py out/fuchsia\n```\n\n## Contributing\n\nCrashpad’s contribution process is very similar to [Chromium’s contribution\nprocess](https://chromium.googlesource.com/chromium/src/+/main/docs/contributing.md).\n\n### Code Review\n\nA code review must be conducted for every change to Crashpad’s source code. Code\nreview is conducted on [Chromium’s\nGerrit](https://chromium-review.googlesource.com/) system, and all code reviews\nmust be sent to an appropriate reviewer, with a Cc sent to\n[crashpad-dev](https://groups.google.com/a/chromium.org/group/crashpad-dev). The\n[`codereview.settings`](https://chromium.googlesource.com/crashpad/crashpad/+/main/codereview.settings)\nfile specifies this environment to `git-cl`.\n\n`git-cl` is part of the\n[depot_tools](https://www.chromium.org/developers/how-tos/depottools). There’s\nno need to install it separately.\n\n```\n$ cd ~/crashpad/crashpad\n$ git checkout -b work_branch origin/main\n…do some work…\n$ git add …\n$ git commit\n$ git cl upload\n```\n\nUploading a patch to Gerrit does not automatically request a review. You must\nselect a reviewer on the Gerrit review page after running `git cl upload`. This\naction notifies your reviewer of the code review request. If you have lost track\nof the review page, `git cl issue` will remind you of its URL. Alternatively,\nyou can request review when uploading to Gerrit by using `git cl upload\n--send-mail`.\n\nGit branches maintain their association with Gerrit reviews, so if you need to\nmake changes based on review feedback, you can do so on the correct Git branch,\ncommitting your changes locally with `git commit`. You can then upload a new\npatch set with `git cl upload` and let your reviewer know you’ve addressed the\nfeedback.\n\nThe most recently uploaded patch set on a review may be tested on a\n[trybot](https://chromium.googlesource.com/chromium/src/+/main/docs/infra/trybot_usage.md)\nby running `git cl try` or by clicking the “CQ Dry Run” button in Gerrit. These\nset the “Commit-Queue: +1” label. This does not mean that the patch will be\ncommitted, but the trybot and commit queue share infrastructure and a Gerrit\nlabel. The patch will be tested on trybots in a variety of configurations.\nStatus information will be available on Gerrit. Trybot access is available to\nCrashpad and Chromium committers.\n\n### Landing Changes\n\nAfter code review is complete and “Code-Review: +1” has been received from all\nreviewers, the patch can be submitted to Crashpad’s [commit\nqueue](https://chromium.googlesource.com/chromium/src/+/main/docs/infra/cq.md)\nby clicking the “Submit to CQ” button in Gerrit. This sets the “Commit-Queue:\n+2” label, which tests the patch on trybots before landing it. Commit queue\naccess is available to Crashpad and Chromium committers.\n\nAlthough the commit queue is recommended, if needed, project members can bypass\nthe commit queue and land patches without testing by using the “Submit” button\nin Gerrit or by committing via `git cl land`:\n\n```\n$ cd ~/crashpad/crashpad\n$ git checkout work_branch\n$ git cl land\n```\n\n### External Contributions\n\nCopyright holders must complete the [Individual Contributor License\nAgreement](https://cla.developers.google.com/about/google-individual) or\n[Corporate Contributor License\nAgreement](https://cla.developers.google.com/about/google-corporate) as\nappropriate before any submission can be accepted, and must be listed in the\n[`AUTHORS`](https://chromium.googlesource.com/crashpad/crashpad/+/main/AUTHORS)\nfile. Contributors may be listed in the\n[`CONTRIBUTORS`](https://chromium.googlesource.com/crashpad/crashpad/+/main/CONTRIBUTORS)\nfile.\n\n## Buildbot\n\nThe [Crashpad Buildbot](https://ci.chromium.org/p/crashpad/g/main/console)\nperforms automated builds and tests of Crashpad. Before checking out or updating\nthe Crashpad source code, and after checking in a new change, it is prudent to\ncheck the Buildbot to ensure that “the tree is green.”\n" }, { "path": "doc/ios_overview_design.md", "content": "\n\n# iOS Crashpad Overview Design\n\n[TOC]\n\n## iOS Limitations\n\nCrashpad on other platforms captures exceptions out-of-process. The iOS sandbox,\nhowever, restricts applications from delegating work to separate processes.\nThis limitation means Crashpad on iOS must combine the work of the handler and\nthe client into the same process as the main application.\n\n## The Crashpad In-Process Handler\n\nIn-process handling comes with a number of limitations and difficulties. It is\nnot possible to catch the specific Mach exception `EXC_CRASH`, so certain groups\nof crashes cannot be captured. This includes some major ones, like out-of-memory\ncrashes. This also introduces difficulties in capturing all the relevant crash\ndata and writing the minidump, as the process itself is in an unsafe state.\n\nWhile handling an exception, the handler may not, for example:\n\n - Allocate memory.\n - Use libc, or most any library call.\n\nWhile handling an exception, the handler may only:\n\n - Use audited syscalls.\n - access memory via `vm_read`.\n\nIn conjunction with Crashpad’s existing minidump writer and structural\nlimitations of the minidump format, it is not possible to write a minidump\nimmediately from the crash handler. Instead, an intermediate dump is written\nwhen a handler would normally write a minidump (such as during an exception or a\nforced dump without crashing). The intermediate dump file will be converted to\na minidump on the next run (or when the application decides it's safe to do so).\n\nDuring Crashpad initialization, the handler gathers basic system information\nand opens a pending intermediate dump adjacent to the Crashpad database.\n\n## The Crashpad IntermediateDump Format\n\nDue to the limitations of in-process handling, an intermediate dump file is\nwritten during exceptions. The data is streamed to a file, which will be used to\ngenerate a final minidump when appropriate.\n\nThe file format is similar to binary JSON, supporting keyed properties, maps and\narrays.\n\n - `Property` [key:int, length:int, value:intarray]\n - `StartMap` [key:int], followed by repeating Properties until `EndMap`\n - `StartArray` [key:int], followed by repeating Maps until `EndArray`\n - `EndMap`, `EndArray`, `EndDocument`\n\nSimilar to JSON, maps can contain other maps, arrays and properties.\n\n## The life of an iOS crash report\n\nImmediately upon calling StartCrashpadInProcessHandler, the iOS in-process\nhandler is installed. This will open a temporary file within the database\ndirectory, in a subdirectory named `pending-serialized-ios-dump`. This file will\nbe used to write an intermediate dump in the event of a crash. This must happen\nbefore installing the various types of crash handlers, as each depends on having\na valid handler with an intermediate dump ready to be written to.\n\nAfter the in-process handler is initialized, the Mach exception, POSIX signal\nand Objective-C exception preprocessor handlers are installed.\n\n### Intermediate Dump File Locking\n\nIt is expected that multiple Crashpad clients may share the same database\ndirectory, and this directory may be inside an iOS app group directory. While\nit's possible for each Crashpad client to write to its own private directory,\nif a shared directory is used, it's possible for different applications to\nupload a crash report from any application in a shared group. This might be\nused, for example, by an application and its various app extensions, where each\nclient may generate a crash report but only the main application uploads\nreports. Alternatively, a suite of applications may upload each other's crash\nreports. Otherwise, the only opportunity to upload a report would be when a\nspecific app that crashed relaunches.\n\nTo prevent multiple clients from processing a pending intermediate dump, files\nmust be locked. However, POSIX locks on app group files will trigger app\ntermination on app backgrounding, so a custom file locking protocol is used.\nLocked temporary files are named `@.locked`. The `.locked`\nextension is removed when the file is unlocked. The `bundle-id` is used to\ndetermine which Crashpad clients can process leftover locked files.\n\n### Writing Crashes to Intermediate Dumps\n\nWhen an app encounters a crash (via a Mach exception, Objective-C exception, or\na POSIX signal), an intermediate dump is written to the temporary locked file,\nthe .locked extension is removed, and a new temporary locked file is opened.\n\nApp terminations not handled by Crashpad will leave behind a temporary\nlocked file, to be cleaned up on next launch. These files are still processed,\nbecause it is possible for the app to be terminated while writing an\nintermediate dump, and if enough data is written this may still be valuable.\n\nNote: Generally iOS apps are single-process, so it's safe for the client to\nconsider any files matching its `bundle-id`, but there are edge-cases (such as\nif a share-to app extension is opened at the same time in two different apps) so\nold locked files won't be cleared until after 24 hours. Any locked file found\nafter 60 days is unlocked regardless of `bundle-id`.\n\n### Writing to Intermediate Dumps without a Crash\n\nApps may also generate intermediate dumps without a crash, often used for\ndebugging. Chromium makes heavy use of this for detecting main thread hangs,\nsomething that can appear as a crash for the user, but is uncatchable for crash\nhandlers like Crashpad. When an app requests this (via DumpWithoutCrash,\nDumpWithoutCrashAndDeferProcessing), an intermediate dump is written to the\ntemporary locked file, the .locked extension is removed, and a new temporary\nlocked file is opened.\n\nNote: DumpWithoutCrashAndDeferProcessingAtPath writes an intermediate dump to\nthe requested location, not the previously opened temporary file. This is useful\nbecause Chromium's main thread hang detection will throw away hang reports in\ncertain circumstances (if the app recovers, if a different crash report is\nwritten, etc).\n\n## The Crashpad In-Process Client\n\nOther Crashpad platforms handle exceptions and upload minidumps out-of-process.\nOn iOS, everything must happen in-process. Once started, the client will\nautomatically handle exceptions and capture the crashed process state in an\nintermediate dump file. Converting that intermediate dump file into a minidump\nis likely not safe to do from within a crashed process, and uploading a minidump\nis definitely unsafe to do at crash time. Applications are expected to process\nintermediate dumps into pending minidumps and begin processing pending\nminidumps, possibly for upload, at suitable times following the next application\nrestart.\n\nNote: Applications are not required to call either of these methods. For\nexample, application extensions may choose to generate dumps but leave\nprocessing and uploading to the main applications. Clients that share the\nsame database directory between apps can take advantage of processing and\nuploading crash reports from different applications.\n\n### `ProcessIntermediateDumps`\nFor performance and stability reasons applications may choose the correct time\nto convert intermediate dumps, as well as append metadata to the pending\nintermediate dumps. This is expected to happen during application startup, when\nsuitable. After converting, a minidump will be written to the Crashpad database,\nsimilar to how other platforms write a minidump on exception handling. If\nuploading is enabled, this minidump will also be immediately uploaded. New\nintermediate dumps generated by exceptions or by\n`CRASHPAD_SIMULATE_CRASH_AND_DEFER_PROCESSING` will not be processed until\nthe next call to `ProcessIntermediateDumps`. Conversely,\n`CRASHPAD_SIMULATE_CRASH` can be called when the client has no performance or\nstability concerns. In this case, intermediate dumps are automatically\nconverted to minidumps and immediately eligible for uploading.\n\nApplications can include annotations here as well. Chromium uses this for its\ninsta-crash logic, which detects if an app is crashing repeatedly on startup.\n\n### `StartProcessingPendingReports`\nFor similar reasons, applications may choose the correct time to begin uploading\npending reports, such as when ideal network conditions exist. By default,\nclients start with uploading disabled. Applications should call this API when\nit is determined that it is appropriate to do so (such as on a few seconds after\nstartup, or when network connectivity is appropriate).\n\n## tvOS considerations\n\ntvOS, an operating system based on iOS, shares the constraints described above\nand uses the same architecture. Additionally, tvOS does not allow the use of\nthe `mach_msg()` APIs so using Mach exceptions is impossible.\n\nConsequently, the Mach exception handler is _not_ installed once the in-process\nhandler is initialized; the tvOS handler only uses the POSIX signals and\nObjective-C exception preprocessors. Furthermore, the POSIX signal handler is\nunable to handle all crashes that the Mach exception handler can (e.g. stack\noverflows, as `sigaltstack()` cannot be used either). In other words, the tvOS\nin-process handler can only handle a subset of all exceptions that the iOS\nin-process handler does.\n" }, { "path": "doc/man.md", "content": "\n\n# Man Pages\n\n## Section 1: User Commands\n\n * [crashpad_database_util](../tools/crashpad_database_util.md)\n * [crashpad_http_upload](../tools/crashpad_http_upload.md)\n * [generate_dump](../tools/generate_dump.md)\n\n### macOS-Specific\n\n * [catch_exception_tool](../tools/mac/catch_exception_tool.md)\n * [exception_port_tool](../tools/mac/exception_port_tool.md)\n * [on_demand_service_tool](../tools/mac/on_demand_service_tool.md)\n * [run_with_crashpad](../tools/run_with_crashpad.md)\n\n## Section 8: Dӕmons\n\n * [crashpad_handler](../handler/crashpad_handler.md)\n" }, { "path": "doc/overview_design.md", "content": "\n\n# Crashpad Overview Design\n\n[TOC]\n\n## Objective\n\nCrashpad is a library for capturing, storing and transmitting postmortem crash\nreports from a client to an upstream collection server. Crashpad aims to make it\npossible for clients to capture process state at the time of crash with the best\npossible fidelity and coverage, with the minimum of fuss.\n\nCrashpad also provides a facility for clients to capture dumps of process state\non-demand for diagnostic purposes.\n\nCrashpad additionally provides minimal facilities for clients to adorn their\ncrashes with application-specific metadata in the form of per-process key/value\npairs. More sophisticated clients are able to adorn crash reports further\nthrough extensibility points that allow the embedder to augment the crash report\nwith application-specific metadata.\n\n## Background\n\nIt’s an unfortunate truth that any large piece of software will contain bugs\nthat will cause it to occasionally crash. Even in the absence of bugs, software\nincompatibilities can cause program instability.\n\nFixing bugs and incompatibilities in client software that ships to millions of\nusers around the world is a daunting task. User reports and manual reproduction\nof crashes can work, but even given a user report, often times the problem is\nnot readily reproducible. This is for various reasons, such as e.g. system\nversion or third-party software incompatibility, or the problem can happen due\nto a race of some sort. Users are also unlikely to report problems they\nencounter, and user reports are often of poor quality, as unfortunately most\nusers don’t have experience with making good bug reports.\n\nAutomatic crash telemetry has been the best solution to the problem so far, as\nthis relieves the burden of manual reporting from users, while capturing the\nhardware and software state at the time of crash.\n\nTODO(siggi): examples of this?\n\nCrash telemetry involves capturing postmortem crash dumps and transmitting them\nto a backend collection server. On the server they can be stackwalked and\nsymbolized, and evaluated and aggregated in various ways. Stackwalking and\nsymbolizing the reports on an upstream server has several benefits over\nperforming these tasks on the client. High-fidelity stackwalking requires access\nto bulky unwind data, and it may be desirable to not ship this to end users out\nof concern for the application size. The process of symbolization requires\naccess to debugging symbols, which can be quite large, and the symbolization\nprocess can consume considerable other resources. Transmitting un-stackwalked\nand un-symbolized postmortem dumps to the collection server also allows deep\nanalysis of individual dumps, which is often necessary to resolve the bug\ncausing the crash.\n\nTransmitting reports to the collection server allows aggregating crashes by\ncause, which in turn allows assessing the importance of different crashes in\nterms of the occurrence rate and e.g. the potential security impact.\n\nA postmortem crash dump must contain the program state at the time of crash\nwith sufficient fidelity to allow diagnosing and fixing the problem. As the full\nprogram state is usually too large to transmit to an upstream server, the\npostmortem dump captures a heuristic subset of the full state.\n\nThe crashed program is in an indeterminate state and, in fact, has often crashed\nbecause of corrupt global state - such as heap. It’s therefore important to\ngenerate crash reports with as little execution in the crashed process as\npossible. Different operating systems vary in the facilities they provide for\nthis.\n\n## Overview\n\nCrashpad is a client-side library that focuses on capturing machine and program\nstate in a postmortem crash report, and transmitting this report to a backend\nserver - a “collection server”. The Crashpad library is embedded by the client\napplication. Conceptually, Crashpad breaks down into the handler and the client.\nThe handler runs in a separate process from the client or clients. It is\nresponsible for snapshotting the crashing client process’ state on a crash,\nsaving it to a crash dump, and transmitting the crash dump to an upstream\nserver. Clients register with the handler to allow it to capture and upload\ntheir crashes. On iOS, there is no separate process for the handler.\n[This is a limitation of iOS.](ios_overview_design.md#ios-limitations)\n\n### The Crashpad handler\n\nThe Crashpad handler is instantiated in a process supplied by the embedding\napplication. It provides means for clients to register themselves by some means\nof IPC, or where operating system support is available, by taking advantage of\nsuch support to cause crash notifications to be delivered to the handler. On\ncrash, the handler snapshots the crashed client process’ state, writes it to a\npostmortem dump in a database, and may also transmit the dump to an upstream\nserver if so configured.\n\nThe Crashpad handler is able to handle cross-bitted requests and generate crash\ndumps across bitness, where e.g. the handler is a 64-bit process while the\nclient is a 32-bit process or vice versa. In the case of Windows, this is\nlimited by the OS such that a 32-bit handler can only generate crash dumps for\n32-bit clients, but a 64-bit handler can acquire nearly all of the detail for a\n32-bit process.\n\n### The Crashpad client\n\nThe Crashpad client provides two main facilities.\n1. Registration with the Crashpad handler.\n2. Metadata communication to the Crashpad handler on crash.\n\nA Crashpad embedder links the Crashpad client library into one or more\nexecutables, whether a loadable library or a program file. The client process\nthen registers with the Crashpad handler through some mode of IPC or other\noperating system-specific support.\n\nOn crash, metadata is communicated to the Crashpad handler via the CrashpadInfo\nstructure. Each client executable module linking the Crashpad client library\nembeds a CrashpadInfo structure, which can be updated by the client with\nwhatever state the client wishes to record with a crash.\n\n![Overview image](overview.png)\n\nHere is an overview picture of the conceptual relationships between embedder (in\nlight blue), client modules (darker blue), and Crashpad (in green). Note that\nmultiple client modules can contain a CrashpadInfo structure, but only one\nregistration is necessary.\n\n## Detailed Design\n\n### Requirements\n\nThe purpose of Crashpad is to capture machine, OS and application state in\nsufficient detail and fidelity to allow developers to diagnose and, where\npossible, fix the issue causing the crash.\n\nEach distinct crash report is assigned a globally unique ID, in order to allow\nusers to associate them with a user report, report in bug reports and so on.\n\nIt’s critical to safeguard the user’s privacy by ensuring that no crash report\nis ever uploaded without user consent. Likewise it’s important to ensure that\nCrashpad never captures or uploads reports from non-client processes.\n\n### Concepts\n\n* **Client ID**. A UUID tied to a single instance of a Crashpad database. When\n creating a crash report, the Crashpad handler includes the client ID stored\n in the database. This provides a means to determine how many individual end\n users are affected by a specific crash signature.\n\n* **Crash ID**. A UUID representing a single crash report. Uploaded crash\n reports also receive a “server ID.” The Crashpad database indexes both the\n locally-generated and server-generated IDs.\n\n* **Collection Server**. See [crash server documentation.](\n https://goto.google.com/crash-server-overview)\n\n* **Client Process**. Any process that has registered with a Crashpad handler.\n\n* **Handler process**. A process hosting the Crashpad handler library. This may\n be a dedicated executable, or it may be hosted within a client executable\n with control passed to it based on special signaling under the client’s\n control, such as a command-line parameter.\n\n* **CrashpadInfo**. A structure used by client modules to provide information to\n the handler.\n\n* **Annotations**. Each CrashpadInfo structure points to a dictionary of\n {string, string} annotations that the client can use to communicate\n application state in the case of crash.\n\n* **Database**. The Crashpad database contains persistent client settings as\n well as crash dumps pending upload.\n\nTODO(siggi): moar concepts?\n\n### Overview Picture\n\nHere is a rough overview picture of the various Crashpad constructs, their\nlayering and intended use by clients.\n\n![Layering image](layering.png)\n\nDark blue boxes are interfaces, light blue boxes are implementation. Gray is the\nembedding client application. Note that wherever possible, implementation that\nnecessarily has to be OS-specific, exposes OS-agnostic interfaces to the rest of\nCrashpad and the client.\n\n### Registration\n\nThe particulars of how a client registers with the handler varies across\noperating systems.\n\n#### macOS\n\nAt registration time, the client designates a Mach port monitored by the\nCrashpad handler as the EXC_CRASH exception port for the client. The port may be\nacquired by launching a new handler process or by retrieving service already\nregistered with the system. The registration is maintained by the kernel and is\ninherited by subprocesses at creation time by default, so only the topmost\nprocess of a process tree need register.\n\nCrashpad provides a facility for a process to disassociate (unregister) with an\nexisting crash handler, which can be necessary when an older client spawns an\nupdated version.\n\n#### iOS\n\niOS registers both a signal handler for `SIGABRT` and a Mach exception handler\nwith a subset of available exceptions. [This is a limitation of\niOS.](ios_overview_design.md#ios-limitations)\n\n#### Windows\n\nThere are two modes of registration on Windows. In both cases the handler is\nadvised of the address of a set of structures in the client process’ address\nspace. These structures include a pair of ExceptionInformation structs, one for\ngenerating a postmortem dump for a crashing process, and another one for\ngenerating a dump for a non- crashing process.\n\n##### Normal registration\n\nIn the normal registration mode, the client connects to a named pipe by a\npre-arranged name. A registration request is written to the pipe. During\nregistration, the handler creates a set of events, duplicates them to the\nregistering client, then returns the handle values in the registration response.\nThis is a blocking process.\n\n##### Initial Handler Creation\n\nIn order to avoid blocking client startup for the creation and initialization of\nthe handler, a different mode of registration can be used for the handler\ncreation. In this mode, the client creates a set of event handles and inherits\nthem into the newly created handler process. The handler process is advised of\nthe handle values and the location of the ExceptionInformation structures by way\nof command line arguments in this mode.\n\n#### Linux/Android\n\nOn Linux, a registration is a connected socket pair between a client process and\nthe Crashpad handler. This socket pair may be private or shared among many\nclient processes.\n\n##### Private Connections\n\nPrivate connections are the default registration mode when starting the handler\nprocess in response to a crash or on behalf of another client. This mode is\nrequired to use a ptrace broker, which is in turn required to trace Android\nisolated processes.\n\n##### Shared Connections\n\nShared connections are the default mode when using a long-lived handler. The\nsame connected socket pair may be shared among any number of clients. The socket\npair is created by the first process to start the handler at which point the\nclient socket end may be shared with other clients by any convenient means (e.g.\ninheritance).\n\n### Capturing Exceptions\n\nThe details of how Crashpad captures the exceptions leading to crashes varies\nbetween operating systems.\n\n#### macOS\n\nOn macOS, the operating system will notify the handler of client crashes via the\nMach port set as the client process’ exception port. As exceptions are\ndispatched to the Mach port by the kernel, on macOS, exceptions can be handled\nentirely from the Crashpad handler without the need to run any code in the crash\nprocess at the time of the exception.\n\n#### iOS\n\nOn iOS, the operating system will notify the handler of crashes via the Mach\nexception port or the signal handler. As exceptions are handled in-process, an\nintermediate dump file is generated rather than a minidump. See more\ninformation about the [iOS in-process\nhandler.](ios_overview_design.md#ios-in-process-handler)\n\n#### Windows\n\nOn Windows, the OS dispatches exceptions in the context of the crashing thread.\nTo notify the handler of exceptions, the Crashpad client registers an\nUnhandledExceptionFilter (UEF) in the client process. When an exception trickles\nup to the UEF, it stores the exception information and the crashing thread’s ID\nin the ExceptionInformation structure registered with the handler. It then sets\nan event handle to signal the handler to go ahead and process the exception.\n\n##### Caveats\n\n* If the crashing thread’s stack is smashed when an exception occurs, the\n exception cannot be dispatched. In this case the OS will summarily terminate\n the process, without the handler having an opportunity to generate a crash\n report.\n* If an exception is handled in the crashing thread, it will never propagate\n to the UEF, and thus a crash report won’t be generated. This happens a fair\n bit in Windows as system libraries will often dispatch callbacks under a\n structured exception handler. This occurs during Window message dispatching\n on some system configurations, as well as during e.g. DLL entry point\n notifications.\n* A growing number of conditions in the system and runtime exist where\n detected corruption or illegal calls result in summary termination of the\n process, in which case no crash report will be generated.\n\n###### Out-Of-Process Exception Handling\n\nThere exists a mechanism in Windows Error Reporting (WER) that allows a client\nprocess to register for handling client exceptions out of the crashing process.\nUnfortunately this mechanism is difficult to use, and doesn’t provide coverage\nfor many of the caveats above. [Details\nhere.](https://crashpad.chromium.org/bug/133)\n\n#### Linux/Android\n\nOn Linux, exceptions are dispatched as signals to the crashing thread. Crashpad\nsignal handlers will send a message over the socket to the Crashpad handler\nnotifying it of the crash and the location of exception information to be read\nfrom the crashing process. When using a shared socket connection, communication\nis entirely one-way. The client sends its dump request to the handler and then\nwaits until the handler responds with a SIGCONT or a timeout occurs. When using\na private socket connection, the handler may respond over the socket to\ncommunicate with a ptrace broker process. The broker is forked from the crashing\nprocess, executes ptrace requests against the crashing process, and sends the\ninformation over the socket to the handler.\n\n### The CrashpadInfo structure\n\nThe CrashpadInfo structure is used to communicate information from the client to\nthe handler. Each executable module in a client process can contain a\nCrashpadInfo structure. On a crash, the handler crawls all modules in the\ncrashing process to locate all CrashpadInfo structures present. The CrashpadInfo\nstructures are linked into a special, named section of the executable, where the\nhandler can readily find them.\n\nThe CrashpadInfo structure has a magic signature, and contains a size and a\nversion field. The intent is to allow backwards compatibility from older client\nmodules to newer handler. It may also be necessary to provide forwards\ncompatibility from newer clients to older handler, though this hasn’t occurred\nyet.\n\nThe CrashpadInfo structure contains such properties as the cap for how much\nmemory to include in the crash dump, some tristate flags for controlling the\nhandler’s behavior, a pointer to an annotation dictionary and so on.\n\n### Snapshot\n\nSnapshot is a layer of interfaces that represent the machine and OS entities\nthat Crashpad cares about. Different concrete implementations of snapshot can\nthen be backed different ways, such as e.g. from the in-memory representation of\na crashed process, or e.g. from the contents of a minidump.\n\n### Crash Dump Creation\n\nTo create a crash dump, a subset of the machine, OS and application state is\ngrabbed from the crashed process into an in-memory snapshot structure in the\nhandler process. Since the full application state is typically too large for\ncapturing to disk and transmitting to an upstream server, the snapshot contains\na heuristically selected subset of the full state.\n\nThe precise details of what’s captured varies between operating systems, but\ngenerally includes the following\n* The set of modules (executable, shared libraries) that are loaded into the\n crashing process.\n* An enumeration of the threads running in the crashing process, including the\n register contents and the contents of stack memory of each thread.\n* A selection of the OS-related state of the process, such as e.g. the command\n line, environment and so on.\n* A selection of memory potentially referenced from registers and from stack.\n\nTo capture a crash dump, the crashing process is first suspended, then a\nsnapshot is created in the handler process. The snapshot includes the\nCrashpadInfo structures of the modules loaded into the process, and the contents\nof those is used to control the level of detail captured for the crash dump.\n\nOnce the snapshot has been constructed, it is then written to a minidump file,\nwhich is added to the database. The process is un-suspended after the minidump\nfile has been written. In the case of a crash (as opposed to a client request to\nproduce a dump without crashing), it is then either killed by the operating\nsystem or the Crashpad handler.\n\nIn general the snapshotting process has to be very intimate with the operating\nsystem it’s working with, so there will be a set of concrete implementation\nclasses, many deriving from the snapshot interfaces, doing this for each\noperating system.\n\n### Minidump\n\nThe minidump implementation is responsible for writing a snapshot to a\nserialized on-disk file in the minidump format. The minidump implementation is\nOS-agnostic, as it works on an OS-agnostic Snapshot interface.\n\nTODO(siggi): Talk about two-phase writes and contents ordering here.\n\n### Database\n\nThe Crashpad database contains persistent client settings, including a unique\ncrash client identifier and the upload-enabled bit. Note that the crash client\nidentifier is assigned by Crashpad, and is distinct from any identifiers the\nclient application uses to identify users, installs, machines or such - if any.\nThe expectation is that the client application will manage the user’s upload\nconsent, and inform Crashpad of changes in consent.\n\nThe unique client identifier is set at the time of database creation. It is then\nrecorded into every crash report collected by the handler and communicated to\nthe upstream server.\n\nThe database stores a configurable number of recorded crash dumps to a\nconfigurable maximum aggregate size. For each crash dump it stores annotations\nrelating to whether the crash dumps have been uploaded. For successfully\nuploaded crash dumps it also stores their server-assigned ID.\n\nThe database consists of a settings file, named \"settings.dat\" with binary\ncontents (see crashpad::Settings::Data for the file format), as well as\ndirectory containing the crash dumps. Additionally each crash dump is adorned\nwith properties relating to the state of the dump for upload and such. The\ndetails of how these properties are stored vary between platforms.\n\n#### macOS\n\nThe macOS implementation simply stores database properties on the minidump files\nin filesystem extended attributes.\n\n#### iOS\n\nThe iOS implementation also stores database properties of minidump files in\nfilesystem extended attributes. Separate from the database, iOS also stores its\nintermediate dump files adjacent to the database. See more information about\n[iOS intermediate\ndumps.](ios_overview_design.md#the-crashpad-intermediatedump-format)\n\n#### Windows\n\nThe Windows implementation stores database properties in a binary file named\n“metadata” at the top level of the database directory.\n\n### Report Format\n\nCrash reports are recorded in the Windows minidump format with\nextensions to support Crashpad additions, such as e.g. Annotations.\n\n### Upload to collection server\n\n#### Wire Format\n\nFor the time being, Crashpad uses the Breakpad wire protocol, which is\nessentially a MIME multipart message communicated over HTTP(S). To support this,\nthe annotations from all the CrashpadInfo structures found in the crashing\nprocess are merged to create the Breakpad “crash keys” as form data. The\npostmortem minidump is then attached as an “application/octet- stream”\nattachment with the name “upload_file_minidump”. The entirety of the request\nbody, including the minidump, can be gzip-compressed to reduce transmission time\nand increase transmission reliability. Note that by convention there is a set of\n“crash keys” that are used to communicate the product, version, client ID and\nother relevant data about the client, to the server. Crashpad normally stores\nthese values in the minidump file itself, but retrieves them from the minidump\nand supplies them as form data for compatibility with the Breakpad-style server.\n\nThis is a temporary compatibility measure to allow the current Breakpad-based\nupstream server to handle Crashpad reports. In the fullness of time, the wire\nprotocol is expected to change to remove this redundant transmission and\nprocessing of the Annotations.\n\n#### Transport\n\nThe embedding client controls the URL of the collection server by the command\nline passed to the handler. The handler can upload crashes with HTTP or HTTPS,\ndepending on client’s preference. It’s strongly suggested use HTTPS transport\nfor crash uploads to protect the user’s privacy against man-in-the-middle\nsnoopers.\n\nTODO(mmentovai): Certificate pinning.\n\n#### Throttling & Retry Strategy\n\nTo protect both the collection server from DDoS as well as to protect the\nclients from unreasonable data transfer demands, the handler implements a\nclient-side throttling strategy. At the moment, the strategy is very simplistic,\nit simply limits uploads to one upload per hour, and failed uploads are aborted.\n\nAn experiment has been conducted to lift all throttling. Analysis on the\naggregate data this produced shows that multiple crashes within a short timespan\non the same client are nearly always due to the same cause. Therefore there is\nvery little loss of signal due to the throttling, though the ability to\nreconstruct at least the full crash count is highly desirable.\n\nThe lack of retry is expected to [change\nsoon](https://crashpad.chromium.org/bug/23), as this creates blind spots for\nclient crashes that exclusively occur on e.g. network down events, during\nsuspend and resume and such.\n\n### Extensibility\n\n#### Client Extensibility\n\nClients are able to extend the generated crash reports in two ways, by\nmanipulating their CrashpadInfo structure.\nThe two extensibility points are:\n1. Nominating a set of address ranges for inclusion in the crash report.\n2. Adding user-defined minidump streams for inclusion in the crash report.\n\nIn both cases the CrashpadInfo structure has to be updated before a crash\noccurs.\n\n##### Embedder Extensibility\n\nAdditionally, embedders of the handler can provide \"user stream data source\"\ninstances to the handler's main function. Any time a minidump is written, these\ninstances get called.\n\nEach data source may contribute a custom stream to the minidump, which can be\ncomputed from e.g. system or application state relevant to the crash.\n\nAs a case in point, it can be handy to know whether the system was under memory\nor other resource duress at the time of crash.\n\n### Dependencies\n\nAside from system headers and APIs, when used outside of Chromium, Crashpad has\na dependency on “mini_chromium”, which is a subset of the Chromium base library.\nThis is to allow non-Chromium clients to use Crashpad, without taking a direct\ndependency on the Chromium base, while allowing Chromium projects to use\nCrashpad with minimum code duplication or hassle. When using Crashpad as part of\nChromium, Chromium’s own copy of the base library is used instead of\nmini_chromium.\n\nThe downside to this is that mini_chromium must be kept up to date with\ninterface and implementation changes in Chromium base, for the subset of\nfunctionality used by Crashpad.\n\n## Caveats\n\nTODO(anyone): You may need to describe what you did not do or why simpler\napproaches don't work. Mention other things to watch out for (if any).\n\n## Security Considerations\n\nCrashpad may be used to capture the state of sandboxed processes and it writes\nminidumps to disk. It may therefore straddle security boundaries, so it’s\nimportant that Crashpad handle all data it reads out of the crashed process with\nextreme care. The Crashpad handler takes care to access client address spaces\nthrough specially-designed accessors that check pointer validity and enforce\naccesses within prescribed bounds. The flow of information into the Crashpad\nhandler is exclusively one-way: Crashpad never communicates anything back to\nits clients, aside from providing single-bit indications of completion.\n\n## Privacy Considerations\n\nCrashpad may capture arbitrary contents from crashed process’ memory, including\nuser IDs and passwords, credit card information, URLs and whatever other content\nusers have trusted the crashing program with. The client program must acquire\nand honor the user’s consent to upload crash reports, and appropriately manage\nthe upload state in Crashpad’s database.\n\nCrashpad must also be careful not to upload crashes for arbitrary processes on\nthe user’s system. To this end, Crashpad will never upload a process that hasn’t\nregistered with the handler, but note that registrations are inherited by child\nprocesses on some operating systems.\n" }, { "path": "doc/status.md", "content": "\n\n# Project Status\n\n## Completed\n\nCrashpad has complete crash-reporting clients and some related tools for macOS,\nWindows, Fuchsia, and Linux (including Android and Chromium OS). Crashpad became\nthe crash reporter client for [Chromium](https://www.chromium.org/Home) on macOS\nas of [March\n2015](https://chromium.googlesource.com/chromium/src/\\+/d413b2dcb54d523811d386f1ff4084f677a6d089),\nWindows as of [November\n2015](https://chromium.googlesource.com/chromium/src/\\+/cfa5b01bb1d06bf96967bd37e21a44752801948c),\nand Android as of [January\n2019](https://chromium.googlesource.com/chromium/src/+/f890e4b5495ab693d2d37aec3c378239946154f7).\n\n\n## In Progress\n\nChromium is transitioning to Crashpad for [Chromium OS and Desktop\nLinux](https://crbug.com/942279).\n\nWork has begun on a Crashpad client for\n[iOS](https://crashpad.chromium.org/bug/31).\n\n## Future\n\nThere are also plans to implement a [crash report\nprocessor](https://crashpad.chromium.org/bug/29) as part of Crashpad. No\ntimeline for completing this work has been set yet.\n" }, { "path": "doc/support/compat.sh", "content": "# Copyright 2015 The Crashpad Authors\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n\nif [[ \"${BASH_SOURCE[0]}\" = \"${0}\" ]]; then\n echo \"${0}: this file must be sourced, not run directly\" >& 2\n exit 1\nfi\n\n# Some extensions of command-line tools behave differently on different systems.\n# $sed_ext should be a sed invocation that enables extended regular expressions.\n# $date_time_t should be a date invocation that causes it to print the date and\n# time corresponding to a time_t string that immediately follows it.\ncase \"$(uname -s)\" in\n Darwin)\n sed_ext=\"sed -E\"\n date_time_t=\"date -r\"\n ;;\n Linux)\n sed_ext=\"sed -r\"\n date_time_t=\"date -d@\"\n ;;\n *)\n echo \"${0}: unknown operating system\" >& 2\n exit 1\n ;;\nesac\n" }, { "path": "doc/support/crashpad.doxy", "content": "# Doxyfile 1.13.2\n\n# This file describes the settings to be used by the documentation system\n# Doxygen (www.doxygen.org) for a project.\n#\n# All text after a double hash (##) is considered a comment and is placed in\n# front of the TAG it is preceding.\n#\n# All text after a single hash (#) is considered a comment and will be ignored.\n# The format is:\n# TAG = value [value, ...]\n# For lists, items can also be appended using:\n# TAG += value [value, ...]\n# Values that contain spaces should be placed between quotes (\\\" \\\").\n#\n# Note:\n#\n# Use Doxygen to compare the used configuration file with the template\n# configuration file:\n# doxygen -x [configFile]\n# Use Doxygen to compare the used configuration file with the template\n# configuration file without replacing the environment variables or CMake type\n# replacement variables:\n# doxygen -x_noenv [configFile]\n\n#---------------------------------------------------------------------------\n# Project related configuration options\n#---------------------------------------------------------------------------\n\n# This tag specifies the encoding used for all characters in the configuration\n# file that follow. The default is UTF-8 which is also the encoding used for all\n# text before the first occurrence of this tag. Doxygen uses libiconv (or the\n# iconv built into libc) for the transcoding. See\n# https://www.gnu.org/software/libiconv/ for the list of possible encodings.\n# The default value is: UTF-8.\n\nDOXYFILE_ENCODING = UTF-8\n\n# The PROJECT_NAME tag is a single word (or a sequence of words surrounded by\n# double-quotes, unless you are using Doxywizard) that should identify the\n# project for which the documentation is generated. This name is used in the\n# title of most generated pages and in a few other places.\n# The default value is: My Project.\n\nPROJECT_NAME = Crashpad\n\n# The PROJECT_NUMBER tag can be used to enter a project or revision number. This\n# could be handy for archiving the generated documentation or if some version\n# control system is used.\n\nPROJECT_NUMBER =\n\n# Using the PROJECT_BRIEF tag one can provide an optional one line description\n# for a project that appears at the top of each page and should give viewers a\n# quick idea about the purpose of the project. Keep the description short.\n\nPROJECT_BRIEF =\n\n# With the PROJECT_LOGO tag one can specify a logo or an icon that is included\n# in the documentation. The maximum height of the logo should not exceed 55\n# pixels and the maximum width should not exceed 200 pixels. Doxygen will copy\n# the logo to the output directory.\n\nPROJECT_LOGO =\n\n# With the PROJECT_ICON tag one can specify an icon that is included in the tabs\n# when the HTML document is shown. Doxygen will copy the logo to the output\n# directory.\n\nPROJECT_ICON =\n\n# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path\n# into which the generated documentation will be written. If a relative path is\n# entered, it will be relative to the location where Doxygen was started. If\n# left blank the current directory will be used.\n\nOUTPUT_DIRECTORY = out/doc/doxygen\n\n# If the CREATE_SUBDIRS tag is set to YES then Doxygen will create up to 4096\n# sub-directories (in 2 levels) under the output directory of each output format\n# and will distribute the generated files over these directories. Enabling this\n# option can be useful when feeding Doxygen a huge amount of source files, where\n# putting all generated files in the same directory would otherwise cause\n# performance problems for the file system. Adapt CREATE_SUBDIRS_LEVEL to\n# control the number of sub-directories.\n# The default value is: NO.\n\nCREATE_SUBDIRS = NO\n\n# Controls the number of sub-directories that will be created when\n# CREATE_SUBDIRS tag is set to YES. Level 0 represents 16 directories, and every\n# level increment doubles the number of directories, resulting in 4096\n# directories at level 8 which is the default and also the maximum value. The\n# sub-directories are organized in 2 levels, the first level always has a fixed\n# number of 16 directories.\n# Minimum value: 0, maximum value: 8, default value: 8.\n# This tag requires that the tag CREATE_SUBDIRS is set to YES.\n\nCREATE_SUBDIRS_LEVEL = 8\n\n# If the ALLOW_UNICODE_NAMES tag is set to YES, Doxygen will allow non-ASCII\n# characters to appear in the names of generated files. If set to NO, non-ASCII\n# characters will be escaped, for example _xE3_x81_x84 will be used for Unicode\n# U+3044.\n# The default value is: NO.\n\nALLOW_UNICODE_NAMES = NO\n\n# The OUTPUT_LANGUAGE tag is used to specify the language in which all\n# documentation generated by Doxygen is written. Doxygen will use this\n# information to generate all constant output in the proper language.\n# Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Bulgarian,\n# Catalan, Chinese, Chinese-Traditional, Croatian, Czech, Danish, Dutch, English\n# (United States), Esperanto, Farsi (Persian), Finnish, French, German, Greek,\n# Hindi, Hungarian, Indonesian, Italian, Japanese, Japanese-en (Japanese with\n# English messages), Korean, Korean-en (Korean with English messages), Latvian,\n# Lithuanian, Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese,\n# Romanian, Russian, Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish,\n# Swedish, Turkish, Ukrainian and Vietnamese.\n# The default value is: English.\n\nOUTPUT_LANGUAGE = English\n\n# If the BRIEF_MEMBER_DESC tag is set to YES, Doxygen will include brief member\n# descriptions after the members that are listed in the file and class\n# documentation (similar to Javadoc). Set to NO to disable this.\n# The default value is: YES.\n\nBRIEF_MEMBER_DESC = YES\n\n# If the REPEAT_BRIEF tag is set to YES, Doxygen will prepend the brief\n# description of a member or function before the detailed description\n#\n# Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the\n# brief descriptions will be completely suppressed.\n# The default value is: YES.\n\nREPEAT_BRIEF = YES\n\n# This tag implements a quasi-intelligent brief description abbreviator that is\n# used to form the text in various listings. Each string in this list, if found\n# as the leading text of the brief description, will be stripped from the text\n# and the result, after processing the whole list, is used as the annotated\n# text. Otherwise, the brief description is used as-is. If left blank, the\n# following values are used ($name is automatically replaced with the name of\n# the entity):The $name class, The $name widget, The $name file, is, provides,\n# specifies, contains, represents, a, an and the.\n\nABBREVIATE_BRIEF =\n\n# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then\n# Doxygen will generate a detailed section even if there is only a brief\n# description.\n# The default value is: NO.\n\nALWAYS_DETAILED_SEC = NO\n\n# If the INLINE_INHERITED_MEMB tag is set to YES, Doxygen will show all\n# inherited members of a class in the documentation of that class as if those\n# members were ordinary class members. Constructors, destructors and assignment\n# operators of the base classes will not be shown.\n# The default value is: NO.\n\nINLINE_INHERITED_MEMB = NO\n\n# If the FULL_PATH_NAMES tag is set to YES, Doxygen will prepend the full path\n# before files name in the file list and in the header files. If set to NO the\n# shortest path that makes the file name unique will be used\n# The default value is: YES.\n\nFULL_PATH_NAMES = YES\n\n# The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path.\n# Stripping is only done if one of the specified strings matches the left-hand\n# part of the path. The tag can be used to show relative paths in the file list.\n# If left blank the directory from which Doxygen is run is used as the path to\n# strip.\n#\n# Note that you can specify absolute paths here, but also relative paths, which\n# will be relative from the directory where Doxygen is started.\n# This tag requires that the tag FULL_PATH_NAMES is set to YES.\n\nSTRIP_FROM_PATH =\n\n# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the\n# path mentioned in the documentation of a class, which tells the reader which\n# header file to include in order to use a class. If left blank only the name of\n# the header file containing the class definition is used. Otherwise one should\n# specify the list of include paths that are normally passed to the compiler\n# using the -I flag.\n\nSTRIP_FROM_INC_PATH = . \\\n compat/non_mac \\\n compat/non_win\n\n# If the SHORT_NAMES tag is set to YES, Doxygen will generate much shorter (but\n# less readable) file names. This can be useful if your file system doesn't\n# support long names like on DOS, Mac, or CD-ROM.\n# The default value is: NO.\n\nSHORT_NAMES = NO\n\n# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen will interpret the\n# first line (until the first dot, question mark or exclamation mark) of a\n# Javadoc-style comment as the brief description. If set to NO, the Javadoc-\n# style will behave just like regular Qt-style comments (thus requiring an\n# explicit @brief command for a brief description.)\n# The default value is: NO.\n\nJAVADOC_AUTOBRIEF = NO\n\n# If the JAVADOC_BANNER tag is set to YES then Doxygen will interpret a line\n# such as\n# /***************\n# as being the beginning of a Javadoc-style comment \"banner\". If set to NO, the\n# Javadoc-style will behave just like regular comments and it will not be\n# interpreted by Doxygen.\n# The default value is: NO.\n\nJAVADOC_BANNER = NO\n\n# If the QT_AUTOBRIEF tag is set to YES then Doxygen will interpret the first\n# line (until the first dot, question mark or exclamation mark) of a Qt-style\n# comment as the brief description. If set to NO, the Qt-style will behave just\n# like regular Qt-style comments (thus requiring an explicit \\brief command for\n# a brief description.)\n# The default value is: NO.\n\nQT_AUTOBRIEF = NO\n\n# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen treat a\n# multi-line C++ special comment block (i.e. a block of //! or /// comments) as\n# a brief description. This used to be the default behavior. The new default is\n# to treat a multi-line C++ comment block as a detailed description. Set this\n# tag to YES if you prefer the old behavior instead.\n#\n# Note that setting this tag to YES also means that rational rose comments are\n# not recognized any more.\n# The default value is: NO.\n\nMULTILINE_CPP_IS_BRIEF = NO\n\n# By default Python docstrings are displayed as preformatted text and Doxygen's\n# special commands cannot be used. By setting PYTHON_DOCSTRING to NO the\n# Doxygen's special commands can be used and the contents of the docstring\n# documentation blocks is shown as Doxygen documentation.\n# The default value is: YES.\n\nPYTHON_DOCSTRING = YES\n\n# If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the\n# documentation from any documented member that it re-implements.\n# The default value is: YES.\n\nINHERIT_DOCS = YES\n\n# If the SEPARATE_MEMBER_PAGES tag is set to YES then Doxygen will produce a new\n# page for each member. If set to NO, the documentation of a member will be part\n# of the file/class/namespace that contains it.\n# The default value is: NO.\n\nSEPARATE_MEMBER_PAGES = NO\n\n# The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen\n# uses this value to replace tabs by spaces in code fragments.\n# Minimum value: 1, maximum value: 16, default value: 4.\n\nTAB_SIZE = 4\n\n# This tag can be used to specify a number of aliases that act as commands in\n# the documentation. An alias has the form:\n# name=value\n# For example adding\n# \"sideeffect=@par Side Effects:^^\"\n# will allow you to put the command \\sideeffect (or @sideeffect) in the\n# documentation, which will result in a user-defined paragraph with heading\n# \"Side Effects:\". Note that you cannot put \\n's in the value part of an alias\n# to insert newlines (in the resulting output). You can put ^^ in the value part\n# of an alias to insert a newline as if a physical newline was in the original\n# file. When you need a literal { or } or , in the value part of an alias you\n# have to escape them by means of a backslash (\\), this can lead to conflicts\n# with the commands \\{ and \\} for these it is advised to use the version @{ and\n# @} or use a double escape (\\\\{ and \\\\})\n\nALIASES =\n\n# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources\n# only. Doxygen will then generate output that is more tailored for C. For\n# instance, some of the names that are used will be different. The list of all\n# members will be omitted, etc.\n# The default value is: NO.\n\nOPTIMIZE_OUTPUT_FOR_C = NO\n\n# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or\n# Python sources only. Doxygen will then generate output that is more tailored\n# for that language. For instance, namespaces will be presented as packages,\n# qualified scopes will look different, etc.\n# The default value is: NO.\n\nOPTIMIZE_OUTPUT_JAVA = NO\n\n# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran\n# sources. Doxygen will then generate output that is tailored for Fortran.\n# The default value is: NO.\n\nOPTIMIZE_FOR_FORTRAN = NO\n\n# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL\n# sources. Doxygen will then generate output that is tailored for VHDL.\n# The default value is: NO.\n\nOPTIMIZE_OUTPUT_VHDL = NO\n\n# Set the OPTIMIZE_OUTPUT_SLICE tag to YES if your project consists of Slice\n# sources only. Doxygen will then generate output that is more tailored for that\n# language. For instance, namespaces will be presented as modules, types will be\n# separated into more groups, etc.\n# The default value is: NO.\n\nOPTIMIZE_OUTPUT_SLICE = NO\n\n# Doxygen selects the parser to use depending on the extension of the files it\n# parses. With this tag you can assign which parser to use for a given\n# extension. Doxygen has a built-in mapping, but you can override or extend it\n# using this tag. The format is ext=language, where ext is a file extension, and\n# language is one of the parsers supported by Doxygen: IDL, Java, JavaScript,\n# Csharp (C#), C, C++, Lex, D, PHP, md (Markdown), Objective-C, Python, Slice,\n# VHDL, Fortran (fixed format Fortran: FortranFixed, free formatted Fortran:\n# FortranFree, unknown formatted Fortran: Fortran. In the later case the parser\n# tries to guess whether the code is fixed or free formatted code, this is the\n# default for Fortran type files). For instance to make Doxygen treat .inc files\n# as Fortran files (default is PHP), and .f files as C (default is Fortran),\n# use: inc=Fortran f=C.\n#\n# Note: For files without extension you can use no_extension as a placeholder.\n#\n# Note that for custom extensions you also need to set FILE_PATTERNS otherwise\n# the files are not read by Doxygen. When specifying no_extension you should add\n# * to the FILE_PATTERNS.\n#\n# Note see also the list of default file extension mappings.\n\nEXTENSION_MAPPING =\n\n# If the MARKDOWN_SUPPORT tag is enabled then Doxygen pre-processes all comments\n# according to the Markdown format, which allows for more readable\n# documentation. See https://daringfireball.net/projects/markdown/ for details.\n# The output of markdown processing is further processed by Doxygen, so you can\n# mix Doxygen, HTML, and XML commands with Markdown formatting. Disable only in\n# case of backward compatibilities issues.\n# The default value is: YES.\n\nMARKDOWN_SUPPORT = YES\n\n# When the TOC_INCLUDE_HEADINGS tag is set to a non-zero value, all headings up\n# to that level are automatically included in the table of contents, even if\n# they do not have an id attribute.\n# Note: This feature currently applies only to Markdown headings.\n# Minimum value: 0, maximum value: 99, default value: 6.\n# This tag requires that the tag MARKDOWN_SUPPORT is set to YES.\n\nTOC_INCLUDE_HEADINGS = 0\n\n# The MARKDOWN_ID_STYLE tag can be used to specify the algorithm used to\n# generate identifiers for the Markdown headings. Note: Every identifier is\n# unique.\n# Possible values are: DOXYGEN use a fixed 'autotoc_md' string followed by a\n# sequence number starting at 0 and GITHUB use the lower case version of title\n# with any whitespace replaced by '-' and punctuation characters removed.\n# The default value is: DOXYGEN.\n# This tag requires that the tag MARKDOWN_SUPPORT is set to YES.\n\nMARKDOWN_ID_STYLE = DOXYGEN\n\n# When enabled Doxygen tries to link words that correspond to documented\n# classes, or namespaces to their corresponding documentation. Such a link can\n# be prevented in individual cases by putting a % sign in front of the word or\n# globally by setting AUTOLINK_SUPPORT to NO. Words listed in the\n# AUTOLINK_IGNORE_WORDS tag are excluded from automatic linking.\n# The default value is: YES.\n\nAUTOLINK_SUPPORT = YES\n\n# This tag specifies a list of words that, when matching the start of a word in\n# the documentation, will suppress auto links generation, if it is enabled via\n# AUTOLINK_SUPPORT. This list does not affect affect links explicitly created\n# using \\# or the \\link or commands.\n# This tag requires that the tag AUTOLINK_SUPPORT is set to YES.\n\nAUTOLINK_IGNORE_WORDS =\n\n# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want\n# to include (a tag file for) the STL sources as input, then you should set this\n# tag to YES in order to let Doxygen match functions declarations and\n# definitions whose arguments contain STL classes (e.g. func(std::string);\n# versus func(std::string) {}). This also makes the inheritance and\n# collaboration diagrams that involve STL classes more complete and accurate.\n# The default value is: NO.\n\nBUILTIN_STL_SUPPORT = NO\n\n# If you use Microsoft's C++/CLI language, you should set this option to YES to\n# enable parsing support.\n# The default value is: NO.\n\nCPP_CLI_SUPPORT = NO\n\n# Set the SIP_SUPPORT tag to YES if your project consists of sip (see:\n# https://www.riverbankcomputing.com/software) sources only. Doxygen will parse\n# them like normal C++ but will assume all classes use public instead of private\n# inheritance when no explicit protection keyword is present.\n# The default value is: NO.\n\nSIP_SUPPORT = NO\n\n# For Microsoft's IDL there are propget and propput attributes to indicate\n# getter and setter methods for a property. Setting this option to YES will make\n# Doxygen to replace the get and set methods by a property in the documentation.\n# This will only work if the methods are indeed getting or setting a simple\n# type. If this is not the case, or you want to show the methods anyway, you\n# should set this option to NO.\n# The default value is: YES.\n\nIDL_PROPERTY_SUPPORT = YES\n\n# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC\n# tag is set to YES then Doxygen will reuse the documentation of the first\n# member in the group (if any) for the other members of the group. By default\n# all members of a group must be documented explicitly.\n# The default value is: NO.\n\nDISTRIBUTE_GROUP_DOC = YES\n\n# If one adds a struct or class to a group and this option is enabled, then also\n# any nested class or struct is added to the same group. By default this option\n# is disabled and one has to add nested compounds explicitly via \\ingroup.\n# The default value is: NO.\n\nGROUP_NESTED_COMPOUNDS = NO\n\n# Set the SUBGROUPING tag to YES to allow class member groups of the same type\n# (for instance a group of public functions) to be put as a subgroup of that\n# type (e.g. under the Public Functions section). Set it to NO to prevent\n# subgrouping. Alternatively, this can be done per class using the\n# \\nosubgrouping command.\n# The default value is: YES.\n\nSUBGROUPING = YES\n\n# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions\n# are shown inside the group in which they are included (e.g. using \\ingroup)\n# instead of on a separate page (for HTML and Man pages) or section (for LaTeX\n# and RTF).\n#\n# Note that this feature does not work in combination with\n# SEPARATE_MEMBER_PAGES.\n# The default value is: NO.\n\nINLINE_GROUPED_CLASSES = NO\n\n# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions\n# with only public data fields or simple typedef fields will be shown inline in\n# the documentation of the scope in which they are defined (i.e. file,\n# namespace, or group documentation), provided this scope is documented. If set\n# to NO, structs, classes, and unions are shown on a separate page (for HTML and\n# Man pages) or section (for LaTeX and RTF).\n# The default value is: NO.\n\nINLINE_SIMPLE_STRUCTS = NO\n\n# When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or\n# enum is documented as struct, union, or enum with the name of the typedef. So\n# typedef struct TypeS {} TypeT, will appear in the documentation as a struct\n# with name TypeT. When disabled the typedef will appear as a member of a file,\n# namespace, or class. And the struct will be named TypeS. This can typically be\n# useful for C code in case the coding convention dictates that all compound\n# types are typedef'ed and only the typedef is referenced, never the tag name.\n# The default value is: NO.\n\nTYPEDEF_HIDES_STRUCT = NO\n\n# The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This\n# cache is used to resolve symbols given their name and scope. Since this can be\n# an expensive process and often the same symbol appears multiple times in the\n# code, Doxygen keeps a cache of pre-resolved symbols. If the cache is too small\n# Doxygen will become slower. If the cache is too large, memory is wasted. The\n# cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range\n# is 0..9, the default is 0, corresponding to a cache size of 2^16=65536\n# symbols. At the end of a run Doxygen will report the cache usage and suggest\n# the optimal cache size from a speed point of view.\n# Minimum value: 0, maximum value: 9, default value: 0.\n\nLOOKUP_CACHE_SIZE = 0\n\n# The NUM_PROC_THREADS specifies the number of threads Doxygen is allowed to use\n# during processing. When set to 0 Doxygen will based this on the number of\n# cores available in the system. You can set it explicitly to a value larger\n# than 0 to get more control over the balance between CPU load and processing\n# speed. At this moment only the input processing can be done using multiple\n# threads. Since this is still an experimental feature the default is set to 1,\n# which effectively disables parallel processing. Please report any issues you\n# encounter. Generating dot graphs in parallel is controlled by the\n# DOT_NUM_THREADS setting.\n# Minimum value: 0, maximum value: 32, default value: 1.\n\nNUM_PROC_THREADS = 1\n\n# If the TIMESTAMP tag is set different from NO then each generated page will\n# contain the date or date and time when the page was generated. Setting this to\n# NO can help when comparing the output of multiple runs.\n# Possible values are: YES, NO, DATETIME and DATE.\n# The default value is: NO.\n\nTIMESTAMP = NO\n\n#---------------------------------------------------------------------------\n# Build related configuration options\n#---------------------------------------------------------------------------\n\n# If the EXTRACT_ALL tag is set to YES, Doxygen will assume all entities in\n# documentation are documented, even if no documentation was available. Private\n# class members and static file members will be hidden unless the\n# EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES.\n# Note: This will also disable the warnings about undocumented members that are\n# normally produced when WARNINGS is set to YES.\n# The default value is: NO.\n\nEXTRACT_ALL = NO\n\n# If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will\n# be included in the documentation.\n# The default value is: NO.\n\nEXTRACT_PRIVATE = NO\n\n# If the EXTRACT_PRIV_VIRTUAL tag is set to YES, documented private virtual\n# methods of a class will be included in the documentation.\n# The default value is: NO.\n\nEXTRACT_PRIV_VIRTUAL = NO\n\n# If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal\n# scope will be included in the documentation.\n# The default value is: NO.\n\nEXTRACT_PACKAGE = NO\n\n# If the EXTRACT_STATIC tag is set to YES, all static members of a file will be\n# included in the documentation.\n# The default value is: NO.\n\nEXTRACT_STATIC = NO\n\n# If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined\n# locally in source files will be included in the documentation. If set to NO,\n# only classes defined in header files are included. Does not have any effect\n# for Java sources.\n# The default value is: YES.\n\nEXTRACT_LOCAL_CLASSES = YES\n\n# This flag is only useful for Objective-C code. If set to YES, local methods,\n# which are defined in the implementation section but not in the interface are\n# included in the documentation. If set to NO, only methods in the interface are\n# included.\n# The default value is: NO.\n\nEXTRACT_LOCAL_METHODS = NO\n\n# If this flag is set to YES, the members of anonymous namespaces will be\n# extracted and appear in the documentation as a namespace called\n# 'anonymous_namespace{file}', where file will be replaced with the base name of\n# the file that contains the anonymous namespace. By default anonymous namespace\n# are hidden.\n# The default value is: NO.\n\nEXTRACT_ANON_NSPACES = NO\n\n# If this flag is set to YES, the name of an unnamed parameter in a declaration\n# will be determined by the corresponding definition. By default unnamed\n# parameters remain unnamed in the output.\n# The default value is: YES.\n\nRESOLVE_UNNAMED_PARAMS = YES\n\n# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all\n# undocumented members inside documented classes or files. If set to NO these\n# members will be included in the various overviews, but no documentation\n# section is generated. This option has no effect if EXTRACT_ALL is enabled.\n# The default value is: NO.\n\nHIDE_UNDOC_MEMBERS = NO\n\n# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all\n# undocumented classes that are normally visible in the class hierarchy. If set\n# to NO, these classes will be included in the various overviews. This option\n# will also hide undocumented C++ concepts if enabled. This option has no effect\n# if EXTRACT_ALL is enabled.\n# The default value is: NO.\n\nHIDE_UNDOC_CLASSES = NO\n\n# If the HIDE_UNDOC_NAMESPACES tag is set to YES, Doxygen will hide all\n# undocumented namespaces that are normally visible in the namespace hierarchy.\n# If set to NO, these namespaces will be included in the various overviews. This\n# option has no effect if EXTRACT_ALL is enabled.\n# The default value is: YES.\n\nHIDE_UNDOC_NAMESPACES = YES\n\n# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all friend\n# declarations. If set to NO, these declarations will be included in the\n# documentation.\n# The default value is: NO.\n\nHIDE_FRIEND_COMPOUNDS = NO\n\n# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any\n# documentation blocks found inside the body of a function. If set to NO, these\n# blocks will be appended to the function's detailed documentation block.\n# The default value is: NO.\n\nHIDE_IN_BODY_DOCS = NO\n\n# The INTERNAL_DOCS tag determines if documentation that is typed after a\n# \\internal command is included. If the tag is set to NO then the documentation\n# will be excluded. Set it to YES to include the internal documentation.\n# The default value is: NO.\n\nINTERNAL_DOCS = NO\n\n# With the correct setting of option CASE_SENSE_NAMES Doxygen will better be\n# able to match the capabilities of the underlying filesystem. In case the\n# filesystem is case sensitive (i.e. it supports files in the same directory\n# whose names only differ in casing), the option must be set to YES to properly\n# deal with such files in case they appear in the input. For filesystems that\n# are not case sensitive the option should be set to NO to properly deal with\n# output files written for symbols that only differ in casing, such as for two\n# classes, one named CLASS and the other named Class, and to also support\n# references to files without having to specify the exact matching casing. On\n# Windows (including Cygwin) and macOS, users should typically set this option\n# to NO, whereas on Linux or other Unix flavors it should typically be set to\n# YES.\n# Possible values are: SYSTEM, NO and YES.\n# The default value is: SYSTEM.\n\nCASE_SENSE_NAMES = YES\n\n# If the HIDE_SCOPE_NAMES tag is set to NO then Doxygen will show members with\n# their full class and namespace scopes in the documentation. If set to YES, the\n# scope will be hidden.\n# The default value is: NO.\n\nHIDE_SCOPE_NAMES = NO\n\n# If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then Doxygen will\n# append additional text to a page's title, such as Class Reference. If set to\n# YES the compound reference will be hidden.\n# The default value is: NO.\n\nHIDE_COMPOUND_REFERENCE= NO\n\n# If the SHOW_HEADERFILE tag is set to YES then the documentation for a class\n# will show which file needs to be included to use the class.\n# The default value is: YES.\n\nSHOW_HEADERFILE = YES\n\n# If the SHOW_INCLUDE_FILES tag is set to YES then Doxygen will put a list of\n# the files that are included by a file in the documentation of that file.\n# The default value is: YES.\n\nSHOW_INCLUDE_FILES = YES\n\n# If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each\n# grouped member an include statement to the documentation, telling the reader\n# which file to include in order to use the member.\n# The default value is: NO.\n\nSHOW_GROUPED_MEMB_INC = NO\n\n# If the FORCE_LOCAL_INCLUDES tag is set to YES then Doxygen will list include\n# files with double quotes in the documentation rather than with sharp brackets.\n# The default value is: NO.\n\nFORCE_LOCAL_INCLUDES = YES\n\n# If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the\n# documentation for inline members.\n# The default value is: YES.\n\nINLINE_INFO = YES\n\n# If the SORT_MEMBER_DOCS tag is set to YES then Doxygen will sort the\n# (detailed) documentation of file and class members alphabetically by member\n# name. If set to NO, the members will appear in declaration order.\n# The default value is: YES.\n\nSORT_MEMBER_DOCS = YES\n\n# If the SORT_BRIEF_DOCS tag is set to YES then Doxygen will sort the brief\n# descriptions of file, namespace and class members alphabetically by member\n# name. If set to NO, the members will appear in declaration order. Note that\n# this will also influence the order of the classes in the class list.\n# The default value is: NO.\n\nSORT_BRIEF_DOCS = NO\n\n# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then Doxygen will sort the\n# (brief and detailed) documentation of class members so that constructors and\n# destructors are listed first. If set to NO the constructors will appear in the\n# respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS.\n# Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief\n# member documentation.\n# Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting\n# detailed member documentation.\n# The default value is: NO.\n\nSORT_MEMBERS_CTORS_1ST = NO\n\n# If the SORT_GROUP_NAMES tag is set to YES then Doxygen will sort the hierarchy\n# of group names into alphabetical order. If set to NO the group names will\n# appear in their defined order.\n# The default value is: NO.\n\nSORT_GROUP_NAMES = NO\n\n# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by\n# fully-qualified names, including namespaces. If set to NO, the class list will\n# be sorted only by class name, not including the namespace part.\n# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.\n# Note: This option applies only to the class list, not to the alphabetical\n# list.\n# The default value is: NO.\n\nSORT_BY_SCOPE_NAME = NO\n\n# If the STRICT_PROTO_MATCHING option is enabled and Doxygen fails to do proper\n# type resolution of all parameters of a function it will reject a match between\n# the prototype and the implementation of a member function even if there is\n# only one candidate or it is obvious which candidate to choose by doing a\n# simple string match. By disabling STRICT_PROTO_MATCHING Doxygen will still\n# accept a match between prototype and implementation in such cases.\n# The default value is: NO.\n\nSTRICT_PROTO_MATCHING = NO\n\n# The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo\n# list. This list is created by putting \\todo commands in the documentation.\n# The default value is: YES.\n\nGENERATE_TODOLIST = NO\n\n# The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test\n# list. This list is created by putting \\test commands in the documentation.\n# The default value is: YES.\n\nGENERATE_TESTLIST = NO\n\n# The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug\n# list. This list is created by putting \\bug commands in the documentation.\n# The default value is: YES.\n\nGENERATE_BUGLIST = NO\n\n# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO)\n# the deprecated list. This list is created by putting \\deprecated commands in\n# the documentation.\n# The default value is: YES.\n\nGENERATE_DEPRECATEDLIST= NO\n\n# The ENABLED_SECTIONS tag can be used to enable conditional documentation\n# sections, marked by \\if ... \\endif and \\cond \n# ... \\endcond blocks.\n\nENABLED_SECTIONS =\n\n# The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the\n# initial value of a variable or macro / define can have for it to appear in the\n# documentation. If the initializer consists of more lines than specified here\n# it will be hidden. Use a value of 0 to hide initializers completely. The\n# appearance of the value of individual variables and macros / defines can be\n# controlled using \\showinitializer or \\hideinitializer command in the\n# documentation regardless of this setting.\n# Minimum value: 0, maximum value: 10000, default value: 30.\n\nMAX_INITIALIZER_LINES = 30\n\n# Set the SHOW_USED_FILES tag to NO to disable the list of files generated at\n# the bottom of the documentation of classes and structs. If set to YES, the\n# list will mention the files that were used to generate the documentation.\n# The default value is: YES.\n\nSHOW_USED_FILES = YES\n\n# Set the SHOW_FILES tag to NO to disable the generation of the Files page. This\n# will remove the Files entry from the Quick Index and from the Folder Tree View\n# (if specified).\n# The default value is: YES.\n\nSHOW_FILES = YES\n\n# Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces\n# page. This will remove the Namespaces entry from the Quick Index and from the\n# Folder Tree View (if specified).\n# The default value is: YES.\n\nSHOW_NAMESPACES = YES\n\n# The FILE_VERSION_FILTER tag can be used to specify a program or script that\n# Doxygen should invoke to get the current version for each file (typically from\n# the version control system). Doxygen will invoke the program by executing (via\n# popen()) the command command input-file, where command is the value of the\n# FILE_VERSION_FILTER tag, and input-file is the name of an input file provided\n# by Doxygen. Whatever the program writes to standard output is used as the file\n# version. For an example see the documentation.\n\nFILE_VERSION_FILTER =\n\n# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed\n# by Doxygen. The layout file controls the global structure of the generated\n# output files in an output format independent way. To create the layout file\n# that represents Doxygen's defaults, run Doxygen with the -l option. You can\n# optionally specify a file name after the option, if omitted DoxygenLayout.xml\n# will be used as the name of the layout file. See also section \"Changing the\n# layout of pages\" for information.\n#\n# Note that if you run Doxygen from a directory containing a file called\n# DoxygenLayout.xml, Doxygen will parse it automatically even if the LAYOUT_FILE\n# tag is left empty.\n\nLAYOUT_FILE =\n\n# The CITE_BIB_FILES tag can be used to specify one or more bib files containing\n# the reference definitions. This must be a list of .bib files. The .bib\n# extension is automatically appended if omitted. This requires the bibtex tool\n# to be installed. See also https://en.wikipedia.org/wiki/BibTeX for more info.\n# For LaTeX the style of the bibliography can be controlled using\n# LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the\n# search path. See also \\cite for info how to create references.\n\nCITE_BIB_FILES =\n\n# The EXTERNAL_TOOL_PATH tag can be used to extend the search path (PATH\n# environment variable) so that external tools such as latex and gs can be\n# found.\n# Note: Directories specified with EXTERNAL_TOOL_PATH are added in front of the\n# path already specified by the PATH variable, and are added in the order\n# specified.\n# Note: This option is particularly useful for macOS version 14 (Sonoma) and\n# higher, when running Doxygen from Doxywizard, because in this case any user-\n# defined changes to the PATH are ignored. A typical example on macOS is to set\n# EXTERNAL_TOOL_PATH = /Library/TeX/texbin /usr/local/bin\n# together with the standard path, the full search path used by doxygen when\n# launching external tools will then become\n# PATH=/Library/TeX/texbin:/usr/local/bin:/usr/bin:/bin:/usr/sbin:/sbin\n\nEXTERNAL_TOOL_PATH =\n\n#---------------------------------------------------------------------------\n# Configuration options related to warning and progress messages\n#---------------------------------------------------------------------------\n\n# The QUIET tag can be used to turn on/off the messages that are generated to\n# standard output by Doxygen. If QUIET is set to YES this implies that the\n# messages are off.\n# The default value is: NO.\n\nQUIET = YES\n\n# The WARNINGS tag can be used to turn on/off the warning messages that are\n# generated to standard error (stderr) by Doxygen. If WARNINGS is set to YES\n# this implies that the warnings are on.\n#\n# Tip: Turn warnings on while writing the documentation.\n# The default value is: YES.\n\nWARNINGS = YES\n\n# If the WARN_IF_UNDOCUMENTED tag is set to YES then Doxygen will generate\n# warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag\n# will automatically be disabled.\n# The default value is: YES.\n\nWARN_IF_UNDOCUMENTED = NO\n\n# If the WARN_IF_DOC_ERROR tag is set to YES, Doxygen will generate warnings for\n# potential errors in the documentation, such as documenting some parameters in\n# a documented function twice, or documenting parameters that don't exist or\n# using markup commands wrongly.\n# The default value is: YES.\n\nWARN_IF_DOC_ERROR = YES\n\n# If WARN_IF_INCOMPLETE_DOC is set to YES, Doxygen will warn about incomplete\n# function parameter documentation. If set to NO, Doxygen will accept that some\n# parameters have no documentation without warning.\n# The default value is: YES.\n\nWARN_IF_INCOMPLETE_DOC = YES\n\n# This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that\n# are documented, but have no documentation for their parameters or return\n# value. If set to NO, Doxygen will only warn about wrong parameter\n# documentation, but not about the absence of documentation. If EXTRACT_ALL is\n# set to YES then this flag will automatically be disabled. See also\n# WARN_IF_INCOMPLETE_DOC\n# The default value is: NO.\n\nWARN_NO_PARAMDOC = NO\n\n# If WARN_IF_UNDOC_ENUM_VAL option is set to YES, Doxygen will warn about\n# undocumented enumeration values. If set to NO, Doxygen will accept\n# undocumented enumeration values. If EXTRACT_ALL is set to YES then this flag\n# will automatically be disabled.\n# The default value is: NO.\n\nWARN_IF_UNDOC_ENUM_VAL = NO\n\n# If WARN_LAYOUT_FILE option is set to YES, Doxygen will warn about issues found\n# while parsing the user defined layout file, such as missing or wrong elements.\n# See also LAYOUT_FILE for details. If set to NO, problems with the layout file\n# will be suppressed.\n# The default value is: YES.\n\nWARN_LAYOUT_FILE = YES\n\n# If the WARN_AS_ERROR tag is set to YES then Doxygen will immediately stop when\n# a warning is encountered. If the WARN_AS_ERROR tag is set to FAIL_ON_WARNINGS\n# then Doxygen will continue running as if WARN_AS_ERROR tag is set to NO, but\n# at the end of the Doxygen process Doxygen will return with a non-zero status.\n# If the WARN_AS_ERROR tag is set to FAIL_ON_WARNINGS_PRINT then Doxygen behaves\n# like FAIL_ON_WARNINGS but in case no WARN_LOGFILE is defined Doxygen will not\n# write the warning messages in between other messages but write them at the end\n# of a run, in case a WARN_LOGFILE is defined the warning messages will be\n# besides being in the defined file also be shown at the end of a run, unless\n# the WARN_LOGFILE is defined as - i.e. standard output (stdout) in that case\n# the behavior will remain as with the setting FAIL_ON_WARNINGS.\n# Possible values are: NO, YES, FAIL_ON_WARNINGS and FAIL_ON_WARNINGS_PRINT.\n# The default value is: NO.\n\nWARN_AS_ERROR = NO\n\n# The WARN_FORMAT tag determines the format of the warning messages that Doxygen\n# can produce. The string should contain the $file, $line, and $text tags, which\n# will be replaced by the file and line number from which the warning originated\n# and the warning text. Optionally the format may contain $version, which will\n# be replaced by the version of the file (if it could be obtained via\n# FILE_VERSION_FILTER)\n# See also: WARN_LINE_FORMAT\n# The default value is: $file:$line: $text.\n\nWARN_FORMAT = \"$file:$line: $text\"\n\n# In the $text part of the WARN_FORMAT command it is possible that a reference\n# to a more specific place is given. To make it easier to jump to this place\n# (outside of Doxygen) the user can define a custom \"cut\" / \"paste\" string.\n# Example:\n# WARN_LINE_FORMAT = \"'vi $file +$line'\"\n# See also: WARN_FORMAT\n# The default value is: at line $line of file $file.\n\nWARN_LINE_FORMAT = \"at line $line of file $file\"\n\n# The WARN_LOGFILE tag can be used to specify a file to which warning and error\n# messages should be written. If left blank the output is written to standard\n# error (stderr). In case the file specified cannot be opened for writing the\n# warning and error messages are written to standard error. When as file - is\n# specified the warning and error messages are written to standard output\n# (stdout).\n\nWARN_LOGFILE =\n\n#---------------------------------------------------------------------------\n# Configuration options related to the input files\n#---------------------------------------------------------------------------\n\n# The INPUT tag is used to specify the files and/or directories that contain\n# documented source files. You may enter file names like myfile.cpp or\n# directories like /usr/src/myproject. Separate the files or directories with\n# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING\n# Note: If this tag is empty the current directory is searched.\n\nINPUT =\n\n# This tag can be used to specify the character encoding of the source files\n# that Doxygen parses. Internally Doxygen uses the UTF-8 encoding. Doxygen uses\n# libiconv (or the iconv built into libc) for the transcoding. See the libiconv\n# documentation (see:\n# https://www.gnu.org/software/libiconv/) for the list of possible encodings.\n# See also: INPUT_FILE_ENCODING\n# The default value is: UTF-8.\n\nINPUT_ENCODING = UTF-8\n\n# This tag can be used to specify the character encoding of the source files\n# that Doxygen parses. The INPUT_FILE_ENCODING tag can be used to specify\n# character encoding on a per file pattern basis. Doxygen will compare the file\n# name with each pattern and apply the encoding instead of the default\n# INPUT_ENCODING if there is a match. The character encodings are a list of the\n# form: pattern=encoding (like *.php=ISO-8859-1).\n# See also: INPUT_ENCODING for further information on supported encodings.\n\nINPUT_FILE_ENCODING =\n\n# If the value of the INPUT tag contains directories, you can use the\n# FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and\n# *.h) to filter out the source-files in the directories.\n#\n# Note that for custom extensions or not directly supported extensions you also\n# need to set EXTENSION_MAPPING for the extension otherwise the files are not\n# read by Doxygen.\n#\n# Note the list of default checked file patterns might differ from the list of\n# default file extension mappings.\n#\n# If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cxxm,\n# *.cpp, *.cppm, *.ccm, *.c++, *.c++m, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl,\n# *.idl, *.ddl, *.odl, *.h, *.hh, *.hxx, *.hpp, *.h++, *.ixx, *.l, *.cs, *.d,\n# *.php, *.php4, *.php5, *.phtml, *.inc, *.m, *.markdown, *.md, *.mm, *.dox (to\n# be provided as Doxygen C comment), *.py, *.pyw, *.f90, *.f95, *.f03, *.f08,\n# *.f18, *.f, *.for, *.vhd, *.vhdl, *.ucf, *.qsf and *.ice.\n\nFILE_PATTERNS = *.c \\\n *.cc \\\n *.h \\\n *.m \\\n *.mm\n\n# The RECURSIVE tag can be used to specify whether or not subdirectories should\n# be searched for input files as well.\n# The default value is: NO.\n\nRECURSIVE = YES\n\n# The EXCLUDE tag can be used to specify files and/or directories that should be\n# excluded from the INPUT source files. This way you can easily exclude a\n# subdirectory from a directory tree whose root is specified with the INPUT tag.\n#\n# Note that relative paths are relative to the directory from which Doxygen is\n# run.\n\nEXCLUDE = compat/android \\\n compat/ios \\\n compat/linux \\\n compat/mac \\\n compat/win \\\n third_party\n\n# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or\n# directories that are symbolic links (a Unix file system feature) are excluded\n# from the input.\n# The default value is: NO.\n\nEXCLUDE_SYMLINKS = NO\n\n# If the value of the INPUT tag contains directories, you can use the\n# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude\n# certain files from those directories.\n#\n# Note that the wildcards are matched against the file with absolute path, so to\n# exclude all test directories for example use the pattern */test/*\n\nEXCLUDE_PATTERNS = out*\n\n# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names\n# (namespaces, classes, functions, etc.) that should be excluded from the\n# output. The symbol name can be a fully qualified name, a word, or if the\n# wildcard * is used, a substring. Examples: ANamespace, AClass,\n# ANamespace::AClass, ANamespace::*Test\n\nEXCLUDE_SYMBOLS =\n\n# The EXAMPLE_PATH tag can be used to specify one or more files or directories\n# that contain example code fragments that are included (see the \\include\n# command).\n\nEXAMPLE_PATH =\n\n# If the value of the EXAMPLE_PATH tag contains directories, you can use the\n# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and\n# *.h) to filter out the source-files in the directories. If left blank all\n# files are included.\n\nEXAMPLE_PATTERNS = *\n\n# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be\n# searched for input files to be used with the \\include or \\dontinclude commands\n# irrespective of the value of the RECURSIVE tag.\n# The default value is: NO.\n\nEXAMPLE_RECURSIVE = NO\n\n# The IMAGE_PATH tag can be used to specify one or more files or directories\n# that contain images that are to be included in the documentation (see the\n# \\image command).\n\nIMAGE_PATH =\n\n# The INPUT_FILTER tag can be used to specify a program that Doxygen should\n# invoke to filter for each input file. Doxygen will invoke the filter program\n# by executing (via popen()) the command:\n#\n# \n#\n# where is the value of the INPUT_FILTER tag, and is the\n# name of an input file. Doxygen will then use the output that the filter\n# program writes to standard output. If FILTER_PATTERNS is specified, this tag\n# will be ignored.\n#\n# Note that the filter must not add or remove lines; it is applied before the\n# code is scanned, but not when the output code is generated. If lines are added\n# or removed, the anchors will not be placed correctly.\n#\n# Note that Doxygen will use the data processed and written to standard output\n# for further processing, therefore nothing else, like debug statements or used\n# commands (so in case of a Windows batch file always use @echo OFF), should be\n# written to standard output.\n#\n# Note that for custom extensions or not directly supported extensions you also\n# need to set EXTENSION_MAPPING for the extension otherwise the files are not\n# properly processed by Doxygen.\n\nINPUT_FILTER =\n\n# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern\n# basis. Doxygen will compare the file name with each pattern and apply the\n# filter if there is a match. The filters are a list of the form: pattern=filter\n# (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how\n# filters are used. If the FILTER_PATTERNS tag is empty or if none of the\n# patterns match the file name, INPUT_FILTER is applied.\n#\n# Note that for custom extensions or not directly supported extensions you also\n# need to set EXTENSION_MAPPING for the extension otherwise the files are not\n# properly processed by Doxygen.\n\nFILTER_PATTERNS =\n\n# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using\n# INPUT_FILTER) will also be used to filter the input files that are used for\n# producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES).\n# The default value is: NO.\n\nFILTER_SOURCE_FILES = NO\n\n# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file\n# pattern. A pattern will override the setting for FILTER_PATTERN (if any) and\n# it is also possible to disable source filtering for a specific pattern using\n# *.ext= (so without naming a filter).\n# This tag requires that the tag FILTER_SOURCE_FILES is set to YES.\n\nFILTER_SOURCE_PATTERNS =\n\n# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that\n# is part of the input, its contents will be placed on the main page\n# (index.html). This can be useful if you have a project on for instance GitHub\n# and want to reuse the introduction page also for the Doxygen output.\n\nUSE_MDFILE_AS_MAINPAGE =\n\n# If the IMPLICIT_DIR_DOCS tag is set to YES, any README.md file found in sub-\n# directories of the project's root, is used as the documentation for that sub-\n# directory, except when the README.md starts with a \\dir, \\page or \\mainpage\n# command. If set to NO, the README.md file needs to start with an explicit \\dir\n# command in order to be used as directory documentation.\n# The default value is: YES.\n\nIMPLICIT_DIR_DOCS = YES\n\n# The Fortran standard specifies that for fixed formatted Fortran code all\n# characters from position 72 are to be considered as comment. A common\n# extension is to allow longer lines before the automatic comment starts. The\n# setting FORTRAN_COMMENT_AFTER will also make it possible that longer lines can\n# be processed before the automatic comment starts.\n# Minimum value: 7, maximum value: 10000, default value: 72.\n\nFORTRAN_COMMENT_AFTER = 72\n\n#---------------------------------------------------------------------------\n# Configuration options related to source browsing\n#---------------------------------------------------------------------------\n\n# If the SOURCE_BROWSER tag is set to YES then a list of source files will be\n# generated. Documented entities will be cross-referenced with these sources.\n#\n# Note: To get rid of all source code in the generated output, make sure that\n# also VERBATIM_HEADERS is set to NO.\n# The default value is: NO.\n\nSOURCE_BROWSER = NO\n\n# Setting the INLINE_SOURCES tag to YES will include the body of functions,\n# multi-line macros, enums or list initialized variables directly into the\n# documentation.\n# The default value is: NO.\n\nINLINE_SOURCES = NO\n\n# Setting the STRIP_CODE_COMMENTS tag to YES will instruct Doxygen to hide any\n# special comment blocks from generated source code fragments. Normal C, C++ and\n# Fortran comments will always remain visible.\n# The default value is: YES.\n\nSTRIP_CODE_COMMENTS = YES\n\n# If the REFERENCED_BY_RELATION tag is set to YES then for each documented\n# entity all documented functions referencing it will be listed.\n# The default value is: NO.\n\nREFERENCED_BY_RELATION = NO\n\n# If the REFERENCES_RELATION tag is set to YES then for each documented function\n# all documented entities called/used by that function will be listed.\n# The default value is: NO.\n\nREFERENCES_RELATION = NO\n\n# If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set\n# to YES then the hyperlinks from functions in REFERENCES_RELATION and\n# REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will\n# link to the documentation.\n# The default value is: YES.\n\nREFERENCES_LINK_SOURCE = YES\n\n# If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the\n# source code will show a tooltip with additional information such as prototype,\n# brief description and links to the definition and documentation. Since this\n# will make the HTML file larger and loading of large files a bit slower, you\n# can opt to disable this feature.\n# The default value is: YES.\n# This tag requires that the tag SOURCE_BROWSER is set to YES.\n\nSOURCE_TOOLTIPS = YES\n\n# If the USE_HTAGS tag is set to YES then the references to source code will\n# point to the HTML generated by the htags(1) tool instead of Doxygen built-in\n# source browser. The htags tool is part of GNU's global source tagging system\n# (see https://www.gnu.org/software/global/global.html). You will need version\n# 4.8.6 or higher.\n#\n# To use it do the following:\n# - Install the latest version of global\n# - Enable SOURCE_BROWSER and USE_HTAGS in the configuration file\n# - Make sure the INPUT points to the root of the source tree\n# - Run doxygen as normal\n#\n# Doxygen will invoke htags (and that will in turn invoke gtags), so these\n# tools must be available from the command line (i.e. in the search path).\n#\n# The result: instead of the source browser generated by Doxygen, the links to\n# source code will now point to the output of htags.\n# The default value is: NO.\n# This tag requires that the tag SOURCE_BROWSER is set to YES.\n\nUSE_HTAGS = NO\n\n# If the VERBATIM_HEADERS tag is set the YES then Doxygen will generate a\n# verbatim copy of the header file for each class for which an include is\n# specified. Set to NO to disable this.\n# See also: Section \\class.\n# The default value is: YES.\n\nVERBATIM_HEADERS = NO\n\n#---------------------------------------------------------------------------\n# Configuration options related to the alphabetical class index\n#---------------------------------------------------------------------------\n\n# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all\n# compounds will be generated. Enable this if the project contains a lot of\n# classes, structs, unions or interfaces.\n# The default value is: YES.\n\nALPHABETICAL_INDEX = YES\n\n# The IGNORE_PREFIX tag can be used to specify a prefix (or a list of prefixes)\n# that should be ignored while generating the index headers. The IGNORE_PREFIX\n# tag works for classes, function and member names. The entity will be placed in\n# the alphabetical list under the first letter of the entity name that remains\n# after removing the prefix.\n# This tag requires that the tag ALPHABETICAL_INDEX is set to YES.\n\nIGNORE_PREFIX =\n\n#---------------------------------------------------------------------------\n# Configuration options related to the HTML output\n#---------------------------------------------------------------------------\n\n# If the GENERATE_HTML tag is set to YES, Doxygen will generate HTML output\n# The default value is: YES.\n\nGENERATE_HTML = YES\n\n# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a\n# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of\n# it.\n# The default directory is: html.\n# This tag requires that the tag GENERATE_HTML is set to YES.\n\nHTML_OUTPUT = html\n\n# The HTML_FILE_EXTENSION tag can be used to specify the file extension for each\n# generated HTML page (for example: .htm, .php, .asp).\n# The default value is: .html.\n# This tag requires that the tag GENERATE_HTML is set to YES.\n\nHTML_FILE_EXTENSION = .html\n\n# The HTML_HEADER tag can be used to specify a user-defined HTML header file for\n# each generated HTML page. If the tag is left blank Doxygen will generate a\n# standard header.\n#\n# To get valid HTML the header file that includes any scripts and style sheets\n# that Doxygen needs, which is dependent on the configuration options used (e.g.\n# the setting GENERATE_TREEVIEW). It is highly recommended to start with a\n# default header using\n# doxygen -w html new_header.html new_footer.html new_stylesheet.css\n# YourConfigFile\n# and then modify the file new_header.html. See also section \"Doxygen usage\"\n# for information on how to generate the default header that Doxygen normally\n# uses.\n# Note: The header is subject to change so you typically have to regenerate the\n# default header when upgrading to a newer version of Doxygen. For a description\n# of the possible markers and block names see the documentation.\n# This tag requires that the tag GENERATE_HTML is set to YES.\n\nHTML_HEADER =\n\n# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each\n# generated HTML page. If the tag is left blank Doxygen will generate a standard\n# footer. See HTML_HEADER for more information on how to generate a default\n# footer and what special commands can be used inside the footer. See also\n# section \"Doxygen usage\" for information on how to generate the default footer\n# that Doxygen normally uses.\n# This tag requires that the tag GENERATE_HTML is set to YES.\n\nHTML_FOOTER =\n\n# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style\n# sheet that is used by each HTML page. It can be used to fine-tune the look of\n# the HTML output. If left blank Doxygen will generate a default style sheet.\n# See also section \"Doxygen usage\" for information on how to generate the style\n# sheet that Doxygen normally uses.\n# Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as\n# it is more robust and this tag (HTML_STYLESHEET) will in the future become\n# obsolete.\n# This tag requires that the tag GENERATE_HTML is set to YES.\n\nHTML_STYLESHEET =\n\n# The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined\n# cascading style sheets that are included after the standard style sheets\n# created by Doxygen. Using this option one can overrule certain style aspects.\n# This is preferred over using HTML_STYLESHEET since it does not replace the\n# standard style sheet and is therefore more robust against future updates.\n# Doxygen will copy the style sheet files to the output directory.\n# Note: The order of the extra style sheet files is of importance (e.g. the last\n# style sheet in the list overrules the setting of the previous ones in the\n# list).\n# Note: Since the styling of scrollbars can currently not be overruled in\n# Webkit/Chromium, the styling will be left out of the default doxygen.css if\n# one or more extra stylesheets have been specified. So if scrollbar\n# customization is desired it has to be added explicitly. For an example see the\n# documentation.\n# This tag requires that the tag GENERATE_HTML is set to YES.\n\nHTML_EXTRA_STYLESHEET = doc/support/crashpad_doxygen.css\n\n# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or\n# other source files which should be copied to the HTML output directory. Note\n# that these files will be copied to the base HTML output directory. Use the\n# $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these\n# files. In the HTML_STYLESHEET file, use the file name only. Also note that the\n# files will be copied as-is; there are no commands or markers available.\n# This tag requires that the tag GENERATE_HTML is set to YES.\n\nHTML_EXTRA_FILES =\n\n# The HTML_COLORSTYLE tag can be used to specify if the generated HTML output\n# should be rendered with a dark or light theme.\n# Possible values are: LIGHT always generates light mode output, DARK always\n# generates dark mode output, AUTO_LIGHT automatically sets the mode according\n# to the user preference, uses light mode if no preference is set (the default),\n# AUTO_DARK automatically sets the mode according to the user preference, uses\n# dark mode if no preference is set and TOGGLE allows a user to switch between\n# light and dark mode via a button.\n# The default value is: AUTO_LIGHT.\n# This tag requires that the tag GENERATE_HTML is set to YES.\n\nHTML_COLORSTYLE = AUTO_LIGHT\n\n# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen\n# will adjust the colors in the style sheet and background images according to\n# this color. Hue is specified as an angle on a color-wheel, see\n# https://en.wikipedia.org/wiki/Hue for more information. For instance the value\n# 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300\n# purple, and 360 is red again.\n# Minimum value: 0, maximum value: 359, default value: 220.\n# This tag requires that the tag GENERATE_HTML is set to YES.\n\nHTML_COLORSTYLE_HUE = 220\n\n# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors\n# in the HTML output. For a value of 0 the output will use gray-scales only. A\n# value of 255 will produce the most vivid colors.\n# Minimum value: 0, maximum value: 255, default value: 100.\n# This tag requires that the tag GENERATE_HTML is set to YES.\n\nHTML_COLORSTYLE_SAT = 100\n\n# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the\n# luminance component of the colors in the HTML output. Values below 100\n# gradually make the output lighter, whereas values above 100 make the output\n# darker. The value divided by 100 is the actual gamma applied, so 80 represents\n# a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not\n# change the gamma.\n# Minimum value: 40, maximum value: 240, default value: 80.\n# This tag requires that the tag GENERATE_HTML is set to YES.\n\nHTML_COLORSTYLE_GAMMA = 80\n\n# If the HTML_DYNAMIC_MENUS tag is set to YES then the generated HTML\n# documentation will contain a main index with vertical navigation menus that\n# are dynamically created via JavaScript. If disabled, the navigation index will\n# consists of multiple levels of tabs that are statically embedded in every HTML\n# page. Disable this option to support browsers that do not have JavaScript,\n# like the Qt help browser.\n# The default value is: YES.\n# This tag requires that the tag GENERATE_HTML is set to YES.\n\nHTML_DYNAMIC_MENUS = YES\n\n# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML\n# documentation will contain sections that can be hidden and shown after the\n# page has loaded.\n# The default value is: NO.\n# This tag requires that the tag GENERATE_HTML is set to YES.\n\nHTML_DYNAMIC_SECTIONS = NO\n\n# If the HTML_CODE_FOLDING tag is set to YES then classes and functions can be\n# dynamically folded and expanded in the generated HTML source code.\n# The default value is: YES.\n# This tag requires that the tag GENERATE_HTML is set to YES.\n\nHTML_CODE_FOLDING = YES\n\n# If the HTML_COPY_CLIPBOARD tag is set to YES then Doxygen will show an icon in\n# the top right corner of code and text fragments that allows the user to copy\n# its content to the clipboard. Note this only works if supported by the browser\n# and the web page is served via a secure context (see:\n# https://www.w3.org/TR/secure-contexts/), i.e. using the https: or file:\n# protocol.\n# The default value is: YES.\n# This tag requires that the tag GENERATE_HTML is set to YES.\n\nHTML_COPY_CLIPBOARD = YES\n\n# Doxygen stores a couple of settings persistently in the browser (via e.g.\n# cookies). By default these settings apply to all HTML pages generated by\n# Doxygen across all projects. The HTML_PROJECT_COOKIE tag can be used to store\n# the settings under a project specific key, such that the user preferences will\n# be stored separately.\n# This tag requires that the tag GENERATE_HTML is set to YES.\n\nHTML_PROJECT_COOKIE =\n\n# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries\n# shown in the various tree structured indices initially; the user can expand\n# and collapse entries dynamically later on. Doxygen will expand the tree to\n# such a level that at most the specified number of entries are visible (unless\n# a fully collapsed tree already exceeds this amount). So setting the number of\n# entries 1 will produce a full collapsed tree by default. 0 is a special value\n# representing an infinite number of entries and will result in a full expanded\n# tree by default.\n# Minimum value: 0, maximum value: 9999, default value: 100.\n# This tag requires that the tag GENERATE_HTML is set to YES.\n\nHTML_INDEX_NUM_ENTRIES = 100\n\n# If the GENERATE_DOCSET tag is set to YES, additional index files will be\n# generated that can be used as input for Apple's Xcode 3 integrated development\n# environment (see:\n# https://developer.apple.com/xcode/), introduced with OSX 10.5 (Leopard). To\n# create a documentation set, Doxygen will generate a Makefile in the HTML\n# output directory. Running make will produce the docset in that directory and\n# running make install will install the docset in\n# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at\n# startup. See https://developer.apple.com/library/archive/featuredarticles/Doxy\n# genXcode/_index.html for more information.\n# The default value is: NO.\n# This tag requires that the tag GENERATE_HTML is set to YES.\n\nGENERATE_DOCSET = NO\n\n# This tag determines the name of the docset feed. A documentation feed provides\n# an umbrella under which multiple documentation sets from a single provider\n# (such as a company or product suite) can be grouped.\n# The default value is: Doxygen generated docs.\n# This tag requires that the tag GENERATE_DOCSET is set to YES.\n\nDOCSET_FEEDNAME = \"Doxygen generated docs\"\n\n# This tag determines the URL of the docset feed. A documentation feed provides\n# an umbrella under which multiple documentation sets from a single provider\n# (such as a company or product suite) can be grouped.\n# This tag requires that the tag GENERATE_DOCSET is set to YES.\n\nDOCSET_FEEDURL =\n\n# This tag specifies a string that should uniquely identify the documentation\n# set bundle. This should be a reverse domain-name style string, e.g.\n# com.mycompany.MyDocSet. Doxygen will append .docset to the name.\n# The default value is: org.doxygen.Project.\n# This tag requires that the tag GENERATE_DOCSET is set to YES.\n\nDOCSET_BUNDLE_ID = org.doxygen.Project\n\n# The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify\n# the documentation publisher. This should be a reverse domain-name style\n# string, e.g. com.mycompany.MyDocSet.documentation.\n# The default value is: org.doxygen.Publisher.\n# This tag requires that the tag GENERATE_DOCSET is set to YES.\n\nDOCSET_PUBLISHER_ID = org.doxygen.Publisher\n\n# The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher.\n# The default value is: Publisher.\n# This tag requires that the tag GENERATE_DOCSET is set to YES.\n\nDOCSET_PUBLISHER_NAME = Publisher\n\n# If the GENERATE_HTMLHELP tag is set to YES then Doxygen generates three\n# additional HTML index files: index.hhp, index.hhc, and index.hhk. The\n# index.hhp is a project file that can be read by Microsoft's HTML Help Workshop\n# on Windows. In the beginning of 2021 Microsoft took the original page, with\n# a.o. the download links, offline (the HTML help workshop was already many\n# years in maintenance mode). You can download the HTML help workshop from the\n# web archives at Installation executable (see:\n# http://web.archive.org/web/20160201063255/http://download.microsoft.com/downlo\n# ad/0/A/9/0A939EF6-E31C-430F-A3DF-DFAE7960D564/htmlhelp.exe).\n#\n# The HTML Help Workshop contains a compiler that can convert all HTML output\n# generated by Doxygen into a single compiled HTML file (.chm). Compiled HTML\n# files are now used as the Windows 98 help format, and will replace the old\n# Windows help format (.hlp) on all Windows platforms in the future. Compressed\n# HTML files also contain an index, a table of contents, and you can search for\n# words in the documentation. The HTML workshop also contains a viewer for\n# compressed HTML files.\n# The default value is: NO.\n# This tag requires that the tag GENERATE_HTML is set to YES.\n\nGENERATE_HTMLHELP = NO\n\n# The CHM_FILE tag can be used to specify the file name of the resulting .chm\n# file. You can add a path in front of the file if the result should not be\n# written to the html output directory.\n# This tag requires that the tag GENERATE_HTMLHELP is set to YES.\n\nCHM_FILE =\n\n# The HHC_LOCATION tag can be used to specify the location (absolute path\n# including file name) of the HTML help compiler (hhc.exe). If non-empty,\n# Doxygen will try to run the HTML help compiler on the generated index.hhp.\n# The file has to be specified with full path.\n# This tag requires that the tag GENERATE_HTMLHELP is set to YES.\n\nHHC_LOCATION =\n\n# The GENERATE_CHI flag controls if a separate .chi index file is generated\n# (YES) or that it should be included in the main .chm file (NO).\n# The default value is: NO.\n# This tag requires that the tag GENERATE_HTMLHELP is set to YES.\n\nGENERATE_CHI = NO\n\n# The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc)\n# and project file content.\n# This tag requires that the tag GENERATE_HTMLHELP is set to YES.\n\nCHM_INDEX_ENCODING =\n\n# The BINARY_TOC flag controls whether a binary table of contents is generated\n# (YES) or a normal table of contents (NO) in the .chm file. Furthermore it\n# enables the Previous and Next buttons.\n# The default value is: NO.\n# This tag requires that the tag GENERATE_HTMLHELP is set to YES.\n\nBINARY_TOC = NO\n\n# The TOC_EXPAND flag can be set to YES to add extra items for group members to\n# the table of contents of the HTML help documentation and to the tree view.\n# The default value is: NO.\n# This tag requires that the tag GENERATE_HTMLHELP is set to YES.\n\nTOC_EXPAND = NO\n\n# The SITEMAP_URL tag is used to specify the full URL of the place where the\n# generated documentation will be placed on the server by the user during the\n# deployment of the documentation. The generated sitemap is called sitemap.xml\n# and placed on the directory specified by HTML_OUTPUT. In case no SITEMAP_URL\n# is specified no sitemap is generated. For information about the sitemap\n# protocol see https://www.sitemaps.org\n# This tag requires that the tag GENERATE_HTML is set to YES.\n\nSITEMAP_URL =\n\n# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and\n# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that\n# can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help\n# (.qch) of the generated HTML documentation.\n# The default value is: NO.\n# This tag requires that the tag GENERATE_HTML is set to YES.\n\nGENERATE_QHP = NO\n\n# If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify\n# the file name of the resulting .qch file. The path specified is relative to\n# the HTML output folder.\n# This tag requires that the tag GENERATE_QHP is set to YES.\n\nQCH_FILE =\n\n# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help\n# Project output. For more information please see Qt Help Project / Namespace\n# (see:\n# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#namespace).\n# The default value is: org.doxygen.Project.\n# This tag requires that the tag GENERATE_QHP is set to YES.\n\nQHP_NAMESPACE = org.doxygen.Project\n\n# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt\n# Help Project output. For more information please see Qt Help Project / Virtual\n# Folders (see:\n# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#virtual-folders).\n# The default value is: doc.\n# This tag requires that the tag GENERATE_QHP is set to YES.\n\nQHP_VIRTUAL_FOLDER = doc\n\n# If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom\n# filter to add. For more information please see Qt Help Project / Custom\n# Filters (see:\n# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-filters).\n# This tag requires that the tag GENERATE_QHP is set to YES.\n\nQHP_CUST_FILTER_NAME =\n\n# The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the\n# custom filter to add. For more information please see Qt Help Project / Custom\n# Filters (see:\n# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-filters).\n# This tag requires that the tag GENERATE_QHP is set to YES.\n\nQHP_CUST_FILTER_ATTRS =\n\n# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this\n# project's filter section matches. Qt Help Project / Filter Attributes (see:\n# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#filter-attributes).\n# This tag requires that the tag GENERATE_QHP is set to YES.\n\nQHP_SECT_FILTER_ATTRS =\n\n# The QHG_LOCATION tag can be used to specify the location (absolute path\n# including file name) of Qt's qhelpgenerator. If non-empty Doxygen will try to\n# run qhelpgenerator on the generated .qhp file.\n# This tag requires that the tag GENERATE_QHP is set to YES.\n\nQHG_LOCATION =\n\n# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be\n# generated, together with the HTML files, they form an Eclipse help plugin. To\n# install this plugin and make it available under the help contents menu in\n# Eclipse, the contents of the directory containing the HTML and XML files needs\n# to be copied into the plugins directory of eclipse. The name of the directory\n# within the plugins directory should be the same as the ECLIPSE_DOC_ID value.\n# After copying Eclipse needs to be restarted before the help appears.\n# The default value is: NO.\n# This tag requires that the tag GENERATE_HTML is set to YES.\n\nGENERATE_ECLIPSEHELP = NO\n\n# A unique identifier for the Eclipse help plugin. When installing the plugin\n# the directory name containing the HTML and XML files should also have this\n# name. Each documentation set should have its own identifier.\n# The default value is: org.doxygen.Project.\n# This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES.\n\nECLIPSE_DOC_ID = org.doxygen.Project\n\n# If you want full control over the layout of the generated HTML pages it might\n# be necessary to disable the index and replace it with your own. The\n# DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top\n# of each HTML page. A value of NO enables the index and the value YES disables\n# it. Since the tabs in the index contain the same information as the navigation\n# tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES.\n# The default value is: YES.\n# This tag requires that the tag GENERATE_HTML is set to YES.\n\nDISABLE_INDEX = YES\n\n# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index\n# structure should be generated to display hierarchical information. If the tag\n# value is set to YES, a side panel will be generated containing a tree-like\n# index structure (just like the one that is generated for HTML Help). For this\n# to work a browser that supports JavaScript, DHTML, CSS and frames is required\n# (i.e. any modern browser). Windows users are probably better off using the\n# HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can\n# further fine tune the look of the index (see \"Fine-tuning the output\"). As an\n# example, the default style sheet generated by Doxygen has an example that\n# shows how to put an image at the root of the tree instead of the PROJECT_NAME.\n# Since the tree basically has the same information as the tab index, you could\n# consider setting DISABLE_INDEX to YES when enabling this option.\n# The default value is: YES.\n# This tag requires that the tag GENERATE_HTML is set to YES.\n\nGENERATE_TREEVIEW = YES\n\n# When both GENERATE_TREEVIEW and DISABLE_INDEX are set to YES, then the\n# FULL_SIDEBAR option determines if the side bar is limited to only the treeview\n# area (value NO) or if it should extend to the full height of the window (value\n# YES). Setting this to YES gives a layout similar to\n# https://docs.readthedocs.io with more room for contents, but less room for the\n# project logo, title, and description. If either GENERATE_TREEVIEW or\n# DISABLE_INDEX is set to NO, this option has no effect.\n# The default value is: NO.\n# This tag requires that the tag GENERATE_HTML is set to YES.\n\nFULL_SIDEBAR = NO\n\n# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that\n# Doxygen will group on one line in the generated HTML documentation.\n#\n# Note that a value of 0 will completely suppress the enum values from appearing\n# in the overview section.\n# Minimum value: 0, maximum value: 20, default value: 4.\n# This tag requires that the tag GENERATE_HTML is set to YES.\n\nENUM_VALUES_PER_LINE = 0\n\n# When the SHOW_ENUM_VALUES tag is set doxygen will show the specified\n# enumeration values besides the enumeration mnemonics.\n# The default value is: NO.\n\nSHOW_ENUM_VALUES = NO\n\n# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used\n# to set the initial width (in pixels) of the frame in which the tree is shown.\n# Minimum value: 0, maximum value: 1500, default value: 250.\n# This tag requires that the tag GENERATE_HTML is set to YES.\n\nTREEVIEW_WIDTH = 250\n\n# If the EXT_LINKS_IN_WINDOW option is set to YES, Doxygen will open links to\n# external symbols imported via tag files in a separate window.\n# The default value is: NO.\n# This tag requires that the tag GENERATE_HTML is set to YES.\n\nEXT_LINKS_IN_WINDOW = NO\n\n# If the OBFUSCATE_EMAILS tag is set to YES, Doxygen will obfuscate email\n# addresses.\n# The default value is: YES.\n# This tag requires that the tag GENERATE_HTML is set to YES.\n\nOBFUSCATE_EMAILS = YES\n\n# If the HTML_FORMULA_FORMAT option is set to svg, Doxygen will use the pdf2svg\n# tool (see https://github.com/dawbarton/pdf2svg) or inkscape (see\n# https://inkscape.org) to generate formulas as SVG images instead of PNGs for\n# the HTML output. These images will generally look nicer at scaled resolutions.\n# Possible values are: png (the default) and svg (looks nicer but requires the\n# pdf2svg or inkscape tool).\n# The default value is: png.\n# This tag requires that the tag GENERATE_HTML is set to YES.\n\nHTML_FORMULA_FORMAT = png\n\n# Use this tag to change the font size of LaTeX formulas included as images in\n# the HTML documentation. When you change the font size after a successful\n# Doxygen run you need to manually remove any form_*.png images from the HTML\n# output directory to force them to be regenerated.\n# Minimum value: 8, maximum value: 50, default value: 10.\n# This tag requires that the tag GENERATE_HTML is set to YES.\n\nFORMULA_FONTSIZE = 10\n\n# The FORMULA_MACROFILE can contain LaTeX \\newcommand and \\renewcommand commands\n# to create new LaTeX commands to be used in formulas as building blocks. See\n# the section \"Including formulas\" for details.\n\nFORMULA_MACROFILE =\n\n# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see\n# https://www.mathjax.org) which uses client side JavaScript for the rendering\n# instead of using pre-rendered bitmaps. Use this if you do not have LaTeX\n# installed or if you want to formulas look prettier in the HTML output. When\n# enabled you may also need to install MathJax separately and configure the path\n# to it using the MATHJAX_RELPATH option.\n# The default value is: NO.\n# This tag requires that the tag GENERATE_HTML is set to YES.\n\nUSE_MATHJAX = NO\n\n# With MATHJAX_VERSION it is possible to specify the MathJax version to be used.\n# Note that the different versions of MathJax have different requirements with\n# regards to the different settings, so it is possible that also other MathJax\n# settings have to be changed when switching between the different MathJax\n# versions.\n# Possible values are: MathJax_2 and MathJax_3.\n# The default value is: MathJax_2.\n# This tag requires that the tag USE_MATHJAX is set to YES.\n\nMATHJAX_VERSION = MathJax_2\n\n# When MathJax is enabled you can set the default output format to be used for\n# the MathJax output. For more details about the output format see MathJax\n# version 2 (see:\n# http://docs.mathjax.org/en/v2.7-latest/output.html) and MathJax version 3\n# (see:\n# http://docs.mathjax.org/en/latest/web/components/output.html).\n# Possible values are: HTML-CSS (which is slower, but has the best\n# compatibility. This is the name for Mathjax version 2, for MathJax version 3\n# this will be translated into chtml), NativeMML (i.e. MathML. Only supported\n# for MathJax 2. For MathJax version 3 chtml will be used instead.), chtml (This\n# is the name for Mathjax version 3, for MathJax version 2 this will be\n# translated into HTML-CSS) and SVG.\n# The default value is: HTML-CSS.\n# This tag requires that the tag USE_MATHJAX is set to YES.\n\nMATHJAX_FORMAT = HTML-CSS\n\n# When MathJax is enabled you need to specify the location relative to the HTML\n# output directory using the MATHJAX_RELPATH option. The destination directory\n# should contain the MathJax.js script. For instance, if the mathjax directory\n# is located at the same level as the HTML output directory, then\n# MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax\n# Content Delivery Network so you can quickly see the result without installing\n# MathJax. However, it is strongly recommended to install a local copy of\n# MathJax from https://www.mathjax.org before deployment. The default value is:\n# - in case of MathJax version 2: https://cdn.jsdelivr.net/npm/mathjax@2\n# - in case of MathJax version 3: https://cdn.jsdelivr.net/npm/mathjax@3\n# This tag requires that the tag USE_MATHJAX is set to YES.\n\nMATHJAX_RELPATH =\n\n# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax\n# extension names that should be enabled during MathJax rendering. For example\n# for MathJax version 2 (see\n# https://docs.mathjax.org/en/v2.7-latest/tex.html#tex-and-latex-extensions):\n# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols\n# For example for MathJax version 3 (see\n# http://docs.mathjax.org/en/latest/input/tex/extensions/index.html):\n# MATHJAX_EXTENSIONS = ams\n# This tag requires that the tag USE_MATHJAX is set to YES.\n\nMATHJAX_EXTENSIONS =\n\n# The MATHJAX_CODEFILE tag can be used to specify a file with JavaScript pieces\n# of code that will be used on startup of the MathJax code. See the MathJax site\n# (see:\n# http://docs.mathjax.org/en/v2.7-latest/output.html) for more details. For an\n# example see the documentation.\n# This tag requires that the tag USE_MATHJAX is set to YES.\n\nMATHJAX_CODEFILE =\n\n# When the SEARCHENGINE tag is enabled Doxygen will generate a search box for\n# the HTML output. The underlying search engine uses JavaScript and DHTML and\n# should work on any modern browser. Note that when using HTML help\n# (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET)\n# there is already a search function so this one should typically be disabled.\n# For large projects the JavaScript based search engine can be slow, then\n# enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to\n# search using the keyboard; to jump to the search box use + S\n# (what the is depends on the OS and browser, but it is typically\n# , /