vendor: Move virtcontainers to project's root directory

Lets have a global vendor base on virtcontainers.

Signed-off-by: Julio Montes <julio.montes@intel.com>
Signed-off-by: James O. D. Hunt <james.o.hunt@intel.com>
Signed-off-by: Jose Carlos Venegas Munoz <jose.carlos.venegas.munoz@intel.com>
This commit is contained in:
Jose Carlos Venegas Munoz
2018-03-13 10:33:11 -06:00
parent 167d54a5ce
commit dad59fe092
719 changed files with 0 additions and 0 deletions

View File

@@ -0,0 +1,410 @@
// Copyright (c) 2016 Intel Corporation
//
// 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 client
import (
"encoding/json"
"errors"
"fmt"
"net"
"syscall"
"github.com/clearcontainers/proxy/api"
)
// The Client struct can be used to issue proxy API calls with a convenient
// high level API.
type Client struct {
conn net.Conn
}
// NewClient creates a new client object to communicate with the proxy using
// the connection conn. The user should call Close() once finished with the
// client object to close conn.
func NewClient(conn net.Conn) *Client {
return &Client{
conn: conn,
}
}
// Close a client, closing the underlying AF_UNIX socket.
func (client *Client) Close() {
client.conn.Close()
}
func (client *Client) sendCommandFull(cmd api.Command, payload interface{},
waitForResponse bool) (*api.Frame, error) {
var data []byte
var frame *api.Frame
var err error
if payload != nil {
if data, err = json.Marshal(payload); err != nil {
return nil, err
}
}
if err := api.WriteCommand(client.conn, cmd, data); err != nil {
return nil, err
}
if !waitForResponse {
return nil, nil
}
if frame, err = api.ReadFrame(client.conn); err != nil {
return nil, err
}
if cmd == api.CmdSignal {
payloadSignal, ok := payload.(*api.Signal)
if !ok {
return nil, err
}
if payloadSignal.SignalNumber == int(syscall.SIGKILL) ||
payloadSignal.SignalNumber == int(syscall.SIGTERM) {
if frame.Header.Type != api.TypeNotification {
return nil, fmt.Errorf("unexpected frame type %v", frame.Header.Type)
}
if frame, err = api.ReadFrame(client.conn); err != nil {
return nil, err
}
}
}
if frame.Header.Type != api.TypeResponse {
return nil, fmt.Errorf("unexpected frame type %v", frame.Header.Type)
}
if frame.Header.Opcode != int(cmd) {
return nil, fmt.Errorf("unexpected opcode %v", frame.Header.Opcode)
}
return frame, nil
}
func (client *Client) sendCommand(cmd api.Command, payload interface{}) (*api.Frame, error) {
return client.sendCommandFull(cmd, payload, true)
}
func (client *Client) sendCommandNoResponse(cmd api.Command, payload interface{}) error {
_, err := client.sendCommandFull(cmd, payload, false)
return err
}
func errorFromResponse(resp *api.Frame) error {
// We should always have an error with the response, but better safe
// than sorry.
if !resp.Header.InError {
return nil
}
decoded := api.ErrorResponse{}
if err := json.Unmarshal(resp.Payload, &decoded); err != nil {
return err
}
if decoded.Message == "" {
return errors.New("unknown error")
}
return errors.New(decoded.Message)
}
func unmarshalResponse(resp *api.Frame, decoded interface{}) error {
if len(resp.Payload) == 0 {
return nil
}
if err := json.Unmarshal(resp.Payload, decoded); err != nil {
return err
}
return nil
}
// RegisterVMOptions holds extra arguments one can pass to the RegisterVM
// function.
//
// See the api.RegisterVM payload for more details.
type RegisterVMOptions struct {
Console string
NumIOStreams int
}
// RegisterVMReturn contains the return values from RegisterVM.
//
// See the api.RegisterVM and api.RegisterVMResponse payloads.
type RegisterVMReturn api.RegisterVMResponse
// RegisterVM wraps the api.RegisterVM payload.
//
// See payload description for more details.
func (client *Client) RegisterVM(containerID, ctlSerial, ioSerial string,
options *RegisterVMOptions) (*RegisterVMReturn, error) {
payload := api.RegisterVM{
ContainerID: containerID,
CtlSerial: ctlSerial,
IoSerial: ioSerial,
}
if options != nil {
payload.Console = options.Console
payload.NumIOStreams = options.NumIOStreams
}
resp, err := client.sendCommand(api.CmdRegisterVM, &payload)
if err != nil {
return nil, err
}
if err := errorFromResponse(resp); err != nil {
return nil, err
}
decoded := RegisterVMReturn{}
err = unmarshalResponse(resp, &decoded)
return &decoded, err
}
// AttachVMOptions holds extra arguments one can pass to the AttachVM function.
//
// See the api.AttachVM payload for more details.
type AttachVMOptions struct {
NumIOStreams int
}
// AttachVMReturn contains the return values from AttachVM.
//
// See the api.AttachVM and api.AttachVMResponse payloads.
type AttachVMReturn api.AttachVMResponse
// AttachVM wraps the api.AttachVM payload.
//
// See the api.AttachVM payload description for more details.
func (client *Client) AttachVM(containerID string, options *AttachVMOptions) (*AttachVMReturn, error) {
payload := api.AttachVM{
ContainerID: containerID,
}
if options != nil {
payload.NumIOStreams = options.NumIOStreams
}
resp, err := client.sendCommand(api.CmdAttachVM, &payload)
if err != nil {
return nil, err
}
if err := errorFromResponse(resp); err != nil {
return nil, err
}
decoded := AttachVMReturn{}
err = unmarshalResponse(resp, &decoded)
return &decoded, err
}
// Hyper wraps the Hyper payload (see payload description for more details)
func (client *Client) Hyper(hyperName string, hyperMessage interface{}) ([]byte, error) {
return client.HyperWithTokens(hyperName, nil, hyperMessage)
}
// HyperWithTokens is a Hyper variant where the users can specify a list of I/O tokens.
//
// See the api.Hyper payload description for more details.
func (client *Client) HyperWithTokens(hyperName string, tokens []string, hyperMessage interface{}) ([]byte, error) {
var data []byte
if hyperMessage != nil {
var err error
data, err = json.Marshal(hyperMessage)
if err != nil {
return nil, err
}
}
hyper := api.Hyper{
HyperName: hyperName,
Data: data,
}
if tokens != nil {
hyper.Tokens = tokens
}
resp, err := client.sendCommand(api.CmdHyper, &hyper)
if err != nil {
return nil, err
}
if err = errorFromResponse(resp); err != nil {
return nil, err
}
return resp.Payload, errorFromResponse(resp)
}
// UnregisterVM wraps the api.UnregisterVM payload.
//
// See the api.UnregisterVM payload description for more details.
func (client *Client) UnregisterVM(containerID string) error {
payload := api.UnregisterVM{
ContainerID: containerID,
}
resp, err := client.sendCommand(api.CmdUnregisterVM, &payload)
if err != nil {
return err
}
return errorFromResponse(resp)
}
// ConnectShim wraps the api.CmdConnectShim command and associated
// api.ConnectShim payload.
func (client *Client) ConnectShim(token string) error {
payload := api.ConnectShim{
Token: token,
}
resp, err := client.sendCommand(api.CmdConnectShim, &payload)
if err != nil {
return err
}
return errorFromResponse(resp)
}
// DisconnectShim wraps the api.CmdDisconnectShim command and associated
// api.DisconnectShim payload.
func (client *Client) DisconnectShim() error {
return client.sendCommandNoResponse(api.CmdDisconnectShim, nil)
}
func (client *Client) signal(signal syscall.Signal, columns, rows int) error {
payload := api.Signal{
SignalNumber: int(signal),
Columns: columns,
Rows: rows,
}
resp, err := client.sendCommand(api.CmdSignal, &payload)
if err != nil {
return err
}
return errorFromResponse(resp)
}
// Kill wraps the api.CmdSignal command and can be used by a shim to send a
// signal to the associated process.
func (client *Client) Kill(signal syscall.Signal) error {
return client.signal(signal, 0, 0)
}
// SendTerminalSize wraps the api.CmdSignal command and can be used by a shim
// to send a new signal to the associated process.
func (client *Client) SendTerminalSize(columns, rows int) error {
return client.signal(syscall.SIGWINCH, columns, rows)
}
func (client *Client) sendStream(op api.Stream, data []byte) error {
return api.WriteStream(client.conn, op, data)
}
// SendStdin sends stdin data. This can only be used from shim clients.
func (client *Client) SendStdin(data []byte) error {
return client.sendStream(api.StreamStdin, data)
}
// LogLevel is the severity of log entries.
type LogLevel uint8
const (
// LogLevelDebug is for log messages only useful debugging.
LogLevelDebug LogLevel = iota
// LogLevelInfo is for reporting landmark events.
LogLevelInfo
// LogLevelWarn is for reporting warnings.
LogLevelWarn
// LogLevelError is for reporting errors.
LogLevelError
logLevelMax
)
var levelToString = []string{"debug", "info", "warn", "error"}
// String implements stringer for LogLevel.
func (l LogLevel) String() string {
if l < logLevelMax {
return levelToString[l]
}
return "unknown"
}
// LogSource is the source of log entries
type LogSource uint8
const (
// LogSourceRuntime represents a runtime.
LogSourceRuntime LogSource = iota
// LogSourceShim represents a shim.
LogSourceShim
logSourceMax
)
var sourceToString = []string{"runtime", "shim"}
// String implements stringer for LogSource
func (s LogSource) String() string {
if s < logSourceMax {
return sourceToString[s]
}
return "unknown"
}
// Log sends log entries.
func (client *Client) Log(level LogLevel, source LogSource, containerID string, args ...interface{}) {
payload := api.LogEntry{
Level: level.String(),
Source: source.String(),
ContainerID: containerID,
Message: fmt.Sprint(args...),
}
data, _ := json.Marshal(&payload)
_ = client.sendStream(api.StreamLog, data)
}
// Logf sends log entries.
func (client *Client) Logf(level LogLevel, source LogSource, containerID string, format string, args ...interface{}) {
payload := api.LogEntry{
Level: level.String(),
Source: source.String(),
ContainerID: containerID,
Message: fmt.Sprintf(format, args...),
}
data, _ := json.Marshal(&payload)
_ = client.sendStream(api.StreamLog, data)
}