Andrew Boyson / net

A stack which works with or without an Mbed os library. Provides IPv4 or IPv6 with a full 1500 byte buffer.

Dependents:   oldheating gps motorhome heating

udp/ntp.c@69:6b3c648e1452, 2018-01-31 (annotated)

Committer:
andrewboyson
Date:
Wed Jan 31 19:35:34 2018 +0000
Revision:
69:6b3c648e1452
Parent:
68:e8c002e5ee4b
Child:
83:08c983006a6e
Added header log to ntp server request

Who changed what in which revision?

UserRevisionLine numberNew contents of line
andrewboyson 61:aad055f1b0d1 1 #include <stdint.h>
andrewboyson 61:aad055f1b0d1 2 #include <stdbool.h>
andrewboyson 61:aad055f1b0d1 3
andrewboyson 37:793b39683406 4 #include "log.h"
andrewboyson 37:793b39683406 5 #include "net.h"
andrewboyson 37:793b39683406 6 #include "action.h"
andrewboyson 49:1a6336f2b3f9 7 #include "ip6addr.h"
andrewboyson 37:793b39683406 8 #include "udp.h"
andrewboyson 48:952dddb74b8b 9 #include "ar4.h"
andrewboyson 48:952dddb74b8b 10 #include "ar6.h"
andrewboyson 37:793b39683406 11 #include "arp.h"
andrewboyson 37:793b39683406 12 #include "eth.h"
andrewboyson 50:492f2d2954e4 13 #include "nr4.h"
andrewboyson 50:492f2d2954e4 14 #include "nr6.h"
andrewboyson 37:793b39683406 15 #include "dns.h"
andrewboyson 37:793b39683406 16 #include "mac.h"
andrewboyson 22:914b970356f0 17
andrewboyson 37:793b39683406 18 bool NtpTrace = false;
andrewboyson 0:faa09bd4e6bf 19
andrewboyson 0:faa09bd4e6bf 20 #define CLIENT 3
andrewboyson 0:faa09bd4e6bf 21 #define SERVER 4
andrewboyson 0:faa09bd4e6bf 22
andrewboyson 22:914b970356f0 23 uint64_t (*NtpGetClockNowFunction) ();
andrewboyson 22:914b970356f0 24
andrewboyson 22:914b970356f0 25 bool NtpServerEnable = false;
andrewboyson 22:914b970356f0 26 uint64_t (*NtpGetClockRefFunction) ();
andrewboyson 22:914b970356f0 27 int (*NtpGetClockStratumFunction)();
andrewboyson 22:914b970356f0 28 char * (*NtpGetClockIdentFunction) ();
andrewboyson 22:914b970356f0 29
andrewboyson 36:900e24b27bfb 30 uint32_t NtpServerIp4;
andrewboyson 36:900e24b27bfb 31 char NtpServerIp6[16];
andrewboyson 22:914b970356f0 32 bool NtpClientRequest = false;
andrewboyson 68:e8c002e5ee4b 33 bool NtpClientTrace = false;
andrewboyson 35:93c39d260a83 34 char NtpServerName[DNS_MAX_LABEL_LENGTH+1];
andrewboyson 35:93c39d260a83 35 void (*NtpSetClockFunction) (uint64_t ori, uint64_t rec);
andrewboyson 35:93c39d260a83 36
andrewboyson 61:aad055f1b0d1 37 __packed struct header
andrewboyson 61:aad055f1b0d1 38 {
andrewboyson 0:faa09bd4e6bf 39 unsigned Mode : 3;
andrewboyson 0:faa09bd4e6bf 40 unsigned VN : 3;
andrewboyson 0:faa09bd4e6bf 41 unsigned LI : 2;
andrewboyson 0:faa09bd4e6bf 42 uint8_t Stratum;
andrewboyson 0:faa09bd4e6bf 43 int8_t Poll;
andrewboyson 0:faa09bd4e6bf 44 int8_t Precision;
andrewboyson 0:faa09bd4e6bf 45 uint32_t RootDelay;
andrewboyson 0:faa09bd4e6bf 46 uint32_t Dispersion;
andrewboyson 0:faa09bd4e6bf 47 char RefIdentifier[4];
andrewboyson 0:faa09bd4e6bf 48
andrewboyson 0:faa09bd4e6bf 49 uint64_t RefTimeStamp;
andrewboyson 0:faa09bd4e6bf 50 uint64_t OriTimeStamp;
andrewboyson 0:faa09bd4e6bf 51 uint64_t RecTimeStamp;
andrewboyson 0:faa09bd4e6bf 52 uint64_t TraTimeStamp;
andrewboyson 0:faa09bd4e6bf 53 };
andrewboyson 37:793b39683406 54 static void logHeader(struct header* pHeader)
andrewboyson 37:793b39683406 55 {
andrewboyson 61:aad055f1b0d1 56 if (NetTraceVerbose) Log ("NTP header\r\n ");
andrewboyson 61:aad055f1b0d1 57 else Log ("NTP header: ");
andrewboyson 61:aad055f1b0d1 58
andrewboyson 61:aad055f1b0d1 59 LogF("Mode %d", pHeader->Mode);
andrewboyson 61:aad055f1b0d1 60 LogF(", Version %d", pHeader->VN);
andrewboyson 61:aad055f1b0d1 61 LogF(", LI %d", pHeader->LI);
andrewboyson 61:aad055f1b0d1 62 LogF(", Stratum %d", pHeader->Stratum);
andrewboyson 61:aad055f1b0d1 63 LogF(", Poll %d", pHeader->Poll);
andrewboyson 61:aad055f1b0d1 64 LogF(", Precision %d", pHeader->Precision);
andrewboyson 61:aad055f1b0d1 65 LogF(", Root delay %d", NetToHost32(pHeader->RootDelay));
andrewboyson 61:aad055f1b0d1 66 LogF(", Dispersion %d", NetToHost32(pHeader->Dispersion));
andrewboyson 61:aad055f1b0d1 67 Log (", Ident ");
andrewboyson 61:aad055f1b0d1 68 for (int i = 0; i < 4; i++) if (pHeader->RefIdentifier[i]) LogPush(pHeader->RefIdentifier[i]);
andrewboyson 61:aad055f1b0d1 69 Log ("\r\n");
andrewboyson 61:aad055f1b0d1 70
andrewboyson 43:bc028d5a6424 71 if (NetTraceVerbose)
andrewboyson 43:bc028d5a6424 72 {
andrewboyson 43:bc028d5a6424 73 LogF(" REF %llu\r\n", NetToHost64(pHeader->RefTimeStamp));
andrewboyson 43:bc028d5a6424 74 LogF(" ORI %llu\r\n", NetToHost64(pHeader->OriTimeStamp));
andrewboyson 43:bc028d5a6424 75 LogF(" REC %llu\r\n", NetToHost64(pHeader->RecTimeStamp));
andrewboyson 43:bc028d5a6424 76 LogF(" TRA %llu\r\n", NetToHost64(pHeader->TraTimeStamp));
andrewboyson 43:bc028d5a6424 77 }
andrewboyson 37:793b39683406 78 }
andrewboyson 69:6b3c648e1452 79 static void (*pTraceBack)(void);
andrewboyson 59:e0e556c8bd46 80 static int handleRequest(struct header* pHeaderRx, struct header* pHeaderTx)
andrewboyson 0:faa09bd4e6bf 81 {
andrewboyson 22:914b970356f0 82 if (!NtpServerEnable) return DO_NOTHING;
andrewboyson 17:e475ab861365 83
andrewboyson 17:e475ab861365 84 if (!NtpGetClockRefFunction || !NtpGetClockNowFunction || !NtpGetClockStratumFunction || !NtpGetClockIdentFunction)
andrewboyson 17:e475ab861365 85 {
andrewboyson 17:e475ab861365 86 LogTimeF("NtpHandleRequest - NTP server is enabled but has not been plumbed into a clock\r\n");
andrewboyson 17:e475ab861365 87 return DO_NOTHING;
andrewboyson 17:e475ab861365 88 }
andrewboyson 69:6b3c648e1452 89
andrewboyson 69:6b3c648e1452 90 if (NtpTrace)
andrewboyson 69:6b3c648e1452 91 {
andrewboyson 69:6b3c648e1452 92 if (NetTraceNewLine) Log("\r\n");
andrewboyson 69:6b3c648e1452 93 LogTimeF("NTP received request\r\n");
andrewboyson 69:6b3c648e1452 94 if (NetTraceStack) pTraceBack();
andrewboyson 69:6b3c648e1452 95 logHeader(pHeaderRx);
andrewboyson 69:6b3c648e1452 96 }
andrewboyson 69:6b3c648e1452 97
andrewboyson 20:23f2b29b48ea 98 uint64_t refNtp = NtpGetClockRefFunction();
andrewboyson 20:23f2b29b48ea 99 uint64_t nowNtp = NtpGetClockNowFunction();
andrewboyson 20:23f2b29b48ea 100 int stratum = NtpGetClockStratumFunction();
andrewboyson 20:23f2b29b48ea 101 char* ident = NtpGetClockIdentFunction();
andrewboyson 22:914b970356f0 102
andrewboyson 59:e0e556c8bd46 103 pHeaderTx->Mode = SERVER;
andrewboyson 61:aad055f1b0d1 104 pHeaderTx->VN = 3;
andrewboyson 59:e0e556c8bd46 105 pHeaderTx->LI = 0;
andrewboyson 59:e0e556c8bd46 106 pHeaderTx->Stratum = stratum;
andrewboyson 59:e0e556c8bd46 107 pHeaderTx->Poll = 0;
andrewboyson 59:e0e556c8bd46 108 pHeaderTx->Precision = 0;
andrewboyson 59:e0e556c8bd46 109 pHeaderTx->RootDelay = 0;
andrewboyson 59:e0e556c8bd46 110 pHeaderTx->Dispersion = 0;
andrewboyson 59:e0e556c8bd46 111 pHeaderTx->RefIdentifier[0] = ident[0]; //For stratum 1 (reference clock), this is a four-octet, left-justified, zero-padded ASCII string.
andrewboyson 59:e0e556c8bd46 112 pHeaderTx->RefIdentifier[1] = ident[1];
andrewboyson 59:e0e556c8bd46 113 pHeaderTx->RefIdentifier[2] = ident[2];
andrewboyson 59:e0e556c8bd46 114 pHeaderTx->RefIdentifier[3] = ident[3];
andrewboyson 59:e0e556c8bd46 115 pHeaderTx->RefTimeStamp = NetToHost64(refNtp);
andrewboyson 59:e0e556c8bd46 116 pHeaderTx->OriTimeStamp = pHeaderRx->TraTimeStamp;
andrewboyson 59:e0e556c8bd46 117 pHeaderTx->RecTimeStamp = NetToHost64(nowNtp);
andrewboyson 59:e0e556c8bd46 118 pHeaderTx->TraTimeStamp = NetToHost64(nowNtp);
andrewboyson 69:6b3c648e1452 119
andrewboyson 69:6b3c648e1452 120 if (NtpTrace) logHeader(pHeaderTx);
andrewboyson 22:914b970356f0 121 return UNICAST;
andrewboyson 22:914b970356f0 122 }
andrewboyson 59:e0e556c8bd46 123 static void handleReply(struct header* pHeader)
andrewboyson 22:914b970356f0 124 {
andrewboyson 22:914b970356f0 125 if (!NtpGetClockNowFunction || !NtpSetClockFunction)
andrewboyson 22:914b970356f0 126 {
andrewboyson 22:914b970356f0 127 LogTimeF("Ntp reply has been received but NTP has not been plumbed into a clock\r\n");
andrewboyson 59:e0e556c8bd46 128 return;
andrewboyson 22:914b970356f0 129 }
andrewboyson 37:793b39683406 130 if (NtpTrace)
andrewboyson 22:914b970356f0 131 {
andrewboyson 43:bc028d5a6424 132 if (NetTraceNewLine) Log("\r\n");
andrewboyson 22:914b970356f0 133 LogTimeF("NTP received reply\r\n");
andrewboyson 43:bc028d5a6424 134 if (NetTraceStack) pTraceBack();
andrewboyson 37:793b39683406 135 logHeader(pHeader);
andrewboyson 22:914b970356f0 136 }
andrewboyson 37:793b39683406 137
andrewboyson 22:914b970356f0 138 uint64_t ori = NetToHost64(pHeader->OriTimeStamp);
andrewboyson 22:914b970356f0 139 uint64_t rec = NetToHost64(pHeader->RecTimeStamp);
andrewboyson 22:914b970356f0 140
andrewboyson 22:914b970356f0 141 NtpSetClockFunction(ori, rec);
andrewboyson 22:914b970356f0 142 }
andrewboyson 59:e0e556c8bd46 143 int NtpHandlePacketReceived(void (*traceback)(void), int sizeRx, void * pPacketRx, int* pSizeTx, void* pPacketTx)
andrewboyson 22:914b970356f0 144 {
andrewboyson 37:793b39683406 145 pTraceBack = traceback;
andrewboyson 37:793b39683406 146
andrewboyson 61:aad055f1b0d1 147 if (sizeRx != sizeof(struct header))
andrewboyson 22:914b970356f0 148 {
andrewboyson 59:e0e556c8bd46 149 LogTimeF("\r\nNTP packet wrong size %d\r\n", sizeRx);
andrewboyson 22:914b970356f0 150 return DO_NOTHING;
andrewboyson 22:914b970356f0 151 }
andrewboyson 59:e0e556c8bd46 152 struct header* pHeaderRx = (struct header*)pPacketRx;
andrewboyson 59:e0e556c8bd46 153 struct header* pHeaderTx = (struct header*)pPacketTx;
andrewboyson 17:e475ab861365 154
andrewboyson 59:e0e556c8bd46 155 int dest = DO_NOTHING;
andrewboyson 59:e0e556c8bd46 156 switch (pHeaderRx->Mode)
andrewboyson 0:faa09bd4e6bf 157 {
andrewboyson 59:e0e556c8bd46 158 case CLIENT: dest = handleRequest(pHeaderRx, pHeaderTx); break;
andrewboyson 59:e0e556c8bd46 159 case SERVER: handleReply (pHeaderRx); return DO_NOTHING;
andrewboyson 0:faa09bd4e6bf 160 default:
andrewboyson 59:e0e556c8bd46 161 LogTimeF("\r\nNTP packet unknown mode %d\r\n", pHeaderRx->Mode);
andrewboyson 22:914b970356f0 162 return DO_NOTHING;
andrewboyson 0:faa09bd4e6bf 163 }
andrewboyson 59:e0e556c8bd46 164
andrewboyson 59:e0e556c8bd46 165 if (dest == DO_NOTHING) return DO_NOTHING;
andrewboyson 61:aad055f1b0d1 166 *pSizeTx = sizeof(struct header);
andrewboyson 59:e0e556c8bd46 167
andrewboyson 59:e0e556c8bd46 168 return ActionMakeFromDestAndTrace(dest, NtpTrace && NetTraceStack);
andrewboyson 22:914b970356f0 169 }
andrewboyson 22:914b970356f0 170 static int sendRequest(void* pPacket, int* pSize)
andrewboyson 22:914b970356f0 171 {
andrewboyson 22:914b970356f0 172 struct header* pHeader = (struct header*)pPacket;
andrewboyson 22:914b970356f0 173
andrewboyson 59:e0e556c8bd46 174 pHeader->Mode = CLIENT;
andrewboyson 69:6b3c648e1452 175 pHeader->VN = 3;
andrewboyson 59:e0e556c8bd46 176 pHeader->LI = 0;
andrewboyson 59:e0e556c8bd46 177 pHeader->Stratum = 0;
andrewboyson 59:e0e556c8bd46 178 pHeader->Poll = 0;
andrewboyson 59:e0e556c8bd46 179 pHeader->Precision = 0;
andrewboyson 59:e0e556c8bd46 180 pHeader->RootDelay = 0;
andrewboyson 59:e0e556c8bd46 181 pHeader->Dispersion = 0;
andrewboyson 22:914b970356f0 182 pHeader->RefIdentifier[0] = 0;
andrewboyson 22:914b970356f0 183 pHeader->RefIdentifier[1] = 0;
andrewboyson 22:914b970356f0 184 pHeader->RefIdentifier[2] = 0;
andrewboyson 22:914b970356f0 185 pHeader->RefIdentifier[3] = 0;
andrewboyson 59:e0e556c8bd46 186 pHeader->RefTimeStamp = 0;
andrewboyson 59:e0e556c8bd46 187 pHeader->OriTimeStamp = 0;
andrewboyson 59:e0e556c8bd46 188 pHeader->RecTimeStamp = 0;
andrewboyson 59:e0e556c8bd46 189 pHeader->TraTimeStamp = NetToHost64(NtpGetClockNowFunction());
andrewboyson 59:e0e556c8bd46 190
andrewboyson 61:aad055f1b0d1 191 *pSize = sizeof(struct header);
andrewboyson 22:914b970356f0 192
andrewboyson 22:914b970356f0 193 return UNICAST_NTP;
andrewboyson 0:faa09bd4e6bf 194 }
andrewboyson 36:900e24b27bfb 195 static bool resolve4(char* server, uint32_t* pIp)
andrewboyson 36:900e24b27bfb 196 {
andrewboyson 36:900e24b27bfb 197 //Check if have IP, if not, then request it and stop
andrewboyson 50:492f2d2954e4 198 Nr4NameToIp(server, pIp);
andrewboyson 36:900e24b27bfb 199 if (!*pIp)
andrewboyson 36:900e24b27bfb 200 {
andrewboyson 50:492f2d2954e4 201 Nr4MakeRequestForIpFromName(server); //The request is only repeated if made after a freeze time - call as often as you want.
andrewboyson 36:900e24b27bfb 202 return false;
andrewboyson 36:900e24b27bfb 203 }
andrewboyson 35:93c39d260a83 204
andrewboyson 36:900e24b27bfb 205 //Check if have MAC and, if not, request it and stop
andrewboyson 36:900e24b27bfb 206 char mac[6];
andrewboyson 48:952dddb74b8b 207 Ar4IpToMac(*pIp, mac);
andrewboyson 36:900e24b27bfb 208 if (MacIsEmpty(mac))
andrewboyson 36:900e24b27bfb 209 {
andrewboyson 48:952dddb74b8b 210 Ar4MakeRequestForMacFromIp(*pIp); //The request is only repeated if made after a freeze time - call as often as you want.
andrewboyson 36:900e24b27bfb 211 return false;
andrewboyson 36:900e24b27bfb 212 }
andrewboyson 36:900e24b27bfb 213
andrewboyson 36:900e24b27bfb 214 return true;
andrewboyson 36:900e24b27bfb 215 }
andrewboyson 36:900e24b27bfb 216 static bool resolve6(char* server, char* ip)
andrewboyson 36:900e24b27bfb 217 {
andrewboyson 36:900e24b27bfb 218 //Check if have IP, if not, then request it and stop
andrewboyson 50:492f2d2954e4 219 Nr6NameToIp(server, ip);
andrewboyson 49:1a6336f2b3f9 220 if (Ip6AddressIsEmpty(ip))
andrewboyson 36:900e24b27bfb 221 {
andrewboyson 50:492f2d2954e4 222 Nr6MakeRequestForIpFromName(server); //The request is only repeated if made after a freeze time - call as often as you want.
andrewboyson 36:900e24b27bfb 223 return false;
andrewboyson 36:900e24b27bfb 224 }
andrewboyson 36:900e24b27bfb 225
andrewboyson 36:900e24b27bfb 226 //Check if have MAC and, if not, request it and stop
andrewboyson 36:900e24b27bfb 227 char mac[6];
andrewboyson 48:952dddb74b8b 228 Ar6IpToMac(ip, mac);
andrewboyson 36:900e24b27bfb 229 if (MacIsEmpty(mac))
andrewboyson 36:900e24b27bfb 230 {
andrewboyson 48:952dddb74b8b 231 Ar6MakeRequestForMacFromIp(ip); //The request is only repeated if made after a freeze time - call as often as you want.
andrewboyson 36:900e24b27bfb 232 return false;
andrewboyson 36:900e24b27bfb 233 }
andrewboyson 36:900e24b27bfb 234
andrewboyson 36:900e24b27bfb 235 return true;
andrewboyson 36:900e24b27bfb 236 }
andrewboyson 22:914b970356f0 237 int NtpPollForPacketToSend(int type, void* pPacket, int* pSize)
andrewboyson 22:914b970356f0 238 {
andrewboyson 22:914b970356f0 239 if (!NtpClientRequest) return DO_NOTHING; //Wait until a request for time is made
andrewboyson 22:914b970356f0 240
andrewboyson 35:93c39d260a83 241 if (!NtpServerName[0])
andrewboyson 35:93c39d260a83 242 {
andrewboyson 35:93c39d260a83 243 LogTimeF("NtpPollForRequestToSend - A request to send a client message has been made but no server name has been specified\r\n");
andrewboyson 35:93c39d260a83 244 NtpClientRequest = false;
andrewboyson 35:93c39d260a83 245 return DO_NOTHING;
andrewboyson 35:93c39d260a83 246 }
andrewboyson 35:93c39d260a83 247
andrewboyson 35:93c39d260a83 248 if (!NtpGetClockNowFunction || !NtpSetClockFunction)
andrewboyson 22:914b970356f0 249 {
andrewboyson 22:914b970356f0 250 LogTimeF("NtpPollForRequestToSend - A request to send a client message has been made but NTP has not been plumbed into a clock\r\n");
andrewboyson 22:914b970356f0 251 NtpClientRequest = false;
andrewboyson 22:914b970356f0 252 return DO_NOTHING;
andrewboyson 22:914b970356f0 253 }
andrewboyson 42:222a4f45f916 254
andrewboyson 42:222a4f45f916 255 if (type == IPV4)
andrewboyson 42:222a4f45f916 256 {
andrewboyson 42:222a4f45f916 257 if (!resolve4(NtpServerName, &NtpServerIp4)) return DO_NOTHING;
andrewboyson 42:222a4f45f916 258 }
andrewboyson 42:222a4f45f916 259 else if (type == IPV6)
andrewboyson 42:222a4f45f916 260 {
andrewboyson 42:222a4f45f916 261 if (!resolve6(NtpServerName, NtpServerIp6)) return DO_NOTHING;
andrewboyson 42:222a4f45f916 262 }
andrewboyson 42:222a4f45f916 263 else
andrewboyson 42:222a4f45f916 264 {
andrewboyson 42:222a4f45f916 265 return DO_NOTHING;
andrewboyson 42:222a4f45f916 266 }
andrewboyson 35:93c39d260a83 267
andrewboyson 35:93c39d260a83 268 //Have IP and MAC so send request
andrewboyson 42:222a4f45f916 269 NtpClientRequest = false;
andrewboyson 42:222a4f45f916 270 int dest = sendRequest(pPacket, pSize);
andrewboyson 42:222a4f45f916 271 if (NtpTrace)
andrewboyson 37:793b39683406 272 {
andrewboyson 43:bc028d5a6424 273 if (NetTraceNewLine) Log("\r\n");
andrewboyson 37:793b39683406 274 LogTimeF("Sending NTP request\r\n");
andrewboyson 42:222a4f45f916 275 logHeader((struct header*)pPacket);
andrewboyson 37:793b39683406 276 }
andrewboyson 43:bc028d5a6424 277 return ActionMakeFromDestAndTrace(dest, NtpTrace && NetTraceStack);
andrewboyson 22:914b970356f0 278 }
andrewboyson 22:914b970356f0 279