transmission/libtransmission/platform.c

824 lines
19 KiB
C

/******************************************************************************
* $Id$
*
* Copyright (c) 2005 Transmission authors and contributors
*
* Permission is hereby granted, free of charge, to any person obtaining a
* copy of this software and associated documentation files (the "Software"),
* to deal in the Software without restriction, including without limitation
* the rights to use, copy, modify, merge, publish, distribute, sublicense,
* and/or sell copies of the Software, and to permit persons to whom the
* Software is furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
* FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
* DEALINGS IN THE SOFTWARE.
*****************************************************************************/
#include <assert.h>
#include <errno.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#ifdef __BEOS__
#include <signal.h>
#include <fs_info.h>
#include <FindDirectory.h>
#include <kernel/OS.h>
#define BEOS_MAX_THREADS 256
#elif defined(WIN32)
#include <windows.h>
#include <shlobj.h> /* for CSIDL_APPDATA, CSIDL_PROFILE */
#else
#define _XOPEN_SOURCE 500 /* needed for recursive locks. */
#ifndef __USE_UNIX98
#define __USE_UNIX98 /* some older Linuxes need it spelt out for them */
#endif
#include <pthread.h>
#endif
#include <sys/types.h>
#include <dirent.h>
#include <fcntl.h>
#include <unistd.h> /* getuid getpid close */
#include "transmission.h"
#include "list.h"
#include "net.h"
#include "platform.h"
#include "utils.h"
/***
**** THREADS
***/
#ifdef __BEOS__
typedef thread_id tr_thread_id;
#elif defined(WIN32)
typedef DWORD tr_thread_id;
#else
typedef pthread_t tr_thread_id;
#endif
static tr_thread_id
tr_getCurrentThread( void )
{
#ifdef __BEOS__
return find_thread( NULL );
#elif defined(WIN32)
return GetCurrentThreadId();
#else
return pthread_self( );
#endif
}
static int
tr_areThreadsEqual( tr_thread_id a, tr_thread_id b )
{
#ifdef __BEOS__
return a == b;
#elif defined(WIN32)
return a == b;
#else
return pthread_equal( a, b );
#endif
}
struct tr_thread
{
void (* func ) ( void * );
void * arg;
const char * name;
#ifdef __BEOS__
thread_id thread;
#elif defined(WIN32)
HANDLE thread;
unsigned int thread_id;
#else
pthread_t thread;
#endif
};
int
tr_amInThread ( const tr_thread * t )
{
return tr_areThreadsEqual( tr_getCurrentThread(), t->thread );
}
#ifdef WIN32
#define ThreadFuncReturnType unsigned WINAPI
#else
#define ThreadFuncReturnType void
#endif
static ThreadFuncReturnType
ThreadFunc( void * _t )
{
tr_thread * t = _t;
const char * name = t->name;
#ifdef __BEOS__
/* This is required because on BeOS, SIGINT is sent to each thread,
which kills them not nicely */
signal( SIGINT, SIG_IGN );
#endif
tr_dbg( "Thread '%s' started", name );
t->func( t->arg );
tr_dbg( "Thread '%s' exited", name );
#ifdef WIN32
_endthreadex( 0 );
return 0;
#endif
}
tr_thread *
tr_threadNew( void (*func)(void *),
void * arg,
const char * name )
{
tr_thread * t = tr_new0( tr_thread, 1 );
t->func = func;
t->arg = arg;
t->name = name;
#ifdef __BEOS__
t->thread = spawn_thread( (void*)ThreadFunc, name, B_NORMAL_PRIORITY, t );
resume_thread( t->thread );
#elif defined(WIN32)
t->thread = (HANDLE) _beginthreadex( NULL, 0, &ThreadFunc, t, 0, &t->thread_id );
#else
pthread_create( &t->thread, NULL, (void * (*) (void *)) ThreadFunc, t );
#endif
return t;
}
void
tr_threadJoin( tr_thread * t )
{
if( t != NULL )
{
#ifdef __BEOS__
long exit;
wait_for_thread( t->thread, &exit );
#elif defined(WIN32)
WaitForSingleObject( t->thread, INFINITE );
CloseHandle( t->thread );
#else
pthread_join( t->thread, NULL );
#endif
tr_dbg( "Thread '%s' joined", t->name );
t->name = NULL;
t->func = NULL;
tr_free( t );
}
}
/***
**** LOCKS
***/
struct tr_lock
{
int depth;
#ifdef __BEOS__
sem_id lock;
thread_id lockThread;
#elif defined(WIN32)
CRITICAL_SECTION lock;
DWORD lockThread;
#else
pthread_mutex_t lock;
pthread_t lockThread;
#endif
};
tr_lock*
tr_lockNew( void )
{
tr_lock * l = tr_new0( tr_lock, 1 );
#ifdef __BEOS__
l->lock = create_sem( 1, "" );
#elif defined(WIN32)
InitializeCriticalSection( &l->lock ); /* critical sections support recursion */
#else
pthread_mutexattr_t attr;
pthread_mutexattr_init( &attr );
pthread_mutexattr_settype( &attr, PTHREAD_MUTEX_RECURSIVE );
pthread_mutex_init( &l->lock, &attr );
#endif
return l;
}
void
tr_lockFree( tr_lock * l )
{
#ifdef __BEOS__
delete_sem( l->lock );
#elif defined(WIN32)
DeleteCriticalSection( &l->lock );
#else
pthread_mutex_destroy( &l->lock );
#endif
tr_free( l );
}
void
tr_lockLock( tr_lock * l )
{
#ifdef __BEOS__
acquire_sem( l->lock );
#elif defined(WIN32)
EnterCriticalSection( &l->lock );
#else
pthread_mutex_lock( &l->lock );
#endif
assert( l->depth >= 0 );
if( l->depth )
assert( tr_areThreadsEqual( l->lockThread, tr_getCurrentThread() ) );
l->lockThread = tr_getCurrentThread( );
++l->depth;
}
int
tr_lockHave( const tr_lock * l )
{
return ( l->depth > 0 )
&& ( tr_areThreadsEqual( l->lockThread, tr_getCurrentThread() ) );
}
void
tr_lockUnlock( tr_lock * l )
{
assert( l->depth > 0 );
assert( tr_areThreadsEqual( l->lockThread, tr_getCurrentThread() ));
--l->depth;
assert( l->depth >= 0 );
#ifdef __BEOS__
release_sem( l->lock );
#elif defined(WIN32)
LeaveCriticalSection( &l->lock );
#else
pthread_mutex_unlock( &l->lock );
#endif
}
/***
**** PATHS
***/
#if !defined(WIN32) && !defined(__BEOS__) && !defined(__AMIGAOS4__)
#include <pwd.h>
#endif
const char *
tr_getHomeDirectory( void )
{
static char buf[MAX_PATH_LENGTH];
static int init = 0;
const char * envHome;
if( init )
return buf;
envHome = getenv( "HOME" );
if( envHome )
snprintf( buf, sizeof(buf), "%s", envHome );
else {
#ifdef WIN32
SHGetFolderPath( NULL, CSIDL_PROFILE, NULL, 0, buf );
#elif defined(__BEOS__) || defined(__AMIGAOS4__)
*buf = '\0';
#else
struct passwd * pw = getpwuid( getuid() );
endpwent();
if( pw != NULL )
snprintf( buf, sizeof(buf), "%s", pw->pw_dir );
#endif
}
init = 1;
return buf;
}
static void
tr_migrateResume( const char *oldDirectory, const char *newDirectory )
{
DIR * dirh = opendir( oldDirectory );
if( dirh != NULL )
{
struct dirent * dirp;
while( ( dirp = readdir( dirh ) ) )
{
if( !strncmp( "resume.", dirp->d_name, 7 ) )
{
char o[MAX_PATH_LENGTH];
char n[MAX_PATH_LENGTH];
tr_buildPath( o, sizeof(o), oldDirectory, dirp->d_name, NULL );
tr_buildPath( n, sizeof(n), newDirectory, dirp->d_name, NULL );
rename( o, n );
}
}
closedir( dirh );
}
}
const char *
tr_getPrefsDirectory( void )
{
static char buf[MAX_PATH_LENGTH];
static int init = 0;
static size_t buflen = sizeof(buf);
const char* h;
if( init )
return buf;
h = tr_getHomeDirectory();
#ifdef __BEOS__
find_directory( B_USER_SETTINGS_DIRECTORY,
dev_for_path("/boot"), true, buf, buflen );
strcat( buf, "/Transmission" );
#elif defined( SYS_DARWIN )
tr_buildPath ( buf, buflen, h,
"Library", "Application Support", "Transmission", NULL );
#elif defined(__AMIGAOS4__)
snprintf( buf, buflen, "PROGDIR:.transmission" );
#elif defined(WIN32)
{
char tmp[MAX_PATH_LENGTH];
SHGetFolderPath( NULL, CSIDL_APPDATA, NULL, 0, tmp );
tr_buildPath( buf, sizeof(buf), tmp, "Transmission", NULL );
buflen = strlen( buf );
}
#else
tr_buildPath ( buf, buflen, h, ".transmission", NULL );
#endif
tr_mkdirp( buf, 0700 );
init = 1;
#ifdef SYS_DARWIN
char old[MAX_PATH_LENGTH];
tr_buildPath ( old, sizeof(old), h, ".transmission", NULL );
tr_migrateResume( old, buf );
rmdir( old );
#endif
return buf;
}
const char *
tr_getCacheDirectory( void )
{
static char buf[MAX_PATH_LENGTH];
static int init = 0;
static const size_t buflen = sizeof(buf);
const char * p;
if( init )
return buf;
p = tr_getPrefsDirectory();
#if defined(__BEOS__) || defined(WIN32)
tr_buildPath( buf, buflen, p, "Cache", NULL );
#elif defined( SYS_DARWIN )
tr_buildPath( buf, buflen, tr_getHomeDirectory(),
"Library", "Caches", "Transmission", NULL );
#else
tr_buildPath( buf, buflen, p, "cache", NULL );
#endif
tr_mkdirp( buf, 0700 );
init = 1;
if( strcmp( p, buf ) )
tr_migrateResume( p, buf );
return buf;
}
const char *
tr_getTorrentsDirectory( void )
{
static char buf[MAX_PATH_LENGTH];
static int init = 0;
static const size_t buflen = sizeof(buf);
const char * p;
if( init )
return buf;
p = tr_getPrefsDirectory ();
#if defined(__BEOS__) || defined(WIN32)
tr_buildPath( buf, buflen, p, "Torrents", NULL );
#elif defined( SYS_DARWIN )
tr_buildPath( buf, buflen, p, "Torrents", NULL );
#else
tr_buildPath( buf, buflen, p, "torrents", NULL );
#endif
tr_mkdirp( buf, 0700 );
init = 1;
return buf;
}
/***
**** SOCKETS
***/
#ifdef BSD
#include <sys/types.h>
#include <sys/socket.h>
#include <netinet/in.h>
#include <arpa/inet.h>
#include <netinet/in.h> /* struct in_addr */
#include <sys/sysctl.h>
#include <net/route.h>
static uint8_t *
getroute( int * buflen );
static int
parseroutes( uint8_t * buf, int len, struct in_addr * addr );
int
tr_getDefaultRoute( struct in_addr * addr )
{
uint8_t * buf;
int len;
buf = getroute( &len );
if( NULL == buf )
{
tr_err( "failed to get default route (BSD)" );
return 1;
}
len = parseroutes( buf, len, addr );
free( buf );
return len;
}
#ifndef SA_SIZE
#define ROUNDUP( a, size ) \
( ( (a) & ( (size) - 1 ) ) ? ( 1 + ( (a) | ( (size) - 1 ) ) ) : (a) )
#define SA_SIZE( sap ) \
( sap->sa_len ? ROUNDUP( (sap)->sa_len, sizeof( u_long ) ) : \
sizeof( u_long ) )
#endif /* !SA_SIZE */
#define NEXT_SA( sap ) \
(struct sockaddr *) ( (caddr_t) (sap) + ( SA_SIZE( (sap) ) ) )
static uint8_t *
getroute( int * buflen )
{
int mib[6];
size_t len;
uint8_t * buf;
mib[0] = CTL_NET;
mib[1] = PF_ROUTE;
mib[2] = 0;
mib[3] = AF_INET;
mib[4] = NET_RT_FLAGS;
mib[5] = RTF_GATEWAY;
if( sysctl( mib, 6, NULL, &len, NULL, 0 ) )
{
if( ENOENT != errno )
{
tr_err( "sysctl net.route.0.inet.flags.gateway failed (%s)",
strerror( sockerrno ) );
}
*buflen = 0;
return NULL;
}
buf = malloc( len );
if( NULL == buf )
{
*buflen = 0;
return NULL;
}
if( sysctl( mib, 6, buf, &len, NULL, 0 ) )
{
tr_err( "sysctl net.route.0.inet.flags.gateway failed (%s)",
strerror( sockerrno ) );
free( buf );
*buflen = 0;
return NULL;
}
*buflen = len;
return buf;
}
static int
parseroutes( uint8_t * buf, int len, struct in_addr * addr )
{
uint8_t * end;
struct rt_msghdr * rtm;
struct sockaddr * sa;
struct sockaddr_in * sin;
int ii;
struct in_addr dest, gw;
end = buf + len;
while( end > buf + sizeof( *rtm ) )
{
rtm = (struct rt_msghdr *) buf;
buf += rtm->rtm_msglen;
if( end >= buf )
{
dest.s_addr = INADDR_NONE;
gw.s_addr = INADDR_NONE;
sa = (struct sockaddr *) ( rtm + 1 );
for( ii = 0; ii < RTAX_MAX && (uint8_t *) sa < buf; ii++ )
{
if( buf < (uint8_t *) NEXT_SA( sa ) )
{
break;
}
if( rtm->rtm_addrs & ( 1 << ii ) )
{
if( AF_INET == sa->sa_family )
{
sin = (struct sockaddr_in *) sa;
switch( ii )
{
case RTAX_DST:
dest = sin->sin_addr;
break;
case RTAX_GATEWAY:
gw = sin->sin_addr;
break;
}
}
sa = NEXT_SA( sa );
}
}
if( INADDR_ANY == dest.s_addr && INADDR_NONE != gw.s_addr )
{
*addr = gw;
return 0;
}
}
}
return 1;
}
#elif defined( linux ) || defined( __linux ) || defined( __linux__ )
#include <linux/types.h>
#include <linux/netlink.h>
#include <linux/rtnetlink.h>
#define SEQNUM 195909
static int
getsock( void );
static uint8_t *
getroute( int fd, unsigned int * buflen );
static int
parseroutes( uint8_t * buf, unsigned int len, struct in_addr * addr );
int
tr_getDefaultRoute( struct in_addr * addr )
{
int fd, ret;
unsigned int len;
uint8_t * buf;
ret = 1;
fd = getsock();
if( 0 <= fd )
{
while( ret )
{
buf = getroute( fd, &len );
if( NULL == buf )
{
break;
}
ret = parseroutes( buf, len, addr );
free( buf );
}
close( fd );
}
if( ret )
{
tr_err( "failed to get default route (Linux)" );
}
return ret;
}
static int
getsock( void )
{
int fd, flags;
struct
{
struct nlmsghdr nlh;
struct rtgenmsg rtg;
} req;
struct sockaddr_nl snl;
fd = socket( PF_NETLINK, SOCK_DGRAM, NETLINK_ROUTE );
if( 0 > fd )
{
tr_err( "failed to create routing socket (%s)", strerror( sockerrno ) );
return -1;
}
flags = fcntl( fd, F_GETFL );
if( 0 > flags || 0 > fcntl( fd, F_SETFL, O_NONBLOCK | flags ) )
{
tr_err( "failed to set socket nonblocking (%s)", strerror( sockerrno ) );
close( fd );
return -1;
}
memset( &snl, 0, sizeof(snl) );
snl.nl_family = AF_NETLINK;
memset( &req, 0, sizeof(req) );
req.nlh.nlmsg_len = NLMSG_LENGTH( sizeof( req.rtg ) );
req.nlh.nlmsg_type = RTM_GETROUTE;
req.nlh.nlmsg_flags = NLM_F_REQUEST | NLM_F_DUMP;
req.nlh.nlmsg_seq = SEQNUM;
req.nlh.nlmsg_pid = 0;
req.rtg.rtgen_family = AF_INET;
if( 0 > sendto( fd, &req, sizeof( req ), 0,
(struct sockaddr *) &snl, sizeof( snl ) ) )
{
tr_err( "failed to write to routing socket (%s)", strerror( sockerrno ) );
close( fd );
return -1;
}
return fd;
}
static uint8_t *
getroute( int fd, unsigned int * buflen )
{
void * buf;
unsigned int len;
ssize_t res;
struct sockaddr_nl snl;
socklen_t slen;
len = 8192;
buf = calloc( 1, len );
if( NULL == buf )
{
*buflen = 0;
return NULL;
}
for( ;; )
{
slen = sizeof( snl );
memset( &snl, 0, slen );
res = recvfrom( fd, buf, len, 0, (struct sockaddr *) &snl, &slen );
if( 0 > res )
{
if( EAGAIN != sockerrno )
{
tr_err( "failed to read from routing socket (%s)",
strerror( sockerrno ) );
}
free( buf );
*buflen = 0;
return NULL;
}
if( slen < sizeof( snl ) || AF_NETLINK != snl.nl_family )
{
tr_err( "bad address" );
free( buf );
*buflen = 0;
return NULL;
}
if( 0 == snl.nl_pid )
{
break;
}
}
*buflen = res;
return buf;
}
static int
parseroutes( uint8_t * buf, unsigned int len, struct in_addr * addr )
{
struct nlmsghdr * nlm;
struct nlmsgerr * nle;
struct rtmsg * rtm;
struct rtattr * rta;
int rtalen;
struct in_addr gw, dst;
nlm = ( struct nlmsghdr * ) buf;
while( NLMSG_OK( nlm, len ) )
{
gw.s_addr = INADDR_ANY;
dst.s_addr = INADDR_ANY;
if( NLMSG_ERROR == nlm->nlmsg_type )
{
nle = (struct nlmsgerr *) NLMSG_DATA( nlm );
if( NLMSG_LENGTH( NLMSG_ALIGN( sizeof( struct nlmsgerr ) ) ) >
nlm->nlmsg_len )
{
tr_err( "truncated netlink error" );
}
else
{
tr_err( "netlink error (%s)", strerror( nle->error ) );
}
return 1;
}
else if( RTM_NEWROUTE == nlm->nlmsg_type && SEQNUM == nlm->nlmsg_seq &&
getpid() == (pid_t) nlm->nlmsg_pid &&
NLMSG_LENGTH( sizeof( struct rtmsg ) ) <= nlm->nlmsg_len )
{
rtm = NLMSG_DATA( nlm );
rta = RTM_RTA( rtm );
rtalen = RTM_PAYLOAD( nlm );
while( RTA_OK( rta, rtalen ) )
{
if( sizeof( struct in_addr ) <= RTA_PAYLOAD( rta ) )
{
switch( rta->rta_type )
{
case RTA_GATEWAY:
memcpy( &gw, RTA_DATA( rta ), sizeof( gw ) );
break;
case RTA_DST:
memcpy( &dst, RTA_DATA( rta ), sizeof( dst ) );
break;
}
}
rta = RTA_NEXT( rta, rtalen );
}
}
if( INADDR_NONE != gw.s_addr && INADDR_ANY != gw.s_addr &&
INADDR_ANY == dst.s_addr )
{
*addr = gw;
return 0;
}
nlm = NLMSG_NEXT( nlm, len );
}
return 1;
}
#else /* not BSD or Linux */
int
tr_getDefaultRoute( struct in_addr * addr UNUSED )
{
tr_inf( "don't know how to get default route on this platform" );
return 1;
}
#endif