libsanitizer: Guard cyclades inclusion in sanitizer

[tnfchris]

Summary

The Linux kernel has removed the interface to cyclades from
the latest kernel headers[1] due to them being orphaned for the
past 13 years.

libsanitizer uses this header when compiling against glibc, but
glibcs itself doesn't seem to have any references to cyclades.

Further more it seems that the driver is broken in the kernel and
the firmware doesn't seem to be available anymore.

As such since this is breaking the build of libsanitizer (and so the
GCC bootstrap[2]) I propose to remove this.

[1] https://lkml.org/lkml/2021/3/2/153
[2] https://gcc.gnu.org/bugzilla/show_bug.cgi?id=100379

[jakubjelinek]

Alternative to this would be

#ifdef __has_include
# if __has_include(<linux/cyclades.h>)
#  include <linux/cyclades.h>
#  define SANITIZER_LINUX_CYCLADES 1
# endif
#endif

and use #ifdef SANITIZER_LINUX_CYCLADES to guard the remaining stuff.

Note, the current __has_include uses in sanitizers are incorrect:

sanitizer_common/sanitizer_platform.h:#if __has_include(<features.h>) && !defined(__ANDROID__)
sanitizer_common/sanitizer_platform_limits_netbsd.cpp:#if __has_include(<dev/iscsi/iscsi_ioctl.h>)
sanitizer_common/sanitizer_platform_limits_netbsd.cpp:#if __has_include(<netinet/ip_fil.h>)
sanitizer_common/sanitizer_mac.cpp:#if defined(__has_include) && __has_include(<os/trace.h>)
sanitizer_common/sanitizer_mac.cpp:#if defined(__has_include) && __has_include(<CrashReporterClient.h>)
tsan/rtl/tsan_interceptors_mac.cpp:#if defined(__has_include) && __has_include(<xpc/xpc.h>)
tsan/rtl/tsan_interceptors_mac.cpp:#if defined(__has_include) && __has_include(<xpc/xpc.h>)

If sanitizer relies on has_include support, then it shouldn't use defined(has_include) &&, because it doesn't help anyway, if has_include is not defined then the #if line will not parse properly.
And if it doesn't rely on has_include, it should use the portable way, see https://gcc.gnu.org/onlinedocs/cpp/_005f_005fhas_005finclude.html for details.

[tnfchris]

In D102059#2744070, @jakubjelinek wrote:

Alternative to this would be

#ifdef __has_include
# if __has_include(<linux/cyclades.h>)
#  include <linux/cyclades.h>
#  define SANITIZER_LINUX_CYCLADES 1
# endif
#endif

Ah, I wasn't aware of __has_include :), Will update the patch.

[tnfchris]

Update diff

[jakubjelinek]

compiler-rt/lib/sanitizer_common/sanitizer_platform.h

401

Note, this doesn't define SANITIZER_LINUX_CYCLADES 0 if __has_include is not defined.

[MaskRay]

The Linux kernel has removed the interface to cyclades from the latest kernel headers[1] due to them being orphaned for the past 13 years.

libsanitizer uses this header when compiling against glibc, but glibcs itself doesn't seem to have any references to cyclades.

Sounds like cyclades interceptors should just be deleted?

[tnfchris]

In D102059#2749302, @MaskRay wrote:

The Linux kernel has removed the interface to cyclades from the latest kernel headers[1] due to them being orphaned for the past 13 years.

libsanitizer uses this header when compiling against glibc, but glibcs itself doesn't seem to have any references to cyclades.

Sounds like cyclades interceptors should just be deleted?

I had that in the original patch, but I changed it because in principle there could be someone, somewhere that's using it with downstream fixes?
I don't have any strong opinions either way though and am happy to also remove them (i.e. restore patch back to version 1)

[tnfchris]

@MaskRay was that a you prefer it that way or?

[vitalybuka]

In D102059#2757087, @tnfchris wrote:

@MaskRay was that a you prefer it that way or?

I would go for removing it. @eugenis ?

[tnfchris]

reverted to diff that removed

[tnfchris]

Ping. Sorry for the early ping, but would be good to get bootstrap working again.

[eugenis]

