From fc297702511edef4760c4f7a1d89cc6f02347d50 Mon Sep 17 00:00:00 2001
From: Rahat Mahmood <rahat@google.com>
Date: Mon, 10 Dec 2018 12:47:20 -0800
Subject: Add type safety to shm ids and keys.

PiperOrigin-RevId: 224864380
Change-Id: I49542279ad56bf15ba462d3de1ef2b157b31830a
---
 pkg/sentry/kernel/shm/shm.go | 24 +++++++++++++++---------
 1 file changed, 15 insertions(+), 9 deletions(-)

(limited to 'pkg/sentry/kernel')

diff --git a/pkg/sentry/kernel/shm/shm.go b/pkg/sentry/kernel/shm/shm.go
index f760f5f76..4343dee13 100644
--- a/pkg/sentry/kernel/shm/shm.go
+++ b/pkg/sentry/kernel/shm/shm.go
@@ -51,6 +51,12 @@ import (
 	"gvisor.googlesource.com/gvisor/pkg/syserror"
 )
 
+// Key represents a shm segment key. Analogous to a file name.
+type Key int32
+
+// ID represents the opaque handle for a shm segment. Analogous to an fd.
+type ID int32
+
 // Registry tracks all shared memory segments in an IPC namespace. The registry
 // provides the mechanisms for creating and finding segments, and reporting
 // global shm parameters.
@@ -63,33 +69,33 @@ type Registry struct {
 	mu sync.Mutex `state:"nosave"`
 
 	// shms maps segment ids to segments. Protected by mu.
-	shms map[int32]*Shm
+	shms map[ID]*Shm
 
 	// Sum of the sizes of all existing segments rounded up to page size, in
 	// units of page size. Protected by mu.
 	totalPages uint64
 
 	// lastIDUsed is protected by mu.
-	lastIDUsed int32
+	lastIDUsed ID
 }
 
 // NewRegistry creates a new shm registry.
 func NewRegistry(userNS *auth.UserNamespace) *Registry {
 	return &Registry{
 		userNS: userNS,
-		shms:   make(map[int32]*Shm),
+		shms:   make(map[ID]*Shm),
 	}
 }
 
 // FindByID looks up a segment given an ID.
-func (r *Registry) FindByID(id int32) *Shm {
+func (r *Registry) FindByID(id ID) *Shm {
 	r.mu.Lock()
 	defer r.mu.Unlock()
 	return r.shms[id]
 }
 
 // Precondition: Caller must hold r.mu.
-func (r *Registry) findByKey(key int32) *Shm {
+func (r *Registry) findByKey(key Key) *Shm {
 	for _, v := range r.shms {
 		if v.key == key {
 			return v
@@ -100,7 +106,7 @@ func (r *Registry) findByKey(key int32) *Shm {
 
 // FindOrCreate looks up or creates a segment in the registry. It's functionally
 // analogous to open(2).
-func (r *Registry) FindOrCreate(ctx context.Context, pid, key int32, size uint64, mode linux.FileMode, private, create, exclusive bool) (*Shm, error) {
+func (r *Registry) FindOrCreate(ctx context.Context, pid int32, key Key, size uint64, mode linux.FileMode, private, create, exclusive bool) (*Shm, error) {
 	if (create || private) && (size < linux.SHMMIN || size > linux.SHMMAX) {
 		// "A new segment was to be created and size is less than SHMMIN or
 		// greater than SHMMAX." - man shmget(2)
@@ -178,7 +184,7 @@ func (r *Registry) FindOrCreate(ctx context.Context, pid, key int32, size uint64
 }
 
 // newShm creates a new segment in the registry.
-func (r *Registry) newShm(ctx context.Context, pid, key int32, creator fs.FileOwner, perms fs.FilePermissions, size uint64) (*Shm, error) {
+func (r *Registry) newShm(ctx context.Context, pid int32, key Key, creator fs.FileOwner, perms fs.FilePermissions, size uint64) (*Shm, error) {
 	p := platform.FromContext(ctx)
 	if p == nil {
 		panic(fmt.Sprintf("context.Context %T lacks non-nil value for key %T", ctx, platform.CtxPlatform))
@@ -289,7 +295,7 @@ type Shm struct {
 	registry *Registry
 
 	// ID is the kernel identifier for this segment. Immutable.
-	ID int32
+	ID ID
 
 	// creator is the user that created the segment. Immutable.
 	creator fs.FileOwner
@@ -309,7 +315,7 @@ type Shm struct {
 	fr platform.FileRange
 
 	// key is the public identifier for this segment.
-	key int32
+	key Key
 
 	// mu protects all fields below.
 	mu sync.Mutex `state:"nosave"`
-- 
cgit v1.2.3