Merge branch 'develop' into uniformed-filter

Author: ab9rf

.github/workflows/build-windows.yml

@@ -68,6 +68,10 @@ jobs:
     name: Build win64
     runs-on: windows-2022
     steps:
+      - name: Set up Python
+        uses: actions/setup-python@v6
+        with:
+          python-version: '3.x'
       - name: Install build dependencies
         run: |
           choco install sccache

.pre-commit-config.yaml

@@ -20,11 +20,11 @@ repos:
       args: ['--fix=lf']
     - id: trailing-whitespace
 - repo: https://github.com/python-jsonschema/check-jsonschema
-  rev: 0.36.0
+  rev: 0.36.1
   hooks:
     - id: check-github-workflows
 - repo: https://github.com/Lucas-C/pre-commit-hooks
-  rev: v1.5.5
+  rev: v1.5.6
   hooks:
     - id: forbid-tabs
       exclude_types:

CMakeLists.txt

@@ -6,7 +6,7 @@ cmake_policy(SET CMP0048 NEW)
 cmake_policy(SET CMP0074 NEW)
 
 # set up versioning.
-set(DF_VERSION "53.09")
+set(DF_VERSION "53.10")
 set(DFHACK_RELEASE "r1")
 set(DFHACK_PRERELEASE FALSE)
 

docs/changelog.txt

@@ -58,10 +58,12 @@ Template for new versions:
 
 ## New Features
 - `sort`: added ``Uniformed`` filter to squad assignment screen to filter dwarves with mining, woodcutting, or hunting labors
+- `sort`: Add death cause button to dead/missing tab in the creatures screen
 
 ## Fixes
 
 ## Misc Improvements
+- Core: DFHack now validates vtable pointers in objects read from memory and will throw an exception instead of crashing when an invalid vtable pointer is encountered. This makes it easier to identify which DF data structure contains corrupted data when this manifests in the form of a bad vtable pointer, and shifts blame for such crashes from DFHack to DF.
 
 ## Documentation
 
@@ -71,6 +73,28 @@ Template for new versions:
 
 ## Removed
 
+# 53.10-r1
+
+## New Tools
+
+## New Features
+
+## Fixes
+- `autochop`: the report will no longer throw a C++ exception when burrows are defined.
+- `suspendmanager`: Fix the overlay appearing where it should not when following a unit
+
+## Misc Improvements
+
+## Documentation
+
+## API
+- Added ``Burrows::getName``: obtains the name of a burrow, or the same placeholder name that DF would show if the burrow is unnamed.
+
+## Lua
+- Added ``Burrows::getName`` as ``dfhack.burrows.getName``.
+
+## Removed
+
 # 53.09-r1
 
 ## New Tools

docs/dev/Lua API.rst

@@ -2489,6 +2489,11 @@ Maps module
 Burrows module
 --------------
 
+* ``dfhack.burrows.getName(burrow)``
+
+  Returns the name of the burrow.
+  If the burrow has no set name, returns the same placeholder name that DF would show in the UI.
+
 * ``dfhack.burrows.findByName(name[, ignore_final_plus])``
 
   Returns the burrow pointer or *nil*. if ``ignore_final_plus`` is ``true``,

library/DataDefs.cpp

@@ -370,7 +370,7 @@ const virtual_identity *virtual_identity::find(void *vtable)
 
     // If using a reader/writer lock, re-grab as write here, and recheck
     Core &core = Core::getInstance();
-    std::string name = core.p->doReadClassName(vtable);
+    std::string name = core.p->readClassName(vtable);
 
     auto name_it = (*name_lookup).find(name);
     if (name_it != (*name_lookup).end()) {

library/Process.cpp

@@ -236,6 +236,9 @@ Process::~Process()
 
 string Process::doReadClassName (void * vptr)
 {
+    if (!checkValidAddress(vptr))
+        throw std::runtime_error(fmt::format("invalid vtable ptr {}", vptr));
+
     char* rtti = Process::readPtr(((char*)vptr - sizeof(void*)));
 #ifndef WIN32
     char* typestring = Process::readPtr(rtti + sizeof(void*));
@@ -591,6 +594,20 @@ void Process::getMemRanges(vector<t_memrange>& ranges)
 }
 #endif
 
+bool Process::checkValidAddress(void* ptr)
+{
+    uintptr_t addr = reinterpret_cast<uintptr_t>(ptr);
+    auto validate = [&] (t_memrange& r) {
+        uintptr_t lo = reinterpret_cast<uintptr_t>(r.start);
+        uintptr_t hi = reinterpret_cast<uintptr_t>(r.end);
+        return addr >= lo && addr < hi;
+        };
+    std::vector<t_memrange> mr;
+    getMemRanges(mr);
+    bool valid = std::any_of(mr.begin(), mr.end(), validate);
+    return valid;
+}
+
 uintptr_t Process::getBase()
 {
 #if WIN32

library/include/MemAccess.h

@@ -221,7 +221,7 @@ namespace DFHack
 
         std::string readClassName(void* vptr)
         {
-            std::map<void*, std::string>::iterator it = classNameCache.find(vptr);
+            auto it = classNameCache.find(vptr);
             if (it != classNameCache.end())
                 return it->second;
             return classNameCache[vptr] = doReadClassName(vptr);
@@ -247,6 +247,9 @@ namespace DFHack
         /// get virtual memory ranges of the process (what is mapped where)
         static void getMemRanges(std::vector<t_memrange>& ranges);
 
+        /// check if an address has a mapping
+        bool checkValidAddress(void* ptr);
+
         /// get the symbol table extension of this process
         std::shared_ptr<DFHack::VersionInfo> getDescriptor()
         {

library/include/modules/Burrows.h

@@ -45,6 +45,8 @@ namespace DFHack
 {
 namespace Burrows
 {
+    DFHACK_EXPORT std::string getName(df::burrow* burrow);
+
     DFHACK_EXPORT df::burrow *findByName(std::string name, bool ignore_final_plus = false);
 
     // Units

library/modules/Burrows.cpp

@@ -52,6 +52,13 @@ using namespace df::enums;
 using df::global::world;
 using df::global::plotinfo;
 
+std::string Burrows::getName(df::burrow* burrow)
+{
+    CHECK_NULL_POINTER(burrow);
+    return burrow->name.empty() ? fmt::format("Burrow {}", burrow->id + 1) : burrow->name;
+}
+
+
 df::burrow *Burrows::findByName(std::string name, bool ignore_final_plus)
 {
     auto &vec = df::burrow::get_vector();