I'd be OK with removing it. 13 years should be enough time to deprecate features.

Context not available.

This change is simple enough so it does not matter, but please upload future diffs with full context.

[tnfchris]

Ah I forgot the context.. Thanks @eugenis !

[tnfchris]

Buildbot has shown a test failure in hwasan with reverting this. Investigating.

https://lab.llvm.org/buildbot/#/builders/53/builds/2778/steps/7/logs/FAIL__HWAddressSanitizer-aarch64__stack-uar-dynami

Not sure why removing cyclades causes a stack check to fail..

[tnfchris]

The test HWAddressSanitizer-aarch64 :: TestCases/stack-uar-dynamic.c fails already at commit a647100b4320923b0e9d156cc3872b3be470ad98 which is before mine.
As such can't be caused by mine, I'll re-commit the patch.

[justinkb]

Any chance this gets backported to 10, 11? edit: let me rephrase that, if I backport this to 10 and 11, will you merge it?

[aaronpuchert]

In D102059#2855043, @justinkb wrote:

Any chance this gets backported to 10, 11?

I don't think there are going to be any more releases for 10 or 11. But it might be interesting for 12.

Can anyone say if this is ABI-compatible? It looks like none of these headers are installed.

It certainly removes an API, but according to the commit message that hasn't usable for a while and it would be good to have the latest LLVM buildable with the latest glibc.

[justinkb]

I believe it will be part of 12.0.1 already, luckily. Already ported to
release/12.x afaict

[aaronpuchert]

You're right. For the record, it's rG884040db086936107ec81656aa5b4c607235fb9a.

compiler-rt/lib/sanitizer_common/sanitizer_common_interceptors_ioctl.inc

if (IOCTL_##rq != IOCTL_NOT_PRESENT) {                 \
     CHECK(ioctl_table_size < ioctl_table_max);           \
     ioctl_table[ioctl_table_size].req = IOCTL_##rq;      \
     ioctl_table[ioctl_table_size].type = ioctl_desc::tp; \
     ioctl_table[ioctl_table_size].size = sz;             \
     ioctl_table[ioctl_table_size].name = #rq;            \
     ++ioctl_table_size;                                  \
   }
 
   _(FIOASYNC, READ, sizeof(int));
   _(FIOCLEX, NONE, 0);
   _(FIOGETOWN, WRITE, sizeof(int));
   _(FIONBIO, READ, sizeof(int));
   _(FIONCLEX, NONE, 0);
   _(FIOSETOWN, READ, sizeof(int));
   _(SIOCATMARK, WRITE, sizeof(int));
   _(SIOCGIFCONF, CUSTOM, 0);
   _(SIOCGPGRP, WRITE, sizeof(int));
   _(SIOCSPGRP, READ, sizeof(int));
 #if !SANITIZER_SOLARIS
   _(TIOCCONS, NONE, 0);
 #endif
   _(TIOCEXCL, NONE, 0);
   _(TIOCGETD, WRITE, sizeof(int));
#endif
   _(VT_RESIZEX, READ, struct_vt_consize_sz);
   _(VT_SENDSIG, NONE, 0);
   _(VT_SETMODE, READ, struct_vt_mode_sz);
   _(VT_WAITACTIVE, NONE, 0);
 #endif
 
 #if SANITIZER_GLIBC
   // _(SIOCDEVPLIP, WRITE, struct_ifreq_sz); // the same as EQL_ENSLAVE
+#if SANITIZER_LINUX_CYCLADES
   _(CYGETDEFTHRESH, WRITE, sizeof(int));
   _(CYGETDEFTIMEOUT, WRITE, sizeof(int));
   _(CYGETMON, WRITE, struct_cyclades_monitor_sz);
   _(CYGETTHRESH, WRITE, sizeof(int));
   _(CYGETTIMEOUT, WRITE, sizeof(int));
   _(CYSETDEFTHRESH, NONE, 0);
   _(CYSETDEFTIMEOUT, NONE, 0);
   _(CYSETTHRESH, NONE, 0);
   _(CYSETTIMEOUT, NONE, 0);
