source: trunk/libtransmission/peerparse.h @ 1125

Last change on this file since 1125 was 1064, checked in by titer, 15 years ago

Adds progress in tr_peer_stat_t

  • Property svn:keywords set to Date Rev Author Id
File size: 14.5 KB
Line 
1/******************************************************************************
2 * $Id: peerparse.h 1064 2006-11-10 04:21:46Z livings124 $
3 *
4 * Copyright (c) 2005-2006 Transmission authors and contributors
5 *
6 * Permission is hereby granted, free of charge, to any person obtaining a
7 * copy of this software and associated documentation files (the "Software"),
8 * to deal in the Software without restriction, including without limitation
9 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
10 * and/or sell copies of the Software, and to permit persons to whom the
11 * Software is furnished to do so, subject to the following conditions:
12 *
13 * The above copyright notice and this permission notice shall be included in
14 * all copies or substantial portions of the Software.
15 *
16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
21 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
22 * DEALINGS IN THE SOFTWARE.
23 *****************************************************************************/
24
25/***********************************************************************
26 * This file handles all incoming messages
27 **********************************************************************/
28
29/***********************************************************************
30 * parseChoke
31 ***********************************************************************
32 *
33 **********************************************************************/
34static inline int parseChoke( tr_torrent_t * tor, tr_peer_t * peer,
35                              int len, int choking )
36{
37    tr_request_t * r;
38    int i;
39
40    if( len != 1 )
41    {
42        peer_dbg( "GET  %schoke, invalid", choking ? "" : "un" );
43        return 1;
44    }
45
46    peer_dbg( "GET  %schoke", choking ? "" : "un" );
47
48    peer->peerChoking = choking;
49
50    if( choking )
51    {
52        /* Discard all pending requests */
53        for( i = 0; i < peer->inRequestCount; i++ )
54        {
55            r = &peer->inRequests[i];
56            tr_cpDownloaderRem( tor->completion, tr_block(r->index,r->begin) );
57        }
58        peer->inRequestCount = 0;
59    }
60
61    return 0;
62}
63
64/***********************************************************************
65 * parseInterested
66 ***********************************************************************
67 *
68 **********************************************************************/
69static inline int parseInterested( tr_peer_t * peer, int len,
70                                   int interested )
71{
72    if( len != 1 )
73    {
74        peer_dbg( "GET  %sinterested, invalid", interested ? "" : "un" );
75        return 1;
76    }
77
78    peer_dbg( "GET  %sinterested", interested ? "" : "un" );
79
80    peer->peerInterested = interested;
81
82    return 0;
83}
84
85/***********************************************************************
86 * parseHave
87 ***********************************************************************
88 *
89 **********************************************************************/
90static inline int parseHave( tr_torrent_t * tor, tr_peer_t * peer,
91                             uint8_t * p, int len )
92{
93    uint32_t piece;
94
95    if( len != 5 )
96    {
97        peer_dbg( "GET  have, invalid" );
98        return 1;
99    }
100
101    TR_NTOHL( p, piece );
102
103    peer_dbg( "GET  have %d", piece );
104
105    if( !peer->bitfield )
106    {
107        peer->bitfield = calloc( ( tor->info.pieceCount + 7 ) / 8, 1 );
108    }
109    if( !tr_bitfieldHas( peer->bitfield, piece ) )
110    {
111        peer->pieceCount++;
112        peer->progress = (float) peer->pieceCount / tor->info.pieceCount;
113    }
114    tr_bitfieldAdd( peer->bitfield, piece );
115    updateInterest( tor, peer );
116
117    tr_rcTransferred( tor->swarmspeed, tor->info.pieceSize );
118
119    return 0;
120}
121
122static inline int parseBitfield( tr_torrent_t * tor, tr_peer_t * peer,
123                                 uint8_t * p, int len )
124{
125    tr_info_t * inf = &tor->info;
126    int bitfieldSize;
127    int i;
128
129    bitfieldSize = ( inf->pieceCount + 7 ) / 8;
130   
131    if( len != 1 + bitfieldSize )
132    {
133        peer_dbg( "GET  bitfield, wrong size" );
134        return 1;
135    }
136
137    /* Make sure the spare bits are unset */
138    if( ( inf->pieceCount & 0x7 ) )
139    {
140        uint8_t lastByte;
141       
142        lastByte   = p[bitfieldSize-1];
143        lastByte <<= inf->pieceCount & 0x7;
144        lastByte  &= 0xFF;
145
146        if( lastByte )
147        {
148            peer_dbg( "GET  bitfield, spare bits set" );
149            return 1;
150        }
151    }
152
153    peer_dbg( "GET  bitfield, ok" );
154
155    if( !peer->bitfield )
156    {
157        peer->bitfield = malloc( bitfieldSize );
158    }
159    memcpy( peer->bitfield, p, bitfieldSize );
160
161    peer->pieceCount = 0;
162    for( i = 0; i < inf->pieceCount; i++ )
163    {
164        if( tr_bitfieldHas( peer->bitfield, i ) )
165        {
166            peer->pieceCount++;
167        }
168    }
169    peer->progress = (float) peer->pieceCount / inf->pieceCount;
170
171    updateInterest( tor, peer );
172
173    return 0;
174}
175
176static inline int parseRequest( tr_peer_t * peer, uint8_t * p, int len )
177{
178    int index, begin, length;
179    tr_request_t * r;
180
181    if( len != 13 )
182    {
183        peer_dbg( "GET  request, invalid" );
184        return 1;
185    }
186
187    if( peer->amChoking )
188    {
189        /* Didn't he get it? */
190        sendChoke( peer, 1 );
191        return 0;
192    }
193   
194    TR_NTOHL( p,     index );
195    TR_NTOHL( &p[4], begin );
196    TR_NTOHL( &p[8], length );
197
198    peer_dbg( "GET  request %d/%d (%d bytes)",
199              index, begin, length );
200
201    /* TODO sanity checks (do we have the piece, etc) */
202
203    if( length > 16384 )
204    {
205        /* Sorry mate */
206        return 1;
207    }
208
209    if( peer->outRequestCount >= MAX_REQUEST_COUNT )
210    {
211        tr_err( "Too many requests" );
212        return 1;
213    }
214
215    r         = &peer->outRequests[peer->outRequestCount];
216    r->index  = index;
217    r->begin  = begin;
218    r->length = length;
219
220    (peer->outRequestCount)++;
221
222    return 0;
223}
224
225static inline int parsePiece( tr_torrent_t * tor, tr_peer_t * peer,
226                              uint8_t * p, int len )
227{
228    int index, begin, block, i, j;
229    tr_request_t * r;
230
231    TR_NTOHL( p,     index );
232    TR_NTOHL( &p[4], begin );
233
234    peer_dbg( "GET  piece %d/%d (%d bytes)",
235              index, begin, len - 9 );
236
237    if( peer->inRequestCount < 1 )
238    {
239        /* Our "cancel" was probably late */
240        peer_dbg( "not expecting a block" );
241        return 0;
242    }
243   
244    r = &peer->inRequests[0];
245    if( index != r->index || begin != r->begin )
246    {
247        int suckyClient;
248
249        /* Either our "cancel" was late, or this is a sucky
250           client that cannot deal with multiple requests */
251        suckyClient = 0;
252        for( i = 0; i < peer->inRequestCount; i++ )
253        {
254            r = &peer->inRequests[i];
255
256            if( index != r->index || begin != r->begin )
257            {
258                continue;
259            }
260
261            /* Sucky client, he dropped the previous requests */
262            peer_dbg( "block was expected later" );
263            for( j = 0; j < i; j++ )
264            {
265                r = &peer->inRequests[j];
266                tr_cpDownloaderRem( tor->completion,
267                                    tr_block(r->index,r->begin) );
268            }
269            suckyClient = 1;
270            peer->inRequestCount -= i;
271            memmove( &peer->inRequests[0], &peer->inRequests[i],
272                     peer->inRequestCount * sizeof( tr_request_t ) );
273            r = &peer->inRequests[0];
274            break;
275        }
276
277        if( !suckyClient )
278        {
279            r = &peer->inRequests[0];
280            peer_dbg( "wrong block (expecting %d/%d)",
281                      r->index, r->begin );
282            return 0;
283        }
284    }
285
286    if( len - 9 != r->length )
287    {
288        peer_dbg( "wrong size (expecting %d)", r->length );
289        return 1;
290    }
291
292    tor->downloadedCur += r->length;
293
294    block = tr_block( r->index, r->begin );
295    if( tr_cpBlockIsComplete( tor->completion, block ) )
296    {
297        peer_dbg( "have this block already" );
298        (peer->inRequestCount)--;
299        memmove( &peer->inRequests[0], &peer->inRequests[1],
300                 peer->inRequestCount * sizeof( tr_request_t ) );
301        return 0;
302    }
303
304    /* set blame/credit for this piece */
305    if( !peer->blamefield )
306    {
307        peer->blamefield = calloc( ( tor->info.pieceCount + 7 ) / 8, 1 );
308    }
309    tr_bitfieldAdd( peer->blamefield, index );
310
311    tr_cpBlockAdd( tor->completion, block );
312    tr_ioWrite( tor->io, index, begin, len - 9, &p[8] );
313    tr_cpDownloaderRem( tor->completion, block );
314
315    sendCancel( tor, block );
316
317    if( tr_cpPieceIsComplete( tor->completion, index ) )
318    {
319        tr_peer_t * otherPeer;
320
321        for( i = 0; i < tor->peerCount; i++ )
322        {
323            otherPeer = tor->peers[i];
324
325            if( otherPeer->status < PEER_STATUS_CONNECTED )
326            {
327                continue;
328            }
329
330            sendHave( otherPeer, index );
331            updateInterest( tor, otherPeer );
332        }
333    }
334
335    (peer->inRequestCount)--;
336    memmove( &peer->inRequests[0], &peer->inRequests[1],
337             peer->inRequestCount * sizeof( tr_request_t ) );
338
339    return 0;
340}
341
342static inline int parseCancel( tr_peer_t * peer, uint8_t * p, int len )
343{
344    int index, begin, length;
345    int i;
346    tr_request_t * r;
347
348    if( len != 13 )
349    {
350        peer_dbg( "GET  cancel, invalid" );
351        return 1;
352    }
353
354    TR_NTOHL( p,     index );
355    TR_NTOHL( &p[4], begin );
356    TR_NTOHL( &p[8], length );
357
358    peer_dbg( "GET  cancel %d/%d (%d bytes)",
359              index, begin, length );
360
361    for( i = 0; i < peer->outRequestCount; i++ )
362    {
363        r = &peer->outRequests[i];
364        if( r->index == index && r->begin == begin &&
365            r->length == length )
366        {
367            (peer->outRequestCount)--;
368            memmove( &r[0], &r[1], sizeof( tr_request_t ) *
369                    ( peer->outRequestCount - i ) );
370            break;
371        }
372    }
373
374    return 0;
375}
376
377static inline int parsePort( tr_peer_t * peer, uint8_t * p, int len )
378{
379    in_port_t port;
380
381    if( len != 3 )
382    {
383        peer_dbg( "GET  port, invalid" );
384        return 1;
385    }
386
387    port = *( (in_port_t *) p );
388    peer_dbg( "GET  port %d", ntohs( port ) );
389
390    return 0;
391}
392
393static inline int parseMessage( tr_torrent_t * tor, tr_peer_t * peer,
394                                uint8_t * p, int len )
395{
396    char id;
397
398    /* Type of the message */
399    id = *(p++);
400
401    switch( id )
402    {
403        case 0:
404            return parseChoke( tor, peer, len, 1 );
405        case 1:
406            return parseChoke( tor, peer, len, 0 );
407        case 2:
408            return parseInterested( peer, len, 1 );
409        case 3:
410            return parseInterested( peer, len, 0 );
411        case 4:
412            return parseHave( tor, peer, p, len );
413        case 5:
414            return parseBitfield( tor, peer, p, len );
415        case 6:
416            return parseRequest( peer, p, len );
417        case 7:
418            return parsePiece( tor, peer, p, len );
419        case 8:
420            return parseCancel( peer, p, len );
421        case 9:
422            return parsePort( peer, p, len );
423    }
424
425    peer_dbg( "Unknown message '%d'", id );
426    return 1;
427}
428
429static inline int parseBufHeader( tr_peer_t * peer )
430{
431    uint8_t * p   = peer->buf;
432
433    if( 4 > peer->pos )
434    {
435        return 0;
436    }
437
438    if( p[0] != 19 || memcmp( &p[1], "Bit", 3 ) )
439    {
440        /* Don't wait until we get 68 bytes, this is wrong
441           already */
442        peer_dbg( "GET  handshake, invalid" );
443        tr_netSend( peer->socket, (uint8_t *) "Nice try...\r\n", 13 );
444        return 1;
445    }
446    if( peer->pos < 68 )
447    {
448        return 0;
449    }
450    if( memcmp( &p[4], "Torrent protocol", 16 ) )
451    {
452        peer_dbg( "GET  handshake, invalid" );
453        return 1;
454    }
455
456    return 0;
457}
458
459static uint8_t * parseBufHash( tr_peer_t * peer )
460{
461    if( 48 > peer->pos )
462    {
463        return NULL;
464    }
465    else
466    {
467        return peer->buf + 28;
468    }
469}
470
471static inline int parseBuf( tr_torrent_t * tor, tr_peer_t * peer )
472{
473    tr_info_t * inf = &tor->info;
474
475    int       i;
476    int       len;
477    uint8_t * p   = peer->buf;
478    uint8_t * end = &p[peer->pos];
479
480    if( peer->banned )
481    {
482        /* Don't even parse, we only stay connected */
483        peer->pos = 0;
484        return 0;
485    }
486
487    while( peer->pos >= 4 )
488    {
489        if( peer->status & PEER_STATUS_HANDSHAKE )
490        {
491            char * client;
492
493            if( parseBufHeader( peer ) )
494            {
495                return 1;
496            }
497
498            if( peer->pos < 68 )
499            {
500                break;
501            }
502
503            if( memcmp( &p[28], inf->hash, 20 ) )
504            {
505                peer_dbg( "GET  handshake, wrong torrent hash" );
506                return 1;
507            }
508
509            if( !memcmp( &p[48], tor->id, 20 ) )
510            {
511                /* We are connected to ourselves... */
512                peer_dbg( "GET  handshake, that is us" );
513                return 1;
514            }
515
516            peer->status  = PEER_STATUS_CONNECTED;
517            memcpy( peer->id, &p[48], 20 );
518            p            += 68;
519            peer->pos    -= 68;
520
521            for( i = 0; i < tor->peerCount; i++ )
522            {
523                if( tor->peers[i] == peer )
524                {
525                    continue;
526                }
527                if( !peerCmp( peer, tor->peers[i] ) )
528                {
529                    peer_dbg( "GET  handshake, duplicate" );
530                    return 1;
531                }
532            }
533
534            client = tr_clientForId( (uint8_t *) peer->id );
535            peer_dbg( "GET  handshake, ok (%s)", client );
536            free( client );
537
538            sendBitfield( tor, peer );
539
540            continue;
541        }
542       
543        /* Get payload size */
544        TR_NTOHL( p, len );
545        p += 4;
546
547        if( len > 9 + tor->blockSize )
548        {
549            /* This should never happen. Drop that peer */
550            peer_dbg( "message too large (%d bytes)", len );
551            return 1;
552        }
553
554        if( !len )
555        {
556            /* keep-alive */
557            peer_dbg( "GET  keep-alive" );
558            peer->pos -= 4;
559            continue;
560        }
561
562        if( &p[len] > end )
563        {
564            /* We do not have the entire message */
565            p -= 4;
566            break;
567        }
568
569        /* Remaining data after this message */
570        peer->pos -= 4 + len;
571
572        if( parseMessage( tor, peer, p, len ) )
573        {
574            return 1;
575        }
576
577        p += len;
578    }
579
580    memmove( peer->buf, p, peer->pos );
581
582    return 0;
583}
Note: See TracBrowser for help on using the repository browser.