msan: update motd message for developer use

Author: grooverdan

.github/workflows/build-debian.msan-based.yml

@@ -10,6 +10,7 @@ on:
       - 'ci_build_images/rr.Dockerfile'
       - 'ci_build_images/msan.fragment.Dockerfile'
       - 'ci_build_images/msan.instrumentedlibs.sh'
+      - 'ci_build_images/msan.motd'
       - 'ci_build_images/qpress.Dockerfile'
       - 'ci_build_images/buildbot-worker.Dockerfile'
       - .github/workflows/build-debian.msan-based.yml
@@ -20,6 +21,7 @@ on:
       - 'ci_build_images/rr.Dockerfile'
       - 'ci_build_images/msan.fragment.Dockerfile'
       - 'ci_build_images/msan.instrumentedlibs.sh'
+      - 'ci_build_images/msan.motd'
       - 'ci_build_images/qpress.Dockerfile'
       - 'ci_build_images/buildbot-worker.Dockerfile'
       - .github/workflows/build-debian.msan-based.yml
@@ -50,6 +52,7 @@ jobs:
       nogalera: ${{ matrix.nogalera }}
       files:
         '[
-          {"name": "msan.instrumentedlibs.sh", "source": "''$WORKDIR/msan.instrumentedlibs.sh''", "target": "''$GITHUB_WORKSPACE''"}
+          {"name": "msan.instrumentedlibs.sh", "source": "''$WORKDIR/msan.instrumentedlibs.sh''", "target": "''$GITHUB_WORKSPACE''"},
+          {"name": "msan.motd", "source": "''$WORKDIR/msan.motd''", "target": "''$GITHUB_WORKSPACE''"}
         ]'
     secrets: inherit

ci_build_images/msan.fragment.Dockerfile

@@ -93,51 +93,10 @@ RUN . /etc/os-release \
 COPY --from=rr /tmp/install/usr/ /usr/
 
 # ASAN/UBSAN
+COPY msan.motd /etc/motd
+
 RUN echo "cat /etc/motd" > ~buildbot/.bashrc ; \
-    printf "\
-This is a container for ASAN, UBSAN and MSAN building\n\
-\n\
-A basic MSAN build can be achieved with\n\
-\n\
-cmake -DWITH_EMBEDDED_SERVER=OFF \\ \n\
-      -DWITH_INNODB_{BZIP2,LZ4,LZMA,LZO,SNAPPY}=OFF \\ \n\
-      -DPLUGIN_{MROONGA,ROCKSDB,OQGRAPH,SPIDER}=NO  \\ \n\
-      -DWITH_ZLIB=bundled  \\ \n\
-      -DHAVE_LIBAIO_H=0    \\ \n\
-      -DCMAKE_DISABLE_FIND_PACKAGE_{URING,LIBAIO}=1  \\ \n\
-      -DWITH_NUMA=NO  \\ \n\
-      -DWITH_SYSTEMD=no \\ \n\
-      -DWITH_MSAN=ON  \\ \n\
-      -DHAVE_CXX_NEW=1  \\ \n\
-      -DCMAKE_{EXE,MODULE}_LINKER_FLAGS=\"-L\${MSAN_LIBDIR} -Wl,-rpath=\${MSAN_LIBDIR}\" \\ \n\
-      -DWITH_DBUG_TRACE=OFF \\ \n\
-      /source\n\
-\n\
-A basic combined UBSAN/ASAN build can be achieved with\n\
-\n\
-cmake -DWITH_ASAN=ON -DWITH_ASAN_SCOPED=ON -DWITH_UBSAN=ON -DPLUGIN_PERFSCHEMA=NO /source\n\
-\n\
-Build with:\n\
-\n\
-cmake --build .\n\
-\n\
-Test with:\n\
-\n\
-mysql-test/mtr --parallel=auto\n\
-\n\
-There are UBSAN filters covering currently unfixed bugs within\n\
-the server that can be used to direct your development, or validate if a\n\
-observed failure is known. Perform the following to download/inspect them.\n\
-\n\
-curl https://raw.githubusercontent.com/mariadb-corporation/mariadb-qa/refs/heads/master/UBSAN.filter -o /build/UBSAN.filter\n\
-\n\
-After this, add suppressions to UBSAN_OPTIONS with\n\
-\n\
-export UBSAN_OPTIONS=\$UBSAN_OPTIONS:suppressions=/build/UBSAN.filter\n\
-\n\
-ref sanitizer flags documents:\n\
-* https://github.com/google/sanitizers/wiki/AddressSanitizerFlags\n\
-* https://clang.llvm.org/docs/UndefinedBehaviorSanitizer.html\n\n" > /etc/motd
+    chown buildbot: ~buildbot/.bashrc
 
 ENV ASAN_OPTIONS=quarantine_size_mb=512:atexit=0:detect_invalid_pointer_pairs=3:dump_instruction_bytes=1:allocator_may_return_null=1
 ENV UBSAN_OPTIONS=print_stacktrace=1:report_error_type=1

ci_build_images/msan.motd

@@ -0,0 +1,45 @@
+This is a container for ASAN, UBSAN and MSAN building
+
+A basic MSAN build can be achieved with:
+
+cmake \
+      -DUPDATE_SUBMODULES=OFF \
+      -DWITH_MSAN=ON  \
+      -DCMAKE_{EXE,MODULE}_LINKER_FLAGS="-L${MSAN_LIBDIR} -Wl,-rpath=${MSAN_LIBDIR}" \
+      -DWITH_INNODB_{BZIP2,LZ4,LZMA,LZO,SNAPPY}=OFF \
+      -DPLUGIN_{MROONGA,ROCKSDB,OQGRAPH,COLUMNSTORE}=NO  \
+      -DWITH_ZLIB=bundled  \
+      -DHAVE_LIBAIO_H=0    \
+      -DCMAKE_DISABLE_FIND_PACKAGE_{URING,LIBAIO}=1  \
+      -DWITH_NUMA=NO  \
+      -DWITH_SYSTEMD=no \
+      -DWITH_DBUG_TRACE=OFF \
+      -DWITH_EMBEDDED_SERVER=OFF \
+      /source
+
+A basic combined UBSAN/ASAN build can be achieved with:
+
+cmake -DWITH_ASAN=ON -DWITH_ASAN_SCOPED=ON -DWITH_UBSAN=ON -DWITH_UNIT_TESTS=OFF /source
+
+Build with:
+
+cmake --build .
+
+Test with:
+
+mysql-test/mtr --parallel=auto
+
+There are UBSAN filters covering currently unfixed bugs within
+the server that can be used to direct your development, or validate if a
+observed failure is known. Perform the following to download/inspect them.
+
+curl https://raw.githubusercontent.com/mariadb-corporation/mariadb-qa/refs/heads/master/UBSAN.filter -o /build/UBSAN.filter
+
+After this, add suppressions to UBSAN_OPTIONS with
+
+export UBSAN_OPTIONS=\$UBSAN_OPTIONS:suppressions=/build/UBSAN.filter
+
+ref sanitizer flags documents:
+* https://github.com/google/sanitizers/wiki/AddressSanitizerFlags
+* https://clang.llvm.org/docs/UndefinedBehaviorSanitizer.html
+* https://mariadb.com/docs/server/server-management/install-and-upgrade-mariadb/installing-mariadb/compiling-mariadb-from-source/compile-and-using-mariadb-with-sanitizers-asan-ubsan-tsan-msan#buildbots-msan-container