+#endif
   _(EQL_EMANCIPATE, WRITE, struct_ifreq_sz);
   _(EQL_ENSLAVE, WRITE, struct_ifreq_sz);
   _(EQL_GETMASTRCFG, WRITE, struct_ifreq_sz);
   _(EQL_GETSLAVECFG, WRITE, struct_ifreq_sz);
   _(EQL_SETMASTRCFG, WRITE, struct_ifreq_sz);
   _(EQL_SETSLAVECFG, WRITE, struct_ifreq_sz);
   _(EVIOCGKEYCODE_V2, WRITE, struct_input_keymap_entry_sz);
   _(EVIOCGPROP, WRITE, 0);

compiler-rt/lib/sanitizer_common/sanitizer_platform.h

 // compatible with the sanitizer library being loaded via
 // `dlopen()`.
 #if SANITIZER_MAC
 #define SANITIZER_SUPPORTS_INIT_FOR_DLOPEN 1
 #else
 #define SANITIZER_SUPPORTS_INIT_FOR_DLOPEN 0
 #endif
 
+// Kernel has removed this header, as such check for it's existance
+// before trying to include defines from it.
+// https://lkml.org/lkml/2021/3/2/153
+#ifdef __has_include
+# if __has_include(<linux/cyclades.h>) && !SANITIZER_ANDROID
+#  define SANITIZER_LINUX_CYCLADES 1
+# else
+#  define SANITIZER_LINUX_CYCLADES 0
+# endif
+#endif
+
 #endif // SANITIZER_PLATFORM_H

compiler-rt/lib/sanitizer_common/sanitizer_platform_limits_posix.h

 extern unsigned struct_sbi_instrument_sz;
 extern unsigned struct_seq_event_rec_sz;
 extern unsigned struct_synth_info_sz;
 extern unsigned struct_vt_mode_sz;
 #endif // SANITIZER_LINUX
 
 #if SANITIZER_LINUX && !SANITIZER_ANDROID
 extern unsigned struct_ax25_parms_struct_sz;
+#if SANITIZER_LINUX_CYCLADES
 extern unsigned struct_cyclades_monitor_sz;
+#endif
 extern unsigned struct_input_keymap_entry_sz;
 extern unsigned struct_ipx_config_data_sz;
 extern unsigned struct_kbdiacrs_sz;
 extern unsigned struct_kbentry_sz;
 extern unsigned struct_kbkeycode_sz;
 extern unsigned struct_kbsentry_sz;
 extern unsigned struct_mtconfiginfo_sz;
 extern unsigned struct_nr_parms_struct_sz;

 extern unsigned IOCTL_VT_GETMODE;
 extern unsigned IOCTL_VT_OPENQRY;
 extern unsigned IOCTL_VT_RELDISP;
 extern unsigned IOCTL_VT_SETMODE;
 extern unsigned IOCTL_VT_WAITACTIVE;
 #endif  // SANITIZER_LINUX
 
 #if SANITIZER_LINUX && !SANITIZER_ANDROID
+#if SANITIZER_LINUX_CYCLADES
 extern unsigned IOCTL_CYGETDEFTHRESH;
 extern unsigned IOCTL_CYGETDEFTIMEOUT;
 extern unsigned IOCTL_CYGETMON;
 extern unsigned IOCTL_CYGETTHRESH;
 extern unsigned IOCTL_CYGETTIMEOUT;
 extern unsigned IOCTL_CYSETDEFTHRESH;
 extern unsigned IOCTL_CYSETDEFTIMEOUT;
 extern unsigned IOCTL_CYSETTHRESH;
 extern unsigned IOCTL_CYSETTIMEOUT;
+#endif
 extern unsigned IOCTL_EQL_EMANCIPATE;
 extern unsigned IOCTL_EQL_ENSLAVE;
 extern unsigned IOCTL_EQL_GETMASTRCFG;
 extern unsigned IOCTL_EQL_GETSLAVECFG;
 extern unsigned IOCTL_EQL_SETMASTRCFG;
 extern unsigned IOCTL_EQL_SETSLAVECFG;
 extern unsigned IOCTL_EVIOCGKEYCODE_V2;
 extern unsigned IOCTL_EVIOCGPROP;

