refactor IGC/common about IGC_ASSERT

Change-Id: I544a1f451a2b6434a3fc13b1d80f60c6eb406a93

Author: lukaszgotszaldintel

IGC/common/FunctionUpgrader.cpp

@@ -44,6 +44,8 @@ void FunctionUpgrader::Clean()
 
 llvm::Value* FunctionUpgrader::AddArgument(llvm::StringRef argName, llvm::Type* argType)
 {
+    IGC_ASSERT(nullptr != m_pFunction);
+
     llvm::IGCIRBuilder<> builder(m_pFunction->getContext());
     if (m_pFunction->begin()->empty())
     {
@@ -83,13 +85,13 @@ Argument* FunctionUpgrader::GetArgumentFromRebuild(llvm::LoadInst* pPlaceHolderA
         }
         else
         {
-            IGC_ASSERT(false && "There is no created new argument, did you call RebuildFunction?");
+            IGC_ASSERT_MESSAGE(0, "There is no created new argument, did you call RebuildFunction?");
             return nullptr;
         }
     }
     else
     {
-        IGC_ASSERT(false && "Didn't found new argument!");
+        IGC_ASSERT_MESSAGE(0, "Didn't found new argument!");
         return nullptr;
     }
 }
@@ -101,13 +103,18 @@ std::vector<LoadInst*> FunctionUpgrader::GetPlaceholderVec()
 
 uint32_t FunctionUpgrader::GetArgumentsSize()
 {
+    IGC_ASSERT(nullptr != m_pFunction);
+
     return m_placeHolders.size() + m_pFunction->arg_size();
 }
 
 Function* FunctionUpgrader::RebuildFunction()
 {
     Function* pFunctionRebuild = UpgradeFunctionWithNewArgs();
 
+    IGC_ASSERT(nullptr != m_pFunction);
+    IGC_ASSERT(nullptr != pFunctionRebuild);
+
     auto i_arg_old = m_pFunction->arg_begin();
     auto i_arg_new = pFunctionRebuild->arg_begin();
 
@@ -160,6 +167,8 @@ FunctionType* FunctionUpgrader::UpgradeFunctionTypeWithNewArgs()
 
 Function* FunctionUpgrader::UpgradeFunctionWithNewArgs()
 {
+    IGC_ASSERT(nullptr != m_pFunction);
+
     auto fType = UpgradeFunctionTypeWithNewArgs();
     auto fModule = m_pFunction->getParent();
     auto fName = m_pFunction->getName();
@@ -172,6 +181,8 @@ Function* FunctionUpgrader::UpgradeFunctionWithNewArgs()
             fLinkage,
             fName);
 
+    IGC_ASSERT(nullptr != fModule);
+
     fModule->getFunctionList().insert(m_pFunction->getIterator(), pNewFunc);
 
     // rename all args

IGC/common/ShaderOverride.cpp

@@ -146,7 +146,7 @@ iga_gen_t GetIGAPlatform(const IGC::CPlatform* platform)
             return IGA_GEN12p1;
         }
     default:
-        IGC_ASSERT(0 && "unsupported platform");
+        IGC_ASSERT_MESSAGE(0, "unsupported platform");
         break;
     }
     return IGA_GEN9;

IGC/common/Stats.cpp

@@ -69,7 +69,8 @@ const char* g_cShaderStatItems[STATS_MAX_SHADER_STATS_ITEMS+1] =
 
 int ShaderStats::getShaderStats( SHADER_STATS_ITEMS compileInterval )
 {
-    IGC_ASSERT(compileInterval >= 0 && compileInterval < STATS_MAX_SHADER_STATS_ITEMS);
+    IGC_ASSERT(0 <= compileInterval);
+    IGC_ASSERT(compileInterval < STATS_MAX_SHADER_STATS_ITEMS);
     return m_CompileShaderStats[compileInterval];
 }
 
@@ -419,7 +420,8 @@ void ShaderStats::parseIsaShader( ShaderHash hash, ShaderType shaderType, SIMDMo
 
 void ShaderStats::sumShaderStat( SHADER_STATS_ITEMS compileInterval, int count )
 {
-    IGC_ASSERT(compileInterval >= 0 && compileInterval < STATS_MAX_SHADER_STATS_ITEMS);
+    IGC_ASSERT(0 <= compileInterval);
+    IGC_ASSERT(compileInterval < STATS_MAX_SHADER_STATS_ITEMS);
     m_CompileShaderStats[ compileInterval ] += count;
 };
 
@@ -456,7 +458,7 @@ std::string str(COMPILE_TIME_INTERVALS cti)
 #define DEFINE_TIME_STAT( enumName, stringName, parentEnum, isVISA, isUnacc, isCoarseTimer, isDashBoardTimer ) case enumName: return #enumName;
 #include "timeStats.def"
 #undef DEFINE_TIME_STAT
-    default: IGC_ASSERT(0 && "unreachable"); break;
+    default: IGC_ASSERT_MESSAGE(0, "unreachable"); break;
     }
 
     return "";
