Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

daemon: add SdNotifyMonotonicUsec helper function #435

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions daemon/sdnotify.go
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,9 @@ package daemon
import (
"net"
"os"
"strconv"

"golang.org/x/sys/unix"
)

const (
Expand Down Expand Up @@ -82,3 +85,16 @@ func SdNotify(unsetEnvironment bool, state string) (bool, error) {
}
return true, nil
}

// SdNotifyMonotonicUsec returns a MONOTONIC_USEC=... assignment for the current time.
// This is typically used with [SdNotifyReloading].
//
// If the monotonic clock is not available on the system, the empty string is returned.
func SdNotifyMonotonicUsec() string {
var ts unix.Timespec
if err := unix.ClockGettime(unix.CLOCK_MONOTONIC, &ts); err != nil {
// Monotonic clock is not available on this system.
return ""
}
return "MONOTONIC_USEC=" + strconv.FormatInt(ts.Nano()/1000, 10)
}
75 changes: 75 additions & 0 deletions daemon/sdnotify_linux_test.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,75 @@
// Copyright 2024 CoreOS, Inc.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

package daemon

import (
"strconv"
"strings"
"testing"
"time"

"golang.org/x/sys/unix"
)

// TestUsec checks that SdNotifyMonotonicUsec is probably not returning complete garbage.
func TestUsec(t *testing.T) {
var resolution unix.Timespec
if err := unix.ClockGetres(unix.CLOCK_MONOTONIC, &resolution); err != nil {
if err == unix.EINVAL {
t.Log("CLOCK_MONOTONIC is not supported on this system")
if got := SdNotifyMonotonicUsec(); got != "" {
t.Errorf("SdNotifyMonotonicUsec() = %q; want empty string", got)
}
return
}
t.Fatalf("ClockGetres(CLOCK_MONOTONIC) failed: %v", err)
}

now := func() uint64 {
got := SdNotifyMonotonicUsec()
t.Logf("SdNotifyMonotonicUsec() = %q", got)
if got == "" {
t.Fatal("SdNotifyMonotonicUsec() returned empty string on system which supports CLOCK_MONOTONIC")
}
fields := strings.SplitN(got, "=", 2)
if len(fields) != 2 {
t.Fatal("string is not a well-formed variable assignment")
}
tag, val := fields[0], fields[1]
if tag != "MONOTONIC_USEC" {
t.Errorf("expected tag MONOTONIC_USEC, got %q", tag)
}
ts, err := strconv.ParseUint(val, 10, 64)
if err != nil {
t.Fatalf("value %q is not well-formed: %v", val, err)
}
if ts == 0 {
// CLOCK_MONOTONIC is defined on Linux as the number of seconds
// since boot, per clock_gettime(2). A timestamp of zero is
// almost certainly bogus.
t.Fatal("timestamp is zero")
}
return ts
}

start := now()
time.Sleep(time.Duration(resolution.Nano()) * 3)
ts := now()
if ts < start {
t.Errorf("timestamp went backwards: %d < %d", ts, start)
} else if ts == start {
t.Errorf("timestamp did not advance: %d == %d", ts, start)
}
}
5 changes: 4 additions & 1 deletion go.mod
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,7 @@ module github.com/coreos/go-systemd/v22

go 1.12

require github.com/godbus/dbus/v5 v5.1.0
require (
github.com/godbus/dbus/v5 v5.1.0
golang.org/x/sys v0.0.0-20180927150500-dad3d9fb7b6e
)
2 changes: 2 additions & 0 deletions go.sum
Original file line number Diff line number Diff line change
@@ -1,2 +1,4 @@
github.com/godbus/dbus/v5 v5.1.0 h1:4KLkAxT3aOY8Li4FRJe/KvhoNFFxo0m6fNuFUO8QJUk=
github.com/godbus/dbus/v5 v5.1.0/go.mod h1:xhWf0FNVPg57R7Z0UbKHbJfkEywrmjJnf7w5xrFpKfA=
golang.org/x/sys v0.0.0-20180927150500-dad3d9fb7b6e h1:AqqkRhkzWTerVplYmF0GrGl2ri2S5+F5xhJfDSc/SJY=
golang.org/x/sys v0.0.0-20180927150500-dad3d9fb7b6e/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY=
Loading