From 7f841ff081c7f8d0d8d45c0819f554e589b98ab9 Mon Sep 17 00:00:00 2001
From: Nathaniel Filardo <nfilardo@microsoft.com>
Date: Thu, 1 Apr 2021 00:07:21 +0100
Subject: [PATCH] NFC: Introduce and switch to pal_zero

This wrapper will allow us to pass `AuthPtr<T,B> p` to zero() without needing to
write `p.unsafe_auth_ptr` to get to a `T*` inside.  Moreover, it will give us a
convenient point to assert that `B` is such that the pointer can be used to
manipulate the memory map (i.e. is not exported).
---
 src/mem/alloc.h      |  5 +++--
 src/mem/largealloc.h |  4 ++--
 src/mem/mediumslab.h |  2 +-
 src/mem/metaslab.h   |  4 ++--
 src/pal/pal.h        | 10 ++++++++++
 5 files changed, 18 insertions(+), 7 deletions(-)

diff --git a/src/mem/alloc.h b/src/mem/alloc.h
index 73a5844..91d1de1 100644
--- a/src/mem/alloc.h
+++ b/src/mem/alloc.h
@@ -1026,7 +1026,8 @@ namespace snmalloc
         void* p = remove_cache_friendly_offset(fl.take(entropy), sizeclass);
         if constexpr (zero_mem == YesZero)
         {
-          MemoryProvider::Pal::zero(p, sizeclass_to_size(sizeclass));
+          pal_zero<typename MemoryProvider::Pal>(
+            p, sizeclass_to_size(sizeclass));
         }
         return p;
       }
@@ -1138,7 +1139,7 @@ namespace snmalloc
 
       if constexpr (zero_mem == YesZero)
       {
-        MemoryProvider::Pal::zero(p, sizeclass_to_size(sizeclass));
+        pal_zero<typename MemoryProvider::Pal>(p, sizeclass_to_size(sizeclass));
       }
       return p;
     }
diff --git a/src/mem/largealloc.h b/src/mem/largealloc.h
index ace16d0..e381db3 100644
--- a/src/mem/largealloc.h
+++ b/src/mem/largealloc.h
@@ -319,7 +319,7 @@ namespace snmalloc
           // The first page is already in "use" for the stack element,
           // this will need zeroing for a YesZero call.
           if constexpr (zero_mem == YesZero)
-            MemoryProvider::Pal::template zero<true>(p, OS_PAGE_SIZE);
+            pal_zero<typename MemoryProvider::Pal, true>(p, OS_PAGE_SIZE);
 
           // Notify we are using the rest of the allocation.
           // Passing zero_mem ensures the PAL provides zeroed pages if
@@ -331,7 +331,7 @@ namespace snmalloc
         {
           // This is a superslab that has not been decommitted.
           if constexpr (zero_mem == YesZero)
-            MemoryProvider::Pal::template zero<true>(
+            pal_zero<typename MemoryProvider::Pal, true>(
               p, bits::align_up(size, OS_PAGE_SIZE));
           else
             UNUSED(size);
diff --git a/src/mem/mediumslab.h b/src/mem/mediumslab.h
index dc39da4..585a67a 100644
--- a/src/mem/mediumslab.h
+++ b/src/mem/mediumslab.h
@@ -94,7 +94,7 @@ namespace snmalloc
       self->free--;
 
       if constexpr (zero_mem == YesZero)
-        PAL::zero(p, size);
+        pal_zero<PAL>(p, size);
       else
         UNUSED(size);
 
diff --git a/src/mem/metaslab.h b/src/mem/metaslab.h
index e358fc2..bd90c53 100644
--- a/src/mem/metaslab.h
+++ b/src/mem/metaslab.h
@@ -181,9 +181,9 @@ namespace snmalloc
       if constexpr (zero_mem == YesZero)
       {
         if (rsize < PAGE_ALIGNED_SIZE)
-          PAL::zero(p, rsize);
+          pal_zero<PAL>(p, rsize);
         else
-          PAL::template zero<true>(p, rsize);
+          pal_zero<PAL, true>(p, rsize);
       }
       else
       {
diff --git a/src/pal/pal.h b/src/pal/pal.h
index 2f58c7c..c11efec 100644
--- a/src/pal/pal.h
+++ b/src/pal/pal.h
@@ -69,6 +69,16 @@ namespace snmalloc
   // Used to keep Superslab metadata committed.
   static constexpr size_t OS_PAGE_SIZE = Pal::page_size;
 
+  /**
+   * A centralized, inlinable wrapper around PAL::zero.  This will matter more
+   * when we introduce AuthPtr-s.
+   */
+  template<typename PAL, bool page_aligned = false>
+  static SNMALLOC_FAST_PATH void pal_zero(void* p, size_t sz)
+  {
+    PAL::template zero<page_aligned>(p, sz);
+  }
+
   static_assert(
     bits::is_pow2(OS_PAGE_SIZE), "OS_PAGE_SIZE must be a power of two");
   static_assert(