common: add lcov exclusions in KU_UNREACHABLE

This allows us to avoid the annoying comments everywhere we have unreachable code in the codebase.
kuzudb · Nov 8, 2023 · eb54a18 · eb54a18
1 parent fd388b4
commit eb54a18
Show file tree

Hide file tree

Showing 27 changed files with 6 additions and 115 deletions.
diff --git a/.github/workflows/ci-workflow.yml b/.github/workflows/ci-workflow.yml
@@ -60,7 +60,7 @@ jobs:
 
       - name: Generate coverage report
         run: |
-          lcov -c -d ./ --no-external -o cover.info &&\
+          lcov --config-file .lcovrc -c -d ./ --no-external -o cover.info &&\
           lcov --remove cover.info $(< .github/workflows/lcov_exclude) -o cover.info
 
       - name: Upload coverage report

diff --git a/.lcovrc b/.lcovrc
@@ -0,0 +1 @@
+lcov_excl_line = LCOV_EXCL_LINE|KU_UNREACHABLE
diff --git a/src/binder/bind/bind_copy.cpp b/src/binder/bind/bind_copy.cpp
@@ -185,11 +185,9 @@ expression_vector Binder::bindExpectedNodeFileColumns(
             expectedColumnTypes.push_back(property->getDataType()->copy());
         }
     } break;
-        // LCOV_EXCL_START
     default: {
         KU_UNREACHABLE;
     }
-        // LCOV_EXCL_STOP
     }
     // Detect columns from file.
     std::vector<std::string> detectedColumnNames;
@@ -246,11 +244,9 @@ expression_vector Binder::bindExpectedRelFileColumns(
             readerConfig.columnTypes.push_back(std::move(columnType));
         }
     } break;
-        // LCOV_EXCL_START
     default: {
         KU_UNREACHABLE;
     }
-        // LCOV_EXCL_STOP
     }
     // Detect columns from file.
     std::vector<std::string> detectedColumnNames;

diff --git a/src/binder/bind/bind_ddl.cpp b/src/binder/bind/bind_ddl.cpp
@@ -84,11 +84,9 @@ std::unique_ptr<BoundCreateTableInfo> Binder::bindCreateTableInfo(
     case TableType::RDF: {
         return bindCreateRdfGraphInfo(info);
     }
-        // LCOV_EXCL_START
     default: {
         KU_UNREACHABLE;
     }
-        // LCOV_EXCL_STOP
     }
     return nullptr;
 }
@@ -213,11 +211,9 @@ std::unique_ptr<BoundStatement> Binder::bindAlter(const parser::Statement& state
     case AlterType::RENAME_PROPERTY: {
         return bindRenameProperty(statement);
     }
-        // LCOV_EXCL_START
     default: {
         KU_UNREACHABLE;
     }
-        // LCOV_EXCL_STOP
     }
     return nullptr;
 }

diff --git a/src/binder/bind/bind_graph_pattern.cpp b/src/binder/bind/bind_graph_pattern.cpp
@@ -209,10 +209,8 @@ std::shared_ptr<RelExpression> Binder::bindQueryRel(const RelPattern& relPattern
         dstNode = rightNode;
         directionType = RelDirectionType::BOTH;
     } break;
-        // LCOV_EXCL_START
     default:
         KU_UNREACHABLE;
-        // LCOV_EXCL_STOP
     }
     // bind variable length
     std::shared_ptr<RelExpression> queryRel;
@@ -562,10 +560,8 @@ std::vector<table_id_t> Binder::getNodeTableIDs(const std::vector<table_id_t>& t
     case TableType::NODE: {
         return tableIDs;
     }
-        // LCOV_EXCL_START
     default:
         KU_UNREACHABLE;
-        // LCOV_EXCL_STOP
     }
 }
 
@@ -597,10 +593,8 @@ std::vector<table_id_t> Binder::getRelTableIDs(const std::vector<table_id_t>& ta
     case TableType::REL: {
         return tableIDs;
     }
-        // LCOV_EXCL_START
     default:
         KU_UNREACHABLE;
-        // LCOV_EXCL_STOP
     }
 }
 

diff --git a/src/binder/bind/bind_reading_clause.cpp b/src/binder/bind/bind_reading_clause.cpp
@@ -243,10 +243,8 @@ void Binder::sniffFiles(const common::ReaderConfig& readerConfig,
         } break;
         case FileType::TURTLE:
             break;
