[Inclusive Language] migrate "sanity" checks to "soundness" checks

bolt/lib/Passes/CMOVConversion.cpp

@@ -66,7 +66,7 @@ bool isIfThenSubgraph(const BinaryBasicBlock &LHS,
   if (LHS.pred_size() != 2 || RHS.pred_size() != 1)
     return false;
 
-  // Sanity check
+  // Soundness check
   BinaryBasicBlock *Predecessor = *RHS.pred_begin();
   assert(Predecessor && LHS.isPredecessor(Predecessor) && "invalid subgraph");
   (void)Predecessor;

bolt/lib/Passes/IndirectCallPromotion.cpp

@@ -597,7 +597,7 @@ IndirectCallPromotion::findCallTargetSymbols(std::vector<Callsite> &Targets,
       std::vector<uint64_t>({JTIndex}).swap(NewTargets.back().JTIndices);
       llvm::erase(Target.JTIndices, JTIndex);
 
-      // Keep fixCFG counts sane if more indices use this same target later
+      // Keep fixCFG counts sound if more indices use this same target later
       assert(IndicesPerTarget[Target.To.Sym] > 0 && "wrong map");
       NewTargets.back().Branches =
           Target.Branches / IndicesPerTarget[Target.To.Sym];

bolt/lib/Profile/YAMLProfileReader.cpp

@@ -385,7 +385,7 @@ Error YAMLProfileReader::preprocessProfile(BinaryContext &BC) {
     return errorCodeToError(YamlInput.error());
   }
 
-  // Sanity check.
+  // Soundness check.
   if (YamlBP.Header.Version != 1)
     return make_error<StringError>(
         Twine("cannot read profile : unsupported version"),

bolt/lib/Rewrite/RewriteInstance.cpp

@@ -637,7 +637,7 @@ Error RewriteInstance::discoverStorage() {
     // If user specified a custom address where we should start writing new
     // data, honor that.
     NextAvailableAddress = opts::CustomAllocationVMA;
-    // Sanity check the user-supplied address and emit warnings if something
+    // Soundness check the user-supplied address and emit warnings if something
     // seems off.
     for (const ELF64LE::Phdr &Phdr : PHs) {
       switch (Phdr.p_type) {
@@ -2985,7 +2985,7 @@ void RewriteInstance::handleRelocation(const SectionRef &RelocatedSection,
     }
 
     if (BinaryData *BD = BC->getBinaryDataContainingAddress(SymbolAddress)) {
-      // Note: this assertion is trying to check sanity of BinaryData objects
+      // Note: this assertion is trying to check soundness of BinaryData objects
       // but AArch64 and RISCV has inferred and incomplete object locations
       // coming from GOT/TLS or any other non-trivial relocation (that requires
       // creation of sections and whose symbol address is not really what should

bolt/runtime/instr.cpp

@@ -819,7 +819,7 @@ ProfileWriterContext readDescriptions() {
 #endif
 
 #if !defined(__APPLE__)
-/// Debug by printing overall metadata global numbers to check it is sane
+/// Debug by printing overall metadata global numbers to check it is sound
 void printStats(const ProfileWriterContext &Ctx) {
   char StatMsg[BufSize];
   char *StatPtr = StatMsg;

bolt/test/AArch64/hook-fini.s

@@ -4,7 +4,7 @@
 ## dynamic).
 ## All tests perform the following steps:
 ## - Compile and link for the case to be tested
-## - Some sanity-checks on the dynamic section and relocations in the binary to
+## - Some soundness-checks on the dynamic section and relocations in the binary to
 ##   verify it has the shape we want for testing:
 ##   - DT_FINI or DT_FINI_ARRAY in dynamic section
 ##   - No relative relocations for non-PIE

bolt/test/binary-analysis/AArch64/gs-pacret-autiasp.s

@@ -272,7 +272,7 @@ lr_clobbered_nocfg:
         ret
         .size lr_clobbered_nocfg, .-lr_clobbered_nocfg
 
-/// Now do a basic sanity check on every different Authentication instruction:
+/// Now do a basic soundness check on every different Authentication instruction:
 
         .globl  f_autiasp
         .type   f_autiasp,@function

bolt/test/runtime/AArch64/hook-fini.test

@@ -4,7 +4,7 @@
 # dynamic).
 # All tests perform the following steps:
 # - Compile and link for the case to be tested
-# - Some sanity-checks on the dynamic section and relocations in the binary to
+# - Some soundness-checks on the dynamic section and relocations in the binary to
 #   verify it has the shape we want for testing:
 #   - DT_FINI or DT_FINI_ARRAY in dynamic section
 #   - No relative relocations for non-PIE

bolt/tools/merge-fdata/merge-fdata.cpp

@@ -428,7 +428,7 @@ int main(int argc, char **argv) {
     if (YamlInput.error())
       report_error(InputDataFilename, YamlInput.error());
 
-    // Sanity check.
+    // Soundness check.
     if (BP.Header.Version != 1) {
       errs() << "Unable to merge data from profile using version "
              << BP.Header.Version << '\n';

clang-tools-extra/clang-tidy/google/ExplicitMakePairCheck.cpp

@@ -40,7 +40,7 @@ void ExplicitMakePairCheck::check(const MatchFinder::MatchResult &Result) {
   const auto *Call = Result.Nodes.getNodeAs<CallExpr>("call");
   const auto *DeclRef = Result.Nodes.getNodeAs<DeclRefExpr>("declref");
 
-  // Sanity check: The use might have overriden ::std::make_pair.
+  // Soundness check: The use might have overriden ::std::make_pair.
   if (Call->getNumArgs() != 2)
     return;
 

clang-tools-extra/clang-tidy/hicpp/MultiwayPathsCoveredCheck.cpp

@@ -99,7 +99,7 @@ void MultiwayPathsCoveredCheck::check(const MatchFinder::MatchResult &Result) {
   bool SwitchHasDefault = false;
   std::tie(SwitchCaseCount, SwitchHasDefault) = countCaseLabels(Switch);
 
-  // Checks the sanity of 'switch' statements that actually do define
+  // Checks the soundness of 'switch' statements that actually do define
   // a default branch but might be degenerated by having no or only one case.
   if (SwitchHasDefault) {
     handleSwitchWithDefault(Switch, SwitchCaseCount);

clang-tools-extra/clang-tidy/misc/NoRecursionCheck.cpp

@@ -92,7 +92,7 @@ template <typename T, unsigned SmallSize> class SmartSmallSetVector {
   void populateSet() {
     assert(Set.empty() && "Should not have already utilized the Set.");
     // Magical growth factor prediction - to how many elements do we expect to
-    // sanely grow after switching away from small-size storage?
+    // soundly grow after switching away from small-size storage?
     const size_t NewMaxElts = 4 * Vector.size();
     Vector.reserve(NewMaxElts);
     Set.reserve(NewMaxElts);

clang-tools-extra/clang-tidy/readability/FunctionCognitiveComplexityCheck.cpp

@@ -133,7 +133,7 @@ struct CognitiveComplexity final {
                 "that in terms of stack usage. "
                 "Thus, it is good to minimize the size of the Detail struct.");
   SmallVector<Detail, DefaultLimit> Details; // 25 elements is 200 bytes.
-  // Yes, 25 is a magic number. This is the seemingly-sane default for the
+  // Yes, 25 is a magic number. This is the seemingly-sound default for the
   // upper limit for function cognitive complexity. Thus it would make sense
   // to avoid allocations for any function that does not violate the limit.
 

clang-tools-extra/clang-tidy/readability/NamedParameterCheck.cpp

@@ -61,7 +61,7 @@ void NamedParameterCheck::check(const MatchFinder::MatchResult &Result) {
         Parm->getType()->isSpecificBuiltinType(BuiltinType::Int))
       continue;
 
-    // Sanity check the source locations.
+    // Soundness check the source locations.
     if (!Parm->getLocation().isValid() || Parm->getLocation().isMacroID() ||
         !SM.isWrittenInSameFile(Parm->getBeginLoc(), Parm->getLocation()))
       continue;

clang-tools-extra/clangd/CodeCompletionStrings.cpp

@@ -123,7 +123,7 @@ std::string getDeclComment(const ASTContext &Ctx, const NamedDecl &Decl) {
     if (!RC)
       return "";
 
-    // Sanity check that the comment does not come from the PCH. We choose to
+    // Soundness check that the comment does not come from the PCH. We choose to
     // not write them into PCH, because they are racy and slow to load.
     assert(!Ctx.getSourceManager().isLoadedSourceLocation(RC->getBeginLoc()));
 
@@ -146,7 +146,7 @@ std::string getDeclComment(const ASTContext &Ctx, const NamedDecl &Decl) {
     RC = getCompletionComment(Ctx, &Decl);
     if (!RC)
       return "";
-    // Sanity check that the comment does not come from the PCH. We choose to
+    // Soundness check that the comment does not come from the PCH. We choose to
     // not write them into PCH, because they are racy and slow to load.
     assert(!Ctx.getSourceManager().isLoadedSourceLocation(RC->getBeginLoc()));
     Doc = RC->getFormattedText(Ctx.getSourceManager(), Ctx.getDiagnostics());

clang-tools-extra/clangd/Compiler.cpp

@@ -100,7 +100,7 @@ buildCompilerInvocation(const ParseInputs &Inputs, clang::DiagnosticConsumer &D,
   std::vector<const char *> ArgStrs;
   ArgStrs.reserve(Argv.size() + 1);
   // In asserts builds, CompilerInvocation redundantly reads/parses cc1 args as
-  // a sanity test. This is not useful to clangd, and costs 10% of test time.
+  // a soundness test. This is not useful to clangd, and costs 10% of test time.
   // To avoid mismatches between assert/production builds, disable it always.
   ArgStrs = {Argv.front().c_str(), "-Xclang", "-no-round-trip-args"};
   for (const auto &S : Argv.drop_front())

clang-tools-extra/clangd/XRefs.cpp

@@ -972,7 +972,7 @@ class ReferenceFinder : public index::IndexDataConsumer {
                      llvm::dyn_cast_or_null<ObjCMethodDecl>(ASTNode.OrigD)) {
         OMD->getSelectorLocs(Locs);
       }
-      // Sanity check: we expect the *first* token to match the reported loc.
+      // Soundness check: we expect the *first* token to match the reported loc.
       // Otherwise, maybe it was e.g. some other kind of reference to a Decl.
       if (!Locs.empty() && Locs.front() != Loc)
         Locs.clear(); // First token doesn't match, assume our guess was wrong.

clang-tools-extra/clangd/index/IndexAction.cpp

@@ -106,7 +106,7 @@ struct IncludeGraphCollector : public PPCallbacks {
     NodeForIncluding.first->getValue().DirectIncludes.push_back(NodeForInclude);
   }
 
-  // Sanity check to ensure we have already populated a skipped file.
+  // Soundness check to ensure we have already populated a skipped file.
   void FileSkipped(const FileEntryRef &SkippedFile, const Token &FilenameTok,
                    SrcMgr::CharacteristicKind FileType) override {
 #ifndef NDEBUG

clang-tools-extra/clangd/unittests/BackgroundIndexTests.cpp

@@ -854,7 +854,7 @@ TEST(BackgroundQueueTest, Progress) {
   using testing::AnyOf;
   BackgroundQueue::Stats S;
   BackgroundQueue Q([&](BackgroundQueue::Stats New) {
-    // Verify values are sane.
+    // Verify values are sound.
     // Items are enqueued one at a time (at least in this test).
     EXPECT_THAT(New.Enqueued, AnyOf(S.Enqueued, S.Enqueued + 1));
     // Items are completed one at a time.

clang-tools-extra/clangd/unittests/ClangdTests.cpp

@@ -919,7 +919,7 @@ int d;
   StartSecond.wait();
   Server.addDocument(FooCpp, SourceContentsWithoutErrors);
   ASSERT_TRUE(Server.blockUntilIdleForTest()) << "Waiting for diagnostics";
-  ASSERT_EQ(DiagConsumer.Count, 2); // Sanity check - we actually ran both?
+  ASSERT_EQ(DiagConsumer.Count, 2); // Soundness check - we actually ran both?
 }
 
 TEST(ClangdServerTest, FormatCode) {

clang-tools-extra/clangd/unittests/QualityTests.cpp

@@ -10,7 +10,7 @@
 // For interesting cases, both exact scores and "X beats Y" are too brittle to
 // make good hard assertions.
 //
-// Here we test the signal extraction and sanity-check that signals point in
+// Here we test the signal extraction and soundness-check that signals point in
 // the right direction. This should be supplemented by quality metrics which
 // we can compute from a corpus of queries and preferred rankings.
 //

clang-tools-extra/clangd/unittests/RenameTests.cpp

@@ -1444,7 +1444,7 @@ TEST(RenameTest, IndexMergeMainFile) {
   EXPECT_THAT(Results.GlobalChanges[Main].asTextEdits(),
               ElementsAre(newText("xPrime")));
 
-  // Sanity check: we do expect to see index results!
+  // Soundness check: we do expect to see index results!
   TU.Filename = "other.cc";
   Results = Rename(TU.index().get());
   EXPECT_THAT(Results.GlobalChanges.keys(),

clang-tools-extra/test/clang-tidy/infrastructure/expand-modular-headers-ppcallbacks.cpp

@@ -1,4 +1,4 @@
-// Sanity-check. Run without modules:
+// Soundness-check. Run without modules:
 // RUN: rm -rf %t
 // RUN: mkdir %t
 // RUN: cp %S/Inputs/expand-modular-headers-ppcallbacks/* %t/

clang/docs/AutomaticReferenceCounting.rst

@@ -1993,7 +1993,7 @@ A program is ill-formed if it refers to the ``NSAutoreleasePool`` class.
   dependencies between two calls.  It is also very easy to accidentally forget
   to drain an autorelease pool when using the manual API, and this can
   significantly inflate the process's high-water-mark.  The introduction of a
-  new scope is unfortunate but basically required for sane interaction with the
+  new scope is unfortunate but basically required for sound interaction with the
   rest of the language.  Not draining the pool during an unwind is apparently
   required by the Objective-C exceptions implementation.
 

clang/docs/InternalsManual.rst

@@ -82,7 +82,7 @@ using it.  From this file, :program:`tblgen` generates the unique ID of the
 diagnostic, the severity of the diagnostic and the English translation + format
 string.
 
-There is little sanity with the naming of the unique ID's right now.  Some
+There is little soundness with the naming of the unique ID's right now.  Some
 start with ``err_``, ``warn_``, ``ext_`` to encode the severity into the name.
 Since the enum is referenced in the C++ code that produces the diagnostic, it
 is somewhat useful for it to be reasonably short.

clang/docs/Modules.rst

@@ -1099,7 +1099,7 @@ The module maps will be written using the `module map language`_, which provides
   Headers are often missing ``#include`` directives for headers that they actually depend on. As with the problem of conflicting definitions, this only affects unlucky users who don't happen to include headers in the right order. With modules, the headers of a particular module will be parsed in isolation, so the module may fail to build if there are missing includes.
 
 **Headers that vend multiple APIs at different times**
-  Some systems have headers that contain a number of different kinds of API definitions, only some of which are made available with a given include. For example, the header may vend ``size_t`` only when the macro ``__need_size_t`` is defined before that header is included, and also vend ``wchar_t`` only when the macro ``__need_wchar_t`` is defined. Such headers are often included many times in a single translation unit, and will have no include guards. There is no sane way to map this header to a submodule. One can either eliminate the header (e.g., by splitting it into separate headers, one per actual API) or simply ``exclude`` it in the module map.
+  Some systems have headers that contain a number of different kinds of API definitions, only some of which are made available with a given include. For example, the header may vend ``size_t`` only when the macro ``__need_size_t`` is defined before that header is included, and also vend ``wchar_t`` only when the macro ``__need_wchar_t`` is defined. Such headers are often included many times in a single translation unit, and will have no include guards. There is no sound way to map this header to a submodule. One can either eliminate the header (e.g., by splitting it into separate headers, one per actual API) or simply ``exclude`` it in the module map.
 
 To detect and help address some of these problems, the ``clang-tools-extra`` repository contains a ``modularize`` tool that parses a set of given headers and attempts to detect these problems and produce a report. See the tool's in-source documentation for information on how to check your system or library headers.
 

clang/docs/UsersManual.rst

@@ -2382,7 +2382,7 @@ are listed below.
 
 .. option:: -fno-assume-sane-operator-new
 
-   Don't assume that the C++'s new operator is sane.
+   Don't assume that the C++'s new operator is sound.
 
    This option tells the compiler to do not assume that C++'s global
    new operator will always return a pointer that does not alias any

clang/include/clang/Sema/Sema.h

@@ -6628,7 +6628,7 @@ class Sema final : public SemaBase {
   /// CheckParamExceptionSpec - Check if the parameter and return types of the
   /// two functions have equivalent exception specs. This is part of the
   /// assignment and override compatibility check. We do not check the
-  /// parameters of parameter function pointers recursively, as no sane
+  /// parameters of parameter function pointers recursively, as no sound
   /// programmer would even be able to write such a function type.
   bool CheckParamExceptionSpec(
       const PartialDiagnostic &NestedDiagID, const PartialDiagnostic &NoteID,

clang/lib/AST/ASTStructuralEquivalence.cpp

@@ -879,10 +879,10 @@ static bool IsStructurallyEquivalent(StructuralEquivalenceContext &Context,
       // class comparison.
       if (T1->getTypeClass() == Type::Enum) {
         T1 = cast<EnumType>(T1)->getOriginalDecl()->getIntegerType();
-        assert(T2->isBuiltinType() && !T1.isNull()); // Sanity check
+        assert(T2->isBuiltinType() && !T1.isNull()); // Soundness check
       } else if (T2->getTypeClass() == Type::Enum) {
         T2 = cast<EnumType>(T2)->getOriginalDecl()->getIntegerType();
-        assert(T1->isBuiltinType() && !T2.isNull()); // Sanity check
+        assert(T1->isBuiltinType() && !T2.isNull()); // Soundness check
       }
       TC = Type::Builtin;
     } else

clang/lib/AST/CommentSema.cpp

@@ -249,7 +249,7 @@ void Sema::actOnParamCommandDirectionArg(ParamCommandComment *Command,
           << ArgRange << FixItHint::CreateReplacement(ArgRange, FixedName);
     } else {
       Diag(ArgLocBegin, diag::warn_doc_param_invalid_direction) << ArgRange;
-      Direction = ParamCommandPassDirection::In; // Sane fall back.
+      Direction = ParamCommandPassDirection::In; // Sound fall back.
     }
   }
   Command->setDirection(Direction,

clang/lib/AST/TypePrinter.cpp

@@ -968,7 +968,7 @@ void TypePrinter::printFunctionProtoAfter(const FunctionProtoType *T,
         if (Policy.UseHLSLTypes) {
           // This is a bit of a hack because we _do_ use reference types in the
           // AST for representing inout and out parameters so that code
-          // generation is sane, but when re-printing these for HLSL we need to
+          // generation is sound, but when re-printing these for HLSL we need to
           // skip the reference.
           print(T->getParamType(i).getNonReferenceType(), OS, StringRef());
           continue;

clang/lib/CodeGen/CGCXXABI.cpp

@@ -196,7 +196,7 @@ bool CGCXXABI::isEmittedWithConstantInitializer(
   // translation unit will emit the value as a constant. We rely on the
   // variable being constant-initialized in every translation unit if it's
   // constant-initialized in any translation unit, which isn't actually
-  // guaranteed by the standard but is necessary for sanity.
+  // guaranteed by the standard but is necessary for soundness.
   return InitDecl->hasConstantInitialization();
 }
 

clang/lib/CodeGen/CGCall.cpp

@@ -2469,7 +2469,7 @@ void CodeGenModule::ConstructAttributeList(StringRef Name,
       AddAttributesFromFunctionProtoType(
           getContext(), FuncAttrs, Fn->getType()->getAs<FunctionProtoType>());
       if (AttrOnCallSite && Fn->isReplaceableGlobalAllocationFunction()) {
-        // A sane operator new returns a non-aliasing pointer.
+        // A sound operator new returns a non-aliasing pointer.
         auto Kind = Fn->getDeclName().getCXXOverloadedOperator();
         if (getCodeGenOpts().AssumeSaneOperatorNew &&
             (Kind == OO_New || Kind == OO_Array_New))
@@ -3620,7 +3620,7 @@ static llvm::Value *tryEmitFusedAutoreleaseOfResult(CodeGenFunction &CGF,
   result = call->getArgOperand(0);
   InstsToKill.push_back(call);
 
-  // Keep killing bitcasts, for sanity.  Note that we no longer care
+  // Keep killing bitcasts, for soundness.  Note that we no longer care
   // about precise ordering as long as there's exactly one use.
   while (llvm::BitCastInst *bitcast = dyn_cast<llvm::BitCastInst>(result)) {
     if (!bitcast->hasOneUse())

clang/lib/CodeGen/CGExpr.cpp

@@ -3553,7 +3553,7 @@ llvm::Constant *CodeGenFunction::EmitCheckTypeDescriptor(QualType T) {
     // So we can write the exact amount of bits in TypeName after '\0'
     // making it <diagnostic-like type name>.'\0'.<32-bit width>.
     if (T->isSignedIntegerType() && T->getAs<BitIntType>()) {
-      // Do a sanity checks as we are using 32-bit type to store bit length.
+      // Do a soundness check as we are using 32-bit type to store bit length.
       assert(getContext().getTypeSize(T) > 0 &&
              " non positive amount of bits in __BitInt type");
       assert(getContext().getTypeSize(T) <= 0xFFFFFFFF &&

clang/lib/CodeGen/CGStmt.cpp

@@ -2217,7 +2217,7 @@ static bool FindCaseStatementsForValue(const SwitchStmt &S,
   // Ok, we know which case is being jumped to, try to collect all the
   // statements that follow it.  This can fail for a variety of reasons.  Also,
   // check to see that the recursive walk actually found our case statement.
-  // Insane cases like this can fail to find it in the recursive walk since we
+  // Unsound cases like this can fail to find it in the recursive walk since we
   // don't handle every stmt kind:
   // switch (4) {
   //   while (1) {

clang/lib/Driver/Driver.cpp

@@ -212,7 +212,7 @@ Driver::Driver(StringRef ClangExecutable, StringRef TargetTriple,
       TargetTriple(TargetTriple), Saver(Alloc), PrependArg(nullptr),
       PreferredLinker(CLANG_DEFAULT_LINKER), CheckInputsExist(true),
       ProbePrecompiled(true), SuppressMissingInputWarning(false) {
-  // Provide a sane fallback if no VFS is specified.
+  // Provide a sound fallback if no VFS is specified.
   if (!this->VFS)
     this->VFS = llvm::vfs::getRealFileSystem();