[Instrumentor] Add instruction flags to NumericIO (llvm#200709)

Author: EthanLuisMcDonough

llvm/include/llvm/Transforms/IPO/Instrumentor.h

@@ -1088,14 +1088,15 @@ struct CastIO final
 /// Instrumentation opportunity for numeric operations. This includes Add, FAdd,
 /// Sub, FSub, Mul, FMul, UDiv, FDiv, SDiv, URem, SRem, FRem, Shl, LShr, AShr,
 /// And, Or, Xor, and FNeg.
-struct NumericIO : public InstructionIO<
-                       Instruction::Add, Instruction::FAdd, Instruction::Sub,
-                       Instruction::FSub, Instruction::Mul, Instruction::FMul,
-                       Instruction::UDiv, Instruction::FDiv, Instruction::SDiv,
-                       Instruction::URem, Instruction::SRem, Instruction::FRem,
-                       Instruction::Shl, Instruction::LShr, Instruction::AShr,
-                       Instruction::And, Instruction::Or, Instruction::Xor,
-                       Instruction::FNeg> {
+struct NumericIO final
+    : public InstructionIO<
+          Instruction::Add, Instruction::FAdd, Instruction::Sub,
+          Instruction::FSub, Instruction::Mul, Instruction::FMul,
+          Instruction::UDiv, Instruction::FDiv, Instruction::SDiv,
+          Instruction::URem, Instruction::SRem, Instruction::FRem,
+          Instruction::Shl, Instruction::LShr, Instruction::AShr,
+          Instruction::And, Instruction::Or, Instruction::Xor,
+          Instruction::FNeg> {
   NumericIO(InstrumentationLocation::KindTy Kind) : InstructionIO(Kind) {}
 
   enum ConfigKind {
@@ -1106,6 +1107,7 @@ struct NumericIO : public InstructionIO<
     ReplaceResult,
     PassLeft,
     PassRight,
+    PassFlags,
     PassId,
     NumConfig,
   };
@@ -1122,6 +1124,8 @@ struct NumericIO : public InstructionIO<
                         InstrumentorIRBuilderTy &IIRB);
   static Value *getRight(Value &V, Type &Ty, InstrumentationConfig &IConf,
                          InstrumentorIRBuilderTy &IIRB);
+  static Value *getFlags(Value &V, Type &Ty, InstrumentationConfig &IConf,
+                         InstrumentorIRBuilderTy &IIRB);
 
   static void populate(InstrumentationConfig &IConf,
                        InstrumentorIRBuilderTy &IIRB) {

llvm/lib/Transforms/IPO/Instrumentor.cpp

@@ -1705,6 +1705,61 @@ Value *NumericIO::getRight(Value &V, Type &Ty, InstrumentationConfig &IConf,
     return PoisonValue::get(&Ty);
 }
 
+// NumericIO flag bitmask values.
+enum NumericFlags : uint64_t {
+  NUMERIC_FLAG_NONE = 0,
+  NUMERIC_FLAG_NO_SIGNED_WRAP = 1 << 0,
+  NUMERIC_FLAG_NO_UNSIGNED_WRAP = 1 << 1,
+  NUMERIC_FLAG_HAS_NO_NANS = 1 << 2,
+  NUMERIC_FLAG_HAS_NO_INFS = 1 << 3,
+  NUMERIC_FLAG_HAS_NO_SIGNED_ZEROS = 1 << 4,
+  NUMERIC_FLAG_IS_DISJOINT = 1 << 5,
+  NUMERIC_FLAG_IS_EXACT = 1 << 6,
+};
+
+Value *NumericIO::getFlags(Value &V, Type &Ty, InstrumentationConfig &IConf,
+                           InstrumentorIRBuilderTy &IIRB) {
+  auto &I = cast<Instruction>(V);
+  uint64_t Flag = NUMERIC_FLAG_NONE;
+
+  switch (I.getOpcode()) {
+  case Instruction::Add:
+  case Instruction::Sub:
+  case Instruction::Mul:
+  case Instruction::Shl:
+    if (I.hasNoSignedWrap())
+      Flag |= NUMERIC_FLAG_NO_SIGNED_WRAP;
+    if (I.hasNoUnsignedWrap())
+      Flag |= NUMERIC_FLAG_NO_UNSIGNED_WRAP;
+    break;
+  case Instruction::FAdd:
+  case Instruction::FSub:
+  case Instruction::FMul:
+  case Instruction::FDiv:
+  case Instruction::FNeg:
+    if (I.hasNoNaNs())
+      Flag |= NUMERIC_FLAG_HAS_NO_NANS;
+    if (I.hasNoInfs())
+      Flag |= NUMERIC_FLAG_HAS_NO_INFS;
+    if (I.hasNoSignedZeros())
+      Flag |= NUMERIC_FLAG_HAS_NO_SIGNED_ZEROS;
+    break;
+  case Instruction::AShr:
+  case Instruction::LShr:
+  case Instruction::SDiv:
+  case Instruction::UDiv:
+    if (I.isExact())
+      Flag |= NUMERIC_FLAG_IS_EXACT;
+    break;
+  }
+
+  if (auto *DI = dyn_cast<PossiblyDisjointInst>(&V))
+    if (DI->isDisjoint())
+      Flag |= NUMERIC_FLAG_IS_DISJOINT;
+
+  return getCI(&Ty, Flag);
+}
+
 void NumericIO::init(InstrumentationConfig &IConf,
                      InstrumentorIRBuilderTy &IIRB, ConfigTy *UserConfig) {
   if (UserConfig)
@@ -1714,7 +1769,7 @@ void NumericIO::init(InstrumentationConfig &IConf,
       IRTArg::POTENTIALLY_INDIRECT |
       (Config.has(PassSize) ? IRTArg::INDIRECT_HAS_SIZE : IRTArg::NONE);
   if (Config.has(PassTypeId))
-    IRTArgs.push_back(IRTArg(IIRB.Int64Ty, "type_id",
+    IRTArgs.push_back(IRTArg(IIRB.Int32Ty, "type_id",
                              "The operation's type id.", IRTArg::NONE,
                              getTypeId));
   if (Config.has(PassSize))
@@ -1737,6 +1792,11 @@ void NumericIO::init(InstrumentationConfig &IConf,
         IRTArg(IIRB.Int64Ty, "result", "Result of the operation.",
                IRTArg::REPLACABLE | ValArgOpts, getValue,
                Config.has(ReplaceResult) ? replaceValue : nullptr));
+  if (Config.has(PassFlags))
+    IRTArgs.push_back(
+        IRTArg(IIRB.Int64Ty, "flags",
+               "A bitmask value signaling which instruction flags are present.",
+               IRTArg::NONE, getFlags));
   addCommonArgs(IConf, IIRB.Ctx, Config.has(PassId));
   IConf.addChoice(*this, IIRB.Ctx);
 }

llvm/test/Instrumentation/Instrumentor/default_config.json

@@ -238,6 +238,8 @@
       "left.description": "The operation's left operand.",
       "right": true,
       "right.description": "The operation's right operand. This value is poison for unary operations.",
+      "flags": true,
+      "flags.description": "A bitmask value signaling which instruction flags are present.",
       "id": true,
       "id.description": "A unique ID associated with the given instrumentor call"
     }
@@ -351,6 +353,8 @@
       "result": true,
       "result.replace": true,
       "result.description": "Result of the operation.",
+      "flags": true,
+      "flags.description": "A bitmask value signaling which instruction flags are present.",
       "id": true,
       "id.description": "A unique ID associated with the given instrumentor call"
     }

llvm/test/Instrumentation/Instrumentor/module_and_globals.ll

@@ -56,17 +56,17 @@ entry:
 ; CHECK-NEXT:    [[TMP28:%.*]] = trunc i64 [[TMP27]] to i32
 ; CHECK-NEXT:    [[TMP29:%.*]] = zext i32 [[TMP14]] to i64
 ; CHECK-NEXT:    [[TMP30:%.*]] = zext i32 [[TMP25]] to i64
-; CHECK-NEXT:    call void @__instrumentor_pre_numeric(i64 12, i32 4, i32 14, i64 [[TMP29]], i64 [[TMP30]], i32 12) #[[ATTR0]]
+; CHECK-NEXT:    call void @__instrumentor_pre_numeric(i32 12, i32 4, i32 14, i64 [[TMP29]], i64 [[TMP30]], i64 1, i32 12) #[[ATTR0]]
 ; CHECK-NEXT:    [[ADD:%.*]] = add nsw i32 [[TMP14]], [[TMP25]]
 ; CHECK-NEXT:    [[TMP17:%.*]] = zext i32 [[ADD]] to i64
-; CHECK-NEXT:    [[TMP18:%.*]] = call i64 @__instrumentor_post_numeric(i64 12, i32 4, i32 14, i64 [[TMP29]], i64 [[TMP30]], i64 [[TMP17]], i32 -12) #[[ATTR0]]
+; CHECK-NEXT:    [[TMP18:%.*]] = call i64 @__instrumentor_post_numeric(i32 12, i32 4, i32 14, i64 [[TMP29]], i64 [[TMP30]], i64 [[TMP17]], i64 1, i32 -12) #[[ATTR0]]
 ; CHECK-NEXT:    [[TMP19:%.*]] = trunc i64 [[TMP18]] to i32
 ; CHECK-NEXT:    [[TMP20:%.*]] = zext i32 [[TMP19]] to i64
 ; CHECK-NEXT:    [[TMP24:%.*]] = zext i32 [[TMP28]] to i64
-; CHECK-NEXT:    call void @__instrumentor_pre_numeric(i64 12, i32 4, i32 14, i64 [[TMP20]], i64 [[TMP24]], i32 13) #[[ATTR0]]
+; CHECK-NEXT:    call void @__instrumentor_pre_numeric(i32 12, i32 4, i32 14, i64 [[TMP20]], i64 [[TMP24]], i64 1, i32 13) #[[ATTR0]]
 ; CHECK-NEXT:    [[ADD3:%.*]] = add nsw i32 [[TMP19]], [[TMP28]]
 ; CHECK-NEXT:    [[TMP22:%.*]] = zext i32 [[ADD3]] to i64
-; CHECK-NEXT:    [[TMP23:%.*]] = call i64 @__instrumentor_post_numeric(i64 12, i32 4, i32 14, i64 [[TMP20]], i64 [[TMP24]], i64 [[TMP22]], i32 -13) #[[ATTR0]]
+; CHECK-NEXT:    [[TMP23:%.*]] = call i64 @__instrumentor_post_numeric(i32 12, i32 4, i32 14, i64 [[TMP20]], i64 [[TMP24]], i64 [[TMP22]], i64 1, i32 -13) #[[ATTR0]]
 ; CHECK-NEXT:    [[ADD2:%.*]] = trunc i64 [[TMP23]] to i32
 ; CHECK-NEXT:    call void @__instrumentor_post_function(ptr @foo, ptr @__instrumentor_.str.5, i32 0, ptr null, i8 0, i32 -15) #[[ATTR0]]
 ; CHECK-NEXT:    ret i32 [[ADD2]]