Merge pull request #30 from delphix/master

Sync master to 6.0/stage

Author: sdimitro

.github/workflows/ci.yml

@@ -7,7 +7,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: [3.9, 3.8, 3.7, 3.6]
+        python-version: ['3.10', '3.9', '3.8', '3.7', '3.6']
         cc: [gcc, clang]
       fail-fast: false
     env:
@@ -23,11 +23,11 @@ jobs:
         run: |
           sudo apt-get update
           sudo apt-get install busybox-static libelf-dev libdw-dev qemu-kvm zstd ${{ matrix.cc == 'clang' && 'libomp-$(clang --version | sed -rn "s/.*clang version ([0-9]+).*/\\1/p")-dev' || '' }}
-          pip install mypy
+          pip install mypy pyroute2
       - name: Generate version.py
         run: python setup.py --version
       - name: Check with mypy
-        run: mypy --strict --no-warn-return-any drgn _drgn.pyi
+        run: mypy --strict --no-warn-return-any --no-warn-unused-ignores drgn _drgn.pyi
       - name: Build and test with ${{ matrix.cc }}
         run: python setup.py test -K
 

.github/workflows/dco-check.yml

@@ -0,0 +1,27 @@
+name: DCO Check
+
+on:
+  pull_request:
+    types: [opened, synchronize, reopened, ready_for_review]
+
+jobs:
+  check:
+    if: ${{ !github.event.pull_request.draft }}
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout commit logs
+        run: |
+          git init
+          git fetch --filter=blob:none "$GITHUB_SERVER_URL/$GITHUB_REPOSITORY" "$GITHUB_BASE_REF" "$GITHUB_REF"
+      - name: Check for DCO sign-offs
+        run: |
+          no_sign_off="$(git log --no-merges --grep=Signed-off-by --invert-grep "FETCH_HEAD..$GITHUB_SHA")"
+          if [ -z "$no_sign_off" ]; then
+              echo "All commits have a Developer Certificate of Origin sign-off"
+          else
+              echo "The following commits are missing a Developer Certificate of Origin sign-off;"
+              echo "see https://github.com/osandov/drgn/blob/main/CONTRIBUTING.rst#signing-off"
+              echo
+              echo "$no_sign_off"
+              exit 1
+          fi

.gitignore

@@ -7,7 +7,10 @@
 /cscope.*
 /dist
 /docs/_build
+/drgn-*.tar.gz
 /drgn.egg-info
 /drgn/internal/version.py
 /htmlcov
+/python-drgn-*.src.rpm
+/python-drgn.spec
 __pycache__

.packit.yaml

@@ -0,0 +1,42 @@
+# See the documentation for more information:
+# https://packit.dev/docs/configuration/
+
+specfile_path: python-drgn.spec
+synced_files:
+  - python-drgn.spec
+  - .packit.yaml
+
+upstream_package_name: drgn
+downstream_package_name: python-drgn
+actions:
+  get-current-version: "python3 setup.py --version"
+  # Fetch the specfile from Rawhide and drop any patches
+  post-upstream-clone: "bash -c \"curl -s https://src.fedoraproject.org/rpms/python-drgn/raw/main/f/python-drgn.spec | sed '/^Patch[0-9]/d' > python-drgn.spec\""
+
+jobs:
+- job: copr_build
+  trigger: commit
+  metadata:
+    targets:
+      - fedora-all-aarch64
+      - fedora-all-armhfp
+      - fedora-all-i386
+      - fedora-all-ppc64le
+      - fedora-all-s390x
+      - fedora-all-x86_64
+      - epel-8-aarch64
+      - epel-8-ppc64le
+      - epel-8-x86_64
+- job: copr_build
+  trigger: pull_request
+  metadata:
+    targets:
+      - fedora-all-aarch64
+      - fedora-all-armhfp
+      - fedora-all-i386
+      - fedora-all-ppc64le
+      - fedora-all-s390x
+      - fedora-all-x86_64
+      - epel-8-aarch64
+      - epel-8-ppc64le
+      - epel-8-x86_64

.readthedocs.yml

@@ -1,3 +1,6 @@
 version: 2
 sphinx:
   configuration: docs/conf.py
+python:
+  install:
+    - requirements: docs/requirements.txt