compiler-rt/lib/sanitizer_common/sanitizer_platform_limits_posix.cpp

 #include <sys/mtio.h>
 #include <sys/shm.h>
 #include <sys/statvfs.h>
 #include <sys/timex.h>
 #if defined(__mips64)
 # include <sys/procfs.h>
 #endif
 #include <sys/user.h>
-#include <linux/cyclades.h>
+#if SANITIZER_LINUX_CYCLADES
+# include <linux/cyclades.h>
+#endif
 #include <linux/if_eql.h>
 #include <linux/if_plip.h>
 #include <linux/lp.h>
 #include <linux/mroute.h>
 #include <linux/mroute6.h>
 #include <linux/scc.h>
 #include <linux/serial.h>
 #include <sys/msg.h>
#endif
   unsigned struct_sbi_instrument_sz = sizeof(struct sbi_instrument);
   unsigned struct_seq_event_rec_sz = sizeof(struct seq_event_rec);
   unsigned struct_synth_info_sz = sizeof(struct synth_info);
   unsigned struct_vt_mode_sz = sizeof(struct vt_mode);
 #endif // SANITIZER_LINUX
 
 #if SANITIZER_GLIBC
   unsigned struct_ax25_parms_struct_sz = sizeof(struct ax25_parms_struct);
+#if SANITIZER_LINUX_CYCLADES
   unsigned struct_cyclades_monitor_sz = sizeof(struct cyclades_monitor);
+#endif
 #if EV_VERSION > (0x010000)
   unsigned struct_input_keymap_entry_sz = sizeof(struct input_keymap_entry);
 #else
   unsigned struct_input_keymap_entry_sz = 0;
 #endif
   unsigned struct_ipx_config_data_sz = sizeof(struct ipx_config_data);
   unsigned struct_kbdiacrs_sz = sizeof(struct kbdiacrs);
   unsigned struct_kbentry_sz = sizeof(struct kbentry);
#endif // SOUND_VERSION
   unsigned IOCTL_VT_GETMODE = VT_GETMODE;
   unsigned IOCTL_VT_OPENQRY = VT_OPENQRY;
   unsigned IOCTL_VT_RELDISP = VT_RELDISP;
   unsigned IOCTL_VT_SETMODE = VT_SETMODE;
   unsigned IOCTL_VT_WAITACTIVE = VT_WAITACTIVE;
 #endif // SANITIZER_LINUX
 
 #if SANITIZER_LINUX && !SANITIZER_ANDROID
+#if SANITIZER_LINUX_CYCLADES
   unsigned IOCTL_CYGETDEFTHRESH = CYGETDEFTHRESH;
   unsigned IOCTL_CYGETDEFTIMEOUT = CYGETDEFTIMEOUT;
   unsigned IOCTL_CYGETMON = CYGETMON;
   unsigned IOCTL_CYGETTHRESH = CYGETTHRESH;
   unsigned IOCTL_CYGETTIMEOUT = CYGETTIMEOUT;
   unsigned IOCTL_CYSETDEFTHRESH = CYSETDEFTHRESH;
   unsigned IOCTL_CYSETDEFTIMEOUT = CYSETDEFTIMEOUT;
   unsigned IOCTL_CYSETTHRESH = CYSETTHRESH;
   unsigned IOCTL_CYSETTIMEOUT = CYSETTIMEOUT;
+#endif
   unsigned IOCTL_EQL_EMANCIPATE = EQL_EMANCIPATE;
   unsigned IOCTL_EQL_ENSLAVE = EQL_ENSLAVE;
   unsigned IOCTL_EQL_GETMASTRCFG = EQL_GETMASTRCFG;
   unsigned IOCTL_EQL_GETSLAVECFG = EQL_GETSLAVECFG;
   unsigned IOCTL_EQL_SETMASTRCFG = EQL_SETMASTRCFG;
   unsigned IOCTL_EQL_SETSLAVECFG = EQL_SETSLAVECFG;
 #if EV_VERSION > (0x010000)
   unsigned IOCTL_EVIOCGKEYCODE_V2 = EVIOCGKEYCODE_V2;