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
43 statDirScalarIndex = 1
44 statDirCounterVectorSimple = 2
45 statDirCounterVectorCombined = 3
53 dirVector unsafe.Pointer
54 dirSegment unsafe.Pointer
59 // statSegment represents common API for every stats API version
60 type statSegment interface {
61 // GetDirectoryVector returns pointer to memory where the beginning
62 // of the data directory is located.
63 GetDirectoryVector() dirVector
65 // GetStatDirOnIndex accepts directory vector and particular index.
66 // Returns pointer to the beginning of the segment. Also the directory
67 // name as [128]byte and the directory type is returned for easy use
68 // without needing to know the exact segment version.
70 // Note that if the index is equal to 0, the result pointer points to
71 // the same memory address as the argument.
72 GetStatDirOnIndex(v dirVector, index uint32) (dirSegment, dirName, dirType)
74 // GetEpoch re-loads stats header and returns current epoch
75 //and 'inProgress' value
76 GetEpoch() (int64, bool)
78 // CopyEntryData accepts pointer to a directory segment and returns adapter.Stat
79 // based on directory type populated with data. The index is an optional parameter
80 // (used by symlinks) returning stats for item on the given index only.
81 // Use ^uint32(0) as an empty index (since 0 is a valid value).
82 CopyEntryData(segment dirSegment, index uint32) adapter.Stat
84 // UpdateEntryData accepts pointer to a directory segment with data, and stat
86 UpdateEntryData(segment dirSegment, s *adapter.Stat) error
89 // vecHeader represents a vector header
90 type vecHeader struct {
95 func (t dirType) String() string {
96 return adapter.StatType(t).String()
99 func getVersion(data []byte) uint64 {
100 type apiVersion struct {
103 header := (*apiVersion)(unsafe.Pointer(&data[0]))
104 version := &apiVersion{
105 value: atomic.LoadUint64(&header.value),
107 debugf("stats API version loaded: %d", version.value)
111 func vectorLen(v dirVector) dirVector {
112 vec := *(*vecHeader)(unsafe.Pointer(uintptr(v) - unsafe.Sizeof(uint64(0))))
113 return dirVector(&vec.length)
117 func statSegPointer(v dirVector, offset uintptr) dirVector {
118 return dirVector(uintptr(v) + offset)