Annotate methods with @idempotent or @NonIdempotent

Author: steve-s

graalpython/com.oracle.graal.python/src/com/oracle/graal/python/PythonLanguage.java

@@ -104,6 +104,7 @@
 import com.oracle.truffle.api.TruffleLanguage;
 import com.oracle.truffle.api.TruffleLogger;
 import com.oracle.truffle.api.debug.DebuggerTags;
+import com.oracle.truffle.api.dsl.Idempotent;
 import com.oracle.truffle.api.frame.VirtualFrame;
 import com.oracle.truffle.api.instrumentation.ProvidedTags;
 import com.oracle.truffle.api.instrumentation.StandardTags;
@@ -229,6 +230,7 @@ public final class PythonLanguage extends TruffleLanguage<PythonContext> {
 
     @CompilationFinal private boolean singleContext = true;
 
+    @Idempotent
     public boolean isSingleContext() {
         return singleContext;
     }
@@ -366,6 +368,7 @@ protected PythonContext createContext(Env env) {
         return context;
     }
 
+    @Idempotent
     public <T> T getEngineOption(OptionKey<T> key) {
         assert engineOptions != null;
         if (CompilerDirectives.inInterpreter()) {
@@ -681,6 +684,7 @@ public String getHome() {
     /**
      * If this object can be cached in the AST.
      */
+    @Idempotent
     public static boolean canCache(Object value) {
         CompilerAsserts.neverPartOfCompilation();
         // We cache strings with at most 16 characters. This corresponds to byte length of 64 for

graalpython/com.oracle.graal.python/src/com/oracle/graal/python/builtins/modules/BuiltinFunctions.java

@@ -268,6 +268,7 @@
 import com.oracle.truffle.api.dsl.GenerateCached;
 import com.oracle.truffle.api.dsl.GenerateInline;
 import com.oracle.truffle.api.dsl.GenerateNodeFactory;
+import com.oracle.truffle.api.dsl.Idempotent;
 import com.oracle.truffle.api.dsl.ImportStatic;
 import com.oracle.truffle.api.dsl.NeverDefault;
 import com.oracle.truffle.api.dsl.ReportPolymorphism;
@@ -1410,6 +1411,7 @@ protected RecursiveBinaryCheckBaseNode createRecursive(@SuppressWarnings("unused
             throw new AbstractMethodError(); // Cannot be really abstract b/c Truffle DSL...
         }
 
+        @Idempotent
         protected int getMaxExplodeLoop() {
             return MAX_EXPLODE_LOOP >> depth;
         }

graalpython/com.oracle.graal.python/src/com/oracle/graal/python/builtins/modules/lzma/LZMANodes.java

@@ -134,6 +134,7 @@
 import com.oracle.truffle.api.dsl.GenerateInline;
 import com.oracle.truffle.api.dsl.ImportStatic;
 import com.oracle.truffle.api.dsl.NeverDefault;
+import com.oracle.truffle.api.dsl.NonIdempotent;
 import com.oracle.truffle.api.dsl.Specialization;
 import com.oracle.truffle.api.frame.Frame;
 import com.oracle.truffle.api.frame.VirtualFrame;
@@ -1201,6 +1202,7 @@ public abstract static class IsCheckSupported extends PNodeWithRaise {
 
         public abstract boolean execute(int checkId);
 
+        @NonIdempotent
         protected boolean useNativeContext() {
             return PythonContext.get(this).getNFILZMASupport().isAvailable();
         }
@@ -1227,6 +1229,7 @@ public abstract static class EncodeFilterProperties extends PNodeWithRaise {
 
         public abstract byte[] execute(VirtualFrame frame, Object filter);
 
+        @NonIdempotent
         protected boolean useNativeContext() {
             return PythonContext.get(this).getNFILZMASupport().isAvailable();
         }
@@ -1268,6 +1271,7 @@ public abstract static class DecodeFilterProperties extends PNodeWithRaise {
 
         public abstract void execute(VirtualFrame frame, long id, byte[] encoded, PDict dict);
 
+        @NonIdempotent
         protected boolean useNativeContext() {
             return PythonContext.get(this).getNFILZMASupport().isAvailable();
         }

graalpython/com.oracle.graal.python/src/com/oracle/graal/python/builtins/modules/zlib/ZLibModuleBuiltins.java

@@ -100,6 +100,7 @@
 import com.oracle.truffle.api.dsl.ImportStatic;
 import com.oracle.truffle.api.dsl.NeverDefault;
 import com.oracle.truffle.api.dsl.NodeFactory;
+import com.oracle.truffle.api.dsl.NonIdempotent;
 import com.oracle.truffle.api.dsl.Specialization;
 import com.oracle.truffle.api.dsl.TypeSystemReference;
 import com.oracle.truffle.api.frame.VirtualFrame;
@@ -326,6 +327,7 @@ protected ArgumentClinicProvider getArgumentClinic() {
             return ZLibModuleBuiltinsClinicProviders.Crc32NodeClinicProviderGen.INSTANCE;
         }
 
+        @NonIdempotent
         protected boolean useNative() {
             return PythonContext.get(this).getNFIZlibSupport().isAvailable();
         }
@@ -403,6 +405,7 @@ protected ArgumentClinicProvider getArgumentClinic() {
             return ZLibModuleBuiltinsClinicProviders.Adler32NodeClinicProviderGen.INSTANCE;
         }
 
+        @NonIdempotent
         protected boolean useNative() {
             return getContext().getNFIZlibSupport().isAvailable();
         }
@@ -489,6 +492,7 @@ protected ArgumentClinicProvider getArgumentClinic() {
             return ZLibModuleBuiltinsClinicProviders.CompressNodeClinicProviderGen.INSTANCE;
         }
 
+        @NonIdempotent
         protected boolean useNative() {
             return getContext().getNFIZlibSupport().isAvailable();
         }
@@ -560,6 +564,7 @@ protected ArgumentClinicProvider getArgumentClinic() {
             return ZLibModuleBuiltinsClinicProviders.DecompressNodeClinicProviderGen.INSTANCE;
         }
 
+        @NonIdempotent
         protected boolean useNative() {
             return PythonContext.get(this).getNFIZlibSupport().isAvailable();
         }
@@ -647,6 +652,7 @@ protected ArgumentClinicProvider getArgumentClinic() {
             return ZLibModuleBuiltinsClinicProviders.CompressObjNodeClinicProviderGen.INSTANCE;
         }
 
+        @NonIdempotent
         protected boolean useNative() {
             return PythonContext.get(this).getNFIZlibSupport().isAvailable();
         }
@@ -720,6 +726,7 @@ protected ArgumentClinicProvider getArgumentClinic() {
             return ZLibModuleBuiltinsClinicProviders.DecompressObjNodeClinicProviderGen.INSTANCE;
         }
 
+        @NonIdempotent
         protected boolean useNative() {
             return PythonContext.get(this).getNFIZlibSupport().isAvailable();
         }

graalpython/com.oracle.graal.python/src/com/oracle/graal/python/builtins/objects/cext/common/CExtParseArgumentsNode.java

@@ -95,6 +95,7 @@
 import com.oracle.truffle.api.dsl.Cached.Exclusive;
 import com.oracle.truffle.api.dsl.Cached.Shared;
 import com.oracle.truffle.api.dsl.Fallback;
+import com.oracle.truffle.api.dsl.Idempotent;
 import com.oracle.truffle.api.dsl.ImportStatic;
 import com.oracle.truffle.api.dsl.ReportPolymorphism.Megamorphic;
 import com.oracle.truffle.api.dsl.Specialization;
@@ -150,8 +151,13 @@ public abstract static class ParseTupleAndKeywordsNode extends Node {
 
         public abstract int execute(TruffleString funName, Object argv, Object kwds, Object format, Object kwdnames, Object varargs);
 
+        @Idempotent
+        static int tsLength(TruffleString.CodePointLengthNode lengthNode, TruffleString s) {
+            return lengthNode.execute(s, TS_ENCODING);
+        }
+
         @ExplodeLoop(kind = LoopExplosionKind.FULL_UNROLL_UNTIL_RETURN)
-        @Specialization(guards = {"isDictOrNull(kwds)", "eqNode.execute(cachedFormat, format, TS_ENCODING)", "lengthNode.execute(cachedFormat, TS_ENCODING) <= 8"}, limit = "5")
+        @Specialization(guards = {"isDictOrNull(kwds)", "eqNode.execute(cachedFormat, format, TS_ENCODING)", "tsLength(lengthNode, cachedFormat) <= 8"}, limit = "5")
         int doSpecial(TruffleString funName, PTuple argv, Object kwds, @SuppressWarnings("unused") TruffleString format, Object kwdnames, Object varargs,
                         @Cached(value = "format", allowUncached = true) @SuppressWarnings("unused") TruffleString cachedFormat,
                         @Cached TruffleString.CodePointLengthNode lengthNode,

graalpython/com.oracle.graal.python/src/com/oracle/graal/python/builtins/objects/method/PBuiltinMethod.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2017, 2022, Oracle and/or its affiliates.
+ * Copyright (c) 2017, 2023, Oracle and/or its affiliates.
  * Copyright (c) 2013, Regents of the University of California
  *
  * All rights reserved.
@@ -28,6 +28,7 @@
 import com.oracle.graal.python.builtins.objects.function.PBuiltinFunction;
 import com.oracle.graal.python.builtins.objects.object.PythonBuiltinObject;
 import com.oracle.truffle.api.CompilerAsserts;
+import com.oracle.truffle.api.dsl.Idempotent;
 import com.oracle.truffle.api.interop.InteropLibrary;
 import com.oracle.truffle.api.library.ExportLibrary;
 import com.oracle.truffle.api.library.ExportMessage;
@@ -61,6 +62,7 @@ public PBuiltinMethod(Object clazz, Shape instanceShape, Object self, PBuiltinFu
         this.classObject = classObject;
     }
 
+    @Idempotent
     public PBuiltinFunction getFunction() {
         return function;
     }

graalpython/com.oracle.graal.python/src/com/oracle/graal/python/builtins/objects/object/ObjectBuiltins.java

@@ -142,6 +142,7 @@
 import com.oracle.truffle.api.dsl.Cached.Shared;
 import com.oracle.truffle.api.dsl.Fallback;
 import com.oracle.truffle.api.dsl.GenerateNodeFactory;
+import com.oracle.truffle.api.dsl.Idempotent;
 import com.oracle.truffle.api.dsl.ImportStatic;
 import com.oracle.truffle.api.dsl.NeverDefault;
 import com.oracle.truffle.api.dsl.NodeFactory;
@@ -407,6 +408,7 @@ public abstract static class GetAttributeNode extends PythonBinaryBuiltinNode {
         @Child private ReadAttributeFromObjectNode attrRead;
         @Child private GetClassNode getDescClassNode;
 
+        @Idempotent
         protected static int tsLen(TruffleString ts) {
             CompilerAsserts.neverPartOfCompilation();
             return TruffleString.CodePointLengthNode.getUncached().execute(ts, TS_ENCODING) + 1;

graalpython/com.oracle.graal.python/src/com/oracle/graal/python/builtins/objects/superobject/SuperBuiltins.java

@@ -104,6 +104,7 @@
 import com.oracle.truffle.api.dsl.Cached;
 import com.oracle.truffle.api.dsl.Fallback;
 import com.oracle.truffle.api.dsl.GenerateNodeFactory;
+import com.oracle.truffle.api.dsl.Idempotent;
 import com.oracle.truffle.api.dsl.NeverDefault;
 import com.oracle.truffle.api.dsl.NodeFactory;
 import com.oracle.truffle.api.dsl.Specialization;
@@ -224,6 +225,7 @@ PNone init(VirtualFrame frame, SuperObject self, Object cls, Object obj) {
             return PNone.NONE;
         }
 
+        @Idempotent
         protected boolean isInBuiltinFunctionRoot() {
             return getRootNode() instanceof BuiltinFunctionRootNode;
         }

graalpython/com.oracle.graal.python/src/com/oracle/graal/python/builtins/objects/type/SpecialMethodSlot.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2021, 2022, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2021, 2023, Oracle and/or its affiliates. All rights reserved.
  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
  *
  * The Universal Permissive License (UPL), Version 1.0
@@ -146,6 +146,7 @@
 import com.oracle.truffle.api.CompilerAsserts;
 import com.oracle.truffle.api.CompilerDirectives.CompilationFinal;
 import com.oracle.truffle.api.CompilerDirectives.TruffleBoundary;
+import com.oracle.truffle.api.dsl.Idempotent;
 import com.oracle.truffle.api.dsl.NodeFactory;
 import com.oracle.truffle.api.object.DynamicObject;
 import com.oracle.truffle.api.object.DynamicObjectLibrary;
@@ -334,6 +335,7 @@ public Object getValue(PythonManagedClass klass) {
         return klass.specialMethodSlots[ordinal()];
     }
 
+    @Idempotent
     public Object getValue(PythonBuiltinClassType klassType) {
         // should not be called during initialization
         return klassType.getSpecialMethodSlots()[ordinal()];

graalpython/com.oracle.graal.python/src/com/oracle/graal/python/nodes/PGuards.java

@@ -111,6 +111,7 @@
 import com.oracle.graal.python.util.OverflowException;
 import com.oracle.truffle.api.CompilerDirectives;
 import com.oracle.truffle.api.HostCompilerDirectives.InliningCutoff;
+import com.oracle.truffle.api.dsl.Idempotent;
 import com.oracle.truffle.api.frame.VirtualFrame;
 import com.oracle.truffle.api.interop.InteropLibrary;
 import com.oracle.truffle.api.interop.UnsupportedMessageException;
@@ -202,14 +203,17 @@ public static boolean isStgDict(Object dict) {
         return dict instanceof StgDictObject;
     }
 
+    @Idempotent
     public static boolean isFunction(Object value) {
         return value instanceof PBuiltinFunction || value instanceof PFunction;
     }
 
+    @Idempotent
     public static boolean isPBuiltinFunction(Object value) {
         return value instanceof PBuiltinFunction;
     }
 
+    @Idempotent
     public static boolean isPFunction(Object value) {
         return value instanceof PFunction;
     }