@@ -472,7 +474,7 @@ COMPILE_TIME_INTERVALS interval( std::string const& str )
 #include "timeStats.def"
 #undef DEFINE_TIME_STAT
     //llvm::errs() << str;
-    IGC_ASSERT(0 && "unreachable" && "unknown COMPILE_TIME_INTERVALS name");
+    IGC_ASSERT_MESSAGE(0, "unreachable, unknown COMPILE_TIME_INTERVALS name");
     return MAX_COMPILE_TIME_INTERVALS;
 }
 
@@ -483,7 +485,7 @@ bool isVISATimer( COMPILE_TIME_INTERVALS cti )
 #define DEFINE_TIME_STAT( enumName, stringName, parentEnum, isVISA, isUnacc, isCoarseTimer, isDashBoardTimer ) case enumName: return isVISA;
 #include "timeStats.def"
 #undef DEFINE_TIME_STAT
-    default: IGC_ASSERT(0 && "unreachable"); break;
+    default: IGC_ASSERT_MESSAGE(0, "unreachable"); break;
     }
     return false;
 }
@@ -495,7 +497,7 @@ bool isUnaccounted( COMPILE_TIME_INTERVALS cti )
 #define DEFINE_TIME_STAT( enumName, stringName, parentEnum, isVISA, isUnacc, isCoarseTimer, isDashBoardTimer ) case enumName: return isUnacc;
 #include "timeStats.def"
 #undef DEFINE_TIME_STAT
-    default: IGC_ASSERT(0 && "unreachable"); break;
+    default: IGC_ASSERT_MESSAGE(0, "unreachable"); break;
     }
     return false;
 }
@@ -507,7 +509,7 @@ bool isCoarseTimer( COMPILE_TIME_INTERVALS cti )
 #define DEFINE_TIME_STAT( enumName, stringName, parentEnum, isVISA, isUnacc, isCoarseTimer, isDashBoardTimer ) case enumName: return isCoarseTimer;
 #include "timeStats.def"
 #undef DEFINE_TIME_STAT
-default: IGC_ASSERT(0 && "unreachable"); break;
+    default: IGC_ASSERT_MESSAGE(0, "unreachable"); break;
     }
     return true;
 }
@@ -519,7 +521,7 @@ bool isDashboardTimer( COMPILE_TIME_INTERVALS cti )
 #define DEFINE_TIME_STAT( enumName, stringName, parentEnum, isVISA, isUnacc, isCoarseTimer, isDashBoardTimer ) case enumName: return isDashBoardTimer;
 #include "timeStats.def"
 #undef DEFINE_TIME_STAT
-    default: IGC_ASSERT(0 && "unreachable"); break;
+    default: IGC_ASSERT_MESSAGE(0, "unreachable"); break;
     }
 
     return true;
@@ -532,7 +534,7 @@ COMPILE_TIME_INTERVALS parentInterval( COMPILE_TIME_INTERVALS cti )
 #define DEFINE_TIME_STAT( enumName, stringName, parentEnum, isVISA, isUnacc, isCoarseTimer, isDashBoardTimer ) case enumName: return parentEnum;
 #include "timeStats.def"
 #undef DEFINE_TIME_STAT
-    default: IGC_ASSERT(0 && "unreachable"); break;
+    default: IGC_ASSERT_MESSAGE(0, "unreachable"); break;
     }
     return MAX_COMPILE_TIME_INTERVALS;
 }
