eliminate one form of PythonObject::Reset()

[lawrence_danna]

Summary

I'd like to eliminate all forms of Reset() and all public constructors
on these objects, so the only way to make them is with Take<> and Retain<>
and the only way to copy or move them is with actual c++ copy, move, or
assignment.

This is a simple place to start.

[lawrence_danna]

include move version too

[labath]

I like where this is going.

lldb/source/Plugins/ScriptInterpreter/Python/PythonDataObjects.h

235–245

You can consider simplifying this further down to a "universal"/"sink" operator=(PythonObject other). Since the object is really just a pointer, the extra object being created won't hurt (in fact, the removal of &-indirection might make things faster).

[lawrence_danna]

lldb/source/Plugins/ScriptInterpreter/Python/PythonDataObjects.h

235–245

wouldn't that result in an extra retain and release every time a PythonObject was copied instead of referenced or moved?

[labath]

lldb/source/Plugins/ScriptInterpreter/Python/PythonDataObjects.h

235–245

No, it shouldn't, because the temporary PythonObject will be move-constructed (== no refcount traffic), if the operator= is called with an xvalue (if the rhs was not an xvalue, then you wouldn't end up calling the && overload anyway). Then you can move the temporary object into *this, and avoid refcount traffic again.

So, there is an additional PythonObject created, but it's move-constructed if possible, which should be efficient, if I understand these classes correctly. This is the recommended practice (at least by some) when you don't want to squeeze every last nanosecond of performance..

[lawrence_danna]

lldb/source/Plugins/ScriptInterpreter/Python/PythonDataObjects.h

235–245

How do you move the temporary object into *this, if you only have operator=(PythonObject other) to assign with?

[labath]

lldb/source/Plugins/ScriptInterpreter/Python/PythonDataObjects.h

235–245

In case that wasn't clear, the idea is to replace two operator= overloads with a single universal one taking a temporary. The advantage of that is less opportunities to implement move/copy incorrectly. The cost is one temporary move-constructed object more.

[lawrence_danna]

lldb/source/Plugins/ScriptInterpreter/Python/PythonDataObjects.h

235–245

so does that amount to just deleting the copy-assign, and keeping the move-assign how it is?

[labath]

lldb/source/Plugins/ScriptInterpreter/Python/PythonDataObjects.h

235–245

How do you move the temporary object into *this, if you only have operator=(PythonObject other) to assign with?

You need to do it manually, like the current && overload does, but you don't also need to implement the copy semantics in the const& overload.

so does that amount to just deleting the copy-assign, and keeping the move-assign how it is?

Almost. The implementation of move-assign would remain the same, but you'd drop the && (otherwise you'd lose the ability to copy-assign) from the signature. I.e.,

PythonObject &operator=(PythonObject other) {
    Reset();
    m_py_obj = std::exchange(other.m_py_obj, nullptr); // I just learned of this today so I have to show off.
    return *this;
  }

[lawrence_danna]

lldb/source/Plugins/ScriptInterpreter/Python/PythonDataObjects.h

235–245

oooooooh, i get it. It didn't occur to me that you could treat other as a rvalue without passing it as one in the parameter list, but of course you can because if it's pass-by-value then it's just a local variable by the time operator= gets its hands on it.

[lawrence_danna]

universal assignment

[labath]

lldb/source/Plugins/ScriptInterpreter/Python/PythonDataObjects.h

235–245

Yeah, isn't c++ fun? :)

I actually think this is one of the best features of c++11, as it allows you to write a single function that takes ownership of something more-or-less efficiently without any superfluous overloads or fancy &&s. The only problem is overcoming the learned "wisdom" that const & is the most efficient way to pass objects around.

