aghos

Documentation

Overview

Package aghos contains utilities for functions requiring system calls and other OS-specific APIs. OS-specific network handling should go to aghnet instead.

Index

• Constants
• func ConfigureSyslog(serviceName string) error
• func HaveAdminRights() (bool, error)
• func IsOpenWrt() (ok bool)
• func IsReconfigureSignal(sig os.Signal) (ok bool)
• func IsShutdownSignal(sig os.Signal) (ok bool)
• func NotifyReconfigureSignal(c chan<- os.Signal)
• func NotifyShutdownSignal(c chan<- os.Signal)
• func PIDByCommand(command string, except ...int) (pid int, err error)
• func PreCheckActionStart() (err error)
• func RunCommand(command string, arguments ...string) (code int, output []byte, err error)
• func SendShutdownSignal(c chan<- os.Signal)
• func SetGroup(groupName string) (err error)
• func SetRlimit(val uint64) (err error)
• func SetUser(userName string) (err error)
• func Unsupported(op string) (err error)
• type FSWatcher
  • func NewOSWritesWatcher() (w FSWatcher, err error)
• type FileWalker
  • func (fw FileWalker) Walk(fsys fs.FS, initial ...string) (ok bool, err error)
• type UnsupportedError
  • func (err *UnsupportedError) Error() (msg string)

Constants

const MaxCmdOutputSize = 64 * 1024

MaxCmdOutputSize is the maximum length of performed shell command output in bytes.

Functions

func ConfigureSyslog

func ConfigureSyslog(serviceName string) error

ConfigureSyslog reroutes standard logger output to syslog.

func HaveAdminRights

func HaveAdminRights() (bool, error)

HaveAdminRights checks if the current user has root (administrator) rights.

func IsOpenWrt

func IsOpenWrt() (ok bool)

IsOpenWrt returns true if host OS is OpenWrt.

func IsReconfigureSignal

func IsReconfigureSignal(sig os.Signal) (ok bool)

IsReconfigureSignal returns true if sig is a reconfigure signal.

func IsShutdownSignal

func IsShutdownSignal(sig os.Signal) (ok bool)

IsShutdownSignal returns true if sig is a shutdown signal.

func NotifyReconfigureSignal

func NotifyReconfigureSignal(c chan<- os.Signal)

NotifyReconfigureSignal notifies c on receiving reconfigure signals.

func NotifyShutdownSignal

func NotifyShutdownSignal(c chan<- os.Signal)

NotifyShutdownSignal notifies c on receiving shutdown signals.

func PIDByCommand

func PIDByCommand(command string, except ...int) (pid int, err error)

PIDByCommand searches for process named command and returns its PID ignoring the PIDs from except. If no processes found, the error returned.

func PreCheckActionStart

func PreCheckActionStart() (err error)

PreCheckActionStart performs the service start action pre-check.

func RunCommand

func RunCommand(command string, arguments ...string) (code int, output []byte, err error)

RunCommand runs shell command.

func SendShutdownSignal

func SendShutdownSignal(c chan<- os.Signal)

SendShutdownSignal sends the shutdown signal to the channel.

func SetGroup

func SetGroup(groupName string) (err error)

SetGroup sets the effective group ID of the calling process.

func SetRlimit

func SetRlimit(val uint64) (err error)

SetRlimit sets user-specified limit of how many fd's we can use.

See https://github.com/AdguardTeam/AdGuardHome/internal/issues/659.

func SetUser

func SetUser(userName string) (err error)

SetUser sets the effective user ID of the calling process.

func Unsupported

func Unsupported(op string) (err error)

Unsupported is a helper that returns an *UnsupportedError with the Op field set to op and the OS field set to the current OS.

Types

type FSWatcher

type FSWatcher interface {
	// Start starts watching the added files.
	Start() (err error)

	// Close stops watching the files and closes an update channel.
	io.Closer

	// Events returns the channel to notify about the file system events.
	Events() (e <-chan event)

	// Add starts tracking the file.  It returns an error if the file can't be
	// tracked.  It must not be called after Start.
	Add(name string) (err error)
}

FSWatcher tracks all the fyle system events and notifies about those.

TODO(e.burkov, a.garipov): Move into another package like aghfs.

TODO(e.burkov): Add tests.

func NewOSWritesWatcher

func NewOSWritesWatcher() (w FSWatcher, err error)

NewOSWritesWatcher creates FSWatcher that tracks the real file system of the OS and notifies only about writing events.

type FileWalker

type FileWalker func(r io.Reader) (patterns []string, cont bool, err error)

FileWalker is the signature of a function called for files in the file tree. As opposed to filepath.Walk it only walk the files (not directories) matching the provided pattern and those returned by function itself. All patterns should be valid for fs.Glob. If FileWalker returns false for cont then walking terminates. Prefer using bufio.Scanner to read the r since the input is not limited.

TODO(e.burkov, a.garipov): Move into another package like aghfs.

TODO(e.burkov): Think about passing filename or any additional data.

func (FileWalker) Walk

func (fw FileWalker) Walk(fsys fs.FS, initial ...string) (ok bool, err error)

Walk starts walking the files in fsys defined by patterns from initial. It only returns true if fw signed to stop walking.

type UnsupportedError

type UnsupportedError struct {
	Op string
	OS string
}

UnsupportedError is returned by functions and methods when a particular operation Op cannot be performed on the current OS.

func (*UnsupportedError) Error

func (err *UnsupportedError) Error() (msg string)

Error implements the error interface for *UnsupportedError.