Changeset c4bfda41ac34a173e53c73725b8ccc799eb29bba

Timestamp:

02/23/12 18:43:25 (3 years ago)

Author:

Theo Schlossnagle <jesus@omniti.com>

git-committer:

Theo Schlossnagle <jesus@omniti.com> 1330022605 -0500

git-parent:

[4e26cbc3c2cf67c7b90e4e4dc7ebe5ad6b181da2]

git-author:

Theo Schlossnagle <jesus@omniti.com> 1330022605 -0500

Message:

preliminary support for ntp control protocol

Files:

• docs/config/modules/noit.module.ntp.xml (modified) (1 diff)
• src/modules-lua/noit/module/ntp.lua (modified) (6 diffs)

docs/config/modules/noit.module.ntp.xml

@@ -22 +22 @@
-  <section>
-    <title>Check Configuration</title>
+    <variablelist>
+      <varlistentry>
+        <term>port</term>
+        <listitem>
+          <variablelist>
+            <varlistentry>
+              <term>required</term>
+              <listitem>
+                <para>optional</para>
+              </listitem>
+            </varlistentry>
+            <varlistentry>
+              <term>default</term>
+              <listitem>
+                <para>^123$</para>
+              </listitem>
+            </varlistentry>
+            <varlistentry>
+              <term>allowed</term>
+              <listitem>
+                <para>\d+</para>
+              </listitem>
+            </varlistentry>
+          </variablelist>
+          <para>The port to which we will attempt to speak NTP.</para>
+        </listitem>
+      </varlistentry>
+    </variablelist>
+    <variablelist>
+      <varlistentry>
+        <term>control</term>
+        <listitem>
+          <variablelist>
+            <varlistentry>
+              <term>required</term>
+              <listitem>
+                <para>optional</para>
+              </listitem>
+            </varlistentry>
+            <varlistentry>
+              <term>default</term>
+              <listitem>
+                <para>^false$</para>
+              </listitem>
+            </varlistentry>
+            <varlistentry>
+              <term>allowed</term>
+              <listitem>
+                <para>^(?:true|on|false|off)$</para>
+              </listitem>
+            </varlistentry>
+          </variablelist>
+          <para>Use the NTP control protocol to learn about the other end.  If thise ois not true/on, then this check will determine the NTP telemetry of the target relative to the agent's local time.  If it is true/on, then the agent will request the NTP telemetry of the target regarding it's preferred peer.</para>
+        </listitem>
+      </varlistentry>
+    </variablelist>
-  </section>
-  <example>

src/modules-lua/noit/module/ntp.lua

