sandbox.go 5.7 KB

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