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@61:aad055f1b0d1, 2018-01-11 (annotated)

Committer:
andrewboyson
Date:
Thu Jan 11 17:38:21 2018 +0000
Revision:
61:aad055f1b0d1
Parent:
udp/ntp.cpp@59:e0e556c8bd46
Child:
68:e8c002e5ee4b
Removed dependence on Mbed OS

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