Shared Memory Driver

Last update: May 4, 2022 17:05 UTC (dbea9b7d4)

Table of Contents

• Synopsis
• Description
• Structure of shared memory-segment
• Operation mode=0
• Operation mode=1
• Fudge Factors
• Additional Information

---

Synopsis

Address: 127.127.28.u

Reference ID: SHM

Driver ID: SHM

---

Description

This driver receives its reference clock info from a shared memory-segment. The shared memory-segment is created with owner-only access for unit 0 and 1, and world access for unit 2 and 3.

---

Structure of shared memory-segment

struct shmTime {
  int    mode; /* 0 - if valid set
                *       use values, 
                *       clear valid
                * 1 - if valid set 
                *       if count before and after read of 
                *       values is equal,
                *         use values 
                *       clear valid
                */
  int    count;
  time_t clockTimeStampSec;      /* external clock */
  int    clockTimeStampUSec;     /* external clock */
  time_t receiveTimeStampSec;    /* internal clock, when external value was received */
  int    receiveTimeStampUSec;   /* internal clock, when external value was received */
  int    leap;
  int    precision;
  int    nsamples;
  int    valid;
  int    dummy[10]; 
};

---

Operation mode=0

When the poll-method of the driver is called, the valid-flag of the shared memory-segment is checked:

If set, the values in the record (clockTimeStampSec, clockTimeStampUSec, receiveTimeStampSec, receiveTimeStampUSec, leap, precision) are passed to ntp, and the valid-flag is cleared.

If not set, a timeout is reported to ntp, nothing else happened.

---

Operation mode=1

When the poll-method of the driver is called, the valid-flag of the shared memory-segment is checked:

If set, the count-field of the record is remembered, and the values in the record (clockTimeStampSec, clockTimeStampUSec, receiveTimeStampSec, receiveTimeStampUSec, leap, precision) are read. Then, the remembered count is compared to the count now in the record. If both are equal, the values read from the record are passed to ntp. If they differ, another process has modified the record while it was read out (was not able to produce this case), and failure is reported to ntp. The valid flag is cleared.

If not set, a timeout is reported to ntp, nothing else happened.

---

Fudge Factors

time1 time

Specifies the time offset calibration factor, in seconds and fraction, with default 0.0.

time2 time

Not used by this driver.

stratum number

Specifies the driver stratum, in decimal from 0 to 15, with default 0.

refid string

Specifies the driver reference identifier, an ASCII string from one to four characters, with default SHM.

flag1 0 | 1

Not used by this driver.

flag2 0 | 1

Not used by this driver.

flag3 0 | 1

Not used by this driver.

flag4 0 | 1

Not used by this driver.

---

Additional Information

Reference Clock Drivers