source: trunk/libtransmission/transmission.c @ 162

Last change on this file since 162 was 162, checked in by titer, 16 years ago

Merge from branches/new_api:r161

File size: 19.6 KB
Line 
1/******************************************************************************
2 * Copyright (c) 2005-2006 Transmission authors and contributors
3 *
4 * Permission is hereby granted, free of charge, to any person obtaining a
5 * copy of this software and associated documentation files (the "Software"),
6 * to deal in the Software without restriction, including without limitation
7 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
8 * and/or sell copies of the Software, and to permit persons to whom the
9 * Software is furnished to do so, subject to the following conditions:
10 *
11 * The above copyright notice and this permission notice shall be included in
12 * all copies or substantial portions of the Software.
13 *
14 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
17 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
18 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
19 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
20 * DEALINGS IN THE SOFTWARE.
21 *****************************************************************************/
22
23#include "transmission.h"
24
25/***********************************************************************
26 * Local prototypes
27 **********************************************************************/
28static void torrentReallyStop( tr_torrent_t * );
29static void  downloadLoop( void * );
30static void  acceptLoop( void * );
31static void acceptStop( tr_handle_t * h );
32
33/***********************************************************************
34 * tr_init
35 ***********************************************************************
36 * Allocates a tr_handle_t structure and initializes a few things
37 **********************************************************************/
38tr_handle_t * tr_init()
39{
40    tr_handle_t * h;
41    int           i, r;
42
43    h = calloc( sizeof( tr_handle_t ), 1 );
44
45    /* Generate a peer id : "-TRxxyy-" + 12 random alphanumeric
46       characters, where xx is the major version number and yy the
47       minor version number (Azureus-style) */
48    sprintf( h->id, "-TR%02d%02d-", VERSION_MAJOR, VERSION_MINOR );
49    for( i = 8; i < 20; i++ )
50    {
51        r        = tr_rand( 36 );
52        h->id[i] = ( r < 26 ) ? ( 'a' + r ) : ( '0' + r - 26 ) ;
53    }
54
55    /* Random key */
56    for( i = 0; i < 20; i++ )
57    {
58        r         = tr_rand( 36 );
59        h->key[i] = ( r < 26 ) ? ( 'a' + r ) : ( '0' + r - 26 ) ;
60    }
61
62    /* Don't exit when writing on a broken socket */
63    signal( SIGPIPE, SIG_IGN );
64
65    /* Initialize rate and file descripts controls */
66    h->upload   = tr_rcInit();
67    h->download = tr_rcInit();
68    h->fdlimit  = tr_fdInit();
69    h->choking  = tr_chokingInit( h );
70
71    h->bindPort = -1;
72    h->bindSocket = -1;
73
74    h->acceptDie = 0;
75    tr_lockInit( &h->acceptLock );
76    tr_threadCreate( &h->acceptThread, acceptLoop, h );
77
78    return h;
79}
80
81/***********************************************************************
82 * tr_setBindPort
83 ***********************************************************************
84 *
85 **********************************************************************/
86void tr_setBindPort( tr_handle_t * h, int port )
87{
88    int sock;
89    tr_torrent_t * tor;
90
91    if( h->bindPort == port )
92      return;
93
94#ifndef BEOS_NETSERVER
95    /* BeOS net_server seems to be unable to set incoming connections to
96       non-blocking. Too bad. */
97    if( !tr_fdSocketWillCreate( h->fdlimit, 0 ) )
98    {
99        /* XXX should handle failure here in a better way */
100        sock = tr_netBind( port );
101    }
102#else
103    return;
104#endif
105
106    tr_lockLock( &h->acceptLock );
107
108    h->bindPort = port;
109
110    for( tor = h->torrentList; tor; tor = tor->next )
111    {
112        tr_lockLock( &tor->lock );
113        if( NULL != tor->tracker )
114        {
115            tr_trackerChangePort( tor->tracker, port );
116        }
117        tr_lockUnlock( &tor->lock );
118    }
119
120    if( h->bindSocket > -1 )
121    {
122        tr_netClose( h->bindSocket );
123        tr_fdSocketClosed( h->fdlimit, 0 );
124    }
125
126    h->bindSocket = sock;
127
128    tr_lockUnlock( &h->acceptLock );
129}
130
131/***********************************************************************
132 * tr_setUploadLimit
133 ***********************************************************************
134 *
135 **********************************************************************/
136void tr_setUploadLimit( tr_handle_t * h, int limit )
137{
138    tr_rcSetLimit( h->upload, limit );
139    tr_chokingSetLimit( h->choking, limit );
140}
141
142/***********************************************************************
143 * tr_torrentRates
144 ***********************************************************************
145 *
146 **********************************************************************/
147void tr_torrentRates( tr_handle_t * h, float * dl, float * ul )
148{
149    tr_torrent_t * tor;
150
151    *dl = 0.0;
152    *ul = 0.0;
153    for( tor = h->torrentList; tor; tor = tor->next )
154    {
155        tr_lockLock( &tor->lock );
156        if( tor->status & TR_STATUS_DOWNLOAD )
157            *dl += tr_rcRate( tor->download );
158        *ul += tr_rcRate( tor->upload );
159        tr_lockUnlock( &tor->lock );
160    }
161}
162
163/***********************************************************************
164 * tr_torrentInit
165 ***********************************************************************
166 * Allocates a tr_torrent_t structure, then relies on tr_metainfoParse
167 * to fill it.
168 **********************************************************************/
169tr_torrent_t * tr_torrentInit( tr_handle_t * h, const char * path,
170                               int * error )
171{
172    tr_torrent_t  * tor, * tor_tmp;
173    tr_info_t     * inf;
174    int             i;
175    char          * s1, * s2;
176
177    tor = calloc( sizeof( tr_torrent_t ), 1 );
178    inf = &tor->info;
179
180    /* Parse torrent file */
181    if( tr_metainfoParse( inf, path ) )
182    {
183        *error = TR_EINVALID;
184        free( tor );
185        return NULL;
186    }
187
188    /* Make sure this torrent is not already open */
189    for( tor_tmp = h->torrentList; tor_tmp; tor_tmp = tor_tmp->next )
190    {
191        if( !memcmp( tor->info.hash, tor_tmp->info.hash,
192                     SHA_DIGEST_LENGTH ) )
193        {
194            *error = TR_EDUPLICATE;
195            free( tor );
196            return NULL;
197        }
198    }
199
200    tor->status = TR_STATUS_PAUSE;
201    tor->id     = h->id;
202    tor->key    = h->key;
203    tor->bindPort = &h->bindPort;
204        tor->finished = 0;
205
206
207    /* Guess scrape URL */
208    s1 = strchr( inf->trackerAnnounce, '/' );
209    while( ( s2 = strchr( s1 + 1, '/' ) ) )
210    {
211        s1 = s2;
212    }
213    s1++;
214    if( !strncmp( s1, "announce", 8 ) )
215    {
216        int pre  = (long) s1 - (long) inf->trackerAnnounce;
217        int post = strlen( inf->trackerAnnounce ) - pre - 8;
218        memcpy( tor->scrape, inf->trackerAnnounce, pre );
219        sprintf( &tor->scrape[pre], "scrape" );
220        memcpy( &tor->scrape[pre+6], &inf->trackerAnnounce[pre+8], post );
221    }
222
223    /* Escaped info hash for HTTP queries */
224    for( i = 0; i < SHA_DIGEST_LENGTH; i++ )
225    {
226        sprintf( &tor->hashString[3*i], "%%%02x", inf->hash[i] );
227    }
228
229    /* Block size: usually 16 ko, or less if we have to */
230    tor->blockSize  = MIN( inf->pieceSize, 1 << 14 );
231    tor->blockCount = ( inf->totalSize + tor->blockSize - 1 ) /
232                        tor->blockSize;
233    tor->completion = tr_cpInit( tor );
234
235    tr_lockInit( &tor->lock );
236
237    tor->globalUpload   = h->upload;
238    tor->globalDownload = h->download;
239    tor->fdlimit        = h->fdlimit;
240    tor->upload         = tr_rcInit();
241    tor->download       = tr_rcInit();
242 
243    /* We have a new torrent */
244    tr_lockLock( &h->acceptLock );
245    tor->prev = NULL;
246    tor->next = h->torrentList;
247    if( tor->next )
248    {
249        tor->next->prev = tor;
250    }
251    h->torrentList = tor;
252    (h->torrentCount)++;
253    tr_lockUnlock( &h->acceptLock );
254
255    return tor;
256}
257
258tr_info_t * tr_torrentInfo( tr_torrent_t * tor )
259{
260    return &tor->info;
261}
262
263/***********************************************************************
264 * tr_torrentScrape
265 **********************************************************************/
266int tr_torrentScrape( tr_torrent_t * tor, int * s, int * l )
267{
268    return tr_trackerScrape( tor, s, l );
269}
270
271void tr_torrentSetFolder( tr_torrent_t * tor, const char * path )
272{
273    tor->destination = strdup( path );
274}
275
276char * tr_torrentGetFolder( tr_torrent_t * tor )
277{
278    return tor->destination;
279}
280
281void tr_torrentStart( tr_torrent_t * tor )
282{
283    if( tor->status & ( TR_STATUS_STOPPING | TR_STATUS_STOPPED ) )
284    {
285        /* Join the thread first */
286        torrentReallyStop( tor );
287    }
288
289    tor->status  = TR_STATUS_CHECK;
290    tor->tracker = tr_trackerInit( tor );
291
292    tor->date = tr_date();
293    tor->die = 0;
294    tr_threadCreate( &tor->thread, downloadLoop, tor );
295}
296
297void tr_torrentStop( tr_torrent_t * tor )
298{
299    tr_lockLock( &tor->lock );
300    tr_trackerStopped( tor->tracker );
301    tr_rcReset( tor->download );
302    tr_rcReset( tor->upload );
303    tor->status = TR_STATUS_STOPPING;
304    tor->stopDate = tr_date();
305    tr_lockUnlock( &tor->lock );
306}
307
308/***********************************************************************
309 * torrentReallyStop
310 ***********************************************************************
311 * Joins the download thread and frees/closes everything related to it.
312 **********************************************************************/
313static void torrentReallyStop( tr_torrent_t * tor )
314{
315    tor->die = 1;
316    tr_threadJoin( &tor->thread );
317    tr_dbg( "Thread joined" );
318
319    tr_trackerClose( tor->tracker );
320
321    while( tor->peerCount > 0 )
322    {
323        tr_peerRem( tor, 0 );
324    }
325}
326
327/***********************************************************************
328 * tr_torrentCount
329 ***********************************************************************
330 *
331 **********************************************************************/
332int tr_torrentCount( tr_handle_t * h )
333{
334    return h->torrentCount;
335}
336
337void tr_torrentIterate( tr_handle_t * h, tr_callback_t func, void * d )
338{
339    tr_torrent_t * tor;
340
341    for( tor = h->torrentList; tor; tor = tor->next )
342    {
343        func( tor, d );
344    }
345}
346
347int tr_getFinished( tr_torrent_t * tor )
348{
349    if( tor->finished )
350    {
351        tor->finished = 0;
352        return 1;
353    }
354    return 0;
355}
356
357tr_stat_t * tr_torrentStat( tr_torrent_t * tor )
358{
359    tr_stat_t * s;
360    tr_info_t * inf = &tor->info;
361    int i;
362
363    tor->statCur = ( tor->statCur + 1 ) % 2;
364    s = &tor->stats[tor->statCur];
365
366    if( ( tor->status & TR_STATUS_STOPPED ) ||
367        ( ( tor->status & TR_STATUS_STOPPING ) &&
368          tr_date() > tor->stopDate + 60000 ) )
369    {
370        torrentReallyStop( tor );
371        tor->status = TR_STATUS_PAUSE;
372    }
373
374    tr_lockLock( &tor->lock );
375
376    s->status = tor->status;
377    memcpy( s->trackerError, tor->trackerError,
378            sizeof( s->trackerError ) );
379
380    s->peersTotal       = 0;
381    s->peersUploading   = 0;
382    s->peersDownloading = 0;
383
384    for( i = 0; i < tor->peerCount; i++ )
385    {
386        if( tr_peerIsConnected( tor->peers[i] ) )
387        {
388            (s->peersTotal)++;
389            if( tr_peerIsUploading( tor->peers[i] ) )
390            {
391                (s->peersUploading)++;
392            }
393            if( tr_peerIsDownloading( tor->peers[i] ) )
394            {
395                (s->peersDownloading)++;
396            }
397        }
398    }
399
400    s->progress = tr_cpCompletionAsFloat( tor->completion );
401    if( tor->status & TR_STATUS_DOWNLOAD )
402        s->rateDownload = tr_rcRate( tor->download );
403    else
404        /* tr_rcRate() doesn't make the difference between 'piece'
405           messages and other messages, which causes a non-zero
406           download rate even tough we are not downloading. So we
407           force it to zero not to confuse the user. */
408        s->rateDownload = 0.0;
409    s->rateUpload = tr_rcRate( tor->upload );
410   
411    s->seeders    = tr_trackerSeeders(tor);
412        s->leechers       = tr_trackerLeechers(tor);
413
414    if( s->rateDownload < 0.1 )
415    {
416        s->eta = -1;
417    }
418    else
419    {
420        s->eta = (float) ( 1.0 - s->progress ) *
421            (float) inf->totalSize / s->rateDownload / 1024.0;
422        if( s->eta > 99 * 3600 + 59 * 60 + 59 )
423        {
424            s->eta = -1;
425        }
426    }
427
428    s->downloaded = tor->downloaded;
429    s->uploaded   = tor->uploaded;
430
431    tr_lockUnlock( &tor->lock );
432
433    return s;
434}
435
436void tr_torrentAvailability( tr_torrent_t * tor, int8_t * tab, int size )
437{
438    int i, j, piece;
439
440    tr_lockLock( &tor->lock );
441    for( i = 0; i < size; i++ )
442    {
443        piece = i * tor->info.pieceCount / size;
444
445        if( tr_cpPieceIsComplete( tor->completion, piece ) )
446        {
447            tab[i] = -1;
448            continue;
449        }
450
451        tab[i] = 0;
452        for( j = 0; j < tor->peerCount; j++ )
453        {
454            if( tr_peerBitfield( tor->peers[j] ) &&
455                tr_bitfieldHas( tr_peerBitfield( tor->peers[j] ), piece ) )
456            {
457                (tab[i])++;
458            }
459        }
460    }
461    tr_lockUnlock( &tor->lock );
462}
463
464/***********************************************************************
465 * tr_torrentClose
466 ***********************************************************************
467 * Frees memory allocated by tr_torrentInit.
468 **********************************************************************/
469void tr_torrentClose( tr_handle_t * h, tr_torrent_t * tor )
470{
471    tr_info_t * inf = &tor->info;
472
473    if( tor->status & ( TR_STATUS_STOPPING | TR_STATUS_STOPPED ) )
474    {
475        /* Join the thread first */
476        torrentReallyStop( tor );
477    }
478
479    tr_lockLock( &h->acceptLock );
480
481    h->torrentCount--;
482
483    tr_lockClose( &tor->lock );
484    tr_cpClose( tor->completion );
485
486    tr_rcClose( tor->upload );
487    tr_rcClose( tor->download );
488
489    if( tor->destination )
490    {
491        free( tor->destination );
492    }
493    free( inf->pieces );
494    free( inf->files );
495
496    if( tor->prev )
497    {
498        tor->prev->next = tor->next;
499    }
500    else
501    {
502        h->torrentList = tor->next;
503    }
504    if( tor->next )
505    {
506        tor->next->prev = tor->prev;
507    }
508    free( tor );
509
510    tr_lockUnlock( &h->acceptLock );
511}
512
513void tr_close( tr_handle_t * h )
514{
515    acceptStop( h );
516    tr_chokingClose( h->choking );
517    tr_fdClose( h->fdlimit );
518    tr_rcClose( h->upload );
519    tr_rcClose( h->download );
520    free( h );
521}
522
523/***********************************************************************
524 * downloadLoop
525 **********************************************************************/
526static void downloadLoop( void * _tor )
527{
528    tr_torrent_t * tor = _tor;
529    uint64_t       date1, date2;
530
531    tr_dbg( "Thread started" );
532
533#ifdef SYS_BEOS
534    /* This is required because on BeOS, SIGINT is sent to each thread,
535       which kills them not nicely */
536    signal( SIGINT, SIG_IGN );
537#endif
538
539    tr_lockLock( &tor->lock );
540
541    tr_cpReset( tor->completion );
542    tor->io     = tr_ioInit( tor );
543    tor->status = tr_cpIsSeeding( tor->completion ) ?
544                      TR_STATUS_SEED : TR_STATUS_DOWNLOAD;
545
546    while( !tor->die )
547    {
548        date1 = tr_date();
549
550        /* Are we finished ? */
551        if( ( tor->status & TR_STATUS_DOWNLOAD ) &&
552            tr_cpIsSeeding( tor->completion ) )
553        {
554            /* Done */
555            tor->status = TR_STATUS_SEED;
556                        tor->finished = 1;
557            tr_trackerCompleted( tor->tracker );
558            tr_ioSaveResume( tor->io );
559        }
560
561        /* Receive/send messages */
562        tr_peerPulse( tor );
563
564        /* Try to get new peers or to send a message to the tracker */
565        tr_trackerPulse( tor->tracker );
566
567        if( tor->status & TR_STATUS_STOPPED )
568        {
569            break;
570        }
571
572        /* Wait up to 20 ms */
573        date2 = tr_date();
574        if( date2 < date1 + 20 )
575        {
576            tr_lockUnlock( &tor->lock );
577            tr_wait( date1 + 20 - date2 );
578            tr_lockLock( &tor->lock );
579        }
580    }
581
582    tr_lockUnlock( &tor->lock );
583
584    tr_ioClose( tor->io );
585
586    tor->status = TR_STATUS_STOPPED;
587
588    tr_dbg( "Thread exited" );
589}
590
591/***********************************************************************
592 * acceptLoop
593 **********************************************************************/
594static void acceptLoop( void * _h )
595{
596    tr_handle_t * h = _h;
597    uint64_t      date1, date2, lastchoke = 0;
598    int           ii;
599    uint8_t     * hash;
600    tr_torrent_t * tor;
601
602    tr_dbg( "Accept thread started" );
603
604#ifdef SYS_BEOS
605    /* This is required because on BeOS, SIGINT is sent to each thread,
606       which kills them not nicely */
607    signal( SIGINT, SIG_IGN );
608#endif
609
610    tr_lockLock( &h->acceptLock );
611
612    while( !h->acceptDie )
613    {
614        date1 = tr_date();
615
616        /* Check for incoming connections */
617        if( h->bindSocket > -1 &&
618            h->acceptPeerCount < TR_MAX_PEER_COUNT &&
619            !tr_fdSocketWillCreate( h->fdlimit, 0 ) )
620        {
621            int            s;
622            struct in_addr addr;
623            in_port_t      port;
624            s = tr_netAccept( h->bindSocket, &addr, &port );
625            if( s > -1 )
626            {
627                h->acceptPeers[h->acceptPeerCount++] = tr_peerInit( addr, port, s );
628            }
629            else
630            {
631                tr_fdSocketClosed( h->fdlimit, 0 );
632            }
633        }
634
635        for( ii = 0; ii < h->acceptPeerCount; )
636        {
637            if( tr_peerRead( NULL, h->acceptPeers[ii] ) )
638            {
639                tr_peerDestroy( h->fdlimit, h->acceptPeers[ii] );
640                goto removePeer;
641            }
642            if( NULL != ( hash = tr_peerHash( h->acceptPeers[ii] ) ) )
643            {
644                for( tor = h->torrentList; tor; tor = tor->next )
645                {
646                    tr_lockLock( &tor->lock );
647                    if( 0 == memcmp( tor->info.hash, hash,
648                                     SHA_DIGEST_LENGTH ) )
649                    {
650                      tr_peerAttach( tor, h->acceptPeers[ii] );
651                      tr_lockUnlock( &tor->lock );
652                      goto removePeer;
653                    }
654                    tr_lockUnlock( &tor->lock );
655                }
656                tr_peerDestroy( h->fdlimit, h->acceptPeers[ii] );
657                goto removePeer;
658            }
659            if( date1 > tr_peerDate( h->acceptPeers[ii] ) + 10000 )
660            {
661                /* Give them 10 seconds to send the handshake */
662                tr_peerDestroy( h->fdlimit, h->acceptPeers[ii] );
663                goto removePeer;
664            }
665            ii++;
666            continue;
667           removePeer:
668            h->acceptPeerCount--;
669            memmove( &h->acceptPeers[ii], &h->acceptPeers[ii+1],
670                     ( h->acceptPeerCount - ii ) * sizeof( tr_peer_t * ) );
671        }
672
673        if( date1 > lastchoke + 2000 )
674        {
675            tr_chokingPulse( h->choking );
676            lastchoke = date1;
677        }
678
679        /* Wait up to 20 ms */
680        date2 = tr_date();
681        if( date2 < date1 + 20 )
682        {
683            tr_lockUnlock( &h->acceptLock );
684            tr_wait( date1 + 20 - date2 );
685            tr_lockLock( &h->acceptLock );
686        }
687    }
688
689    tr_lockUnlock( &h->acceptLock );
690
691    tr_dbg( "Accept thread exited" );
692}
693
694/***********************************************************************
695 * acceptStop
696 ***********************************************************************
697 * Joins the accept thread and frees/closes everything related to it.
698 **********************************************************************/
699static void acceptStop( tr_handle_t * h )
700{
701    int ii;
702
703    h->acceptDie = 1;
704    tr_threadJoin( &h->acceptThread );
705    tr_lockClose( &h->acceptLock );
706    tr_dbg( "Accept thread joined" );
707
708    for( ii = 0; ii < h->acceptPeerCount; ii++ )
709    {
710        tr_peerDestroy( h->fdlimit, h->acceptPeers[ii] );
711    }
712
713    if( h->bindSocket > -1 )
714    {
715        tr_netClose( h->bindSocket );
716        tr_fdSocketClosed( h->fdlimit, 0 );
717    }
718}
Note: See TracBrowser for help on using the repository browser.