-            // LCOV_EXCL_START
         default:
             KU_UNREACHABLE;
-            // LCOV_EXCL_STOP
         }
     }
 }

diff --git a/src/binder/bind/bind_updating_clause.cpp b/src/binder/bind/bind_updating_clause.cpp
@@ -36,10 +36,8 @@ std::unique_ptr<BoundUpdatingClause> Binder::bindUpdatingClause(
     case ClauseType::DELETE_: {
         return bindDeleteClause(updatingClause);
     }
-        // LCOV_EXCL_START
     default:
         KU_UNREACHABLE;
-        // LCOV_EXCL_STOP
     }
 }
 

diff --git a/src/binder/bind_expression/bind_function_expression.cpp b/src/binder/bind_expression/bind_function_expression.cpp
@@ -33,10 +33,8 @@ std::shared_ptr<Expression> ExpressionBinder::bindFunctionExpression(
             parsedExpression, functionName, parsedFunctionExpression.getIsDistinct());
     case ExpressionType::MACRO:
         return bindMacroExpression(parsedExpression, functionName);
-        // LOCV_EXCL_START
     default:
         KU_UNREACHABLE;
-        // LOCV_EXCL_STOP
     }
     return nullptr;
 }
@@ -254,10 +252,8 @@ std::shared_ptr<Expression> ExpressionBinder::bindLabelFunction(const Expression
             std::make_unique<Value>(*listType, populateLabelValues(relTableIDs, *catalogContent));
         children.push_back(createLiteralExpression(std::move(labelsValue)));
     } break;
-        // LCOV_EXCL_START
     default:
         KU_UNREACHABLE;
-        // LCOV_EXCL_STOP
     }
     auto execFunc = function::LabelFunction::execFunction;
     auto bindData =

diff --git a/src/binder/binder.cpp b/src/binder/binder.cpp
@@ -47,11 +47,9 @@ std::unique_ptr<BoundStatement> Binder::bind(const Statement& statement) {
     case StatementType::TRANSACTION: {
         boundStatement = bindTransaction(statement);
     } break;
-        // LCOV_EXCL_START
     default: {
         KU_UNREACHABLE;
     }
-        // LCOV_EXCL_STOP
     }
     BoundStatementRewriter::rewrite(*boundStatement, catalog);
     return boundStatement;

diff --git a/src/common/copier_config/copier_config.cpp b/src/common/copier_config/copier_config.cpp
@@ -34,11 +34,9 @@ std::string FileTypeUtils::toString(FileType fileType) {
     case FileType::TURTLE: {
         return "TURTLE";
     }
-        // LCOV_EXCL_START
     default: {
         KU_UNREACHABLE;
     }
-        // LCOV_EXCL_STOP
     }
 }
 

diff --git a/src/common/types/interval_t.cpp b/src/common/types/interval_t.cpp
@@ -248,10 +248,8 @@ int32_t Interval::getIntervalPart(DatePartSpecifier specifier, interval_t& inter
         return (interval.micros % Interval::MICROS_PER_HOUR) / Interval::MICROS_PER_MINUTE;
     case DatePartSpecifier::HOUR:
         return interval.micros / Interval::MICROS_PER_HOUR;
-        // LCOV_EXCL_START
     default:
         KU_UNREACHABLE;
-        // LCOV_EXCL_STOP
     }
 }
 

diff --git a/src/common/types/types.cpp b/src/common/types/types.cpp
@@ -55,10 +55,8 @@ std::string PhysicalTypeUtils::physicalTypeToString(PhysicalTypeID physicalType)
         return "STRUCT";
     case PhysicalTypeID::VAR_LIST:
         return "VAR_LIST";
-        // LCOV_EXCL_START
     default:
         KU_UNREACHABLE;
-        // LCOV_EXCL_STOP
     }
 }
 
@@ -92,10 +90,8 @@ uint32_t PhysicalTypeUtils::getFixedTypeSize(PhysicalTypeID physicalType) {
         return sizeof(interval_t);
     case PhysicalTypeID::INTERNAL_ID:
         return sizeof(internalID_t);
-        // LCOV_EXCL_START
     default:
         KU_UNREACHABLE;
-        // LCOV_EXCL_STOP
     }
 }
 
