source: trunk/libtransmission/platform.c @ 2202

Last change on this file since 2202 was 2202, checked in by charles, 14 years ago

Thread safety improvements. Also, stopping/starting/rechecking/etc. torrents no longer blocks the calling thread. Since this a big commit, it will probably create some short-term pain via new bugs.

  • Property svn:keywords set to Date Rev Author Id
File size: 18.0 KB
Line 
1/******************************************************************************
2 * $Id: platform.c 2202 2007-06-26 18:45:03Z charles $
3 *
4 * Copyright (c) 2005 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#ifdef SYS_BEOS
26  #include <fs_info.h>
27  #include <FindDirectory.h>
28#endif
29#include <sys/types.h>
30#include <dirent.h>
31
32#include "transmission.h"
33
34#if !defined( SYS_BEOS ) && !defined( __AMIGAOS4__ )
35
36#include <pwd.h>
37
38const char *
39tr_getHomeDirectory( void )
40{
41    static char     homeDirectory[MAX_PATH_LENGTH];
42    static int      init = 0;
43    char          * envHome;
44    struct passwd * pw;
45
46    if( init )
47    {
48        return homeDirectory;
49    }
50
51    envHome = getenv( "HOME" );
52    if( NULL == envHome )
53    {
54        pw = getpwuid( getuid() );
55        endpwent();
56        if( NULL == pw )
57        {
58            /* XXX need to handle this case */
59            return NULL;
60        }
61        envHome = pw->pw_dir;
62    }
63
64    snprintf( homeDirectory, MAX_PATH_LENGTH, "%s", envHome );
65    init = 1;
66
67    return homeDirectory;
68}
69
70#else
71
72const char *
73tr_getHomeDirectory( void )
74{
75    /* XXX */
76    return "";
77}
78
79#endif /* !SYS_BEOS && !__AMIGAOS4__ */
80
81static void
82tr_migrateResume( const char *oldDirectory, const char *newDirectory )
83{
84    DIR * dirh = opendir( oldDirectory );
85
86    if( dirh != NULL )
87    {
88        struct dirent * dirp;
89
90        while( ( dirp = readdir( dirh ) ) )
91        {
92            if( !strncmp( "resume.", dirp->d_name, 7 ) )
93            {
94                char o[MAX_PATH_LENGTH];
95                char n[MAX_PATH_LENGTH];
96                tr_buildPath( o, sizeof(o), oldDirectory, dirp->d_name, NULL );
97                tr_buildPath( n, sizeof(n), newDirectory, dirp->d_name, NULL );
98                rename( o, n );
99            }
100        }
101
102        closedir( dirh );
103    }
104}
105
106const char *
107tr_getPrefsDirectory( void )
108{
109    static char   buf[MAX_PATH_LENGTH];
110    static int    init = 0;
111    static size_t buflen = sizeof(buf);
112    const char* h;
113
114    if( init )
115        return buf;
116
117    h = tr_getHomeDirectory();
118#ifdef SYS_BEOS
119    find_directory( B_USER_SETTINGS_DIRECTORY,
120                    dev_for_path("/boot"), true, buf, buflen );
121    strcat( buf, "/Transmission" );
122#elif defined( SYS_DARWIN )
123    tr_buildPath ( buf, buflen, h,
124                  "Library", "Application Support", "Transmission", NULL );
125#elif defined(__AMIGAOS4__)
126    snprintf( buf, buflen, "PROGDIR:.transmission" );
127#else
128    tr_buildPath ( buf, buflen, h, ".transmission", NULL );
129#endif
130
131    tr_mkdir( buf );
132    init = 1;
133
134#ifdef SYS_DARWIN
135    char old[MAX_PATH_LENGTH];
136    tr_buildPath ( old, sizeof(old), h, ".transmission", NULL );
137    tr_migrateResume( old, buf );
138    rmdir( old );
139#endif
140
141    return buf;
142}
143
144const char *
145tr_getCacheDirectory( void )
146{
147    static char buf[MAX_PATH_LENGTH];
148    static int  init = 0;
149    static const size_t buflen = sizeof(buf);
150    const char * p;
151
152    if( init )
153        return buf;
154
155    p = tr_getPrefsDirectory();
156#ifdef SYS_BEOS
157    tr_buildPath( buf, buflen, p, "Cache", NULL );
158#elif defined( SYS_DARWIN )
159    tr_buildPath( buf, buflen, tr_getHomeDirectory(),
160                  "Library", "Caches", "Transmission", NULL );
161#else
162    tr_buildPath( buf, buflen, p, "cache", NULL );
163#endif
164
165    tr_mkdir( buf );
166    init = 1;
167
168    if( strcmp( p, buf ) )
169        tr_migrateResume( p, buf );
170
171    return buf;
172}
173
174const char *
175tr_getTorrentsDirectory( void )
176{
177    static char buf[MAX_PATH_LENGTH];
178    static int  init = 0;
179    static const size_t buflen = sizeof(buf);
180    const char * p;
181
182    if( init )
183        return buf;
184
185    p = tr_getPrefsDirectory ();
186
187#ifdef SYS_BEOS
188    tr_buildPath( buf, buflen, p, "Torrents", NULL );
189#elif defined( SYS_DARWIN )
190    tr_buildPath( buf, buflen, p, "Torrents", NULL );
191#else
192    tr_buildPath( buf, buflen, p, "torrents", NULL );
193#endif
194
195    tr_mkdir( buf );
196    init = 1;
197    return buf;
198}
199
200static void ThreadFunc( void * _t )
201{
202    tr_thread_t * t = _t;
203    char* name = tr_strdup( t->name );
204
205#ifdef SYS_BEOS
206    /* This is required because on BeOS, SIGINT is sent to each thread,
207       which kills them not nicely */
208    signal( SIGINT, SIG_IGN );
209#endif
210
211    tr_dbg( "Thread '%s' started", name );
212    t->func( t->arg );
213    tr_dbg( "Thread '%s' exited", name );
214    tr_free( name );
215}
216
217void tr_threadCreate( tr_thread_t * t,
218                      void (*func)(void *), void * arg,
219                      const char * name )
220{
221    t->func = func;
222    t->arg  = arg;
223    t->name = tr_strdup( name );
224#ifdef SYS_BEOS
225    t->thread = spawn_thread( (void *) ThreadFunc, name,
226                              B_NORMAL_PRIORITY, t );
227    resume_thread( t->thread );
228#else
229    pthread_create( &t->thread, NULL, (void *) ThreadFunc, t );
230#endif
231}
232
233const tr_thread_t THREAD_EMPTY = { NULL, NULL, NULL, 0 };
234
235void tr_threadJoin( tr_thread_t * t )
236{
237    if( t->func != NULL )
238    {
239#ifdef SYS_BEOS
240        long exit;
241        wait_for_thread( t->thread, &exit );
242#else
243        pthread_join( t->thread, NULL );
244#endif
245        tr_dbg( "Thread '%s' joined", t->name );
246        tr_free( t->name );
247        t->name = NULL;
248        t->func = NULL;
249    }
250}
251
252void tr_lockInit( tr_lock_t * l )
253{
254#ifdef SYS_BEOS
255    *l = create_sem( 1, "" );
256#else
257    pthread_mutex_init( l, NULL );
258#endif
259}
260
261void tr_lockClose( tr_lock_t * l )
262{
263#ifdef SYS_BEOS
264    delete_sem( *l );
265#else
266    pthread_mutex_destroy( l );
267#endif
268}
269
270int tr_lockTryLock( tr_lock_t * l )
271{
272#ifdef SYS_BEOS
273    #error how is this done in beos
274#else
275    /* success on zero! */
276    return pthread_mutex_trylock( l );
277#endif
278}
279
280void tr_lockLock( tr_lock_t * l )
281{
282#ifdef SYS_BEOS
283    acquire_sem( *l );
284#else
285    pthread_mutex_lock( l );
286#endif
287}
288
289void tr_lockUnlock( tr_lock_t * l )
290{
291#ifdef SYS_BEOS
292    release_sem( *l );
293#else
294    pthread_mutex_unlock( l );
295#endif
296}
297
298
299void tr_condInit( tr_cond_t * c )
300{
301#ifdef SYS_BEOS
302    *c = -1;
303#else
304    pthread_cond_init( c, NULL );
305#endif
306}
307
308void tr_condWait( tr_cond_t * c, tr_lock_t * l )
309{
310#ifdef SYS_BEOS
311    *c = find_thread( NULL );
312    release_sem( *l );
313    suspend_thread( *c );
314    acquire_sem( *l );
315    *c = -1;
316#else
317    pthread_cond_wait( c, l );
318#endif
319}
320
321void tr_condSignal( tr_cond_t * c )
322{
323#ifdef SYS_BEOS
324    while( *c != -1 )
325    {
326        thread_info info;
327        get_thread_info( *c, &info );
328        if( info.state == B_THREAD_SUSPENDED )
329        {
330            resume_thread( *c );
331            break;
332        }
333        snooze( 5000 );
334    }
335#else
336    pthread_cond_signal( c );
337#endif
338}
339void tr_condBroadcast( tr_cond_t * c )
340{
341#ifdef SYS_BEOS
342    #error how is this done in beos
343#else
344    pthread_cond_broadcast( c );
345#endif
346}
347
348void tr_condClose( tr_cond_t * c )
349{
350#ifdef SYS_BEOS
351    *c = -1; /* Shut up gcc */
352#else
353    pthread_cond_destroy( c );
354#endif
355}
356
357
358#if defined( BSD )
359
360#include <sys/sysctl.h>
361#include <net/route.h>
362
363static uint8_t *
364getroute( int * buflen );
365static int
366parseroutes( uint8_t * buf, int len, struct in_addr * addr );
367
368int
369tr_getDefaultRoute( struct in_addr * addr )
370{
371    uint8_t * buf;
372    int len;
373
374    buf = getroute( &len );
375    if( NULL == buf )
376    {
377        tr_err( "failed to get default route (BSD)" );
378        return 1;
379    }
380
381    len = parseroutes( buf, len, addr );
382    free( buf );
383
384    return len;
385}
386
387#ifndef SA_SIZE
388#define ROUNDUP( a, size ) \
389    ( ( (a) & ( (size) - 1 ) ) ? ( 1 + ( (a) | ( (size) - 1 ) ) ) : (a) )
390#define SA_SIZE( sap ) \
391    ( sap->sa_len ? ROUNDUP( (sap)->sa_len, sizeof( u_long ) ) : \
392                    sizeof( u_long ) )
393#endif /* !SA_SIZE */
394#define NEXT_SA( sap ) \
395    (struct sockaddr *) ( (caddr_t) (sap) + ( SA_SIZE( (sap) ) ) )
396
397static uint8_t *
398getroute( int * buflen )
399{
400    int     mib[6];
401    size_t  len;
402    uint8_t * buf;
403
404    mib[0] = CTL_NET;
405    mib[1] = PF_ROUTE;
406    mib[2] = 0;
407    mib[3] = AF_INET;
408    mib[4] = NET_RT_FLAGS;
409    mib[5] = RTF_GATEWAY;
410
411    if( sysctl( mib, 6, NULL, &len, NULL, 0 ) )
412    {
413        if( ENOENT != errno )
414        {
415            tr_err( "sysctl net.route.0.inet.flags.gateway failed (%s)",
416                    strerror( errno ) );
417        }
418        *buflen = 0;
419        return NULL;
420    }
421
422    buf = malloc( len );
423    if( NULL == buf )
424    {
425        *buflen = 0;
426        return NULL;
427    }
428
429    if( sysctl( mib, 6, buf, &len, NULL, 0 ) )
430    {
431        tr_err( "sysctl net.route.0.inet.flags.gateway failed (%s)",
432                strerror( errno ) );
433        free( buf );
434        *buflen = 0;
435        return NULL;
436    }
437
438    *buflen = len;
439
440    return buf;
441}
442
443static int
444parseroutes( uint8_t * buf, int len, struct in_addr * addr )
445{
446    uint8_t            * end;
447    struct rt_msghdr   * rtm;
448    struct sockaddr    * sa;
449    struct sockaddr_in * sin;
450    int                  ii;
451    struct in_addr       dest, gw;
452
453    end = buf + len;
454    while( end > buf + sizeof( *rtm ) )
455    {
456        rtm = (struct rt_msghdr *) buf;
457        buf += rtm->rtm_msglen;
458        if( end >= buf )
459        {
460            dest.s_addr = INADDR_NONE;
461            gw.s_addr   = INADDR_NONE;
462            sa = (struct sockaddr *) ( rtm + 1 );
463
464            for( ii = 0; ii < RTAX_MAX && (uint8_t *) sa < buf; ii++ )
465            {
466                if( buf < (uint8_t *) NEXT_SA( sa ) )
467                {
468                    break;
469                }
470
471                if( rtm->rtm_addrs & ( 1 << ii ) )
472                {
473                    if( AF_INET == sa->sa_family )
474                    {
475                        sin = (struct sockaddr_in *) sa;
476                        switch( ii )
477                        {
478                            case RTAX_DST:
479                                dest = sin->sin_addr;
480                                break;
481                            case RTAX_GATEWAY:
482                                gw = sin->sin_addr;
483                                break;
484                        }
485                    }
486                    sa = NEXT_SA( sa );
487                }
488            }
489
490            if( INADDR_ANY == dest.s_addr && INADDR_NONE != gw.s_addr )
491            {
492                *addr = gw;
493                return 0;
494            }
495        }
496    }
497
498    return 1;
499}
500
501#elif defined( linux ) || defined( __linux ) || defined( __linux__ )
502
503#include <linux/types.h>
504#include <linux/netlink.h>
505#include <linux/rtnetlink.h>
506
507#define SEQNUM 195909
508
509static int
510getsock( void );
511static uint8_t *
512getroute( int fd, unsigned int * buflen );
513static int
514parseroutes( uint8_t * buf, unsigned int len, struct in_addr * addr );
515
516int
517tr_getDefaultRoute( struct in_addr * addr )
518{
519    int fd, ret;
520    unsigned int len;
521    uint8_t * buf;
522
523    ret = 1;
524    fd = getsock();
525    if( 0 <= fd )
526    {
527        while( ret )
528        {
529            buf = getroute( fd, &len );
530            if( NULL == buf )
531            {
532                break;
533            }
534            ret = parseroutes( buf, len, addr );
535            free( buf );
536        }
537        close( fd );
538    }
539
540    if( ret )
541    {
542        tr_err( "failed to get default route (Linux)" );
543    }
544
545    return ret;
546}
547
548static int
549getsock( void )
550{
551    int fd, flags;
552    struct
553    {
554        struct nlmsghdr nlh;
555        struct rtgenmsg rtg;
556    } req;
557    struct sockaddr_nl snl;
558
559    fd = socket( PF_NETLINK, SOCK_DGRAM, NETLINK_ROUTE );
560    if( 0 > fd )
561    {
562        tr_err( "failed to create routing socket (%s)", strerror( errno ) );
563        return -1;
564    }
565
566    flags = fcntl( fd, F_GETFL );
567    if( 0 > flags || 0 > fcntl( fd, F_SETFL, O_NONBLOCK | flags ) )
568    {
569        tr_err( "failed to set socket nonblocking (%s)", strerror( errno ) );
570        close( fd );
571        return -1;
572    }
573
574    bzero( &snl, sizeof( snl ) );
575    snl.nl_family = AF_NETLINK;
576
577    bzero( &req, sizeof( req ) );
578    req.nlh.nlmsg_len = NLMSG_LENGTH( sizeof( req.rtg ) );
579    req.nlh.nlmsg_type = RTM_GETROUTE;
580    req.nlh.nlmsg_flags = NLM_F_REQUEST | NLM_F_DUMP;
581    req.nlh.nlmsg_seq = SEQNUM;
582    req.nlh.nlmsg_pid = 0;
583    req.rtg.rtgen_family = AF_INET;
584
585    if( 0 > sendto( fd, &req, sizeof( req ), 0,
586                    (struct sockaddr *) &snl, sizeof( snl ) ) )
587    {
588        tr_err( "failed to write to routing socket (%s)", strerror( errno ) );
589        close( fd );
590        return -1;
591    }
592
593    return fd;
594}
595
596static uint8_t *
597getroute( int fd, unsigned int * buflen )
598{
599    void             * buf;
600    unsigned int       len;
601    ssize_t            res;
602    struct sockaddr_nl snl;
603    socklen_t          slen;
604
605    len = 8192;
606    buf = calloc( 1, len );
607    if( NULL == buf )
608    {
609        *buflen = 0;
610        return NULL;
611    }
612
613    for( ;; )
614    {
615        bzero( &snl, sizeof( snl ) );
616        slen = sizeof( snl );
617        res = recvfrom( fd, buf, len, 0, (struct sockaddr *) &snl, &slen );
618        if( 0 > res )
619        {
620            if( EAGAIN != errno )
621            {
622                tr_err( "failed to read from routing socket (%s)",
623                        strerror( errno ) );
624            }
625            free( buf );
626            *buflen = 0;
627            return NULL;
628        }
629        if( slen < sizeof( snl ) || AF_NETLINK != snl.nl_family )
630        {
631            tr_err( "bad address" );
632            free( buf );
633            *buflen = 0;
634            return NULL;
635        }
636
637        if( 0 == snl.nl_pid )
638        {
639            break;
640        }
641    }
642
643    *buflen = res;
644
645    return buf;
646}
647
648static int
649parseroutes( uint8_t * buf, unsigned int len, struct in_addr * addr )
650{
651    struct nlmsghdr * nlm;
652    struct nlmsgerr * nle;
653    struct rtmsg    * rtm;
654    struct rtattr   * rta;
655    int               rtalen;
656    struct in_addr    gw, dst;
657
658    nlm = ( struct nlmsghdr * ) buf;
659    while( NLMSG_OK( nlm, len ) )
660    {
661        gw.s_addr = INADDR_ANY;
662        dst.s_addr = INADDR_ANY;
663        if( NLMSG_ERROR == nlm->nlmsg_type )
664        {
665            nle = (struct nlmsgerr *) NLMSG_DATA( nlm );
666            if( NLMSG_LENGTH( NLMSG_ALIGN( sizeof( struct nlmsgerr ) ) ) >
667                nlm->nlmsg_len )
668            {
669                tr_err( "truncated netlink error" );
670            }
671            else
672            {
673                tr_err( "netlink error (%s)", strerror( nle->error ) );
674            }
675            return 1;
676        }
677        else if( RTM_NEWROUTE == nlm->nlmsg_type && SEQNUM == nlm->nlmsg_seq &&
678                 getpid() == (pid_t) nlm->nlmsg_pid &&
679                 NLMSG_LENGTH( sizeof( struct rtmsg ) ) <= nlm->nlmsg_len )
680        {
681            rtm = NLMSG_DATA( nlm );
682            rta = RTM_RTA( rtm );
683            rtalen = RTM_PAYLOAD( nlm );
684
685            while( RTA_OK( rta, rtalen ) )
686            {
687                if( sizeof( struct in_addr ) <= RTA_PAYLOAD( rta ) )
688                {
689                    switch( rta->rta_type )
690                    {
691                        case RTA_GATEWAY:
692                            memcpy( &gw, RTA_DATA( rta ), sizeof( gw ) );
693                            break;
694                        case RTA_DST:
695                            memcpy( &dst, RTA_DATA( rta ), sizeof( dst ) );
696                            break;
697                    }
698                }
699                rta = RTA_NEXT( rta, rtalen );
700            }
701        }
702
703        if( INADDR_NONE != gw.s_addr && INADDR_ANY != gw.s_addr &&
704            INADDR_ANY == dst.s_addr )
705        {
706            *addr = gw;
707            return 0;
708        }
709
710        nlm = NLMSG_NEXT( nlm, len );
711    }
712
713    return 1;
714}
715
716#else /* not BSD or Linux */
717
718int
719tr_getDefaultRoute( struct in_addr * addr UNUSED )
720{
721    tr_inf( "don't know how to get default route on this platform" );
722    return 1;
723}
724
725#endif
726
727/***
728****
729***/
730
731static void
732tr_rwSignal( tr_rwlock_t * rw )
733{
734  if ( rw->wantToWrite )
735    tr_condSignal( &rw->writeCond );
736  else if ( rw->wantToRead )
737    tr_condBroadcast( &rw->readCond );
738}
739
740void
741tr_rwInit ( tr_rwlock_t * rw )
742{
743    memset( rw, 0, sizeof(tr_rwlock_t) );
744    tr_lockInit( &rw->lock );
745    tr_condInit( &rw->readCond );
746    tr_condInit( &rw->writeCond );
747}
748
749void
750tr_rwReaderLock( tr_rwlock_t * rw )
751{
752    tr_lockLock( &rw->lock );
753    rw->wantToRead++;
754    while( rw->haveWriter || rw->wantToWrite )
755        tr_condWait( &rw->readCond, &rw->lock );
756    rw->wantToRead--;
757    rw->readCount++;
758    tr_lockUnlock( &rw->lock );
759}
760
761int
762tr_rwReaderTrylock( tr_rwlock_t * rw )
763{
764    int ret = FALSE;
765    tr_lockLock( &rw->lock );
766    if ( !rw->haveWriter && !rw->wantToWrite ) {
767        rw->readCount++;
768        ret = TRUE;
769    }
770    tr_lockUnlock( &rw->lock );
771    return ret;
772
773}
774
775void
776tr_rwReaderUnlock( tr_rwlock_t * rw )
777{
778    tr_lockLock( &rw->lock );
779    --rw->readCount;
780    if( !rw->readCount )
781        tr_rwSignal( rw );
782    tr_lockUnlock( &rw->lock );
783}
784
785void
786tr_rwWriterLock( tr_rwlock_t * rw )
787{
788    tr_lockLock( &rw->lock );
789    rw->wantToWrite++;
790    while( rw->haveWriter || rw->readCount )
791        tr_condWait( &rw->writeCond, &rw->lock );
792    rw->wantToWrite--;
793    rw->haveWriter = TRUE;
794    tr_lockUnlock( &rw->lock );
795}
796
797int
798tr_rwWriterTrylock( tr_rwlock_t * rw )
799{
800    int ret = FALSE;
801    tr_lockLock( &rw->lock );
802    if( !rw->haveWriter && !rw->readCount )
803        ret = rw->haveWriter = TRUE;
804    tr_lockUnlock( &rw->lock );
805    return ret;
806}
807void
808tr_rwWriterUnlock( tr_rwlock_t * rw )
809{
810    tr_lockLock( &rw->lock );
811    rw->haveWriter = FALSE;
812    tr_rwSignal( rw );
813    tr_lockUnlock( &rw->lock );
814}
815
816void
817tr_rwClose( tr_rwlock_t * rw )
818{
819    tr_condClose( &rw->writeCond );
820    tr_condClose( &rw->readCond );
821    tr_lockClose( &rw->lock );
822}
Note: See TracBrowser for help on using the repository browser.