From fb04f88147415184d47af11f8340cc64fe3c8223 Mon Sep 17 00:00:00 2001
From: Eric Soroos <eric-github@soroos.net>
Date: Mon, 2 Oct 2017 11:50:17 +0000
Subject: [PATCH] Block Allocator docs

---
 docs/reference/block_allocator.rst | 47 ++++++++++++++++++++++++++++++
 docs/reference/internal_design.rst |  2 ++
 2 files changed, 49 insertions(+)
 create mode 100644 docs/reference/block_allocator.rst

diff --git a/docs/reference/block_allocator.rst b/docs/reference/block_allocator.rst
new file mode 100644
index 000000000..26be98dc7
--- /dev/null
+++ b/docs/reference/block_allocator.rst
@@ -0,0 +1,47 @@
+Block Allocator
+===============
+
+Previous Design
+---------------
+
+Historically there have been two image allocators in Pillow:
+``ImagingAllocateBlock`` and ``ImagingAllocateArray``. The first works
+for images smaller than 16MB of data and allocates one large chank of
+memory of ``im->linesize * im->ysize`` bytes. The second works for
+large images and make one allocation for each scan line of size
+``im->linesize`` bytes.  This makes for a very sharp transition
+between one allocation and potentially thousands of small allocations,
+leading to unpredictable performance penalties around the transition.
+
+New Design
+----------
+
+``ImagingAllocateArray`` now allocates space for images as a chain of
+blocks with a maximum size of 16MB. If there is a memory allocation
+error, it falls back to allocating a 4KB block, or at least one scan
+line. This is now the default for all internal allocations.
+
+``ImagingAllocateBlock`` is now only used for those cases when we are
+specifically requesting a single segment of memory for sharing with
+other code.
+
+Memory Pools
+------------
+
+There is now a memory pool to contain a supply of recently freed
+blocks, which can then be reused without going back to the OS for a
+fresh allocation. This caching of free blocks is currently disabled by
+default, but can be enabled and tweaked using three environment
+variables:
+
+  * ``PILLOW_ALIGNMENT``, in bytes. Specfies the alignment of memory
+    allocations. Valid values are powers of 2 between 1 and
+    128, inclusive. Defaults to 1.
+
+  * ``PILLOW_BLOCK_SIZE``, in bytes, K, or M.  Specifies the maximum
+    block size for ``ImagingAllocateArray``. Valid values are
+    integers, with an optional `k` or `m` suffix. Defaults to 16M.  
+
+  * ``PILLOW_BLOCKS_MAX`` Specifies the number of freed blocks to
+    retain to fill future memory requests. Any freed blocks over this
+    threshold will be returned to the OS immediately. Defaults to 0. 
diff --git a/docs/reference/internal_design.rst b/docs/reference/internal_design.rst
index a8d6e2284..4c0fbb85d 100644
--- a/docs/reference/internal_design.rst
+++ b/docs/reference/internal_design.rst
@@ -6,3 +6,5 @@ Internal Reference Docs
           
   open_files
   limits
+  block_allocator
+