CONTRIBUTING.rst

@@ -7,18 +7,25 @@ submit changes for drgn.
 Building
 --------
 
-The easiest way to develop drgn is by building and running it locally. See the
-`installation documentation
-<https://drgn.readthedocs.io/en/latest/installation.html#development>`_.
+The easiest way to develop drgn is by building and running it locally. Please
+build with warnings enabled. Install the dependencies from the `installation
+instructions <README.rst#from-source>`_, then run:
+
+.. code-block:: console
+
+    $ git clone https://github.com/osandov/drgn.git
+    $ cd drgn
+    $ CFLAGS="-Wall -Werror -g -O2" python3 setup.py build_ext -i
+    $ python3 -m drgn --help
 
 Testing
 -------
 
-.. highlight:: console
-
 Tests should be added for all features and bug fixes.
 
-drgn's test suite can be run with::
+drgn's test suite can be run with:
+
+.. code-block:: console
 
     $ python3 setup.py test
 
@@ -27,7 +34,9 @@ add ``-K``. See `vmtest <vmtest/README.rst>`_ for more details.
 
 Tests can also be run manually with `unittest
 <https://docs.python.org/3/library/unittest.html#command-line-interface>`_
-after building locally::
+after building locally:
+
+.. code-block:: console
 
     $ python3 -m unittest discover -v
 
@@ -49,14 +58,32 @@ C code in drgn mostly follows the `Linux kernel coding style
 <https://www.kernel.org/doc/html/latest/process/coding-style.html>`_ except
 that drgn requires C11 or newer, so declarations may be mixed with code.
 
-A few other guidelines:
+A few other guidelines/conventions:
 
+* Constants should be defined as enums or ``static const`` variables rather
+  than macros.
 * Functions that can fail should return a ``struct drgn_error *`` (and return
   their result via an out parameter if necessary).
 * Out parameters should be named ``ret`` (or suffixed with ``_ret`` if there
-  are multiple).
-* Constants should be defined as enums or ``static const`` variables rather
-  than macros.
+  are multiple) and be the last parameter(s) of the function.
+* Functions that initialize an already allocated structure should be suffixed
+  with ``_init`` and take the structure to initialize as the first argument,
+  e.g., ``struct drgn_error *foo_init(struct foo *foo, int foo_flags)``.
+* The matching function to deinitialize a structure should be suffixed with
+  ``_deinit``, e.g., ``void foo_deinit(struct foo *foo)``. If possible, the
+  definition should be placed directly after the definition of ``_init`` so
+  that it is easier to visually verify that everything is cleaned up.
+* Functions that allocate and initialize a structure should be suffixed with
+  ``_create`` and either return the structure as an out parameter (e.g.,
+  ``struct drgn_error *foo_create(int foo_flags, struct foo **ret)``) or as the
+  return value if they can only fail with an out-of-memory error (e.g.,
+  ``struct foo *foo_create(int foo_flags)``).
+* The matching function to free an allocated structure should be suffixed with
+  ``_destroy``, e.g., ``void foo_destroy(struct foo *foo)``. If possible, the
+  definition should be placed directly after the definition of ``_create``.
+  ``_destroy`` should usually allow a ``NULL`` argument, just like ``free()``.
+* Functions that return a result in a ``struct drgn_object *`` parameter should
+  only modify the object if the function succeeds.
 
 drgn assumes some `implementation-defined behavior
 <https://gcc.gnu.org/onlinedocs/gcc/C-Implementation.html>`_ for sanity:
@@ -74,7 +101,9 @@ Python
 Python code in drgn should be compatible with Python 3.6 and newer.
 
 Python code should be formatted with `black <https://github.com/psf/black>`_
-and `isort <https://github.com/timothycrosley/isort>`_::
+and `isort <https://github.com/timothycrosley/isort>`_:
+
+.. code-block:: console
 
     $ isort . && black .
 

MANIFEST.in

@@ -3,4 +3,4 @@ recursive-include examples *.py
 recursive-include tests *.py
 recursive-include tools *.py
 recursive-include vmtest *.c *.py *.rst
-include COPYING util.py vmtest/config
+include CONTRIBUTING.rst COPYING pytest.ini util.py vmtest/config