@@ -517,10 +513,8 @@ void LogicalType::setPhysicalType() {
     case LogicalTypeID::RDF_VARIANT: {
         physicalType = PhysicalTypeID::STRUCT;
     } break;
-        // LCOV_EXCL_START
     default:
         KU_UNREACHABLE;
-        // LCOV_EXCL_STOP
     }
 }
 
@@ -650,10 +644,8 @@ std::string LogicalTypeUtils::toString(LogicalTypeID dataTypeID) {
         return "MAP";
     case LogicalTypeID::UNION:
         return "UNION";
-        // LCOV_EXCL_START
     default:
         KU_UNREACHABLE;
-        // LCOV_EXCL_STOP
     }
 }
 

diff --git a/src/common/types/value/value.cpp b/src/common/types/value/value.cpp
@@ -364,9 +364,7 @@ void Value::copyValueFrom(const Value& other) {
         }
     } break;
     default:
-        // LCOV_EXCL_START
         KU_UNREACHABLE;
-        // LCOV_EXCL_STOP
     }
 }
 
@@ -437,9 +435,7 @@ std::string Value::toString() const {
         return relToString();
     }
     default:
-        // LCOV_EXCL_START
         KU_UNREACHABLE;
-        // LCOV_EXCL_STOP
     }
 }
 

diff --git a/src/common/utils.cpp b/src/common/utils.cpp
@@ -54,11 +54,9 @@ std::string LoggerUtils::getLoggerName(LoggerConstants::LoggerEnum loggerEnum) {
     case LoggerConstants::LoggerEnum::WAL: {
         return "wal";
     } break;
-        // LCOV_EXCL_START
     default: {
         KU_UNREACHABLE;
     }
-        // LCOV_EXCL_STOP
     }
 }
 } // namespace common

diff --git a/src/common/vector/value_vector.cpp b/src/common/vector/value_vector.cpp
@@ -212,11 +212,9 @@ void ValueVector::copyFromValue(uint64_t pos, const Value& value) {
             case PhysicalTypeID::FLOAT: {
                 memcpy(bufferToWrite, &val->getValueReference<float_t>(), numBytesPerChildValue);
             } break;
-                // LCOV_EXCL_START
             default: {
                 KU_UNREACHABLE;
             }
-                // LCOV_EXCL_STOP
             }
             bufferToWrite += numBytesPerChildValue;
         }
@@ -227,11 +225,9 @@ void ValueVector::copyFromValue(uint64_t pos, const Value& value) {
             structFields[i]->copyFromValue(pos, *NestedVal::getChildVal(&value, i));
         }
     } break;
-        // LCOV_EXCL_START
     default: {
         KU_UNREACHABLE;
     }
-        // LCOV_EXCL_STOP
     }
 }
 
@@ -315,10 +311,8 @@ std::unique_ptr<Value> ValueVector::getAsValue(uint64_t pos) {
         case PhysicalTypeID::FLOAT: {
             FixedListVector::getAsValue<float>(this, children, pos, numElements);
         } break;
-            // LCOV_EXCL_START
         default:
             KU_UNREACHABLE;
-            // LCOV_EXCL_STOP
         }
         value->childrenSize = numElements;
         value->children = std::move(children);
@@ -333,11 +327,9 @@ std::unique_ptr<Value> ValueVector::getAsValue(uint64_t pos) {
         value->childrenSize = children.size();
         value->children = std::move(children);
     } break;
-        // LCOV_EXCL_START
     default: {
         KU_UNREACHABLE;
     }
-        // LCOV_EXCL_STOP
     }
     return value;
 }

diff --git a/src/function/aggregate_function.cpp b/src/function/aggregate_function.cpp
@@ -50,10 +50,8 @@ std::unique_ptr<AggregateFunction> AggregateFunctionUtil::getSumFunc(const std::
     case common::LogicalTypeID::FLOAT:
         return getAggFunc<SumFunction<float_t>>(
             name, std::move(inputType), std::move(resultType), isDistinct);
-        // LCOV_EXCL_START
     default:
         KU_UNREACHABLE;
-        // LCOV_EXCL_STOP
     }
 }
 
@@ -94,10 +92,8 @@ std::unique_ptr<AggregateFunction> AggregateFunctionUtil::getAvgFunc(const std::
     case common::LogicalTypeID::FLOAT:
         return getAggFunc<AvgFunction<float_t>>(
             name, std::move(inputType), std::move(resultType), isDistinct);
-        // LCOV_EXCL_START
     default:
         KU_UNREACHABLE;
-        // LCOV_EXCL_STOP
     }
 }
 

