First step: AutoIP compiled in and working

Dependencies:   mbed

Committer:
darran
Date:
Fri Jun 18 15:54:21 2010 +0000
Revision:
1:4218cacaf696
Parent:
0:55a05330f8cc

        

Who changed what in which revision?

UserRevisionLine numberNew contents of line
darran 0:55a05330f8cc 1
darran 0:55a05330f8cc 2 /*
darran 0:55a05330f8cc 3 Copyright (c) 2010 Donatien Garnier (donatiengar [at] gmail [dot] com)
darran 0:55a05330f8cc 4
darran 0:55a05330f8cc 5 Permission is hereby granted, free of charge, to any person obtaining a copy
darran 0:55a05330f8cc 6 of this software and associated documentation files (the "Software"), to deal
darran 0:55a05330f8cc 7 in the Software without restriction, including without limitation the rights
darran 0:55a05330f8cc 8 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
darran 0:55a05330f8cc 9 copies of the Software, and to permit persons to whom the Software is
darran 0:55a05330f8cc 10 furnished to do so, subject to the following conditions:
darran 0:55a05330f8cc 11
darran 0:55a05330f8cc 12 The above copyright notice and this permission notice shall be included in
darran 0:55a05330f8cc 13 all copies or substantial portions of the Software.
darran 0:55a05330f8cc 14
darran 0:55a05330f8cc 15 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
darran 0:55a05330f8cc 16 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
darran 0:55a05330f8cc 17 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
darran 0:55a05330f8cc 18 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
darran 0:55a05330f8cc 19 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
darran 0:55a05330f8cc 20 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
darran 0:55a05330f8cc 21 THE SOFTWARE.
darran 0:55a05330f8cc 22 */
darran 0:55a05330f8cc 23
darran 0:55a05330f8cc 24 #include "NTPClient.h"
darran 0:55a05330f8cc 25
darran 0:55a05330f8cc 26 #include <stdio.h>
darran 0:55a05330f8cc 27
darran 0:55a05330f8cc 28 //#define __DEBUG
darran 0:55a05330f8cc 29 #include "dbg/dbg.h"
darran 0:55a05330f8cc 30
darran 0:55a05330f8cc 31 #define NTP_PORT 123
darran 1:4218cacaf696 32 #define NTP_CLIENT_PORT 0//50420 //Random port
darran 0:55a05330f8cc 33 #define NTP_REQUEST_TIMEOUT 15000
darran 0:55a05330f8cc 34 #define NTP_TIMESTAMP_DELTA 2208988800ull //Diff btw a UNIX timestamp (Starting Jan, 1st 1970) and a NTP timestamp (Starting Jan, 1st 1900)
darran 0:55a05330f8cc 35
darran 0:55a05330f8cc 36 #define htons( x ) ( (( x << 8 ) & 0xFF00) | (( x >> 8 ) & 0x00FF) )
darran 0:55a05330f8cc 37 #define ntohs( x ) (htons(x))
darran 0:55a05330f8cc 38
darran 0:55a05330f8cc 39 #define htonl( x ) ( (( x << 24 ) & 0xFF000000) \
darran 0:55a05330f8cc 40 | (( x << 8 ) & 0x00FF0000) \
darran 0:55a05330f8cc 41 | (( x >> 8 ) & 0x0000FF00) \
darran 0:55a05330f8cc 42 | (( x >> 24 ) & 0x000000FF) )
darran 0:55a05330f8cc 43 #define ntohl( x ) (htonl(x))
darran 0:55a05330f8cc 44
darran 1:4218cacaf696 45 NTPClient::NTPClient() : NetService(false), m_state(NTP_PING), m_pCbItem(NULL), m_pCbMeth(NULL), m_pCb(NULL),
darran 0:55a05330f8cc 46 m_watchdog(), m_timeout(0), m_closed(true), m_host(), m_pDnsReq(NULL), m_blockingResult(NTP_PROCESSING)
darran 0:55a05330f8cc 47 {
darran 0:55a05330f8cc 48 setTimeout(NTP_REQUEST_TIMEOUT);
darran 0:55a05330f8cc 49 DBG("\r\nNew NTPClient %p\r\n",this);
darran 0:55a05330f8cc 50 }
darran 0:55a05330f8cc 51
darran 0:55a05330f8cc 52 NTPClient::~NTPClient()
darran 0:55a05330f8cc 53 {
darran 0:55a05330f8cc 54 close();
darran 0:55a05330f8cc 55 }
darran 0:55a05330f8cc 56
darran 0:55a05330f8cc 57 //High level setup functions
darran 0:55a05330f8cc 58 NTPResult NTPClient::setTime(const Host& host) //Blocking
darran 0:55a05330f8cc 59 {
darran 0:55a05330f8cc 60 doSetTime(host);
darran 0:55a05330f8cc 61 return blockingProcess();
darran 0:55a05330f8cc 62 }
darran 0:55a05330f8cc 63
darran 0:55a05330f8cc 64 NTPResult NTPClient::setTime(const Host& host, void (*pMethod)(NTPResult)) //Non blocking
darran 0:55a05330f8cc 65 {
darran 0:55a05330f8cc 66 setOnResult(pMethod);
darran 0:55a05330f8cc 67 doSetTime(host);
darran 0:55a05330f8cc 68 return NTP_PROCESSING;
darran 0:55a05330f8cc 69 }
darran 0:55a05330f8cc 70
darran 1:4218cacaf696 71 #if 0 //For doc only
darran 0:55a05330f8cc 72 template<class T>
darran 0:55a05330f8cc 73 NTPResult NTPClient::setTime(const Host& host, T* pItem, void (T::*pMethod)(NTPResult)) //Non blocking
darran 0:55a05330f8cc 74 {
darran 0:55a05330f8cc 75 setOnResult(pItem, pMethod);
darran 0:55a05330f8cc 76 doSetTime(host);
darran 0:55a05330f8cc 77 return NTP_PROCESSING;
darran 0:55a05330f8cc 78 }
darran 0:55a05330f8cc 79 #endif
darran 0:55a05330f8cc 80
darran 0:55a05330f8cc 81 void NTPClient::doSetTime(const Host& host)
darran 0:55a05330f8cc 82 {
darran 0:55a05330f8cc 83 init();
darran 1:4218cacaf696 84 resetTimeout();
darran 0:55a05330f8cc 85 m_host = host;
darran 1:4218cacaf696 86 if(!m_host.getPort())
darran 1:4218cacaf696 87 {
darran 1:4218cacaf696 88 m_host.setPort(NTP_PORT);
darran 1:4218cacaf696 89 }
darran 0:55a05330f8cc 90 if(m_host.getIp().isNull())
darran 0:55a05330f8cc 91 {
darran 0:55a05330f8cc 92 //DNS query required
darran 0:55a05330f8cc 93 m_pDnsReq = new DNSRequest();
darran 0:55a05330f8cc 94 DBG("\r\nNTPClient : DNSRequest %p\r\n", m_pDnsReq);
darran 0:55a05330f8cc 95 m_pDnsReq->setOnReply(this, &NTPClient::onDNSReply);
darran 0:55a05330f8cc 96 m_pDnsReq->resolve(&m_host);
darran 0:55a05330f8cc 97 return;
darran 0:55a05330f8cc 98 }
darran 1:4218cacaf696 99 open();
darran 0:55a05330f8cc 100 }
darran 0:55a05330f8cc 101
darran 0:55a05330f8cc 102 void NTPClient::setOnResult( void (*pMethod)(NTPResult) )
darran 0:55a05330f8cc 103 {
darran 0:55a05330f8cc 104 m_pCb = pMethod;
darran 0:55a05330f8cc 105 }
darran 0:55a05330f8cc 106
darran 0:55a05330f8cc 107 void NTPClient::close()
darran 0:55a05330f8cc 108 {
darran 0:55a05330f8cc 109 if(m_closed)
darran 0:55a05330f8cc 110 return;
darran 0:55a05330f8cc 111 m_closed = true; //Prevent recursive calling or calling on an object being destructed by someone else
darran 1:4218cacaf696 112 m_watchdog.stop();
darran 0:55a05330f8cc 113 m_pUDPSocket->resetOnEvent();
darran 0:55a05330f8cc 114 m_pUDPSocket->close();
darran 0:55a05330f8cc 115 delete m_pUDPSocket;
darran 0:55a05330f8cc 116 if( m_pDnsReq )
darran 0:55a05330f8cc 117 {
darran 0:55a05330f8cc 118 m_pDnsReq->close();
darran 0:55a05330f8cc 119 delete m_pDnsReq;
darran 0:55a05330f8cc 120 m_pDnsReq = NULL;
darran 0:55a05330f8cc 121 }
darran 0:55a05330f8cc 122 }
darran 0:55a05330f8cc 123
darran 1:4218cacaf696 124 void NTPClient::poll() //Called by NetServices
darran 1:4218cacaf696 125 {
darran 1:4218cacaf696 126 if( (!m_closed) && (m_watchdog.read_ms() >= m_timeout) )
darran 1:4218cacaf696 127 {
darran 1:4218cacaf696 128 onTimeout();
darran 1:4218cacaf696 129 }
darran 1:4218cacaf696 130 }
darran 1:4218cacaf696 131
darran 1:4218cacaf696 132 void NTPClient::init() //Create and setup socket if needed
darran 1:4218cacaf696 133 {
darran 1:4218cacaf696 134 if(!m_closed) //Already opened
darran 1:4218cacaf696 135 return;
darran 1:4218cacaf696 136 m_state = NTP_PING;
darran 1:4218cacaf696 137 m_pUDPSocket = new UDPSocket;
darran 1:4218cacaf696 138 m_pUDPSocket->setOnEvent(this, &NTPClient::onUDPSocketEvent);
darran 1:4218cacaf696 139 m_closed = false;
darran 1:4218cacaf696 140 DBG("NTPClient: Init OK\n");
darran 1:4218cacaf696 141 }
darran 1:4218cacaf696 142
darran 1:4218cacaf696 143 void NTPClient::open()
darran 1:4218cacaf696 144 {
darran 1:4218cacaf696 145 resetTimeout();
darran 1:4218cacaf696 146 DBG("Opening connection\n");
darran 1:4218cacaf696 147 m_state = NTP_PING;
darran 1:4218cacaf696 148 Host localhost(IpAddr(127,0,0,1), NTP_CLIENT_PORT, "localhost");
darran 1:4218cacaf696 149 m_pUDPSocket->bind(localhost);
darran 1:4218cacaf696 150 set_time( 1280000000 ); //End of July 2010... just there to limit offset range
darran 1:4218cacaf696 151 process();
darran 1:4218cacaf696 152 }
darran 1:4218cacaf696 153
darran 0:55a05330f8cc 154 #define MIN(a,b) ((a)<(b))?(a):(b)
darran 0:55a05330f8cc 155 void NTPClient::process() //Main state-machine
darran 0:55a05330f8cc 156 {
darran 0:55a05330f8cc 157 int len;
darran 0:55a05330f8cc 158 Host host;
darran 1:4218cacaf696 159
darran 0:55a05330f8cc 160 switch(m_state)
darran 0:55a05330f8cc 161 {
darran 0:55a05330f8cc 162 case NTP_PING:
darran 0:55a05330f8cc 163 DBG("\r\nPing\r\n");
darran 0:55a05330f8cc 164 //Prepare NTP Packet:
darran 1:4218cacaf696 165 m_pkt.li = 0; //Leap Indicator : No warning
darran 1:4218cacaf696 166 m_pkt.vn = 4; //Version Number : 4
darran 1:4218cacaf696 167 m_pkt.mode = 3; //Client mode
darran 1:4218cacaf696 168 m_pkt.stratum = 0; //Not relevant here
darran 1:4218cacaf696 169 m_pkt.poll = 0; //Not significant as well
darran 1:4218cacaf696 170 m_pkt.precision = 0; //Neither this one is
darran 0:55a05330f8cc 171
darran 1:4218cacaf696 172 m_pkt.rootDelay = 0; //Or this one
darran 1:4218cacaf696 173 m_pkt.rootDispersion = 0; //Or that one
darran 1:4218cacaf696 174 m_pkt.refId = 0; //...
darran 0:55a05330f8cc 175
darran 1:4218cacaf696 176 m_pkt.refTm_s = 0;
darran 1:4218cacaf696 177 m_pkt.origTm_s = 0;
darran 1:4218cacaf696 178 m_pkt.rxTm_s = 0;
darran 1:4218cacaf696 179 m_pkt.txTm_s = htonl( NTP_TIMESTAMP_DELTA + time(NULL) ); //WARN: We are in LE format, network byte order is BE
darran 0:55a05330f8cc 180
darran 1:4218cacaf696 181 m_pkt.refTm_f = m_pkt.origTm_f = m_pkt.rxTm_f = m_pkt.txTm_f = 0;
darran 0:55a05330f8cc 182
darran 0:55a05330f8cc 183 //Hex Dump:
darran 0:55a05330f8cc 184 DBG("\r\nDump Tx:\r\n");
darran 0:55a05330f8cc 185 for(int i = 0; i< sizeof(NTPPacket); i++)
darran 0:55a05330f8cc 186 {
darran 1:4218cacaf696 187 DBG("%02x ", *((char*)&m_pkt + i));
darran 0:55a05330f8cc 188 }
darran 0:55a05330f8cc 189 DBG("\r\n\r\n");
darran 0:55a05330f8cc 190
darran 1:4218cacaf696 191 len = m_pUDPSocket->sendto( (char*)&m_pkt, sizeof(NTPPacket), &m_host );
darran 0:55a05330f8cc 192 if(len < sizeof(NTPPacket))
darran 0:55a05330f8cc 193 { onResult(NTP_PRTCL); close(); return; }
darran 0:55a05330f8cc 194
darran 0:55a05330f8cc 195 m_state = NTP_PONG;
darran 0:55a05330f8cc 196
darran 0:55a05330f8cc 197 break;
darran 0:55a05330f8cc 198
darran 0:55a05330f8cc 199 case NTP_PONG:
darran 0:55a05330f8cc 200 DBG("\r\nPong\r\n");
darran 1:4218cacaf696 201 while( len = m_pUDPSocket->recvfrom( (char*)&m_pkt, sizeof(NTPPacket), &host ) )
darran 0:55a05330f8cc 202 {
darran 0:55a05330f8cc 203 if( len <= 0 )
darran 0:55a05330f8cc 204 break;
darran 0:55a05330f8cc 205 if( !host.getIp().isEq(m_host.getIp()) )
darran 0:55a05330f8cc 206 continue; //Not our packet
darran 0:55a05330f8cc 207 if( len > 0 )
darran 0:55a05330f8cc 208 break;
darran 0:55a05330f8cc 209 }
darran 0:55a05330f8cc 210
darran 0:55a05330f8cc 211 if(len == 0)
darran 0:55a05330f8cc 212 return; //Wait for the next packet
darran 0:55a05330f8cc 213
darran 0:55a05330f8cc 214 if(len < 0)
darran 0:55a05330f8cc 215 { onResult(NTP_PRTCL); close(); return; }
darran 0:55a05330f8cc 216
darran 0:55a05330f8cc 217 if(len < sizeof(NTPPacket)) //TODO: Accept chunks
darran 0:55a05330f8cc 218 { onResult(NTP_PRTCL); close(); return; }
darran 0:55a05330f8cc 219
darran 0:55a05330f8cc 220 //Hex Dump:
darran 0:55a05330f8cc 221 DBG("\r\nDump Rx:\r\n");
darran 0:55a05330f8cc 222 for(int i = 0; i< sizeof(NTPPacket); i++)
darran 0:55a05330f8cc 223 {
darran 1:4218cacaf696 224 DBG("%02x ", *((char*)&m_pkt + i));
darran 0:55a05330f8cc 225 }
darran 0:55a05330f8cc 226 DBG("\r\n\r\n");
darran 0:55a05330f8cc 227
darran 1:4218cacaf696 228 if( m_pkt.stratum == 0) //Kiss of death message : Not good !
darran 0:55a05330f8cc 229 {
darran 0:55a05330f8cc 230 onResult(NTP_PRTCL); close(); return;
darran 0:55a05330f8cc 231 }
darran 0:55a05330f8cc 232
darran 0:55a05330f8cc 233 //Correct Endianness
darran 1:4218cacaf696 234 m_pkt.refTm_s = ntohl( m_pkt.refTm_s );
darran 1:4218cacaf696 235 m_pkt.refTm_f = ntohl( m_pkt.refTm_f );
darran 1:4218cacaf696 236 m_pkt.origTm_s = ntohl( m_pkt.origTm_s );
darran 1:4218cacaf696 237 m_pkt.origTm_f = ntohl( m_pkt.origTm_f );
darran 1:4218cacaf696 238 m_pkt.rxTm_s = ntohl( m_pkt.rxTm_s );
darran 1:4218cacaf696 239 m_pkt.rxTm_f = ntohl( m_pkt.rxTm_f );
darran 1:4218cacaf696 240 m_pkt.txTm_s = ntohl( m_pkt.txTm_s );
darran 1:4218cacaf696 241 m_pkt.txTm_f = ntohl( m_pkt.txTm_f );
darran 0:55a05330f8cc 242
darran 0:55a05330f8cc 243 //Compute offset, see RFC 4330 p.13
darran 0:55a05330f8cc 244 uint32_t destTm_s = (NTP_TIMESTAMP_DELTA + time(NULL));
darran 1:4218cacaf696 245 //int32_t origTm = (int32_t) ((uint64_t) m_pkt.origTm - NTP_TIMESTAMP_DELTA); //Convert in local 32 bits timestamps
darran 1:4218cacaf696 246 //int32_t rxTm = (int32_t) ((uint64_t) m_pkt.rxTm - NTP_TIMESTAMP_DELTA); //Convert in local 32 bits timestamps
darran 1:4218cacaf696 247 //int32_t txTm = (int32_t) ((uint64_t) m_pkt.txTm - NTP_TIMESTAMP_DELTA); //Convert in local 32 bits timestamps
darran 1:4218cacaf696 248 // int64_t offset = ( ( ( m_pkt.rxTm_s - m_pkt.origTm_s ) + ( m_pkt.txTm_s - destTm_s ) ) << 32 + ( ( m_pkt.rxTm_f - m_pkt.origTm_f ) + ( m_pkt.txTm_f - 0 ) ) ) / 2;
darran 1:4218cacaf696 249 int64_t offset = ( (int64_t)( m_pkt.rxTm_s - m_pkt.origTm_s ) + (int64_t) ( m_pkt.txTm_s - destTm_s ) ) / 2; //Avoid overflow
darran 1:4218cacaf696 250 DBG("\r\nSent @%d\r\n", m_pkt.txTm_s);
darran 0:55a05330f8cc 251 DBG("\r\nOffset: %d\r\n", offset);
darran 0:55a05330f8cc 252 //Set time accordingly
darran 0:55a05330f8cc 253 set_time( time(NULL) + (offset /*>> 32*/) );
darran 0:55a05330f8cc 254
darran 0:55a05330f8cc 255 onResult(NTP_OK);
darran 0:55a05330f8cc 256 close();
darran 0:55a05330f8cc 257
darran 0:55a05330f8cc 258 break;
darran 0:55a05330f8cc 259 }
darran 0:55a05330f8cc 260 }
darran 0:55a05330f8cc 261
darran 0:55a05330f8cc 262 void NTPClient::setTimeout(int ms)
darran 0:55a05330f8cc 263 {
darran 1:4218cacaf696 264 m_timeout = ms;
darran 0:55a05330f8cc 265 }
darran 0:55a05330f8cc 266
darran 0:55a05330f8cc 267 void NTPClient::resetTimeout()
darran 0:55a05330f8cc 268 {
darran 1:4218cacaf696 269 m_watchdog.reset();
darran 1:4218cacaf696 270 m_watchdog.start();
darran 0:55a05330f8cc 271 }
darran 0:55a05330f8cc 272
darran 0:55a05330f8cc 273 void NTPClient::onTimeout() //Connection has timed out
darran 0:55a05330f8cc 274 {
darran 0:55a05330f8cc 275 close();
darran 0:55a05330f8cc 276 onResult(NTP_TIMEOUT);
darran 0:55a05330f8cc 277 }
darran 0:55a05330f8cc 278
darran 0:55a05330f8cc 279 void NTPClient::onDNSReply(DNSReply r)
darran 0:55a05330f8cc 280 {
darran 0:55a05330f8cc 281 if(m_closed)
darran 0:55a05330f8cc 282 {
darran 0:55a05330f8cc 283 DBG("\r\nWARN: Discarded\r\n");
darran 0:55a05330f8cc 284 return;
darran 0:55a05330f8cc 285 }
darran 0:55a05330f8cc 286
darran 0:55a05330f8cc 287 if( r != DNS_FOUND )
darran 0:55a05330f8cc 288 {
darran 0:55a05330f8cc 289 DBG("\r\nCould not resolve hostname.\r\n");
darran 0:55a05330f8cc 290 onResult(NTP_DNS);
darran 0:55a05330f8cc 291 close();
darran 0:55a05330f8cc 292 return;
darran 0:55a05330f8cc 293 }
darran 1:4218cacaf696 294 DBG("\r\nDNS resolved.\r\n");
darran 0:55a05330f8cc 295 m_pDnsReq->close();
darran 0:55a05330f8cc 296 delete m_pDnsReq;
darran 0:55a05330f8cc 297 m_pDnsReq=NULL;
darran 1:4218cacaf696 298 open();
darran 0:55a05330f8cc 299 }
darran 0:55a05330f8cc 300
darran 0:55a05330f8cc 301 void NTPClient::onUDPSocketEvent(UDPSocketEvent e)
darran 0:55a05330f8cc 302 {
darran 1:4218cacaf696 303 resetTimeout();
darran 0:55a05330f8cc 304 switch(e)
darran 0:55a05330f8cc 305 {
darran 0:55a05330f8cc 306 case UDPSOCKET_READABLE: //The only event for now
darran 0:55a05330f8cc 307 resetTimeout();
darran 0:55a05330f8cc 308 process();
darran 0:55a05330f8cc 309 break;
darran 0:55a05330f8cc 310 }
darran 0:55a05330f8cc 311 }
darran 0:55a05330f8cc 312
darran 0:55a05330f8cc 313 void NTPClient::onResult(NTPResult r) //Must be called by impl when the request completes
darran 0:55a05330f8cc 314 {
darran 0:55a05330f8cc 315 if(m_pCbItem && m_pCbMeth)
darran 0:55a05330f8cc 316 (m_pCbItem->*m_pCbMeth)(r);
darran 0:55a05330f8cc 317 else if(m_pCb)
darran 0:55a05330f8cc 318 m_pCb(r);
darran 0:55a05330f8cc 319 m_blockingResult = r; //Blocking mode
darran 0:55a05330f8cc 320 }
darran 0:55a05330f8cc 321
darran 0:55a05330f8cc 322 NTPResult NTPClient::blockingProcess() //Called in blocking mode, calls Net::poll() until return code is available
darran 0:55a05330f8cc 323 {
darran 0:55a05330f8cc 324 m_blockingResult = NTP_PROCESSING;
darran 0:55a05330f8cc 325 do
darran 0:55a05330f8cc 326 {
darran 0:55a05330f8cc 327 Net::poll();
darran 0:55a05330f8cc 328 } while(m_blockingResult == NTP_PROCESSING);
darran 0:55a05330f8cc 329 Net::poll(); //Necessary for cleanup
darran 0:55a05330f8cc 330 return m_blockingResult;
darran 0:55a05330f8cc 331 }