@@ -31 +31 @@
-module(..., package.seeall)
-
+local band,     bor,     bxor,     bnot,     rshift,     lshift
+    = bit.band, bit.bor, bit.bxor, bit.bnot, bit.rshift, bit.lshift
+
-function onload(image)
-  image.xml_description([=[
@@ -39 +42 @@
-  <object>noit.module.ntp</object>
-  <moduleconfig />
-
+
+
+
+
+
+
+
+
+
+
-  <examples>
-    <example>
@@ -86 +98 @@
-end
-
-
-
+
-  local sec = l32 - 2208988800
-  local usec = (r32 - 0.5) / 4294.967296
-  return noit.timeval.new(sec, usec)
+end
+
+function ntp642timeval(s)
+  local cnt, l32, r32 = string.unpack(s, '>II')
+  return parts2timeval(l32, r32)
-end
-
@@ -103 +119 @@
-   return l16 + (r16 / 65536)
-end
+
+local _sequence = 0
+function next_sequence()
+  _sequence = _sequence + 1
+  return _sequence
+end
+
+function make_ntp_control(req)
+    req.version = req.version or 4 -- NTP version
+    req.mode = req.mode or 6 -- control
+    req.leap = req.leap or 0
+    -- contruct
+    req.li_vn_mode = bor(bor(band(req.mode,0x7),
+                             lshift(band(req.version,0x7),3)),
+                         lshift(band(req.leap,6),0x3))
+    req.op = req.op or 0x01
+    req.r_m_e_op = band(req.op,0x1f)
+    req.sequence = req.sequence or next_sequence()
+    req.status = req.status or 0
+    req.associd = req.associd or 0
+    req.offset = req.offset or 0
+    req.count = req.count or 0
+    local qcnt = req.count
+    req.data = req.data or ''
+    req.pad = ''
+    while (qcnt % 8) ~= 0 do
+        req.pad = req.pad .. '\0'
+    end
+    return string.pack('>bbHHHHH', req.li_vn_mode, req.r_m_e_op, req.sequence,
+                       req.status, req.associd, req.offset, req.count)
+        .. req.data
+        .. req.pad
+         , req.sequence
+end
+
+function ntp_control(s, req)
+    local f = { }
+    local req_packet = make_ntp_control(req)
+    s:send(req_packet)
+
+    f.num_frags = 0
+    f.offsets = {}
+    local done = false
+    repeat
+        local rv, buf = s:recv(480) -- max packet
+        local offset, count, cnt
+        -- need at least a header
+        if buf:len() < 12 then return "short packet" end
+
+        f.hdr = buf:sub(1,12)
+        f.buf = buf:sub(13,buf:len())
+        cnt, f.li_vn_mode, f.r_m_e_op, f.sequence,
+            f.status, f.associd, offset, count = string.unpack(f.hdr, '>bbHHHHH')
+
+        f.mode = band(f.li_vn_mode, 0x7)
+        f.version = band(rshift(f.li_vn_mode, 3), 0x7)
+        f.leap = band(rshift(f.li_vn_mode, 6), 0x3)
+        f.op = band(f.r_m_e_op, 0x1f)
+        f.is_more = band(f.r_m_e_op, 0x20) ~= 0
+        f.is_error = band(f.r_m_e_op, 0x40) ~= 0
+        f.is_response = band(f.r_m_e_op, 0x80) ~= 0
+
+        -- validate
+        if f.version > 4 or f.version < 1 then return "bad version" end
+        if f.mode ~= 6 then return "not a control packet" end
+        if not f.is_response then return "not a response packet" end
+        if req.sequence ~= f.sequence then return "sequence mismatch" end
+        if req.op ~= f.op then return "opcode mismatch " .. req.op .. " != " .. f.op  end
+        if f.is_error then
+            return "error: "
+                .. bit.tohex(band(rshift(f.status, 8), 0xff), 2)
+        end
+        local expect = band(band(12 + count + 3, bnot(3)),0xffff)
+        -- must be aligned on a word boundary
+        if band(buf:len(), 3) ~= 0 then return "bad padding" end
+        if expect > buf:len() then
+            return "bad payload size " .. expect .. " vs. " .. buf:len()
+        end
+        if expect < buf:len() then
+            -- auth
+            return "auth unsupported " .. expect .. " vs. " .. buf:len()
+        end
+        if f.num_frags > 23 then return "too many fragments" end
+        if count < f.buf:len() then
+            f.buf = f.buf:sub(1,count)
+        end
+        f.offsets[offset] = f.buf
+        done = not f.is_more
+    until done
+
+    f.data = ''
+    for i, buf in pairs(f.offsets) do f.data = f.data .. buf end
+    return nil, f
+end
+
-
-function make_ntp_request(fin)
@@ -154 +265 @@
-end
-
+function initiate_control(module, check, s)
+    local err, result = ntp_control(s, {})
+    local associations = {}
+    if err ~= nil then
+        check.status(err)
+        return
+    end
+    local i = 0
+    local len, numassoc = result.data:len(), result.data:len() / 4;
+    local use_id = 0
+    while len > 0 do
+      local cnt, associd, status = string.unpack(result.data:sub(1+4*i, 4+4*i), '>HH')
+      i = i + 1
+      len = len - 4;
+      associations[i] = { }
+      associations[i].associd = associd
+      associations[i].status = status
+      if result.version > 1 then
+          associations[i].flash = band(rshift(status,8),0x7)
+          associations[i].prefer = band(associations[i].flash,0x2) ~= 0
+          associations[i].burst = band(associations[i].flash,0x4) ~= 0
+          associations[i].volley = band(associations[i].flash,0x1) ~= 0
+      else
+          associations[i].flash = band(rshift(status,8),0x3)
+          associations[i].prefer = band(associations[i].flash,0x1) ~= 0
+          associations[i].burst = band(associations[i].flash,0x2) ~= 0
+          associations[i].volley = false
+      end
+      if(associations[i].prefer) then use_id = i end
+    end
+    if(use_id < 1) then use_id = 1 end
+
+    err, result = ntp_control(s, { associd = associations[use_id].associd })
+    if err ~= nil then
+        check.status(err)
+        return
+    end
+    local vars = {}
+    for k, v in string.gmatch(result.data, "%s*([^,]+)=([^,]+)%s*,%s*") do
+       vars[k] = v;
+       noit.log("debug", "ntp: %s = %s\n", k, v)
+    end
+    check.metric_string('clock_name', vars.srcadr)
+    check.metric_int32('stratum', tonumber(vars.stratum))
+
+    -- parse the rec and the reftime
+    local rec_l, rec_h = vars.rec:match('^0x([%da-fA-F]+)%.([%da-fA-F]+)$')
+    rec_l, rec_h = tonumber("0x"..rec_l), tonumber("0x"..rec_h)
+    local rec = parts2timeval(rec_l, rec_h)
+
+    local reftime_l, reftime_h = vars.reftime:match('^0x([%da-fA-F]+)%.([%da-fA-F]+)$')
+    reftime_l, reftime_h = tonumber("0x"..reftime_l), tonumber("0x"..reftime_h)
+    local reftime = parts2timeval(reftime_l, reftime_h)
+
+    local when = nil
+    if rec.sec ~= 0 then when = noit.timeval.seconds(noit.timeval.now() - rec)
+    elseif reftime.sec ~= 0 then when = noit.timeval.seconds(noit.timeval.now() - reftime)
+    end
+    check.metric_double('when', when)
+    local poll = math.pow(2, math.max(math.min(vars.ppoll or 17, vars.hpoll or 17), 3))
+    check.metric_uint32('poll', poll)
+    check.metric_double('delay', tonumber(vars.delay))
+    check.metric_double('offset', tonumber(vars.offset))
+    check.metric_double('jitter', tonumber(vars.jitter))
+    check.metric_double('dispersion', tonumber(vars.dispersion))
+    check.metric_double('xleave', tonumber(vars.xleave))
+    check.metric_int32('peers', numassoc)
+    check.status("ntp successful")
+    check.available()
+    check.good()
+end
+
-function initiate(module, check)
-    local s = noit.socket(check.target_ip, 'udp')
@@ -162 +345 @@
-    check.bad()
-
-
+check.config.port or 
-    status.responses = 0
-    status.avg_offset = 0
-    status.offset = { }
-
+    if check.config.control == "true" or check.config.control == "on" then
+        return initiate_control(module, check, s)
+    end
+
-    for i = 1,cnt do
-        local req = make_ntp_request()
-        s:send(req)
-s
+buf
-        local now = noit.timeval.now()
-s
+buf
-        local offset = calculate_offset(response, now)
-        if offset ~= nil then