1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333
|
//===--- TypeMismatchCheck.cpp - clang-tidy--------------------------------===//
//
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
// See https://llvm.org/LICENSE.txt for license information.
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
//
//===----------------------------------------------------------------------===//
#include "TypeMismatchCheck.h"
#include "clang/Lex/Lexer.h"
#include "clang/Tooling/FixIt.h"
#include "llvm/ADT/StringSet.h"
#include <map>
using namespace clang::ast_matchers;
namespace clang {
namespace tidy {
namespace mpi {
/// Check if a BuiltinType::Kind matches the MPI datatype.
///
/// \param MultiMap datatype group
/// \param Kind buffer type kind
/// \param MPIDatatype name of the MPI datatype
///
/// \returns true if the pair matches
static bool
isMPITypeMatching(const std::multimap<BuiltinType::Kind, StringRef> &MultiMap,
const BuiltinType::Kind Kind, StringRef MPIDatatype) {
auto ItPair = MultiMap.equal_range(Kind);
while (ItPair.first != ItPair.second) {
if (ItPair.first->second == MPIDatatype)
return true;
++ItPair.first;
}
return false;
}
/// Check if the MPI datatype is a standard type.
///
/// \param MPIDatatype name of the MPI datatype
///
/// \returns true if the type is a standard type
static bool isStandardMPIDatatype(StringRef MPIDatatype) {
static llvm::StringSet<> AllTypes = {"MPI_C_BOOL",
"MPI_CHAR",
"MPI_SIGNED_CHAR",
"MPI_UNSIGNED_CHAR",
"MPI_WCHAR",
"MPI_INT",
"MPI_LONG",
"MPI_SHORT",
"MPI_LONG_LONG",
"MPI_LONG_LONG_INT",
"MPI_UNSIGNED",
"MPI_UNSIGNED_SHORT",
"MPI_UNSIGNED_LONG",
"MPI_UNSIGNED_LONG_LONG",
"MPI_FLOAT",
"MPI_DOUBLE",
"MPI_LONG_DOUBLE",
"MPI_C_COMPLEX",
"MPI_C_FLOAT_COMPLEX",
"MPI_C_DOUBLE_COMPLEX",
"MPI_C_LONG_DOUBLE_COMPLEX",
"MPI_INT8_T",
"MPI_INT16_T",
"MPI_INT32_T",
"MPI_INT64_T",
"MPI_UINT8_T",
"MPI_UINT16_T",
"MPI_UINT32_T",
"MPI_UINT64_T",
"MPI_CXX_BOOL",
"MPI_CXX_FLOAT_COMPLEX",
"MPI_CXX_DOUBLE_COMPLEX",
"MPI_CXX_LONG_DOUBLE_COMPLEX"};
return AllTypes.find(MPIDatatype) != AllTypes.end();
}
/// Check if a BuiltinType matches the MPI datatype.
///
/// \param Builtin the builtin type
/// \param BufferTypeName buffer type name, gets assigned
/// \param MPIDatatype name of the MPI datatype
/// \param LO language options
///
/// \returns true if the type matches
static bool isBuiltinTypeMatching(const BuiltinType *Builtin,
std::string &BufferTypeName,
StringRef MPIDatatype,
const LangOptions &LO) {
static std::multimap<BuiltinType::Kind, StringRef> BuiltinMatches = {
// On some systems like PPC or ARM, 'char' is unsigned by default which is
// why distinct signedness for the buffer and MPI type is tolerated.
{BuiltinType::SChar, "MPI_CHAR"},
{BuiltinType::SChar, "MPI_SIGNED_CHAR"},
{BuiltinType::SChar, "MPI_UNSIGNED_CHAR"},
{BuiltinType::Char_S, "MPI_CHAR"},
{BuiltinType::Char_S, "MPI_SIGNED_CHAR"},
{BuiltinType::Char_S, "MPI_UNSIGNED_CHAR"},
{BuiltinType::UChar, "MPI_CHAR"},
{BuiltinType::UChar, "MPI_SIGNED_CHAR"},
{BuiltinType::UChar, "MPI_UNSIGNED_CHAR"},
{BuiltinType::Char_U, "MPI_CHAR"},
{BuiltinType::Char_U, "MPI_SIGNED_CHAR"},
{BuiltinType::Char_U, "MPI_UNSIGNED_CHAR"},
{BuiltinType::WChar_S, "MPI_WCHAR"},
{BuiltinType::WChar_U, "MPI_WCHAR"},
{BuiltinType::Bool, "MPI_C_BOOL"},
{BuiltinType::Bool, "MPI_CXX_BOOL"},
{BuiltinType::Short, "MPI_SHORT"},
{BuiltinType::Int, "MPI_INT"},
{BuiltinType::Long, "MPI_LONG"},
{BuiltinType::LongLong, "MPI_LONG_LONG"},
{BuiltinType::LongLong, "MPI_LONG_LONG_INT"},
{BuiltinType::UShort, "MPI_UNSIGNED_SHORT"},
{BuiltinType::UInt, "MPI_UNSIGNED"},
{BuiltinType::ULong, "MPI_UNSIGNED_LONG"},
{BuiltinType::ULongLong, "MPI_UNSIGNED_LONG_LONG"},
{BuiltinType::Float, "MPI_FLOAT"},
{BuiltinType::Double, "MPI_DOUBLE"},
{BuiltinType::LongDouble, "MPI_LONG_DOUBLE"}};
if (!isMPITypeMatching(BuiltinMatches, Builtin->getKind(), MPIDatatype)) {
BufferTypeName = std::string(Builtin->getName(LO));
return false;
}
return true;
}
/// Check if a complex float/double/long double buffer type matches
/// the MPI datatype.
///
/// \param Complex buffer type
/// \param BufferTypeName buffer type name, gets assigned
/// \param MPIDatatype name of the MPI datatype
/// \param LO language options
///
/// \returns true if the type matches or the buffer type is unknown
static bool isCComplexTypeMatching(const ComplexType *const Complex,
std::string &BufferTypeName,
StringRef MPIDatatype,
const LangOptions &LO) {
static std::multimap<BuiltinType::Kind, StringRef> ComplexCMatches = {
{BuiltinType::Float, "MPI_C_COMPLEX"},
{BuiltinType::Float, "MPI_C_FLOAT_COMPLEX"},
{BuiltinType::Double, "MPI_C_DOUBLE_COMPLEX"},
{BuiltinType::LongDouble, "MPI_C_LONG_DOUBLE_COMPLEX"}};
const auto *Builtin =
Complex->getElementType().getTypePtr()->getAs<BuiltinType>();
if (Builtin &&
!isMPITypeMatching(ComplexCMatches, Builtin->getKind(), MPIDatatype)) {
BufferTypeName = (llvm::Twine(Builtin->getName(LO)) + " _Complex").str();
return false;
}
return true;
}
/// Check if a complex<float/double/long double> templated buffer type matches
/// the MPI datatype.
///
/// \param Template buffer type
/// \param BufferTypeName buffer type name, gets assigned
/// \param MPIDatatype name of the MPI datatype
/// \param LO language options
///
/// \returns true if the type matches or the buffer type is unknown
static bool
isCXXComplexTypeMatching(const TemplateSpecializationType *const Template,
std::string &BufferTypeName, StringRef MPIDatatype,
const LangOptions &LO) {
static std::multimap<BuiltinType::Kind, StringRef> ComplexCXXMatches = {
{BuiltinType::Float, "MPI_CXX_FLOAT_COMPLEX"},
{BuiltinType::Double, "MPI_CXX_DOUBLE_COMPLEX"},
{BuiltinType::LongDouble, "MPI_CXX_LONG_DOUBLE_COMPLEX"}};
if (Template->getAsCXXRecordDecl()->getName() != "complex")
return true;
const auto *Builtin =
Template->getArg(0).getAsType().getTypePtr()->getAs<BuiltinType>();
if (Builtin &&
!isMPITypeMatching(ComplexCXXMatches, Builtin->getKind(), MPIDatatype)) {
BufferTypeName =
(llvm::Twine("complex<") + Builtin->getName(LO) + ">").str();
return false;
}
return true;
}
/// Check if a fixed size width buffer type matches the MPI datatype.
///
/// \param Typedef buffer type
/// \param BufferTypeName buffer type name, gets assigned
/// \param MPIDatatype name of the MPI datatype
///
/// \returns true if the type matches or the buffer type is unknown
static bool isTypedefTypeMatching(const TypedefType *const Typedef,
std::string &BufferTypeName,
StringRef MPIDatatype) {
static llvm::StringMap<StringRef> FixedWidthMatches = {
{"int8_t", "MPI_INT8_T"}, {"int16_t", "MPI_INT16_T"},
{"int32_t", "MPI_INT32_T"}, {"int64_t", "MPI_INT64_T"},
{"uint8_t", "MPI_UINT8_T"}, {"uint16_t", "MPI_UINT16_T"},
{"uint32_t", "MPI_UINT32_T"}, {"uint64_t", "MPI_UINT64_T"}};
const auto It = FixedWidthMatches.find(Typedef->getDecl()->getName());
// Check if the typedef is known and not matching the MPI datatype.
if (It != FixedWidthMatches.end() && It->getValue() != MPIDatatype) {
BufferTypeName = std::string(Typedef->getDecl()->getName());
return false;
}
return true;
}
/// Get the unqualified, dereferenced type of an argument.
///
/// \param CE call expression
/// \param Idx argument index
///
/// \returns type of the argument
static const Type *argumentType(const CallExpr *const CE, const size_t Idx) {
const QualType QT = CE->getArg(Idx)->IgnoreImpCasts()->getType();
return QT.getTypePtr()->getPointeeOrArrayElementType();
}
void TypeMismatchCheck::registerMatchers(MatchFinder *Finder) {
Finder->addMatcher(callExpr().bind("CE"), this);
}
void TypeMismatchCheck::check(const MatchFinder::MatchResult &Result) {
const auto *const CE = Result.Nodes.getNodeAs<CallExpr>("CE");
if (!CE->getDirectCallee())
return;
if (!FuncClassifier)
FuncClassifier.emplace(*Result.Context);
const IdentifierInfo *Identifier = CE->getDirectCallee()->getIdentifier();
if (!Identifier || !FuncClassifier->isMPIType(Identifier))
return;
// These containers are used, to capture buffer, MPI datatype pairs.
SmallVector<const Type *, 1> BufferTypes;
SmallVector<const Expr *, 1> BufferExprs;
SmallVector<StringRef, 1> MPIDatatypes;
// Adds a buffer, MPI datatype pair of an MPI call expression to the
// containers. For buffers, the type and expression is captured.
auto AddPair = [&CE, &Result, &BufferTypes, &BufferExprs, &MPIDatatypes](
const size_t BufferIdx, const size_t DatatypeIdx) {
// Skip null pointer constants and in place 'operators'.
if (CE->getArg(BufferIdx)->isNullPointerConstant(
*Result.Context, Expr::NPC_ValueDependentIsNull) ||
tooling::fixit::getText(*CE->getArg(BufferIdx), *Result.Context) ==
"MPI_IN_PLACE")
return;
StringRef MPIDatatype =
tooling::fixit::getText(*CE->getArg(DatatypeIdx), *Result.Context);
const Type *ArgType = argumentType(CE, BufferIdx);
// Skip unknown MPI datatypes and void pointers.
if (!isStandardMPIDatatype(MPIDatatype) || ArgType->isVoidType())
return;
BufferTypes.push_back(ArgType);
BufferExprs.push_back(CE->getArg(BufferIdx));
MPIDatatypes.push_back(MPIDatatype);
};
// Collect all buffer, MPI datatype pairs for the inspected call expression.
if (FuncClassifier->isPointToPointType(Identifier)) {
AddPair(0, 2);
} else if (FuncClassifier->isCollectiveType(Identifier)) {
if (FuncClassifier->isReduceType(Identifier)) {
AddPair(0, 3);
AddPair(1, 3);
} else if (FuncClassifier->isScatterType(Identifier) ||
FuncClassifier->isGatherType(Identifier) ||
FuncClassifier->isAlltoallType(Identifier)) {
AddPair(0, 2);
AddPair(3, 5);
} else if (FuncClassifier->isBcastType(Identifier)) {
AddPair(0, 2);
}
}
checkArguments(BufferTypes, BufferExprs, MPIDatatypes, getLangOpts());
}
void TypeMismatchCheck::checkArguments(ArrayRef<const Type *> BufferTypes,
ArrayRef<const Expr *> BufferExprs,
ArrayRef<StringRef> MPIDatatypes,
const LangOptions &LO) {
std::string BufferTypeName;
for (size_t I = 0; I < MPIDatatypes.size(); ++I) {
const Type *const BT = BufferTypes[I];
bool Error = false;
if (const auto *Typedef = BT->getAs<TypedefType>()) {
Error = !isTypedefTypeMatching(Typedef, BufferTypeName, MPIDatatypes[I]);
} else if (const auto *Complex = BT->getAs<ComplexType>()) {
Error =
!isCComplexTypeMatching(Complex, BufferTypeName, MPIDatatypes[I], LO);
} else if (const auto *Template = BT->getAs<TemplateSpecializationType>()) {
Error = !isCXXComplexTypeMatching(Template, BufferTypeName,
MPIDatatypes[I], LO);
} else if (const auto *Builtin = BT->getAs<BuiltinType>()) {
Error =
!isBuiltinTypeMatching(Builtin, BufferTypeName, MPIDatatypes[I], LO);
}
if (Error) {
const auto Loc = BufferExprs[I]->getSourceRange().getBegin();
diag(Loc, "buffer type '%0' does not match the MPI datatype '%1'")
<< BufferTypeName << MPIDatatypes[I];
}
}
}
void TypeMismatchCheck::onEndOfTranslationUnit() { FuncClassifier.reset(); }
} // namespace mpi
} // namespace tidy
} // namespace clang
|