NetTribute library with debug turned on in FShandler Donatien Garner -> Segundo Equipo -> this version

Committer:
hexley
Date:
Fri Nov 19 01:54:45 2010 +0000
Revision:
0:281d6ff68967

        

Who changed what in which revision?

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