github/kubernetes
1
0
Fork 0
mirror of https://github.com/k3s-io/kubernetes.git synced 2025-07-22 19:31:44 +00:00
Code Issues Projects Releases Wiki Activity

Cleanup comments in TopologyManager socketmask abstraction

Browse Source
This commit is contained in:
Kevin Klues 2019-07-18 09:09:12 -07:00
parent 0edfd4be35
commit 65b07312b0
1 changed files with 17 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

34
pkg/kubelet/cm/topologymanager/socketmask/socketmask.go
View File

@ -20,7 +20,7 @@ import (
"fmt"
)
//SocketMask interface allows hint providers to create SocketMasks for TopologyHints
// SocketMask interface allows hint providers to create SocketMasks for TopologyHints
type SocketMask interface {
Add(sockets ...int) error
Remove(sockets ...int) error
@ -39,13 +39,13 @@ type SocketMask interface {
type socketMask uint64
//NewEmptySocketMask creates a new, empty SocketMask
// NewEmptySocketMask creates a new, empty SocketMask
func NewEmptySocketMask() SocketMask {
s := socketMask(0)
return &s
}
//NewSocketMask creates a new SocketMask
// NewSocketMask creates a new SocketMask
func NewSocketMask(sockets ...int) (SocketMask, error) {
s := socketMask(0)
err := (&s).Add(sockets...)
@ -55,7 +55,7 @@ func NewSocketMask(sockets ...int) (SocketMask, error) {
return &s, nil
}
//Add adds the sockets with topology affinity to the SocketMask
// Add adds the sockets with topology affinity to the SocketMask
func (s *socketMask) Add(sockets ...int) error {
mask := *s
for _, i := range sockets {
@ -68,7 +68,7 @@ func (s *socketMask) Add(sockets ...int) error {
return nil
}
//Remove removes specified sockets from SocketMask
// Remove removes specified sockets from SocketMask
func (s *socketMask) Remove(sockets ...int) error {
mask := *s
for _, i := range sockets {
@ -81,36 +81,36 @@ func (s *socketMask) Remove(sockets ...int) error {
return nil
}
//And performs and operation on all bits in masks
// And performs and operation on all bits in masks
func (s *socketMask) And(masks ...SocketMask) {
for _, m := range masks {
*s &= *m.(*socketMask)
}
}
//Or performs or operation on all bits in masks
// Or performs or operation on all bits in masks
func (s *socketMask) Or(masks ...SocketMask) {
for _, m := range masks {
*s |= *m.(*socketMask)
}
}
//Clear resets all bits in mask to zero
// Clear resets all bits in mask to zero
func (s *socketMask) Clear() {
*s = 0
}
//Fill sets all bits in mask to one
// Fill sets all bits in mask to one
func (s *socketMask) Fill() {
*s = socketMask(^uint64(0))
}
//IsEmpty checks mask to see if all bits are zero
// IsEmpty checks mask to see if all bits are zero
func (s *socketMask) IsEmpty() bool {
return *s == 0
}
//IsSet checks socket in mask to see if bit is set to one
// IsSet checks socket in mask to see if bit is set to one
func (s *socketMask) IsSet(socket int) bool {
if socket < 0 || socket >= 64 {
return false
@ -118,7 +118,7 @@ func (s *socketMask) IsSet(socket int) bool {
return (*s & (1 << uint64(socket))) > 0
}
//IsEqual checks if masks are equal
// IsEqual checks if masks are equal
func (s *socketMask) IsEqual(mask SocketMask) bool {
return *s == *mask.(*socketMask)
}
@ -137,7 +137,7 @@ func (s *socketMask) IsNarrowerThan(mask SocketMask) bool {
return s.Count() < mask.Count()
}
//String converts mask to string
// String converts mask to string
func (s *socketMask) String() string {
str := ""
for i := uint64(0); i < 64; i++ {
@ -150,7 +150,7 @@ func (s *socketMask) String() string {
return str
}
//Count counts number of bits in mask set to one
// Count counts number of bits in mask set to one
func (s *socketMask) Count() int {
count := 0
for i := uint64(0); i < 64; i++ {
@ -161,7 +161,7 @@ func (s *socketMask) Count() int {
return count
}
//GetSockets returns each socket number with bits set to one
// GetSockets returns each socket number with bits set to one
func (s *socketMask) GetSockets() []int {
var sockets []int
for i := uint64(0); i < 64; i++ {
@ -172,14 +172,14 @@ func (s *socketMask) GetSockets() []int {
return sockets
}
//And is a package level implementation of 'and' between first and masks
// And is a package level implementation of 'and' between first and masks
func And(first SocketMask, masks ...SocketMask) SocketMask {
s := *first.(*socketMask)
s.And(masks...)
return &s
}
//Or is a package level implementation of 'or' between first and masks
// Or is a package level implementation of 'or' between first and masks
func Or(first SocketMask, masks ...SocketMask) SocketMask {
s := *first.(*socketMask)
s.Or(masks...)