2014-01-09 02:47:57 +00:00
package execdriver
import (
2014-01-14 00:18:46 +00:00
"errors"
2014-02-21 21:27:15 +00:00
"io"
"os"
2014-01-09 23:04:45 +00:00
"os/exec"
2014-01-09 02:47:57 +00:00
)
2014-01-14 00:18:46 +00:00
var (
2014-01-14 02:36:59 +00:00
ErrNotRunning = errors . New ( "Process could not be started" )
ErrWaitTimeoutReached = errors . New ( "Wait timeout reached" )
ErrDriverAlreadyRegistered = errors . New ( "A driver already registered this docker init function" )
ErrDriverNotFound = errors . New ( "The requested docker init has not been found" )
2014-01-14 00:18:46 +00:00
)
2014-01-15 21:57:07 +00:00
var dockerInitFcts map [ string ] InitFunc
2014-01-14 02:36:59 +00:00
type (
2014-01-21 00:05:07 +00:00
StartCallback func ( * Command )
2014-01-15 21:57:07 +00:00
InitFunc func ( i * InitArgs ) error
2014-01-14 02:36:59 +00:00
)
2014-01-15 21:57:07 +00:00
func RegisterInitFunc ( name string , fct InitFunc ) error {
2014-01-14 02:36:59 +00:00
if dockerInitFcts == nil {
2014-01-15 21:57:07 +00:00
dockerInitFcts = make ( map [ string ] InitFunc )
2014-01-14 02:36:59 +00:00
}
if _ , ok := dockerInitFcts [ name ] ; ok {
return ErrDriverAlreadyRegistered
}
dockerInitFcts [ name ] = fct
return nil
}
2014-01-15 21:57:07 +00:00
func GetInitFunc ( name string ) ( InitFunc , error ) {
2014-01-14 02:36:59 +00:00
fct , ok := dockerInitFcts [ name ]
if ! ok {
return nil , ErrDriverNotFound
}
return fct , nil
}
2014-01-15 21:57:07 +00:00
// Args provided to the init function for a driver
type InitArgs struct {
2014-01-14 02:36:59 +00:00
User string
Gateway string
Ip string
WorkDir string
Privileged bool
Env [ ] string
Args [ ] string
Mtu int
Driver string
2014-02-24 20:21:13 +00:00
Console string
Pipe int
2014-02-25 20:41:31 +00:00
Root string
2014-01-14 02:36:59 +00:00
}
2014-01-13 23:02:12 +00:00
2014-01-15 21:57:07 +00:00
// Driver specific information based on
// processes registered with the driver
2014-01-15 19:46:25 +00:00
type Info interface {
IsRunning ( ) bool
}
2014-02-21 21:27:15 +00:00
// Terminal in an interface for drivers to implement
// if they want to support Close and Resize calls from
// the core
type Terminal interface {
io . Closer
Resize ( height , width int ) error
}
type TtyTerminal interface {
Master ( ) * os . File
}
2014-01-09 23:04:45 +00:00
type Driver interface {
2014-02-21 20:32:14 +00:00
Run ( c * Command , pipes * Pipes , startCallback StartCallback ) ( int , error ) // Run executes the process and blocks until the process exits and returns the exit code
2014-01-21 00:05:07 +00:00
Kill ( c * Command , sig int ) error
2014-01-28 15:17:51 +00:00
Name ( ) string // Driver name
Info ( id string ) Info // "temporary" hack (until we move state from core to plugins)
GetPidsForContainer ( id string ) ( [ ] int , error ) // Returns a list of pids for the given container.
2014-01-09 23:04:45 +00:00
}
2014-01-09 02:47:57 +00:00
// Network settings of the container
type Network struct {
2014-01-14 00:18:46 +00:00
Gateway string ` json:"gateway" `
IPAddress string ` json:"ip" `
2014-01-16 01:26:04 +00:00
Bridge string ` json:"bridge" `
2014-01-14 00:18:46 +00:00
IPPrefixLen int ` json:"ip_prefix_len" `
Mtu int ` json:"mtu" `
2014-01-09 02:47:57 +00:00
}
2014-01-20 21:23:02 +00:00
type Resources struct {
Memory int64 ` json:"memory" `
MemorySwap int64 ` json:"memory_swap" `
CpuShares int64 ` json:"cpu_shares" `
}
2014-01-10 22:26:29 +00:00
// Process wrapps an os/exec.Cmd to add more metadata
2014-01-21 00:05:07 +00:00
type Command struct {
exec . Cmd ` json:"-" `
2014-01-10 19:44:35 +00:00
2014-01-20 21:23:02 +00:00
ID string ` json:"id" `
Privileged bool ` json:"privileged" `
User string ` json:"user" `
Rootfs string ` json:"rootfs" ` // root fs of the container
InitPath string ` json:"initpath" ` // dockerinit
Entrypoint string ` json:"entrypoint" `
Arguments [ ] string ` json:"arguments" `
WorkingDir string ` json:"working_dir" `
ConfigPath string ` json:"config_path" ` // this should be able to be removed when the lxc template is moved into the driver
Tty bool ` json:"tty" `
Network * Network ` json:"network" ` // if network is nil then networking is disabled
Config [ ] string ` json:"config" ` // generic values that specific drivers can consume
Resources * Resources ` json:"resources" `
2014-02-14 01:23:09 +00:00
2014-03-06 01:57:27 +00:00
Terminal Terminal ` json:"-" ` // standard or tty terminal
Console string ` json:"-" ` // dev/console path
ContainerPid int ` json:"container_pid" ` // the pid for the process inside a container
2014-01-09 23:04:45 +00:00
}
2014-01-14 00:18:46 +00:00
// Return the pid of the process
// If the process is nil -1 will be returned
2014-01-21 00:05:07 +00:00
func ( c * Command ) Pid ( ) int {
2014-03-06 01:57:27 +00:00
return c . ContainerPid
2014-01-09 23:04:45 +00:00
}