mirror of
https://github.com/k3s-io/k3s.git
synced 2024-06-07 19:41:36 +00:00
178 lines
8.0 KiB
Go
178 lines
8.0 KiB
Go
// Package hcn is a shim for the Host Compute Networking (HCN) service, which manages networking for Windows Server
|
|
// containers and Hyper-V containers. Previous to RS5, HCN was referred to as Host Networking Service (HNS).
|
|
package hcn
|
|
|
|
import (
|
|
"encoding/json"
|
|
"fmt"
|
|
"syscall"
|
|
|
|
"github.com/Microsoft/hcsshim/internal/guid"
|
|
)
|
|
|
|
//go:generate go run ../mksyscall_windows.go -output zsyscall_windows.go hcn.go
|
|
|
|
/// HNS V1 API
|
|
|
|
//sys SetCurrentThreadCompartmentId(compartmentId uint32) (hr error) = iphlpapi.SetCurrentThreadCompartmentId
|
|
//sys _hnsCall(method string, path string, object string, response **uint16) (hr error) = vmcompute.HNSCall?
|
|
|
|
/// HCN V2 API
|
|
|
|
// Network
|
|
//sys hcnEnumerateNetworks(query string, networks **uint16, result **uint16) (hr error) = computenetwork.HcnEnumerateNetworks?
|
|
//sys hcnCreateNetwork(id *_guid, settings string, network *hcnNetwork, result **uint16) (hr error) = computenetwork.HcnCreateNetwork?
|
|
//sys hcnOpenNetwork(id *_guid, network *hcnNetwork, result **uint16) (hr error) = computenetwork.HcnOpenNetwork?
|
|
//sys hcnModifyNetwork(network hcnNetwork, settings string, result **uint16) (hr error) = computenetwork.HcnModifyNetwork?
|
|
//sys hcnQueryNetworkProperties(network hcnNetwork, query string, properties **uint16, result **uint16) (hr error) = computenetwork.HcnQueryNetworkProperties?
|
|
//sys hcnDeleteNetwork(id *_guid, result **uint16) (hr error) = computenetwork.HcnDeleteNetwork?
|
|
//sys hcnCloseNetwork(network hcnNetwork) (hr error) = computenetwork.HcnCloseNetwork?
|
|
|
|
// Endpoint
|
|
//sys hcnEnumerateEndpoints(query string, endpoints **uint16, result **uint16) (hr error) = computenetwork.HcnEnumerateEndpoints?
|
|
//sys hcnCreateEndpoint(network hcnNetwork, id *_guid, settings string, endpoint *hcnEndpoint, result **uint16) (hr error) = computenetwork.HcnCreateEndpoint?
|
|
//sys hcnOpenEndpoint(id *_guid, endpoint *hcnEndpoint, result **uint16) (hr error) = computenetwork.HcnOpenEndpoint?
|
|
//sys hcnModifyEndpoint(endpoint hcnEndpoint, settings string, result **uint16) (hr error) = computenetwork.HcnModifyEndpoint?
|
|
//sys hcnQueryEndpointProperties(endpoint hcnEndpoint, query string, properties **uint16, result **uint16) (hr error) = computenetwork.HcnQueryEndpointProperties?
|
|
//sys hcnDeleteEndpoint(id *_guid, result **uint16) (hr error) = computenetwork.HcnDeleteEndpoint?
|
|
//sys hcnCloseEndpoint(endpoint hcnEndpoint) (hr error) = computenetwork.HcnCloseEndpoint?
|
|
|
|
// Namespace
|
|
//sys hcnEnumerateNamespaces(query string, namespaces **uint16, result **uint16) (hr error) = computenetwork.HcnEnumerateNamespaces?
|
|
//sys hcnCreateNamespace(id *_guid, settings string, namespace *hcnNamespace, result **uint16) (hr error) = computenetwork.HcnCreateNamespace?
|
|
//sys hcnOpenNamespace(id *_guid, namespace *hcnNamespace, result **uint16) (hr error) = computenetwork.HcnOpenNamespace?
|
|
//sys hcnModifyNamespace(namespace hcnNamespace, settings string, result **uint16) (hr error) = computenetwork.HcnModifyNamespace?
|
|
//sys hcnQueryNamespaceProperties(namespace hcnNamespace, query string, properties **uint16, result **uint16) (hr error) = computenetwork.HcnQueryNamespaceProperties?
|
|
//sys hcnDeleteNamespace(id *_guid, result **uint16) (hr error) = computenetwork.HcnDeleteNamespace?
|
|
//sys hcnCloseNamespace(namespace hcnNamespace) (hr error) = computenetwork.HcnCloseNamespace?
|
|
|
|
// LoadBalancer
|
|
//sys hcnEnumerateLoadBalancers(query string, loadBalancers **uint16, result **uint16) (hr error) = computenetwork.HcnEnumerateLoadBalancers?
|
|
//sys hcnCreateLoadBalancer(id *_guid, settings string, loadBalancer *hcnLoadBalancer, result **uint16) (hr error) = computenetwork.HcnCreateLoadBalancer?
|
|
//sys hcnOpenLoadBalancer(id *_guid, loadBalancer *hcnLoadBalancer, result **uint16) (hr error) = computenetwork.HcnOpenLoadBalancer?
|
|
//sys hcnModifyLoadBalancer(loadBalancer hcnLoadBalancer, settings string, result **uint16) (hr error) = computenetwork.HcnModifyLoadBalancer?
|
|
//sys hcnQueryLoadBalancerProperties(loadBalancer hcnLoadBalancer, query string, properties **uint16, result **uint16) (hr error) = computenetwork.HcnQueryLoadBalancerProperties?
|
|
//sys hcnDeleteLoadBalancer(id *_guid, result **uint16) (hr error) = computenetwork.HcnDeleteLoadBalancer?
|
|
//sys hcnCloseLoadBalancer(loadBalancer hcnLoadBalancer) (hr error) = computenetwork.HcnCloseLoadBalancer?
|
|
|
|
// Service
|
|
//sys hcnOpenService(service *hcnService, result **uint16) (hr error) = computenetwork.HcnOpenService?
|
|
//sys hcnRegisterServiceCallback(service hcnService, callback int32, context int32, callbackHandle *hcnCallbackHandle) (hr error) = computenetwork.HcnRegisterServiceCallback?
|
|
//sys hcnUnregisterServiceCallback(callbackHandle hcnCallbackHandle) (hr error) = computenetwork.HcnUnregisterServiceCallback?
|
|
//sys hcnCloseService(service hcnService) (hr error) = computenetwork.HcnCloseService?
|
|
|
|
type _guid = guid.GUID
|
|
|
|
type hcnNetwork syscall.Handle
|
|
type hcnEndpoint syscall.Handle
|
|
type hcnNamespace syscall.Handle
|
|
type hcnLoadBalancer syscall.Handle
|
|
type hcnService syscall.Handle
|
|
type hcnCallbackHandle syscall.Handle
|
|
|
|
// SchemaVersion for HCN Objects/Queries.
|
|
type SchemaVersion = Version // hcnglobals.go
|
|
|
|
// HostComputeQueryFlags are passed in to a HostComputeQuery to determine which
|
|
// properties of an object are returned.
|
|
type HostComputeQueryFlags uint32
|
|
|
|
var (
|
|
// HostComputeQueryFlagsNone returns an object with the standard properties.
|
|
HostComputeQueryFlagsNone HostComputeQueryFlags
|
|
// HostComputeQueryFlagsDetailed returns an object with all properties.
|
|
HostComputeQueryFlagsDetailed HostComputeQueryFlags = 1
|
|
)
|
|
|
|
// HostComputeQuery is the format for HCN queries.
|
|
type HostComputeQuery struct {
|
|
SchemaVersion SchemaVersion `json:""`
|
|
Flags HostComputeQueryFlags `json:",omitempty"`
|
|
Filter string `json:",omitempty"`
|
|
}
|
|
|
|
// defaultQuery generates HCN Query.
|
|
// Passed into get/enumerate calls to filter results.
|
|
func defaultQuery() HostComputeQuery {
|
|
query := HostComputeQuery{
|
|
SchemaVersion: SchemaVersion{
|
|
Major: 2,
|
|
Minor: 0,
|
|
},
|
|
Flags: HostComputeQueryFlagsNone,
|
|
}
|
|
return query
|
|
}
|
|
|
|
func defaultQueryJson() string {
|
|
query := defaultQuery()
|
|
queryJson, err := json.Marshal(query)
|
|
if err != nil {
|
|
return ""
|
|
}
|
|
return string(queryJson)
|
|
}
|
|
|
|
// PlatformDoesNotSupportError happens when users are attempting to use a newer shim on an older OS
|
|
func platformDoesNotSupportError(featureName string) error {
|
|
return fmt.Errorf("Platform does not support feature %s", featureName)
|
|
}
|
|
|
|
// V2ApiSupported returns an error if the HCN version does not support the V2 Apis.
|
|
func V2ApiSupported() error {
|
|
supported := GetSupportedFeatures()
|
|
if supported.Api.V2 {
|
|
return nil
|
|
}
|
|
return platformDoesNotSupportError("V2 Api/Schema")
|
|
}
|
|
|
|
func V2SchemaVersion() SchemaVersion {
|
|
return SchemaVersion{
|
|
Major: 2,
|
|
Minor: 0,
|
|
}
|
|
}
|
|
|
|
// RemoteSubnetSupported returns an error if the HCN version does not support Remote Subnet policies.
|
|
func RemoteSubnetSupported() error {
|
|
supported := GetSupportedFeatures()
|
|
if supported.RemoteSubnet {
|
|
return nil
|
|
}
|
|
return platformDoesNotSupportError("Remote Subnet")
|
|
}
|
|
|
|
// HostRouteSupported returns an error if the HCN version does not support Host Route policies.
|
|
func HostRouteSupported() error {
|
|
supported := GetSupportedFeatures()
|
|
if supported.HostRoute {
|
|
return nil
|
|
}
|
|
return platformDoesNotSupportError("Host Route")
|
|
}
|
|
|
|
// DSRSupported returns an error if the HCN version does not support Direct Server Return.
|
|
func DSRSupported() error {
|
|
supported := GetSupportedFeatures()
|
|
if supported.DSR {
|
|
return nil
|
|
}
|
|
return platformDoesNotSupportError("Direct Server Return (DSR)")
|
|
}
|
|
|
|
// RequestType are the different operations performed to settings.
|
|
// Used to update the settings of Endpoint/Namespace objects.
|
|
type RequestType string
|
|
|
|
var (
|
|
// RequestTypeAdd adds the provided settings object.
|
|
RequestTypeAdd RequestType = "Add"
|
|
// RequestTypeRemove removes the provided settings object.
|
|
RequestTypeRemove RequestType = "Remove"
|
|
// RequestTypeUpdate replaces settings with the ones provided.
|
|
RequestTypeUpdate RequestType = "Update"
|
|
// RequestTypeRefresh refreshes the settings provided.
|
|
RequestTypeRefresh RequestType = "Refresh"
|
|
)
|