From 33b76920ec3bde98e58e0a6cb0816eb7be28bb4e Mon Sep 17 00:00:00 2001
From: Austin Clements <austin@google.com>
Date: Thu, 22 Feb 2018 12:35:30 -0500
Subject: [PATCH] runtime: rename "arena index" to "arena map"

There are too many places where I want to talk about "indexing into
the arena index". Make this less awkward and ambiguous by calling it
the "arena map" instead.

Change-Id: I726b0667bb2139dbc006175a0ec09a871cdf73f9
Reviewed-on: https://go-review.googlesource.com/96777
Run-TryBot: Austin Clements <austin@google.com>
Reviewed-by: Rick Hudson <rlh@golang.org>
---
 src/runtime/malloc.go  | 14 +++++++-------
 src/runtime/mbitmap.go |  2 +-
 src/runtime/mheap.go   |  4 ++--
 3 files changed, 10 insertions(+), 10 deletions(-)

diff --git a/src/runtime/malloc.go b/src/runtime/malloc.go
index 6c36e1eea3..6f78455c8b 100644
--- a/src/runtime/malloc.go
+++ b/src/runtime/malloc.go
@@ -90,12 +90,12 @@
 // themselves allocated off-heap.
 //
 // Since arenas are aligned, the address space can be viewed as a
-// series of arena frames. The arena index (mheap_.arenas) maps from
+// series of arena frames. The arena map (mheap_.arenas) maps from
 // arena frame number to *heapArena, or nil for parts of the address
 // space not backed by the Go heap. Since arenas are large, the arena
 // index is just a single-level mapping.
 //
-// The arena index covers the entire possible address space, allowing
+// The arena map covers the entire possible address space, allowing
 // the Go heap to use any part of the address space. The allocator
 // attempts to keep arenas contiguous so that large spans (and hence
 // large objects) can cross arenas.
@@ -203,10 +203,10 @@ const (
 	// mips32 only has access to the low 2GB of virtual memory, so
 	// we further limit it to 31 bits.
 	//
-	// The size of the arena index is proportional to
+	// The size of the arena map is proportional to
 	// 1<<heapAddrBits, so it's important that this not be too
 	// large. 48 bits is about the threshold; above that we would
-	// need to go to a two level arena index.
+	// need to go to a two level arena map.
 	heapAddrBits = _64bit*48 + (1-_64bit)*(32-(sys.GoarchMips+sys.GoarchMipsle))
 
 	// maxAlloc is the maximum size of an allocation. On 64-bit,
@@ -227,7 +227,7 @@ const (
 	pagesPerArena = heapArenaBytes / pageSize
 
 	// arenaBaseOffset is the pointer value that corresponds to
-	// index 0 in the heap arena index.
+	// index 0 in the heap arena map.
 	//
 	// On amd64, the address space is 48 bits, sign extended to 64
 	// bits. This offset lets us handle "negative" addresses (or
@@ -323,10 +323,10 @@ func mallocinit() {
 		throw("bad system page size")
 	}
 
-	// Map the arena index. Most of this will never be written to,
+	// Map the arena map. Most of this will never be written to,
 	mheap_.arenas = (*[(1 << heapAddrBits) / heapArenaBytes]*heapArena)(persistentalloc(unsafe.Sizeof(*mheap_.arenas), sys.PtrSize, nil))
 	if mheap_.arenas == nil {
-		throw("failed to allocate arena index")
+		throw("failed to allocate arena map")
 	}
 
 	// Initialize the heap.
diff --git a/src/runtime/mbitmap.go b/src/runtime/mbitmap.go
index 1b17740f49..85d79c685b 100644
--- a/src/runtime/mbitmap.go
+++ b/src/runtime/mbitmap.go
@@ -146,7 +146,7 @@ type heapBits struct {
 }
 
 // Make the compiler check that heapBits.arena is large enough to hold
-// the maximum arena index.
+// the maximum arena frame number.
 var _ = heapBits{arena: (1<<heapAddrBits)/heapArenaBytes - 1}
 
 // markBits provides access to the mark bit for an object in the heap.
diff --git a/src/runtime/mheap.go b/src/runtime/mheap.go
index b529f086f4..3460c54d72 100644
--- a/src/runtime/mheap.go
+++ b/src/runtime/mheap.go
@@ -96,14 +96,14 @@ type mheap struct {
 	nlargefree  uint64                  // number of frees for large objects (>maxsmallsize)
 	nsmallfree  [_NumSizeClasses]uint64 // number of frees for small objects (<=maxsmallsize)
 
-	// arenas is the heap arena index.
+	// arenas is the heap arena map.
 	// arenas[(va+arenaBaseOffset)/heapArenaBytes] points to the
 	// metadata for the heap arena containing va.
 	//
 	// Use arenaIndex to compute indexes into this array.
 	//
 	// For regions of the address space that are not backed by the
-	// Go heap, the arena index contains nil.
+	// Go heap, the arena map contains nil.
 	//
 	// Modifications are protected by mheap_.lock. Reads can be
 	// performed without locking; however, a given entry can