|
| 1 | +use core::fmt; |
| 2 | +use std::str::FromStr; |
| 3 | + |
| 4 | +use rustc_macros::{Decodable_NoContext, Encodable_NoContext, StableHash}; |
| 5 | + |
| 6 | +#[derive( |
| 7 | + Default, |
| 8 | + Clone, |
| 9 | + Copy, |
| 10 | + PartialEq, |
| 11 | + Eq, |
| 12 | + Hash, |
| 13 | + Encodable_NoContext, |
| 14 | + Decodable_NoContext, |
| 15 | + StableHash |
| 16 | +)] |
| 17 | +pub struct SanitizerSet(u16); |
| 18 | +bitflags::bitflags! { |
| 19 | + impl SanitizerSet: u16 { |
| 20 | + const ADDRESS = 1 << 0; |
| 21 | + const LEAK = 1 << 1; |
| 22 | + const MEMORY = 1 << 2; |
| 23 | + const THREAD = 1 << 3; |
| 24 | + const HWADDRESS = 1 << 4; |
| 25 | + const CFI = 1 << 5; |
| 26 | + const MEMTAG = 1 << 6; |
| 27 | + const SHADOWCALLSTACK = 1 << 7; |
| 28 | + const KCFI = 1 << 8; |
| 29 | + const KERNELADDRESS = 1 << 9; |
| 30 | + const KERNELHWADDRESS = 1 << 10; |
| 31 | + const SAFESTACK = 1 << 11; |
| 32 | + const DATAFLOW = 1 << 12; |
| 33 | + const REALTIME = 1 << 13; |
| 34 | + } |
| 35 | +} |
| 36 | +rustc_data_structures::external_bitflags_debug! { SanitizerSet } |
| 37 | + |
| 38 | +impl SanitizerSet { |
| 39 | + // Taken from LLVM's sanitizer compatibility logic: |
| 40 | + // https://github.com/llvm/llvm-project/blob/release/18.x/clang/lib/Driver/SanitizerArgs.cpp#L512 |
| 41 | + const MUTUALLY_EXCLUSIVE: &'static [(SanitizerSet, SanitizerSet)] = &[ |
| 42 | + (SanitizerSet::ADDRESS, SanitizerSet::MEMORY), |
| 43 | + (SanitizerSet::ADDRESS, SanitizerSet::THREAD), |
| 44 | + (SanitizerSet::ADDRESS, SanitizerSet::HWADDRESS), |
| 45 | + (SanitizerSet::ADDRESS, SanitizerSet::MEMTAG), |
| 46 | + (SanitizerSet::ADDRESS, SanitizerSet::KERNELADDRESS), |
| 47 | + (SanitizerSet::ADDRESS, SanitizerSet::KERNELHWADDRESS), |
| 48 | + (SanitizerSet::ADDRESS, SanitizerSet::SAFESTACK), |
| 49 | + (SanitizerSet::LEAK, SanitizerSet::MEMORY), |
| 50 | + (SanitizerSet::LEAK, SanitizerSet::THREAD), |
| 51 | + (SanitizerSet::LEAK, SanitizerSet::KERNELADDRESS), |
| 52 | + (SanitizerSet::LEAK, SanitizerSet::KERNELHWADDRESS), |
| 53 | + (SanitizerSet::LEAK, SanitizerSet::SAFESTACK), |
| 54 | + (SanitizerSet::MEMORY, SanitizerSet::THREAD), |
| 55 | + (SanitizerSet::MEMORY, SanitizerSet::HWADDRESS), |
| 56 | + (SanitizerSet::MEMORY, SanitizerSet::KERNELADDRESS), |
| 57 | + (SanitizerSet::MEMORY, SanitizerSet::KERNELHWADDRESS), |
| 58 | + (SanitizerSet::MEMORY, SanitizerSet::SAFESTACK), |
| 59 | + (SanitizerSet::THREAD, SanitizerSet::HWADDRESS), |
| 60 | + (SanitizerSet::THREAD, SanitizerSet::KERNELADDRESS), |
| 61 | + (SanitizerSet::THREAD, SanitizerSet::KERNELHWADDRESS), |
| 62 | + (SanitizerSet::THREAD, SanitizerSet::SAFESTACK), |
| 63 | + (SanitizerSet::HWADDRESS, SanitizerSet::MEMTAG), |
| 64 | + (SanitizerSet::HWADDRESS, SanitizerSet::KERNELADDRESS), |
| 65 | + (SanitizerSet::HWADDRESS, SanitizerSet::KERNELHWADDRESS), |
| 66 | + (SanitizerSet::HWADDRESS, SanitizerSet::SAFESTACK), |
| 67 | + (SanitizerSet::CFI, SanitizerSet::KCFI), |
| 68 | + (SanitizerSet::MEMTAG, SanitizerSet::KERNELADDRESS), |
| 69 | + (SanitizerSet::MEMTAG, SanitizerSet::KERNELHWADDRESS), |
| 70 | + (SanitizerSet::KERNELADDRESS, SanitizerSet::KERNELHWADDRESS), |
| 71 | + (SanitizerSet::KERNELADDRESS, SanitizerSet::SAFESTACK), |
| 72 | + (SanitizerSet::KERNELHWADDRESS, SanitizerSet::SAFESTACK), |
| 73 | + ]; |
| 74 | + |
| 75 | + /// Return sanitizer's name |
| 76 | + /// |
| 77 | + /// Returns none if the flags is a set of sanitizers numbering not exactly one. |
| 78 | + pub fn as_str(self) -> Option<&'static str> { |
| 79 | + Some(match self { |
| 80 | + SanitizerSet::ADDRESS => "address", |
| 81 | + SanitizerSet::CFI => "cfi", |
| 82 | + SanitizerSet::DATAFLOW => "dataflow", |
| 83 | + SanitizerSet::KCFI => "kcfi", |
| 84 | + SanitizerSet::KERNELADDRESS => "kernel-address", |
| 85 | + SanitizerSet::KERNELHWADDRESS => "kernel-hwaddress", |
| 86 | + SanitizerSet::LEAK => "leak", |
| 87 | + SanitizerSet::MEMORY => "memory", |
| 88 | + SanitizerSet::MEMTAG => "memtag", |
| 89 | + SanitizerSet::SAFESTACK => "safestack", |
| 90 | + SanitizerSet::SHADOWCALLSTACK => "shadow-call-stack", |
| 91 | + SanitizerSet::THREAD => "thread", |
| 92 | + SanitizerSet::HWADDRESS => "hwaddress", |
| 93 | + SanitizerSet::REALTIME => "realtime", |
| 94 | + _ => return None, |
| 95 | + }) |
| 96 | + } |
| 97 | + |
| 98 | + pub fn mutually_exclusive(self) -> Option<(SanitizerSet, SanitizerSet)> { |
| 99 | + Self::MUTUALLY_EXCLUSIVE |
| 100 | + .into_iter() |
| 101 | + .find(|&(a, b)| self.contains(*a) && self.contains(*b)) |
| 102 | + .copied() |
| 103 | + } |
| 104 | +} |
| 105 | + |
| 106 | +/// Formats a sanitizer set as a comma separated list of sanitizers' names. |
| 107 | +impl fmt::Display for SanitizerSet { |
| 108 | + fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { |
| 109 | + let mut first = true; |
| 110 | + for s in *self { |
| 111 | + let name = s.as_str().unwrap_or_else(|| panic!("unrecognized sanitizer {s:?}")); |
| 112 | + if !first { |
| 113 | + f.write_str(", ")?; |
| 114 | + } |
| 115 | + f.write_str(name)?; |
| 116 | + first = false; |
| 117 | + } |
| 118 | + Ok(()) |
| 119 | + } |
| 120 | +} |
| 121 | + |
| 122 | +impl FromStr for SanitizerSet { |
| 123 | + type Err = String; |
| 124 | + fn from_str(s: &str) -> Result<Self, Self::Err> { |
| 125 | + Ok(match s { |
| 126 | + "address" => SanitizerSet::ADDRESS, |
| 127 | + "cfi" => SanitizerSet::CFI, |
| 128 | + "dataflow" => SanitizerSet::DATAFLOW, |
| 129 | + "kcfi" => SanitizerSet::KCFI, |
| 130 | + "kernel-address" => SanitizerSet::KERNELADDRESS, |
| 131 | + "kernel-hwaddress" => SanitizerSet::KERNELHWADDRESS, |
| 132 | + "leak" => SanitizerSet::LEAK, |
| 133 | + "memory" => SanitizerSet::MEMORY, |
| 134 | + "memtag" => SanitizerSet::MEMTAG, |
| 135 | + "safestack" => SanitizerSet::SAFESTACK, |
| 136 | + "shadow-call-stack" => SanitizerSet::SHADOWCALLSTACK, |
| 137 | + "thread" => SanitizerSet::THREAD, |
| 138 | + "hwaddress" => SanitizerSet::HWADDRESS, |
| 139 | + "realtime" => SanitizerSet::REALTIME, |
| 140 | + s => return Err(format!("unknown sanitizer {s}")), |
| 141 | + }) |
| 142 | + } |
| 143 | +} |
| 144 | + |
| 145 | +impl schemars::JsonSchema for SanitizerSet { |
| 146 | + fn schema_name() -> std::borrow::Cow<'static, str> { |
| 147 | + "SanitizerSet".into() |
| 148 | + } |
| 149 | + fn json_schema(_: &mut schemars::SchemaGenerator) -> schemars::Schema { |
| 150 | + let all = Self::all().iter().map(|sanitizer| sanitizer.as_str()).collect::<Vec<_>>(); |
| 151 | + schemars::json_schema! ({ |
| 152 | + "type": "string", |
| 153 | + "enum": all, |
| 154 | + }) |
| 155 | + } |
| 156 | +} |
| 157 | + |
| 158 | +impl<'de> serde::Deserialize<'de> for SanitizerSet { |
| 159 | + fn deserialize<D>(deserializer: D) -> Result<Self, D::Error> |
| 160 | + where |
| 161 | + D: serde::Deserializer<'de>, |
| 162 | + { |
| 163 | + let s = String::deserialize(deserializer)?; |
| 164 | + FromStr::from_str(&s).map_err(serde::de::Error::custom) |
| 165 | + } |
| 166 | +} |
0 commit comments