Module s4lib::data::fixedstruct

Implement FixedStruct to represent Unix record-keeping C structs. This includes acct, lastlog, lastlogx, utmp, and utmpx formats for various operating systems and architectures.

Modules

• freebsd_x8664
  FixedStruct definitions found on FreeBSD 14.0 amd64 and FreeBSD 13.1 amd64 (x86_64).
• linux_arm64aarch64
  FixedStruct definitions found on Linux running on ARM64 (aarch64) architecture.
• linux_x86
  FixedStruct definitions found in lastlog.h, utmp.h, utmpx.h from GNU glibc for Linux, architectures amd64 (x86_64), i686 (x86_32), ARM6 (aarch64), and RISC-V (riscv64).
• netbsd_x8632
  FixedStruct definitions found on NetBSD 9.3 i686 (x86_32). These are slightly different than amd64 (x86_64).
• netbsd_x8664
  FixedStruct definitions found on NetBSD 9.3 amd64 (x86_64). These are slightly different than i686 (x86_32).
• openbsd_x86
  FixedStruct definitions found on OpenBSD 7.2 i386 (x86_32) and amd64 (x86_64).

Structs

• FixedStruct
  An entry for pointing to a fixed-size C struct with additional derived information.
• tv_pair_type
  time value pair type

Enums

• FixedStructType
  FixedStruct Implementation Type (name FixedStructType is taken).
• InfoAsBytes
  Information returned from as_bytes.

Constants

• ENTRY_SZ_MAX
  Maximum size among all acct/lastlog/utmp/etc. C structs
• ENTRY_SZ_MIN
  Minimum size among all acct/lastlog/utmp/etc. C structs
• NUMTOA_BUF_SZ
  size of the [u8] buffer used for numtoa conversions good up to i64::MAX or i64::MIN plus a little “just in case” head room
• TIMEVAL_SZ_MAX
  Maximum size among all time values for all C structs
• UT_TYPE_VAL_TO_STR
  Map utmp.ut_type value, implied in the index offset, to it’s str representation. These values and definitions appear consistent across all platforms, except NetBSD appends three values.
• UT_TYPE_VAL_TO_STR_LEN
  Count of entries in UT_TYPE_VAL_TO_STR.
• UT_TYPE_VAL_TO_STR_LEN_i16
• UT_TYPE_VAL_TO_STR_LEN_u16

Traits

• FixedStructTrait
  An abstraction for representing varying fixed-size C structs. This includes record-keeping structs acct, lastlog, utmp defined in the namespaces freebsd_x8664, linux_arm64aarch64, etc. Each specific definition defined in those namespaces must implement this trait.

Functions

• buffer_to_fixedstructptr
  Convert [u8] bytes to a FixedStructDynPtr instance specified by fixedstructtype.
• convert_datetime_tvpair
  Convert DateTimeL instance to tv_sec_type and tv_usec_type.
• convert_tvpair_to_datetime
  Convert timeval types tv_sec_type and tv_usec_type to a DateTimeL instance.
• copy_fixedstructptr

Type Aliases

• BufIndex
  Index into a [u8] buffer. Used by as_bytes.
• FixedStructDynPtr
  Box pointer to a dynamically dispatched Trait object FixedStructTrait.
• Score
  A scoring system for the quality of the data in a FixedStruct. A higher score means the data is more likely to be the FixedStructType expected.
• nsecs_type
  common nanoseconds type used as intermediate representation during conversion to DateTimeL
• tv_sec_type
  common denominator time value type representing seconds since Unix epoch
• tv_usec_type
  common denominator time value type representing additional sub-second microseconds since Unix epoch