Move the 'marshal' and 'primitive' packages to the 'pkg' directory.

PiperOrigin-RevId: 331256608

3 files changed, 0 insertions, 278 deletions

diff --git a/tools/go_marshal/marshal/BUILD b/tools/go_marshal/marshal/BUILD
deleted file mode 100644
index 4aec98218..000000000
--- a/tools/go_marshal/marshal/BUILD
+++ /dev/null
@@ -1,17 +0,0 @@
-load("//tools:defs.bzl", "go_library")
-
-licenses(["notice"])
-
-go_library(
-    name = "marshal",
-    srcs = [
-        "marshal.go",
-        "marshal_impl_util.go",
-    ],
-    visibility = [
-        "//:sandbox",
-    ],
-    deps = [
-        "//pkg/usermem",
-    ],
-)
diff --git a/tools/go_marshal/marshal/marshal.go b/tools/go_marshal/marshal/marshal.go
deleted file mode 100644
index 85b196f08..000000000
--- a/tools/go_marshal/marshal/marshal.go
+++ /dev/null
@@ -1,183 +0,0 @@
-// Copyright 2019 The gVisor Authors.
-//
-// Licensed under the Apache License, Version 2.0 (the "License");
-// you may not use this file except in compliance with the License.
-// You may obtain a copy of the License at
-//
-//     http://www.apache.org/licenses/LICENSE-2.0
-//
-// Unless required by applicable law or agreed to in writing, software
-// distributed under the License is distributed on an "AS IS" BASIS,
-// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-// See the License for the specific language governing permissions and
-// limitations under the License.
-
-// Package marshal defines the Marshallable interface for
-// serialize/deserializing go data structures to/from memory, according to the
-// Linux ABI.
-//
-// Implementations of this interface are typically automatically generated by
-// tools/go_marshal. See the go_marshal README for details.
-package marshal
-
-import (
-	"io"
-
-	"gvisor.dev/gvisor/pkg/usermem"
-)
-
-// Task provides a subset of kernel.Task, used in marshalling. We don't import
-// the kernel package directly to avoid circular dependency.
-type Task interface {
-	// CopyScratchBuffer provides a task goroutine-local scratch buffer. See
-	// kernel.CopyScratchBuffer.
-	CopyScratchBuffer(size int) []byte
-
-	// CopyOutBytes writes the contents of b to the task's memory. See
-	// kernel.CopyOutBytes.
-	CopyOutBytes(addr usermem.Addr, b []byte) (int, error)
-
-	// CopyInBytes reads the contents of the task's memory to b. See
-	// kernel.CopyInBytes.
-	CopyInBytes(addr usermem.Addr, b []byte) (int, error)
-}
-
-// Marshallable represents operations on a type that can be marshalled to and
-// from memory.
-//
-// go-marshal automatically generates implementations for this interface for
-// types marked as '+marshal'.
-type Marshallable interface {
-	io.WriterTo
-
-	// SizeBytes is the size of the memory representation of a type in
-	// marshalled form.
-	//
-	// SizeBytes must handle a nil receiver. Practically, this means SizeBytes
-	// cannot deference any fields on the object implementing it (but will
-	// likely make use of the type of these fields).
-	SizeBytes() int
-
-	// MarshalBytes serializes a copy of a type to dst.
-	// Precondition: dst must be at least SizeBytes() in length.
-	MarshalBytes(dst []byte)
-
-	// UnmarshalBytes deserializes a type from src.
-	// Precondition: src must be at least SizeBytes() in length.
-	UnmarshalBytes(src []byte)
-
-	// Packed returns true if the marshalled size of the type is the same as the
-	// size it occupies in memory. This happens when the type has no fields
-	// starting at unaligned addresses (should always be true by default for ABI
-	// structs, verified by automatically generated tests when using
-	// go_marshal), and has no fields marked `marshal:"unaligned"`.
-	//
-	// Packed must return the same result for all possible values of the type
-	// implementing it. Violating this constraint implies the type doesn't have
-	// a static memory layout, and will lead to memory corruption.
-	// Go-marshal-generated code reuses the result of Packed for multiple values
-	// of the same type.
-	Packed() bool
-
-	// MarshalUnsafe serializes a type by bulk copying its in-memory
-	// representation to the dst buffer. This is only safe to do when the type
-	// has no implicit padding, see Marshallable.Packed. When Packed would
-	// return false, MarshalUnsafe should fall back to the safer but slower
-	// MarshalBytes.
-	// Precondition: dst must be at least SizeBytes() in length.
-	MarshalUnsafe(dst []byte)
-
-	// UnmarshalUnsafe deserializes a type by directly copying to the underlying
-	// memory allocated for the object by the runtime.
-	//
-	// This allows much faster unmarshalling of types which have no implicit
-	// padding, see Marshallable.Packed. When Packed would return false,
-	// UnmarshalUnsafe should fall back to the safer but slower unmarshal
-	// mechanism implemented in UnmarshalBytes.
-	// Precondition: src must be at least SizeBytes() in length.
-	UnmarshalUnsafe(src []byte)
-
-	// CopyIn deserializes a Marshallable type from a task's memory. This may
-	// only be called from a task goroutine. This is more efficient than calling
-	// UnmarshalUnsafe on Marshallable.Packed types, as the type being
-	// marshalled does not escape. The implementation should avoid creating
-	// extra copies in memory by directly deserializing to the object's
-	// underlying memory.
-	//
-	// If the copy-in from the task memory is only partially successful, CopyIn
-	// should still attempt to deserialize as much data as possible. See comment
-	// for UnmarshalBytes.
-	CopyIn(task Task, addr usermem.Addr) (int, error)
-
-	// CopyOut serializes a Marshallable type to a task's memory. This may only
-	// be called from a task goroutine. This is more efficient than calling
-	// MarshalUnsafe on Marshallable.Packed types, as the type being serialized
-	// does not escape. The implementation should avoid creating extra copies in
-	// memory by directly serializing from the object's underlying memory.
-	//
-	// The copy-out to the task memory may be partially successful, in which
-	// case CopyOut returns how much data was serialized. See comment for
-	// MarshalBytes for implications.
-	CopyOut(task Task, addr usermem.Addr) (int, error)
-
-	// CopyOutN is like CopyOut, but explicitly requests a partial
-	// copy-out. Note that this may yield unexpected results for non-packed
-	// types and the caller may only want to allow this for packed types. See
-	// comment on MarshalBytes.
-	//
-	// The limit must be less than or equal to SizeBytes().
-	CopyOutN(task Task, addr usermem.Addr, limit int) (int, error)
-}
-
-// go-marshal generates additional functions for a type based on additional
-// clauses to the +marshal directive. They are documented below.
-//
-// Slice API
-// =========
-//
-// Adding a "slice" clause to the +marshal directive for structs or newtypes on
-// primitives like this:
-//
-// // +marshal slice:FooSlice
-// type Foo struct { ... }
-//
-// Generates four additional functions for marshalling slices of Foos like this:
-//
-// // MarshalUnsafeFooSlice is like Foo.MarshalUnsafe, buf for a []Foo. It
-// // might be more efficient that repeatedly calling Foo.MarshalUnsafe
-// // over a []Foo in a loop if the type is Packed.
-// // Preconditions: dst must be at least len(src)*Foo.SizeBytes() in length.
-// func MarshalUnsafeFooSlice(src []Foo, dst []byte) (int, error) { ... }
-//
-// // UnmarshalUnsafeFooSlice is like Foo.UnmarshalUnsafe, buf for a []Foo. It
-// // might be more efficient that repeatedly calling Foo.UnmarshalUnsafe
-// // over a []Foo in a loop if the type is Packed.
-// // Preconditions: src must be at least len(dst)*Foo.SizeBytes() in length.
-// func UnmarshalUnsafeFooSlice(dst []Foo, src []byte) (int, error) { ... }
-//
-// // CopyFooSliceIn copies in a slice of Foo objects from the task's memory.
-// func CopyFooSliceIn(task marshal.Task, addr usermem.Addr, dst []Foo) (int, error) { ... }
-//
-// // CopyFooSliceIn copies out a slice of Foo objects to the task's memory.
-// func CopyFooSliceOut(task marshal.Task, addr usermem.Addr, src []Foo) (int, error) { ... }
-//
-// The name of the functions are of the format "Copy%sIn" and "Copy%sOut", where
-// %s is the first argument to the slice clause. This directive is not supported
-// for newtypes on arrays.
-//
-// The slice clause also takes an optional second argument, which must be the
-// value "inner":
-//
-// // +marshal slice:Int32Slice:inner
-// type Int32 int32
-//
-// This is only valid on newtypes on primitives, and causes the generated
-// functions to accept slices of the inner type instead:
-//
-// func CopyInt32SliceIn(task marshal.Task, addr usermem.Addr, dst []int32) (int, error) { ... }
-//
-// Without "inner", they would instead be:
-//
-// func CopyInt32SliceIn(task marshal.Task, addr usermem.Addr, dst []Int32) (int, error) { ... }
-//
-// This may help avoid a cast depending on how the generated functions are used.
diff --git a/tools/go_marshal/marshal/marshal_impl_util.go b/tools/go_marshal/marshal/marshal_impl_util.go
deleted file mode 100644
index 89c7d3575..000000000
--- a/tools/go_marshal/marshal/marshal_impl_util.go
+++ /dev/null
@@ -1,78 +0,0 @@
-// Copyright 2020 The gVisor Authors.
-//
-// Licensed under the Apache License, Version 2.0 (the "License");
-// you may not use this file except in compliance with the License.
-// You may obtain a copy of the License at
-//
-//     http://www.apache.org/licenses/LICENSE-2.0
-//
-// Unless required by applicable law or agreed to in writing, software
-// distributed under the License is distributed on an "AS IS" BASIS,
-// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-// See the License for the specific language governing permissions and
-// limitations under the License.
-
-package marshal
-
-import (
-	"io"
-
-	"gvisor.dev/gvisor/pkg/usermem"
-)
-
-// StubMarshallable implements the Marshallable interface.
-// StubMarshallable is a convenient embeddable type for satisfying the
-// marshallable interface, but provides no actual implementation. It is
-// useful when the marshallable interface needs to be implemented manually,
-// but the caller doesn't require the full marshallable interface.
-type StubMarshallable struct{}
-
-// WriteTo implements Marshallable.WriteTo.
-func (StubMarshallable) WriteTo(w io.Writer) (n int64, err error) {
-	panic("Please implement your own WriteTo function")
-}
-
-// SizeBytes implements Marshallable.SizeBytes.
-func (StubMarshallable) SizeBytes() int {
-	panic("Please implement your own SizeBytes function")
-}
-
-// MarshalBytes implements Marshallable.MarshalBytes.
-func (StubMarshallable) MarshalBytes(dst []byte) {
-	panic("Please implement your own MarshalBytes function")
-}
-
-// UnmarshalBytes implements Marshallable.UnmarshalBytes.
-func (StubMarshallable) UnmarshalBytes(src []byte) {
-	panic("Please implement your own UnMarshalBytes function")
-}
-
-// Packed implements Marshallable.Packed.
-func (StubMarshallable) Packed() bool {
-	panic("Please implement your own Packed function")
-}
-
-// MarshalUnsafe implements Marshallable.MarshalUnsafe.
-func (StubMarshallable) MarshalUnsafe(dst []byte) {
-	panic("Please implement your own MarshalUnsafe function")
-}
-
-// UnmarshalUnsafe implements Marshallable.UnmarshalUnsafe.
-func (StubMarshallable) UnmarshalUnsafe(src []byte) {
-	panic("Please implement your own UnmarshalUnsafe function")
-}
-
-// CopyIn implements Marshallable.CopyIn.
-func (StubMarshallable) CopyIn(task Task, addr usermem.Addr) (int, error) {
-	panic("Please implement your own CopyIn function")
-}
-
-// CopyOut implements Marshallable.CopyOut.
-func (StubMarshallable) CopyOut(task Task, addr usermem.Addr) (int, error) {
-	panic("Please implement your own CopyOut function")
-}
-
-// CopyOutN implements Marshallable.CopyOutN.
-func (StubMarshallable) CopyOutN(task Task, addr usermem.Addr, limit int) (int, error) {
-	panic("Please implement your own CopyOutN function")
-}