1 // Copyright (c) 2020 Cisco and/or its affiliates.
3 // Licensed under the Apache License, Version 2.0 (the "License");
4 // you may not use this file except in compliance with the License.
5 // You may obtain a copy of the License at:
7 // http://www.apache.org/licenses/LICENSE-2.0
9 // Unless required by applicable law or agreed to in writing, software
10 // distributed under the License is distributed on an "AS IS" BASIS,
11 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 // See the License for the specific language governing permissions and
13 // limitations under the License.
19 "git.fd.io/govpp.git/adapter"
26 // ErrStatDataLenIncorrect is returned when stat data does not match vector
27 // length of a respective data directory
28 ErrStatDataLenIncorrect = fmt.Errorf("stat data length incorrect")
32 MaxWaitInProgress = time.Millisecond * 100
33 CheckDelayInProgress = time.Microsecond * 10
41 var dirTypeMapping = map[dirType]adapter.StatType{
42 1: adapter.ScalarIndex,
43 2: adapter.SimpleCounterVector,
44 3: adapter.CombinedCounterVector,
45 4: adapter.NameVector,
50 var dirTypeMappingLegacy = map[dirType]adapter.StatType{
51 1: adapter.ScalarIndex,
52 2: adapter.SimpleCounterVector,
53 3: adapter.CombinedCounterVector,
54 4: adapter.ErrorIndex,
55 5: adapter.NameVector,
61 dirVector unsafe.Pointer
62 dirSegment unsafe.Pointer
67 // statSegment represents common API for every stats API version
68 type statSegment interface {
69 // GetDirectoryVector returns pointer to memory where the beginning
70 // of the data directory is located.
71 GetDirectoryVector() dirVector
73 // GetStatDirOnIndex accepts directory vector and particular index.
74 // Returns pointer to the beginning of the segment. Also the directory
75 // name as [128]byte and the directory type is returned for easy use
76 // without needing to know the exact segment version.
78 // Note that if the index is equal to 0, the result pointer points to
79 // the same memory address as the argument.
80 GetStatDirOnIndex(v dirVector, index uint32) (dirSegment, dirName, dirType)
82 // GetEpoch re-loads stats header and returns current epoch
83 //and 'inProgress' value
84 GetEpoch() (int64, bool)
86 // CopyEntryData accepts pointer to a directory segment and returns adapter.Stat
87 // based on directory type populated with data. The index is an optional parameter
88 // (used by symlinks) returning stats for item on the given index only.
89 // Use ^uint32(0) as an empty index (since 0 is a valid value).
90 CopyEntryData(segment dirSegment, index uint32) adapter.Stat
92 // UpdateEntryData accepts pointer to a directory segment with data, and stat
94 UpdateEntryData(segment dirSegment, s *adapter.Stat) error
97 // vecHeader represents a vector header
98 type vecHeader struct {
103 func getVersion(data []byte) uint64 {
104 type apiVersion struct {
107 header := (*apiVersion)(unsafe.Pointer(&data[0]))
108 version := &apiVersion{
109 value: atomic.LoadUint64(&header.value),
111 debugf("stats API version loaded: %d", version.value)
115 func vectorLen(v dirVector) dirVector {
116 vec := *(*vecHeader)(unsafe.Pointer(uintptr(v) - unsafe.Sizeof(uint64(0))))
117 return dirVector(&vec.length)
120 func getStatType(dirTypeNum dirType, useLegacyMapping bool) (dirTyp adapter.StatType) {
122 if useLegacyMapping {
123 dirTyp, exists = dirTypeMappingLegacy[dirTypeNum]
125 dirTyp, exists = dirTypeMapping[dirTypeNum]
130 return adapter.Unknown
134 func statSegPointer(v dirVector, offset uintptr) dirVector {
135 return dirVector(uintptr(v) + offset)