Gitiles
Code Review Sign In
gerrit.collaboraoffice.com / core / db421b3eb7ef8f11472a172c7b9420e3c955ae7b
commitdb421b3eb7ef8f11472a172c7b9420e3c955ae7b[log] [tgz]
authorStephan Bergmann <stephan.bergmann@allotropia.de>Wed Jul 10 11:19:36 2024 +0200
committerThorsten Behrens <thorsten.behrens@allotropia.de>Thu Feb 27 18:42:46 2025 +0100
treeffa9831508ccf614103e3be73c3ff32cc4d3b483
parent50fd1637e8e6ceee8237fff76f07d4437634a14e [diff]
Fix UBSan build of ExternalProject_redland

...after c75c21eef670fce33eb5a501357935dbd25be923 "Upgrade raptor to 2.0.16",
where it now started to fail with

> libtool: link: LD_RUN_PATH="/usr/local/lib:" /usr/bin/ccache /home/tdf/lode/opt_private/clang-llvmorg-12.0.1/bin/clang --gcc-toolchain=/opt/rh/gcc-toolset-12/root/usr -fsanitize=address -fsanitize=undefined -fsanitize=float-divide-by-zero -fsanitize=local-bounds -fsanitize-blacklist=/home/tdf/lode/jenkins/workspace/lo_ubsan/sanitize-ubsan-excludelist -fno-sanitize=function -DLIBRDF_INTERNAL=1 -O0 -Wp,-U_FORTIFY_SOURCE -fstrict-aliasing -fstrict-overflow -ggdb2 -gsplit-dwarf -Xclang -debug-info-kind=constructor -Wl,-z -Wl,origin -Wl,-rpath -Wl,\$ORIGIN -Wl,-rpath-link -Wl,/home/tdf/lode/jenkins/workspace/lo_ubsan/instdir/program -Wl,-z -Wl,origin -Wl,-rpath -Wl,\$ORIGIN -Wl,-rpath-link -Wl,/home/tdf/lode/jenkins/workspace/lo_ubsan/instdir/program -o .libs/redland-db-upgrade db_upgrade.o  -L/home/tdf/lode/jenkins/workspace/lo_ubsan/workdir/UnpackedTarball/raptor/src/.libs /home/tdf/lode/jenkins/workspace/lo_ubsan/workdir/UnpackedTarball/raptor/src/.libs/libraptor2.so -L/home/tdf/lode/jenkins/workspace/lo_ubsan/workdir/UnpackedTarball/libxml2/.libs /home/tdf/lode/jenkins/workspace/lo_ubsan/workdir/UnpackedTarball/libxml2/.libs/libxml2.so -L/home/tdf/lode/jenkins/workspace/lo_ubsan/workdir/UnpackedTarball/rasqal/src/.libs /home/tdf/lode/jenkins/workspace/lo_ubsan/workdir/UnpackedTarball/rasqal/src/.libs/librasqal.so ../src/.libs/librdf.so
> /opt/rh/gcc-toolset-12/root/usr/bin/ld: /home/tdf/lode/jenkins/workspace/lo_ubsan/instdir/program/libicuuc.so.74: undefined reference to `__ubsan_vptr_type_cache'
> /opt/rh/gcc-toolset-12/root/usr/bin/ld: /home/tdf/lode/jenkins/workspace/lo_ubsan/instdir/program/libicuuc.so.74: undefined reference to `__ubsan_handle_function_type_mismatch_v1'
> /opt/rh/gcc-toolset-12/root/usr/bin/ld: /home/tdf/lode/jenkins/workspace/lo_ubsan/instdir/program/libicuuc.so.74: undefined reference to `__ubsan_handle_dynamic_type_cache_miss'
> clang-12: error: linker command failed with exit code 1 (use -v to see invocation)
> make[3]: *** [Makefile:489: redland-db-upgrade] Error 1

(<https://ci.libreoffice.org/job/lo_ubsan/3239/>) because $(CC) is used to link
a (nominally C-only) executable that links against C++ ICU shared libraries that
in turn require a C++-specific UBSan library to be linked in.  So just use
$(CXX) for linking instead.

Change-Id: If7c61c6ee7e1b43965a928b1560f8ab4ae2b0603
Reviewed-on: https://gerrit.libreoffice.org/c/core/+/170277
Tested-by: Jenkins
Reviewed-by: Stephan Bergmann <stephan.bergmann@allotropia.de>
(cherry picked from commit b3300387f2e14ea59c70db513a8f6eda6fe17afa)
Reviewed-on: https://gerrit.libreoffice.org/c/core/+/173793
Tested-by: Stephan Bergmann <stephan.bergmann@allotropia.de>
2 files changed
tree: ffa9831508ccf614103e3be73c3ff32cc4d3b483
  1. .git-hooks/
  2. .github/
  3. .vscode/
  4. accessibility/
  5. android/
  6. animations/
  7. apple_remote/
  8. avmedia/
  9. basctl/
  10. basegfx/
  11. basic/
  12. bean/
  13. bin/
  14. binaryurp/
  15. bridges/
  16. canvas/
  17. chart2/
  18. cli_ure/
  19. codemaker/
  20. comphelper/
  21. compilerplugins/
  22. config_host/
  23. configmgr/
  24. connectivity/
  25. cppcanvas/
  26. cppu/
  27. cppuhelper/
  28. cpputools/
  29. cui/
  30. dbaccess/
  31. desktop/
  32. distro-configs/
  33. docmodel/
  34. drawinglayer/
  35. editeng/
  36. embeddedobj/
  37. embedserv/
  38. emfio/
  39. eventattacher/
  40. extensions/
  41. external/
  42. extras/
  43. filter/
  44. forms/
  45. formula/
  46. fpicker/
  47. framework/
  48. helpcompiler/
  49. hwpfilter/
  50. i18nlangtag/
  51. i18npool/
  52. i18nutil/
  53. icon-themes/
  54. idl/
  55. idlc/
  56. include/
  57. instsetoo_native/
  58. io/
  59. ios/
  60. javaunohelper/
  61. jurt/
  62. jvmaccess/
  63. jvmfwk/
  64. l10ntools/
  65. librelogo/
  66. libreofficekit/
  67. lingucomponent/
  68. linguistic/
  69. lotuswordpro/
  70. m4/
  71. msicreator/
  72. nlpsolver/
  73. o3tl/
  74. odk/
  75. offapi/
  76. officecfg/
  77. onlineupdate/
  78. oovbaapi/
  79. oox/
  80. opencl/
  81. osx/
  82. package/
  83. pch/
  84. postprocess/
  85. pyuno/
  86. qadevOOo/
  87. readlicense_oo/
  88. registry/
  89. remotebridges/
  90. reportbuilder/
  91. reportdesign/
  92. ridljar/
  93. sal/
  94. salhelper/
  95. sax/
  96. sc/
  97. scaddins/
  98. sccomp/
  99. schema/
  100. scp2/
  101. scripting/
  102. sd/
  103. sdext/
  104. setup_native/
  105. sfx2/
  106. shell/
  107. slideshow/
  108. smoketest/
  109. solenv/
  110. soltools/
  111. sot/
  112. starmath/
  113. static/
  114. stoc/
  115. store/
  116. svgio/
  117. svl/
  118. svtools/
  119. svx/
  120. sw/
  121. swext/
  122. sysui/
  123. test/
  124. testtools/
  125. toolkit/
  126. tools/
  127. ucb/
  128. ucbhelper/
  129. udkapi/
  130. uitest/
  131. UnoControls/
  132. unodevtools/
  133. unoidl/
  134. unoil/
  135. unotest/
  136. unotools/
  137. unoxml/
  138. ure/
  139. uui/
  140. vbahelper/
  141. vcl/
  142. winaccessibility/
  143. wizards/
  144. writerfilter/
  145. writerperfect/
  146. xmerge/
  147. xmlhelp/
  148. xmloff/
  149. xmlreader/
  150. xmlscript/
  151. xmlsecurity/
  152. dictionaries
  153. helpcontent2
  154. translations
  155. .buckconfig
  156. .buckversion
  157. .clang-format
  158. .editorconfig
  159. .git-blame-ignore-revs
  160. .gitattributes
  161. .gitignore
  162. .gitmodules
  163. .gitpod.dockerfile
  164. .gitpod.yml
  165. .gitreview
  166. antivirusDetection.vbs
  167. autogen.sh
  168. BUCK
  169. config.guess
  170. config.sub
  171. config_host.mk.in
  172. config_host_lang.mk.in
  173. configure.ac
  174. COPYING
  175. COPYING.LGPL
  176. COPYING.MPL
  177. cpp.hint
  178. download.lst
  179. g
  180. install-sh
  181. install_deps.sh
  182. leak-suppress.txt
  183. Library_merged.mk
  184. logerrit
  185. Makefile.fetch
  186. Makefile.gbuild
  187. Makefile.in
  188. README.cross
  189. README.help.md
  190. README.md
  191. README.Solaris
  192. Repository.mk
  193. RepositoryExternal.mk
  194. RepositoryFixes.mk
  195. RepositoryModule_build.mk
  196. RepositoryModule_host.mk
  197. sanitize-ubsan-excludelist
  198. setup.cfg
  199. TEMPLATE.SOURCECODE.HEADER
  200. tsan-suppress.txt
README.md

LibreOffice

Coverity Scan Build Status CII Best Practices Translation status

LibreOffice is an integrated office suite based on copyleft licenses and compatible with most document formats and standards. Libreoffice is backed by The Document Foundation, which represents a large independent community of enterprises, developers and other volunteers moved by the common goal of bringing to the market the best software for personal productivity. LibreOffice is open source, and free to download, use and distribute.

A quick overview of the LibreOffice code structure.

Overview

You can develop for LibreOffice in one of two ways, one recommended and one much less so. First the somewhat less recommended way: it is possible to use the SDK to develop an extension, for which you can read the API docs and Developers Guide. This re-uses the (extremely generic) UNO APIs that are also used by macro scripting in StarBasic.

The best way to add a generally useful feature to LibreOffice is to work on the code base however. Overall this way makes it easier to compile and build your code, it avoids any arbitrary limitations of our scripting APIs, and in general is far more simple and intuitive - if you are a reasonably able C++ programmer.

The Build Chain and Runtime Baselines

These are the current minimal operating system and compiler versions to run and compile LibreOffice, also used by the TDF builds:

  • Windows:
    • Runtime: Windows 7
    • Build: Cygwin + Visual Studio 2019 version 16.10
  • macOS:
    • Runtime: 10.15
    • Build: 12 (13 for aarch64) + Xcode 14
  • Linux:
    • Runtime: RHEL 8 or CentOS 8 and comparable
    • Build: either GCC 12; or Clang 12 with libstdc++ 8.5
  • iOS (only for LibreOfficeKit):
    • Runtime: 11.4 (only support for newer i devices == 64 bit)
    • Build: Xcode 9.3 and iPhone SDK 11.4
  • Android:
    • Build: NDK r23 and SDK 30.0.3
  • Emscripten / WASM:
    • Runtime: a browser with SharedMemory support (threads + atomics)
    • Build: Qt 5.15 with Qt supported Emscripten 1.39.8
    • See README.wasm

Java is required for building many parts of LibreOffice. In TDF Wiki article Development/Java, the exact modules that depend on Java are listed.

The baseline for Java is Java Development Kit (JDK) Version 17 or later.

If you want to use Clang with the LibreOffice compiler plugins, the minimal version of Clang is 12.0.1. Since Xcode doesn't provide the compiler plugin headers, you have to compile your own Clang to use them on macOS.

You can find the TDF configure switches in the distro-configs/ directory.

To setup your initial build environment on Windows and macOS, we provide the LibreOffice Development Environment (LODE) scripts.

For more information see the build instructions for your platform in the TDF wiki.

The Important Bits of Code

Each module should have a README.md file inside it which has some degree of documentation for that module; patches are most welcome to improve those. We have those turned into a web page here:

https://docs.libreoffice.org/

However, there are two hundred modules, many of them of only peripheral interest for a specialist audience. So - where is the good stuff, the code that is most useful. Here is a quick overview of the most important ones:

ModuleDescription
sal/this provides a simple System Abstraction Layer
tools/this provides basic internal types: Rectangle, Color etc.
vcl/this is the widget toolkit library and one rendering abstraction
framework/UNO framework, responsible for building toolbars, menus, status bars, and the chrome around the document using widgets from VCL, and XML descriptions from /uiconfig/ files
sfx2/legacy core framework used by Writer/Calc/Draw: document model / load/save / signals for actions etc.
svx/drawing model related helper code, including much of Draw/Impress

Then applications

ModuleDescription
desktop/this is where the main() for the application lives, init / bootstrap. the name dates back to an ancient StarOffice that also drew a desktop
sw/Writer
sc/Calc
sd/Draw / Impress

There are several other libraries that are helpful from a graphical perspective:

ModuleDescription
basegfx/algorithms and data-types for graphics as used in the canvas
canvas/new (UNO) canvas rendering model with various backends
cppcanvas/C++ helper classes for using the UNO canvas
drawinglayer/View code to render drawable objects and break them down into primitives we can render more easily.

Rules for #include Directives (C/C++)

Use the "..." form if and only if the included file is found next to the including file. Otherwise, use the <...> form. (For further details, see the mail Re: C[++]: Normalizing include syntax ("" vs <>).)

The UNO API include files should consistently use double quotes, for the benefit of external users of this API.

loplugin:includeform (compilerplugins/clang/includeform.cxx) enforces these rules.

Finding Out More

Beyond this, you can read the README.md files, send us patches, ask on the mailing list libreoffice@lists.freedesktop.org (no subscription required) or poke people on IRC #libreoffice-dev on irc.libera.chat - we're a friendly and generally helpful mob. We know the code can be hard to get into at first, and so there are no silly questions.