@@ -581,26 +583,30 @@ void TimeStats::recordVISATimers()
 
 void TimeStats::recordTimerStart( COMPILE_TIME_INTERVALS compileInterval )
 {
-    IGC_ASSERT(compileInterval >= 0 && compileInterval < MAX_COMPILE_TIME_INTERVALS);
+    IGC_ASSERT(0 <= compileInterval);
+    IGC_ASSERT(compileInterval < MAX_COMPILE_TIME_INTERVALS);
     m_wallclockStart[ compileInterval ] = iSTD::GetTimestampCounter();
 }
 
 void TimeStats::recordTimerEnd( COMPILE_TIME_INTERVALS compileInterval )
 {
-    IGC_ASSERT(compileInterval >= 0 && compileInterval < MAX_COMPILE_TIME_INTERVALS);
+    IGC_ASSERT(0 <= compileInterval);
+    IGC_ASSERT(compileInterval < MAX_COMPILE_TIME_INTERVALS);
     m_elapsedTime[ compileInterval ] += iSTD::GetTimestampCounter() - m_wallclockStart[ compileInterval ];
     m_hitCount[ compileInterval ]++;
 }
 
 uint64_t TimeStats::getCompileTime( COMPILE_TIME_INTERVALS compileInterval ) const
 {
-    IGC_ASSERT(compileInterval >= 0 && compileInterval < MAX_COMPILE_TIME_INTERVALS);
+    IGC_ASSERT(0 <= compileInterval);
+    IGC_ASSERT(compileInterval < MAX_COMPILE_TIME_INTERVALS);
     return m_elapsedTime[ compileInterval ];
 }
 
 uint64_t TimeStats::getCompileHit( COMPILE_TIME_INTERVALS compileInterval ) const
 {
-    IGC_ASSERT(compileInterval >= 0 && compileInterval < MAX_COMPILE_TIME_INTERVALS);
+    IGC_ASSERT(0 <= compileInterval);
+    IGC_ASSERT(compileInterval < MAX_COMPILE_TIME_INTERVALS);
     return m_hitCount[ compileInterval ];
 }
 
