Add rule category to rule meta data

The category information enables evaluation time computation of the
effective category of a rule. The effective category is determined by
the rule's category and a possible recategorization through a Guideline
Recategorization Plan.

The effective category will be used to determine how to handle a deviation applied to a query implementing the
rule.

Author: rvermeulen

cpp/common/src/codingstandards/cpp/exclusions/RuleMetadata.qll

@@ -8,13 +8,18 @@ newtype TQuery =
 
 class Query extends TQuery {
   string getQueryId() {
-    CPPRuleMetadata::isQueryMetadata(this, result, _) or
-    CRuleMetadata::isQueryMetadata(this, result, _)
+    CPPRuleMetadata::isQueryMetadata(this, result, _, _) or
+    CRuleMetadata::isQueryMetadata(this, result, _, _)
   }
 
   string getRuleId() {
-    CPPRuleMetadata::isQueryMetadata(this, _, result) or
-    CRuleMetadata::isQueryMetadata(this, _, result)
+    CPPRuleMetadata::isQueryMetadata(this, _, result, _) or
+    CRuleMetadata::isQueryMetadata(this, _, result, _)
+  }
+
+  string getCategory() {
+    CPPRuleMetadata::isQueryMetadata(this, _, _, result) or
+    CRuleMetadata::isQueryMetadata(this, _, _, result)
   }
 
   string toString() { result = getQueryId() }

cpp/common/src/codingstandards/cpp/exclusions/c/Banned.qll

@@ -24,158 +24,177 @@ newtype BannedQuery =
   TOctalConstantsUsedQuery() or
   TRestrictTypeQualifierUsedQuery()
 
-predicate isBannedQueryMetadata(Query query, string queryId, string ruleId) {
+predicate isBannedQueryMetadata(Query query, string queryId, string ruleId, string category) {
   query =
     // `Query` instance for the `doNotCallSystem` query
     BannedPackage::doNotCallSystemQuery() and
   queryId =
     // `@id` for the `doNotCallSystem` query
     "c/cert/do-not-call-system" and
-  ruleId = "ENV33-C"
+  ruleId = "ENV33-C" and
+  category = "rule"
   or
   query =
     // `Query` instance for the `commaOperatorShouldNotBeUsed` query
     BannedPackage::commaOperatorShouldNotBeUsedQuery() and
   queryId =
     // `@id` for the `commaOperatorShouldNotBeUsed` query
     "c/misra/comma-operator-should-not-be-used" and
-  ruleId = "RULE-12-3"
+  ruleId = "RULE-12-3" and
+  category = "advisory"
   or
   query =
     // `Query` instance for the `featuresOfStdarghUsed` query
     BannedPackage::featuresOfStdarghUsedQuery() and
   queryId =
     // `@id` for the `featuresOfStdarghUsed` query
     "c/misra/features-of-stdargh-used" and
-  ruleId = "RULE-17-1"
+  ruleId = "RULE-17-1" and
+  category = "required"
   or
   query =
     // `Query` instance for the `unionKeywordShouldNotBeUsed` query
     BannedPackage::unionKeywordShouldNotBeUsedQuery() and
   queryId =
     // `@id` for the `unionKeywordShouldNotBeUsed` query
     "c/misra/union-keyword-should-not-be-used" and
-  ruleId = "RULE-19-2"
+  ruleId = "RULE-19-2" and
+  category = "advisory"
   or
   query =
     // `Query` instance for the `standardLibraryTimeAndDateFunctionsUsed` query
     BannedPackage::standardLibraryTimeAndDateFunctionsUsedQuery() and
   queryId =
     // `@id` for the `standardLibraryTimeAndDateFunctionsUsed` query
     "c/misra/standard-library-time-and-date-functions-used" and
-  ruleId = "RULE-21-10"
+  ruleId = "RULE-21-10" and
+  category = "required"
   or
   query =
     // `Query` instance for the `standardHeaderFileTgmathhUsed` query
     BannedPackage::standardHeaderFileTgmathhUsedQuery() and
   queryId =
     // `@id` for the `standardHeaderFileTgmathhUsed` query
     "c/misra/standard-header-file-tgmathh-used" and
-  ruleId = "RULE-21-11"
+  ruleId = "RULE-21-11" and
+  category = "required"
   or
   query =
     // `Query` instance for the `exceptionHandlingFeaturesOfFenvhUsed` query
     BannedPackage::exceptionHandlingFeaturesOfFenvhUsedQuery() and
   queryId =
     // `@id` for the `exceptionHandlingFeaturesOfFenvhUsed` query
     "c/misra/exception-handling-features-of-fenvh-used" and
-  ruleId = "RULE-21-12"
+  ruleId = "RULE-21-12" and
+  category = "advisory"
   or
   query =
     // `Query` instance for the `systemOfStdlibhUsed` query
     BannedPackage::systemOfStdlibhUsedQuery() and
   queryId =
     // `@id` for the `systemOfStdlibhUsed` query
     "c/misra/system-of-stdlibh-used" and
-  ruleId = "RULE-21-21"
+  ruleId = "RULE-21-21" and
+  category = "required"
   or
   query =
     // `Query` instance for the `memoryAllocDeallocFunctionsOfStdlibhUsed` query
     BannedPackage::memoryAllocDeallocFunctionsOfStdlibhUsedQuery() and
   queryId =
     // `@id` for the `memoryAllocDeallocFunctionsOfStdlibhUsed` query
     "c/misra/memory-alloc-dealloc-functions-of-stdlibh-used" and
-  ruleId = "RULE-21-3"
+  ruleId = "RULE-21-3" and
+  category = "required"
   or
   query =
     // `Query` instance for the `standardHeaderFileUsedSetjmph` query
     BannedPackage::standardHeaderFileUsedSetjmphQuery() and
   queryId =
     // `@id` for the `standardHeaderFileUsedSetjmph` query
     "c/misra/standard-header-file-used-setjmph" and
-  ruleId = "RULE-21-4"
+  ruleId = "RULE-21-4" and
+  category = "required"
   or
   query =
     // `Query` instance for the `standardHeaderFileUsedSignalh` query
     BannedPackage::standardHeaderFileUsedSignalhQuery() and
   queryId =
     // `@id` for the `standardHeaderFileUsedSignalh` query
     "c/misra/standard-header-file-used-signalh" and
-  ruleId = "RULE-21-5"
+  ruleId = "RULE-21-5" and
+  category = "required"
   or
   query =
     // `Query` instance for the `standardLibraryInputoutputFunctionsUsed` query
     BannedPackage::standardLibraryInputoutputFunctionsUsedQuery() and
   queryId =
     // `@id` for the `standardLibraryInputoutputFunctionsUsed` query
     "c/misra/standard-library-inputoutput-functions-used" and
-  ruleId = "RULE-21-6"
+  ruleId = "RULE-21-6" and
+  category = "required"
   or
   query =
     // `Query` instance for the `atofAtoiAtolAndAtollOfStdlibhUsed` query
     BannedPackage::atofAtoiAtolAndAtollOfStdlibhUsedQuery() and
   queryId =
     // `@id` for the `atofAtoiAtolAndAtollOfStdlibhUsed` query
     "c/misra/atof-atoi-atol-and-atoll-of-stdlibh-used" and
-  ruleId = "RULE-21-7"
+  ruleId = "RULE-21-7" and
+  category = "required"
   or
   query =
     // `Query` instance for the `terminationFunctionsOfStdlibhUsed` query
     BannedPackage::terminationFunctionsOfStdlibhUsedQuery() and
   queryId =
     // `@id` for the `terminationFunctionsOfStdlibhUsed` query
     "c/misra/termination-functions-of-stdlibh-used" and
-  ruleId = "RULE-21-8"
+  ruleId = "RULE-21-8" and
+  category = "required"
   or
   query =
     // `Query` instance for the `terminationMacrosOfStdlibhUsed` query
     BannedPackage::terminationMacrosOfStdlibhUsedQuery() and
   queryId =
     // `@id` for the `terminationMacrosOfStdlibhUsed` query
     "c/misra/termination-macros-of-stdlibh-used" and
-  ruleId = "RULE-21-8"
+  ruleId = "RULE-21-8" and
+  category = "required"
   or
   query =
     // `Query` instance for the `bsearchAndQsortOfStdlibhUsed` query
     BannedPackage::bsearchAndQsortOfStdlibhUsedQuery() and
   queryId =
     // `@id` for the `bsearchAndQsortOfStdlibhUsed` query
     "c/misra/bsearch-and-qsort-of-stdlibh-used" and
-  ruleId = "RULE-21-9"
+  ruleId = "RULE-21-9" and
+  category = "required"
   or
   query =
     // `Query` instance for the `stdLibDynamicMemoryAllocationUsed` query
     BannedPackage::stdLibDynamicMemoryAllocationUsedQuery() and
   queryId =
     // `@id` for the `stdLibDynamicMemoryAllocationUsed` query
     "c/misra/std-lib-dynamic-memory-allocation-used" and
-  ruleId = "DIR-4-12"
+  ruleId = "DIR-4-12" and
+  category = "required"
   or
   query =
     // `Query` instance for the `octalConstantsUsed` query
     BannedPackage::octalConstantsUsedQuery() and
   queryId =
     // `@id` for the `octalConstantsUsed` query
     "c/misra/octal-constants-used" and
-  ruleId = "RULE-7-1"
+  ruleId = "RULE-7-1" and
+  category = "required"
   or
   query =
     // `Query` instance for the `restrictTypeQualifierUsed` query
     BannedPackage::restrictTypeQualifierUsedQuery() and
   queryId =
     // `@id` for the `restrictTypeQualifierUsed` query
     "c/misra/restrict-type-qualifier-used" and
-  ruleId = "RULE-8-14"
+  ruleId = "RULE-8-14" and
+  category = "required"
 }
 
 module BannedPackage {

cpp/common/src/codingstandards/cpp/exclusions/c/Concurrency1.qll

@@ -8,30 +8,33 @@ newtype Concurrency1Query =
   TRaceConditionsWhenUsingLibraryFunctionsQuery() or
   TDoNotCallSignalInMultithreadedProgramQuery()
 
-predicate isConcurrency1QueryMetadata(Query query, string queryId, string ruleId) {
+predicate isConcurrency1QueryMetadata(Query query, string queryId, string ruleId, string category) {
   query =
     // `Query` instance for the `preventDataRacesWithMultipleThreads` query
     Concurrency1Package::preventDataRacesWithMultipleThreadsQuery() and
   queryId =
     // `@id` for the `preventDataRacesWithMultipleThreads` query
     "c/cert/prevent-data-races-with-multiple-threads" and
-  ruleId = "CON32-C"
+  ruleId = "CON32-C" and
+  category = "rule"
   or
   query =
     // `Query` instance for the `raceConditionsWhenUsingLibraryFunctions` query
     Concurrency1Package::raceConditionsWhenUsingLibraryFunctionsQuery() and
   queryId =
     // `@id` for the `raceConditionsWhenUsingLibraryFunctions` query
     "c/cert/race-conditions-when-using-library-functions" and
-  ruleId = "CON33-C"
+  ruleId = "CON33-C" and
+  category = "rule"
   or
   query =
     // `Query` instance for the `doNotCallSignalInMultithreadedProgram` query
     Concurrency1Package::doNotCallSignalInMultithreadedProgramQuery() and
   queryId =
     // `@id` for the `doNotCallSignalInMultithreadedProgram` query
     "c/cert/do-not-call-signal-in-multithreaded-program" and
-  ruleId = "CON37-C"
+  ruleId = "CON37-C" and
+  category = "rule"
 }
 
 module Concurrency1Package {

cpp/common/src/codingstandards/cpp/exclusions/c/Concurrency2.qll

@@ -7,22 +7,24 @@ newtype Concurrency2Query =
   TDeadlockByLockingInPredefinedOrderQuery() or
   TWrapFunctionsThatCanSpuriouslyWakeUpInLoopQuery()
 
-predicate isConcurrency2QueryMetadata(Query query, string queryId, string ruleId) {
+predicate isConcurrency2QueryMetadata(Query query, string queryId, string ruleId, string category) {
   query =
     // `Query` instance for the `deadlockByLockingInPredefinedOrder` query
     Concurrency2Package::deadlockByLockingInPredefinedOrderQuery() and
   queryId =
     // `@id` for the `deadlockByLockingInPredefinedOrder` query
     "c/cert/deadlock-by-locking-in-predefined-order" and
-  ruleId = "CON35-C"
+  ruleId = "CON35-C" and
+  category = "rule"
   or
   query =
     // `Query` instance for the `wrapFunctionsThatCanSpuriouslyWakeUpInLoop` query
     Concurrency2Package::wrapFunctionsThatCanSpuriouslyWakeUpInLoopQuery() and
   queryId =
     // `@id` for the `wrapFunctionsThatCanSpuriouslyWakeUpInLoop` query
     "c/cert/wrap-functions-that-can-spuriously-wake-up-in-loop" and
-  ruleId = "CON36-C"
+  ruleId = "CON36-C" and
+  category = "rule"
 }
 
 module Concurrency2Package {

cpp/common/src/codingstandards/cpp/exclusions/c/Concurrency3.qll

@@ -9,38 +9,42 @@ newtype Concurrency3Query =
   TPreserveSafetyWhenUsingConditionVariablesQuery() or
   TWrapFunctionsThatCanFailSpuriouslyInLoopQuery()
 
-predicate isConcurrency3QueryMetadata(Query query, string queryId, string ruleId) {
+predicate isConcurrency3QueryMetadata(Query query, string queryId, string ruleId, string category) {
   query =
     // `Query` instance for the `doNotAllowAMutexToGoOutOfScopeWhileLocked` query
     Concurrency3Package::doNotAllowAMutexToGoOutOfScopeWhileLockedQuery() and
   queryId =
     // `@id` for the `doNotAllowAMutexToGoOutOfScopeWhileLocked` query
     "c/cert/do-not-allow-a-mutex-to-go-out-of-scope-while-locked" and
-  ruleId = "CON31-C"
+  ruleId = "CON31-C" and
+  category = "rule"
   or
   query =
     // `Query` instance for the `doNotDestroyAMutexWhileItIsLocked` query
     Concurrency3Package::doNotDestroyAMutexWhileItIsLockedQuery() and
   queryId =
     // `@id` for the `doNotDestroyAMutexWhileItIsLocked` query
     "c/cert/do-not-destroy-a-mutex-while-it-is-locked" and
-  ruleId = "CON31-C"
+  ruleId = "CON31-C" and
+  category = "rule"
   or
   query =
     // `Query` instance for the `preserveSafetyWhenUsingConditionVariables` query
     Concurrency3Package::preserveSafetyWhenUsingConditionVariablesQuery() and
   queryId =
     // `@id` for the `preserveSafetyWhenUsingConditionVariables` query
     "c/cert/preserve-safety-when-using-condition-variables" and
-  ruleId = "CON38-C"
+  ruleId = "CON38-C" and
+  category = "rule"
   or
   query =
     // `Query` instance for the `wrapFunctionsThatCanFailSpuriouslyInLoop` query
     Concurrency3Package::wrapFunctionsThatCanFailSpuriouslyInLoopQuery() and
   queryId =
     // `@id` for the `wrapFunctionsThatCanFailSpuriouslyInLoop` query
     "c/cert/wrap-functions-that-can-fail-spuriously-in-loop" and
-  ruleId = "CON41-C"
+  ruleId = "CON41-C" and
+  category = "rule"
 }
 
 module Concurrency3Package {

cpp/common/src/codingstandards/cpp/exclusions/c/Concurrency4.qll

@@ -8,30 +8,33 @@ newtype Concurrency4Query =
   TAppropriateThreadObjectStorageDurationsQuery() or
   TThreadObjectStorageDurationsNotInitializedQuery()
 
-predicate isConcurrency4QueryMetadata(Query query, string queryId, string ruleId) {
+predicate isConcurrency4QueryMetadata(Query query, string queryId, string ruleId, string category) {
   query =
     // `Query` instance for the `cleanUpThreadSpecificStorage` query
     Concurrency4Package::cleanUpThreadSpecificStorageQuery() and
   queryId =
     // `@id` for the `cleanUpThreadSpecificStorage` query
     "c/cert/clean-up-thread-specific-storage" and
-  ruleId = "CON30-C"
+  ruleId = "CON30-C" and
+  category = "rule"
   or
   query =
     // `Query` instance for the `appropriateThreadObjectStorageDurations` query
     Concurrency4Package::appropriateThreadObjectStorageDurationsQuery() and
   queryId =
     // `@id` for the `appropriateThreadObjectStorageDurations` query
     "c/cert/appropriate-thread-object-storage-durations" and
-  ruleId = "CON34-C"
+  ruleId = "CON34-C" and
+  category = "rule"
   or
   query =
     // `Query` instance for the `threadObjectStorageDurationsNotInitialized` query
     Concurrency4Package::threadObjectStorageDurationsNotInitializedQuery() and
   queryId =
     // `@id` for the `threadObjectStorageDurationsNotInitialized` query
     "c/cert/thread-object-storage-durations-not-initialized" and
-  ruleId = "CON34-C"
+  ruleId = "CON34-C" and
+  category = "rule"
 }
 
 module Concurrency4Package {