diff --git a/src/function/vector_cast_functions.cpp b/src/function/vector_cast_functions.cpp
@@ -357,10 +357,8 @@ static std::unique_ptr<ScalarFunction> bindCastToStringFunction(
         func = ScalarFunction::UnaryCastExecFunction<union_entry_t, ku_string_t, CastToString>;
     } break;
         // ToDo(Kebing): RECURSIVE_REL to string
-        // LCOV_EXCL_START
     default:
         KU_UNREACHABLE;
-        // LCOV_EXCL_STOP
     }
     return std::make_unique<ScalarFunction>(
         functionName, std::vector<LogicalTypeID>{sourceTypeID}, LogicalTypeID::STRING, func);

diff --git a/src/include/parser/expression/parsed_parameter_expression.h b/src/include/parser/expression/parsed_parameter_expression.h
@@ -16,23 +16,13 @@ class ParsedParameterExpression : public ParsedExpression {
 
     static std::unique_ptr<ParsedParameterExpression> deserialize(
         common::Deserializer& /*deserializer*/) {
-        // LCOV_EXCL_START
         KU_UNREACHABLE;
-        // LCOV_EXCL_STOP
     }
 
-    inline std::unique_ptr<ParsedExpression> copy() const override {
-        // LCOV_EXCL_START
-        KU_UNREACHABLE;
-        // LCOV_EXCL_STOP
-    }
+    inline std::unique_ptr<ParsedExpression> copy() const override { KU_UNREACHABLE; }
 
 private:
-    void serializeInternal(common::Serializer& /*serializer*/) const override {
-        // LCOV_EXCL_START
-        KU_UNREACHABLE;
-        // LCOV_EXCL_STOP
-    }
+    void serializeInternal(common::Serializer& /*serializer*/) const override { KU_UNREACHABLE; }
 
 private:
     std::string parameterName;

diff --git a/src/include/parser/expression/parsed_subquery_expression.h b/src/include/parser/expression/parsed_subquery_expression.h
@@ -33,23 +33,13 @@ class ParsedSubqueryExpression : public ParsedExpression {
 
     static std::unique_ptr<ParsedSubqueryExpression> deserialize(
         common::Deserializer& /*deserializer*/) {
-        // LCOV_EXCL_START
         KU_UNREACHABLE;
-        // LCOV_EXCL_STOP
     }
 
-    std::unique_ptr<ParsedExpression> copy() const override {
-        // LCOV_EXCL_START
-        KU_UNREACHABLE;
-        // LCOV_EXCL_STOP
-    }
+    std::unique_ptr<ParsedExpression> copy() const override { KU_UNREACHABLE; }
 
 private:
-    void serializeInternal(common::Serializer& /*serializer*/) const override {
-        // LCOV_EXCL_START
-        KU_UNREACHABLE;
-        // LCOV_EXCL_STOP
-    }
+    void serializeInternal(common::Serializer& /*serializer*/) const override { KU_UNREACHABLE; }
 
 private:
     std::vector<std::unique_ptr<PatternElement>> patternElements;

diff --git a/src/include/processor/operator/order_by/order_by_key_encoder.h b/src/include/processor/operator/order_by/order_by_key_encoder.h
@@ -95,9 +95,7 @@ class OrderByKeyEncoder {
 
     template<typename type>
     static void encodeData(type /*data*/, uint8_t* /*resultPtr*/, bool /*swapBytes*/) {
-        // LCOV_EXCL_START
         KU_UNREACHABLE;
-        // LCOV_EXCL_STOP
     }
 
     static inline uint8_t flipSign(uint8_t key_byte) { return key_byte ^ 128; }

diff --git a/src/optimizer/acc_hash_join_optimizer.cpp b/src/optimizer/acc_hash_join_optimizer.cpp
@@ -234,10 +234,8 @@ std::shared_ptr<planner::LogicalOperator> HashJoinSIPOptimizer::appendNodeSemiMa
         key = extend->getNbrNode()->getInternalID();
         nodeTableIDs = extend->getNbrNode()->getTableIDs();
     } break;
-        // LCOV_EXCL_START
     default:
         KU_UNREACHABLE;
-        // LCOV_EXCL_STOP
     }
     auto semiMasker = std::make_shared<LogicalSemiMasker>(SemiMaskType::NODE, std::move(key),
         std::move(nodeTableIDs), opsToApplySemiMask, std::move(child));