lldb/source/Plugins/ScriptInterpreter/Python/PythonDataObjects.h

 class PythonObject {
 public:
   PythonObject() : m_py_obj(nullptr) {}
 
   PythonObject(PyRefType type, PyObject *py_obj) : m_py_obj(nullptr) {
     Reset(type, py_obj);
   }
 
-  PythonObject(const PythonObject &rhs) : m_py_obj(nullptr) { Reset(rhs); }
+  PythonObject(const PythonObject &rhs)
+      : PythonObject(PyRefType::Borrowed, rhs.m_py_obj) {}
 
   PythonObject(PythonObject &&rhs) {
     m_py_obj = rhs.m_py_obj;
     rhs.m_py_obj = nullptr;
   }
 
   ~PythonObject() { Reset(); }
 
   void Reset() {
     if (m_py_obj && Py_IsInitialized())
       Py_DECREF(m_py_obj);
     m_py_obj = nullptr;
   }
 
-  void Reset(const PythonObject &rhs) {
-    if (!rhs.IsValid())
-      Reset();
-    else
-      Reset(PyRefType::Borrowed, rhs.m_py_obj);
-  }
-
-  // PythonObject is implicitly convertible to PyObject *, which will call the
-  // wrong overload.  We want to explicitly disallow this, since a PyObject
-  // *always* owns its reference.  Therefore the overload which takes a
-  // PyRefType doesn't make sense, and the copy constructor should be used.
-  void Reset(PyRefType type, const PythonObject &ref) = delete;
-
   void Reset(PyRefType type, PyObject *py_obj) {
     if (py_obj == m_py_obj)
       return;
 
     if (Py_IsInitialized())
       Py_XDECREF(m_py_obj);
 
     m_py_obj = py_obj;
public:
   PyObject *get() const { return m_py_obj; }
 
   PyObject *release() {
     PyObject *result = m_py_obj;
     m_py_obj = nullptr;
     return result;
   }
 
   PythonObject &operator=(const PythonObject &other) {
     Reset(PyRefType::Borrowed, other.get());
     return *this;
   }
 
-  void Reset(PythonObject &&other) {
+  PythonObject &operator=(PythonObject &&other) {
     Reset();
     m_py_obj = other.m_py_obj;
     other.m_py_obj = nullptr;
-  }
-
-  PythonObject &operator=(PythonObject &&other) {
-    Reset(std::move(other));
     return *this;
   }
 
   PyObjectType GetObjectType() const;
 
   PythonString Repr() const;
 
   PythonString Str() const;
 
   static PythonObject ResolveNameWithDictionary(llvm::StringRef name,

lldb/source/Plugins/ScriptInterpreter/Python/PythonDataObjects.cpp

 }
 
 void PythonString::SetString(llvm::StringRef string) {
   auto s = FromUTF8(string);
   if (!s) {
     llvm::consumeError(s.takeError());
     Reset();
   } else {
-    PythonObject::Reset(std::move(s.get()));
+    *this = std::move(s.get());
   }
 }
 
 StructuredData::StringSP PythonString::CreateStructuredString() const {
   StructuredData::StringSP result(new StructuredData::String);
   result->SetValue(GetString());
   return result;
 }

lldb/unittests/ScriptInterpreter/Python/PythonDataObjectsTests.cpp

TEST_F(PythonDataObjectsTest, TestPythonListValueEquality) {
   static const long long_value0 = 5;
   static const char *const string_value1 = "String Index 1";
 
   PyObject *py_list = PyList_New(2);
   EXPECT_TRUE(PythonList::Check(py_list));
   PythonList list(PyRefType::Owned, py_list);
 
   PythonObject list_items[list_size];
-  list_items[0].Reset(PythonInteger(long_value0));
-  list_items[1].Reset(PythonString(string_value1));
+  list_items[0] = PythonInteger(long_value0);
+  list_items[1] = PythonString(string_value1);
 
   for (unsigned i = 0; i < list_size; ++i)
     list.SetItemAtIndex(i, list_items[i]);
 
   EXPECT_EQ(list_size, list.GetSize());
   EXPECT_EQ(PyObjectType::List, list.GetObjectType());
 
   // Verify that the values match
TEST_F(PythonDataObjectsTest, TestPythonDictionaryValueEquality) {
   const char *key_0 = "Key 0";
   int key_1 = 1;
   const int value_0 = 0;
   const char *value_1 = "Value 1";
 
   PythonObject py_keys[dict_entries];
   PythonObject py_values[dict_entries];
 
-  py_keys[0].Reset(PythonString(key_0));
-  py_keys[1].Reset(PythonInteger(key_1));
-  py_values[0].Reset(PythonInteger(value_0));
-  py_values[1].Reset(PythonString(value_1));
+  py_keys[0] = PythonString(key_0);
+  py_keys[1] = PythonInteger(key_1);
+  py_values[0] = PythonInteger(value_0);
+  py_values[1] = PythonString(value_1);
 
   PyObject *py_dict = PyDict_New();
   EXPECT_TRUE(PythonDictionary::Check(py_dict));
   PythonDictionary dict(PyRefType::Owned, py_dict);
 
   for (unsigned i = 0; i < dict_entries; ++i)
     PyDict_SetItem(py_dict, py_keys[i].get(), py_values[i].get());
   EXPECT_EQ(dict.GetSize(), dict_entries);
TEST_F(PythonDataObjectsTest, TestPythonDictionaryManipulation) {
   const char *const key_0 = "Key 0";
   const char *const key_1 = "Key 1";
   const long value_0 = 1;
   const char *const value_1 = "Value 1";
 
   PythonString keys[dict_entries];
   PythonObject values[dict_entries];
 
-  keys[0].Reset(PythonString(key_0));
-  keys[1].Reset(PythonString(key_1));
-  values[0].Reset(PythonInteger(value_0));
-  values[1].Reset(PythonString(value_1));
+  keys[0] = PythonString(key_0);
+  keys[1] = PythonString(key_1);
+  values[0] = PythonInteger(value_0);
+  values[1] = PythonString(value_1);
 
   PythonDictionary dict(PyInitialValue::Empty);
   for (int i = 0; i < 2; ++i)
     dict.SetItemForKey(keys[i], values[i]);
 
   EXPECT_EQ(dict_entries, dict.GetSize());
 
   // Verify that the keys and values match
// the old implementation of GetArgInfo just doesn't work on builtins.
     ASSERT_THAT_EXPECTED(arginfo, llvm::Succeeded());
     EXPECT_EQ(arginfo.get().count, 1);
     EXPECT_EQ(arginfo.get().max_positional_args, 1u);
     EXPECT_EQ(arginfo.get().has_varargs, false);
   }
 
 #endif
 }
 No newline at end of file