@@ -712,7 +718,7 @@ bool TimeStats::skipTimer( int i ) const
 }
 void TimeStats::printSumTimeCSV(const char* outputFile) const
 {
-    IGC_ASSERT(m_isPostProcessed && "Print functions should only be called on a Post-Processed TimeStats object");
+    IGC_ASSERT_MESSAGE(m_isPostProcessed, "Print functions should only be called on a Post-Processed TimeStats object");
 
     bool fileExist = false;
 
@@ -786,7 +792,7 @@ void TimeStats::printSumTimeCSV(const char* outputFile) const
 
 void TimeStats::printPerPassSumTimeCSV(const char* outputFile) const
 {
-    IGC_ASSERT(m_isPostProcessed && "Print functions should only be called on a Post-Processed TimeStats object");
+    IGC_ASSERT_MESSAGE(m_isPostProcessed, "Print functions should only be called on a Post-Processed TimeStats object");
 
     if (m_PassTimeStatsMap.empty())
     {
@@ -898,7 +904,7 @@ namespace {
 
 void TimeStats::printSumTimeTable( llvm::raw_ostream & OS ) const
 {
-    IGC_ASSERT(m_isPostProcessed && "Print functions should only be called on a Post-Processed TimeStats object");
+    IGC_ASSERT_MESSAGE(m_isPostProcessed, "Print functions should only be called on a Post-Processed TimeStats object");
 
     llvm::formatted_raw_ostream FS(OS);
 
@@ -1041,7 +1047,7 @@ void TimeStats::printPerPassSumTime(llvm::raw_ostream& OS) const
 
 void TimeStats::printTimeCSV( std::string const& corpusName ) const
 {
-    IGC_ASSERT(m_isPostProcessed && "Print functions should only be called on a Post-Processed TimeStats object");
+    IGC_ASSERT_MESSAGE(m_isPostProcessed, "Print functions should only be called on a Post-Processed TimeStats object");
 
     const std::string outputFilePath = std::string("c:\\Intel\\") + "TimeStat_" + IGC::Debug::GetShaderCorpusName() + ".csv";
     const char *outputFile = outputFilePath.c_str();
@@ -1090,7 +1096,7 @@ void TimeStats::printTimeCSV( std::string const& corpusName ) const
 
 void TimeStats::printPerPassTimeCSV(std::string const& corpusName) const
 {
-    IGC_ASSERT(m_isPostProcessed && "Print functions should only be called on a Post-Processed TimeStats object");
+    IGC_ASSERT_MESSAGE(m_isPostProcessed, "Print functions should only be called on a Post-Processed TimeStats object");
 
     if (m_PassTimeStatsMap.empty())
     {

IGC/common/SysUtils.cpp

@@ -75,17 +75,17 @@ namespace IGC
 #if defined (__linux__)
             ifstream in(MakeStr("/proc/", getpid(), "/cmdline"), ios::in);
             if (!in.is_open())
-                IGC_ASSERT(0 && "Can not open cmdline pseudo file for current process");
+                IGC_ASSERT_MESSAGE(0, "Can not open cmdline pseudo file for current process");
 
             //in cmdline arguments are separated with \0
             getline(in, ret, '\0');
             if (!in.good())
-                IGC_ASSERT(0 && "Error reading from cmdline pseudo file");
+                IGC_ASSERT_MESSAGE(0, "Error reading from cmdline pseudo file");
 
 #elif defined(_WIN64) || defined(_WIN32)
             ret.resize(MAX_PATH);
             DWORD size = ::GetModuleFileNameA(NULL, &ret[0], ret.size());
-            IGC_ASSERT(size < ret.size() && "Windows path can have MAX_PATH characters max");
+            IGC_ASSERT_MESSAGE(size < ret.size(), "Windows path can have MAX_PATH characters max");
             ret.resize(size);
 #endif
 

IGC/common/SystemThread.cpp

@@ -367,7 +367,7 @@ CGenSystemInstructionKernelProgram* CGenSystemInstructionKernelProgram::Create(
     }
     else
     {
-        IGC_ASSERT((SIPIndex < SIPKernelInfo.size()) && ("Invalid SIPIndex while loading"));
+        IGC_ASSERT_MESSAGE((SIPIndex < SIPKernelInfo.size()), "Invalid SIPIndex while loading");
         m_LinearAddress = SIPKernelInfo[SIPIndex].first;
         m_ProgramSize = SIPKernelInfo[SIPIndex].second;
     }

IGC/common/Types.hpp

@@ -102,9 +102,10 @@ inline uint16_t numLanes(SIMDMode width)
     case SIMDMode::SIMD16  : return 16;
     case SIMDMode::SIMD32  : return 32;
     case SIMDMode::UNKNOWN :
-    default                : IGC_ASSERT(0 && "unreachable"); break;
+    default:
+        IGC_ASSERT_MESSAGE(0, "unreachable");
+        return 1;
     }
-    return 1;
 }
 
 inline SIMDMode lanesToSIMDMode(unsigned lanes) {
@@ -116,11 +117,9 @@ inline SIMDMode lanesToSIMDMode(unsigned lanes) {
     case 16: return SIMDMode::SIMD16;
     case 32: return SIMDMode::SIMD32;
     default:
-        break;
+        IGC_ASSERT_MESSAGE(0, "Unexpected number of lanes!");
+        return SIMDMode::UNKNOWN;
     }
-
-    IGC_ASSERT(false && "Unexpected number of lanes!");
-    return SIMDMode::UNKNOWN;
 }
 
 enum class ShaderType
@@ -280,8 +279,9 @@ inline typename std::enable_if<
     static_assert(std::is_integral<TDst>::value && std::is_integral<TSrc>::value,
         "int_cast<>() should be used only for conversions between integer types.");
 
-    IGC_ASSERT(std::numeric_limits<TDst>::min() <= value &&
-        value <= std::numeric_limits<TDst>::max());
+    IGC_ASSERT(std::numeric_limits<TDst>::min() <= value);
+    IGC_ASSERT(value <= std::numeric_limits<TDst>::max());
+
     return static_cast<TDst>(value);
 }
 
@@ -293,8 +293,8 @@ inline typename std::enable_if<
     static_assert(std::is_integral<TDst>::value && std::is_integral<TSrc>::value,
         "int_cast<>() should be used only for conversions between integer types.");
 
-    IGC_ASSERT(value <= static_cast<typename std::make_unsigned<TDst>::type>(
-        std::numeric_limits<TDst>::max()));
+    IGC_ASSERT(value <= static_cast<typename std::make_unsigned<TDst>::type>(std::numeric_limits<TDst>::max()));
+
     return static_cast<TDst>(value);
 }
 
@@ -306,8 +306,9 @@ inline typename std::enable_if<
     static_assert(std::is_integral<TDst>::value && std::is_integral<TSrc>::value,
         "int_cast<>() should be used only for conversions between integer types.");
 
-    IGC_ASSERT(0 <= value &&
-        static_cast<typename std::make_unsigned<TSrc>::type>(value) <= std::numeric_limits<TDst>::max());
+    IGC_ASSERT(0 <= value);
+    IGC_ASSERT(static_cast<typename std::make_unsigned<TSrc>::type>(value) <= std::numeric_limits<TDst>::max());
+
     return static_cast<TDst>(value);
 }
 
@@ -344,8 +345,7 @@ inline typename std::enable_if<
     static_assert(std::is_integral<TDst>::value,
         "int_cast<>() should be used only for conversions between integer types.");
 
-    IGC_ASSERT(value.getFixedSize() <= static_cast<typename std::make_unsigned<TDst>::type>(
-        std::numeric_limits<TDst>::max()));
+    IGC_ASSERT(value.getFixedSize() <= static_cast<typename std::make_unsigned<TDst>::type>(std::numeric_limits<TDst>::max()));
     return static_cast<TDst>(value.getFixedSize());
 }