sandbox.go 7.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199
  1. // Package osl describes structures and interfaces which abstract os entities
  2. package osl
  3. import (
  4. "net"
  5. "github.com/docker/docker/libnetwork/types"
  6. )
  7. // SandboxType specify the time of the sandbox, this can be used to apply special configs
  8. type SandboxType int
  9. const (
  10. // SandboxTypeIngress indicates that the sandbox is for the ingress
  11. SandboxTypeIngress = iota
  12. // SandboxTypeLoadBalancer indicates that the sandbox is a load balancer
  13. SandboxTypeLoadBalancer = iota
  14. )
  15. // IfaceOption is a function option type to set interface options.
  16. type IfaceOption func(i *nwIface)
  17. // NeighOption is a function option type to set neighbor options.
  18. type NeighOption func(nh *neigh)
  19. // Sandbox represents a network sandbox, identified by a specific key. It
  20. // holds a list of Interfaces, routes etc, and more can be added dynamically.
  21. type Sandbox interface {
  22. // Key returns the path where the network namespace is mounted.
  23. Key() string
  24. // AddInterface adds an existing Interface to this sandbox. The operation will rename
  25. // from the Interface SrcName to DstName as it moves, and reconfigure the
  26. // interface according to the specified settings. The caller is expected
  27. // to only provide a prefix for DstName. The AddInterface api will auto-generate
  28. // an appropriate suffix for the DstName to disambiguate.
  29. AddInterface(SrcName string, DstPrefix string, options ...IfaceOption) error
  30. // SetGateway sets the default IPv4 gateway for the sandbox.
  31. SetGateway(gw net.IP) error
  32. // SetGatewayIPv6 sets the default IPv6 gateway for the sandbox.
  33. SetGatewayIPv6(gw net.IP) error
  34. // UnsetGateway the previously set default IPv4 gateway in the sandbox.
  35. UnsetGateway() error
  36. // UnsetGatewayIPv6 unsets the previously set default IPv6 gateway in the sandbox.
  37. UnsetGatewayIPv6() error
  38. // GetLoopbackIfaceName returns the name of the loopback interface
  39. GetLoopbackIfaceName() string
  40. // AddAliasIP adds the passed IP address to the named interface
  41. AddAliasIP(ifName string, ip *net.IPNet) error
  42. // RemoveAliasIP removes the passed IP address from the named interface
  43. RemoveAliasIP(ifName string, ip *net.IPNet) error
  44. // DisableARPForVIP disables ARP replies and requests for VIP addresses
  45. // on a particular interface.
  46. DisableARPForVIP(ifName string) error
  47. // AddStaticRoute adds a static route to the sandbox.
  48. AddStaticRoute(*types.StaticRoute) error
  49. // RemoveStaticRoute removes a static route from the sandbox.
  50. RemoveStaticRoute(*types.StaticRoute) error
  51. // AddNeighbor adds a neighbor entry into the sandbox.
  52. AddNeighbor(dstIP net.IP, dstMac net.HardwareAddr, force bool, option ...NeighOption) error
  53. // DeleteNeighbor deletes neighbor entry from the sandbox.
  54. DeleteNeighbor(dstIP net.IP, dstMac net.HardwareAddr, osDelete bool) error
  55. // NeighborOptions returns an interface with methods to set neighbor options.
  56. NeighborOptions() NeighborOptionSetter
  57. // InterfaceOptions an interface with methods to set interface options.
  58. InterfaceOptions() IfaceOptionSetter
  59. // InvokeFunc invoke a function in the network namespace.
  60. InvokeFunc(func()) error
  61. // Info returns an interface with methods to get sandbox state.
  62. Info() Info
  63. // Destroy destroys the sandbox.
  64. Destroy() error
  65. // Restore restores the sandbox.
  66. Restore(ifsopt map[string][]IfaceOption, routes []*types.StaticRoute, gw net.IP, gw6 net.IP) error
  67. // ApplyOSTweaks applies operating system specific knobs on the sandbox.
  68. ApplyOSTweaks([]SandboxType)
  69. }
  70. // NeighborOptionSetter interface defines the option setter methods for interface options
  71. type NeighborOptionSetter interface {
  72. // LinkName returns an option setter to set the srcName of the link that should
  73. // be used in the neighbor entry
  74. LinkName(string) NeighOption
  75. // Family returns an option setter to set the address family for the neighbor
  76. // entry. eg. AF_BRIDGE
  77. Family(int) NeighOption
  78. }
  79. // IfaceOptionSetter interface defines the option setter methods for interface options.
  80. type IfaceOptionSetter interface {
  81. // Bridge returns an option setter to set if the interface is a bridge.
  82. Bridge(bool) IfaceOption
  83. // MacAddress returns an option setter to set the MAC address.
  84. MacAddress(net.HardwareAddr) IfaceOption
  85. // Address returns an option setter to set IPv4 address.
  86. Address(*net.IPNet) IfaceOption
  87. // AddressIPv6 returns an option setter to set IPv6 address.
  88. AddressIPv6(*net.IPNet) IfaceOption
  89. // LinkLocalAddresses returns an option setter to set the link-local IP addresses.
  90. LinkLocalAddresses([]*net.IPNet) IfaceOption
  91. // Master returns an option setter to set the master interface if any for this
  92. // interface. The master interface name should refer to the srcname of a
  93. // previously added interface of type bridge.
  94. Master(string) IfaceOption
  95. // Routes returns an option setter to set interface routes.
  96. Routes([]*net.IPNet) IfaceOption
  97. }
  98. // Info represents all possible information that
  99. // the driver wants to place in the sandbox which includes
  100. // interfaces, routes and gateway
  101. type Info interface {
  102. // Interfaces returns the collection of Interface previously added with the AddInterface
  103. // method. Note that this doesn't include network interfaces added in any
  104. // other way (such as the default loopback interface which is automatically
  105. // created on creation of a sandbox).
  106. Interfaces() []Interface
  107. // Gateway returns the IPv4 gateway for the sandbox.
  108. Gateway() net.IP
  109. // GatewayIPv6 returns the IPv6 gateway for the sandbox.
  110. GatewayIPv6() net.IP
  111. // StaticRoutes returns additional static routes for the sandbox. Note that
  112. // directly connected routes are stored on the particular interface they
  113. // refer to.
  114. StaticRoutes() []*types.StaticRoute
  115. // TODO: Add ip tables etc.
  116. }
  117. // Interface represents the settings and identity of a network device. It is
  118. // used as a return type for Network.Link, and it is common practice for the
  119. // caller to use this information when moving interface SrcName from host
  120. // namespace to DstName in a different net namespace with the appropriate
  121. // network settings.
  122. type Interface interface {
  123. // SrcName returns the name of the interface in the origin network namespace.
  124. SrcName() string
  125. // DstName returns the name that will be assigned to the interface once
  126. // moved inside a network namespace. When the caller passes in a DstName,
  127. // it is only expected to pass a prefix. The name will be modified with an
  128. // auto-generated suffix.
  129. DstName() string
  130. // Address returns the IPv4 address for the interface.
  131. Address() *net.IPNet
  132. // AddressIPv6 returns the IPv6 address for the interface.
  133. AddressIPv6() *net.IPNet
  134. // LinkLocalAddresses returns the link-local IP addresses assigned to the
  135. // interface.
  136. LinkLocalAddresses() []*net.IPNet
  137. // Routes returns IP routes for the interface.
  138. Routes() []*net.IPNet
  139. // Bridge returns true if the interface is a bridge.
  140. Bridge() bool
  141. // Master returns the srcname of the master interface for this interface.
  142. Master() string
  143. // Remove an interface from the sandbox by renaming to original name
  144. // and moving it out of the sandbox.
  145. Remove() error
  146. // Statistics returns the statistics for this interface
  147. Statistics() (*types.InterfaceStatistics, error)
  148. }