source: trunk/libtransmission/fdlimit.c @ 8142

Last change on this file since 8142 was 8142, checked in by charles, 13 years ago

(trunk libT) #1966: add explicit support for preallocating files on XFS filesystems

  • Property svn:keywords set to Date Rev Author Id
File size: 16.4 KB
Line 
1/******************************************************************************
2 * $Id: fdlimit.c 8142 2009-04-05 14:04:07Z charles $
3 *
4 * Copyright (c) 2005-2008 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#ifndef WIN32
26 #define HAVE_GETRLIMIT
27#endif
28
29#ifdef HAVE_POSIX_FADVISE
30 #ifdef _XOPEN_SOURCE
31  #undef _XOPEN_SOURCE
32 #endif
33 #define _XOPEN_SOURCE 600
34#endif
35
36#include <assert.h>
37#include <errno.h>
38#include <inttypes.h>
39#include <stdio.h>
40#include <stdlib.h>
41#include <string.h>
42#ifdef SYS_DARWIN
43 #include <fcntl.h>
44#endif
45
46#ifdef HAVE_FALLOCATE
47 #include <linux/falloc.h>
48#endif
49
50#ifdef HAVE_XFS_XFS_H
51 #include <xfs/xfs.h>
52#endif
53
54#include <sys/types.h>
55#include <sys/stat.h>
56#ifdef HAVE_GETRLIMIT
57 #include <sys/time.h> /* getrlimit */
58 #include <sys/resource.h> /* getrlimit */
59#endif
60#include <unistd.h>
61#include <fcntl.h> /* O_LARGEFILE posix_fadvise */
62
63#include <evutil.h>
64
65#include "transmission.h"
66#include "fdlimit.h"
67#include "list.h"
68#include "net.h"
69#include "platform.h" /* tr_lock */
70#include "utils.h"
71
72#define dbgmsg( ... ) \
73    do { \
74        if( tr_deepLoggingIsActive( ) ) \
75            tr_deepLog( __FILE__, __LINE__, NULL, __VA_ARGS__ ); \
76    } while( 0 )
77
78/**
79***
80**/
81
82enum
83{
84    NOFILE_BUFFER = 512, /* the process' number of open files is
85                            globalMaxPeers + NOFILE_BUFFER */
86
87    SYNC_INTERVAL = 15   /* (arbitrary number) how many seconds to go
88                            between fsync calls for files in heavy use */
89};
90
91struct tr_openfile
92{
93    tr_bool    isCheckedOut;
94    tr_bool    isWritable;
95    tr_bool    closeWhenDone;
96    char       filename[MAX_PATH_LENGTH];
97    int        fd;
98    uint64_t   date;
99    time_t     syncAt;
100};
101
102struct tr_fd_s
103{
104    int                   socketCount;
105    int                   socketLimit;
106
107    struct tr_openfile  * openFiles;
108    int                   openFileLimit;
109
110    tr_lock             * lock;
111};
112
113static struct tr_fd_s * gFd = NULL;
114
115/***
116****
117****  Local Files
118****
119***/
120
121#ifndef O_LARGEFILE
122 #define O_LARGEFILE 0
123#endif
124
125static tr_bool
126preallocateFileSparse( int fd, uint64_t length )
127{
128    const char zero = '\0';
129
130    if( length == 0 )
131        return TRUE;
132
133    if( lseek( fd, length-1, SEEK_SET ) == -1 )
134        return FALSE;
135    if( write( fd, &zero, 1 ) == -1 )
136        return FALSE;
137    if( ftruncate( fd, length ) == -1 )
138        return FALSE;
139
140    return TRUE;
141}
142
143static tr_bool
144preallocateFileFull( const char * filename, uint64_t length )
145{
146    tr_bool success = 0;
147
148#ifdef WIN32
149
150    HANDLE hFile = CreateFile( filename, GENERIC_WRITE, 0, 0, CREATE_NEW, 0, 0 );
151    if( hFile != INVALID_HANDLE_VALUE )
152    {
153        LARGE_INTEGER li;
154        li.QuadPart = length;
155        success = SetFilePointerEx( hFile, li, NULL, FILE_BEGIN ) && SetEndOfFile( hFile );
156        CloseHandle( hFile );
157    }
158
159#else
160
161    int flags = O_RDWR | O_CREAT | O_LARGEFILE;
162    int fd = open( filename, flags, 0666 );
163    if( fd >= 0 )
164    {
165# ifdef HAVE_XFS_XFS_H
166        if( !success && platform_test_xfs_fd( fd ) )
167        {
168            xfs_flock64_t fl;
169            fl.l_whence = 0;
170            fl.l_start = 0;
171            fl.l_len = length;
172            success = !xfsctl( NULL, fd, XFS_IOC_RESVSP64, &fl );
173        }
174# endif
175# ifdef SYS_DARWIN
176        if( !success )
177        {
178            fstore_t fst;
179            fst.fst_flags = F_ALLOCATECONTIG;
180            fst.fst_posmode = F_PEOFPOSMODE;
181            fst.fst_offset = 0;
182            fst.fst_length = length;
183            fst.fst_bytesalloc = 0;
184            success = !fcntl( fd, F_PREALLOCATE, &fst );
185        }
186# endif
187# ifdef HAVE_FALLOCATE
188        if( !success )
189        {
190            success = !fallocate( fd, FALLOC_FL_KEEP_SIZE, 0, length );
191        }
192# endif
193# ifdef HAVE_POSIX_FALLOCATE
194        if( !success )
195        {
196            success = !posix_fallocate( fd, 0, length );
197        }
198# endif
199
200        close( fd );
201    }
202
203#endif
204
205    return success;
206}
207
208/**
209 * returns 0 on success, or an errno value on failure.
210 * errno values include ENOENT if the parent folder doesn't exist,
211 * plus the errno values set by tr_mkdirp() and open().
212 */
213static int
214TrOpenFile( int                      i,
215            const char             * folder,
216            const char             * torrentFile,
217            tr_bool                  doWrite,
218            tr_preallocation_mode    preallocationMode,
219            uint64_t                 desiredFileSize )
220{
221    struct tr_openfile * file = &gFd->openFiles[i];
222    int                  flags;
223    char               * filename;
224    struct stat          sb;
225    int                  alreadyExisted;
226
227    /* confirm the parent folder exists */
228    if( stat( folder, &sb ) || !S_ISDIR( sb.st_mode ) )
229    {
230        tr_err( _( "Couldn't create \"%1$s\": parent folder \"%2$s\" does not exist" ), torrentFile, folder );
231        return ENOENT;
232    }
233
234    /* create subfolders, if any */
235    filename = tr_buildPath( folder, torrentFile, NULL );
236    if( doWrite )
237    {
238        char * tmp = tr_dirname( filename );
239        const int err = tr_mkdirp( tmp, 0777 ) ? errno : 0;
240        if( err ) {
241            tr_err( _( "Couldn't create \"%1$s\": %2$s" ), tmp, tr_strerror( err ) );
242            tr_free( tmp );
243            tr_free( filename );
244            return err;
245        }
246        tr_free( tmp );
247    }
248
249    alreadyExisted = !stat( filename, &sb ) && S_ISREG( sb.st_mode );
250
251    if( doWrite && !alreadyExisted && ( preallocationMode == TR_PREALLOCATE_FULL ) )
252        if( preallocateFileFull( filename, desiredFileSize ) )
253            tr_inf( _( "Preallocated file \"%s\"" ), filename );
254   
255    /* open the file */
256    flags = doWrite ? ( O_RDWR | O_CREAT ) : O_RDONLY;
257#ifdef O_RANDOM
258    flags |= O_RANDOM
259#endif
260#ifdef O_LARGEFILE
261    flags |= O_LARGEFILE;
262#endif
263#ifdef WIN32
264    flags |= O_BINARY;
265#endif
266    file->fd = open( filename, flags, 0666 );
267    if( file->fd == -1 )
268    {
269        const int err = errno;
270        tr_err( _( "Couldn't open \"%1$s\": %2$s" ), filename, tr_strerror( err ) );
271        tr_free( filename );
272        return err;
273    }
274
275    if( doWrite && !alreadyExisted && ( preallocationMode == TR_PREALLOCATE_SPARSE ) )
276        preallocateFileSparse( file->fd, desiredFileSize );
277
278#if defined( SYS_DARWIN )
279    fcntl( file->fd, F_NOCACHE, 1 );
280    fcntl( file->fd, F_RDAHEAD, 0 );
281#elif defined( HAVE_POSIX_FADVISE )
282    posix_fadvise( file->fd, 0, 0, POSIX_FADV_RANDOM );
283#endif
284
285    tr_free( filename );
286    return 0;
287}
288
289static int
290fileIsOpen( const struct tr_openfile * o )
291{
292    return o->fd >= 0;
293}
294
295static void
296TrCloseFile( int i )
297{
298    struct tr_openfile * o = &gFd->openFiles[i];
299
300    assert( i >= 0 );
301    assert( i < gFd->openFileLimit );
302    assert( fileIsOpen( o ) );
303
304    close( o->fd );
305    o->fd = -1;
306    o->isCheckedOut = 0;
307}
308
309static int
310fileIsCheckedOut( const struct tr_openfile * o )
311{
312    return fileIsOpen( o ) && o->isCheckedOut;
313}
314
315/* returns an fd on success, or a -1 on failure and sets errno */
316int
317tr_fdFileCheckout( const char             * folder,
318                   const char             * torrentFile,
319                   tr_bool                  doWrite,
320                   tr_preallocation_mode    preallocationMode,
321                   uint64_t                 desiredFileSize )
322{
323    int i, winner = -1;
324    struct tr_openfile * o;
325    char filename[MAX_PATH_LENGTH];
326
327    assert( folder && *folder );
328    assert( torrentFile && *torrentFile );
329    assert( doWrite == 0 || doWrite == 1 );
330
331    tr_snprintf( filename, sizeof( filename ), "%s%c%s", folder, TR_PATH_DELIMITER, torrentFile );
332    dbgmsg( "looking for file '%s', writable %c", filename, doWrite ? 'y' : 'n' );
333
334    tr_lockLock( gFd->lock );
335
336    /* Is it already open? */
337    for( i = 0; i < gFd->openFileLimit; ++i )
338    {
339        o = &gFd->openFiles[i];
340
341        if( !fileIsOpen( o ) )
342            continue;
343
344        if( strcmp( filename, o->filename ) )
345            continue;
346
347        if( fileIsCheckedOut( o ) )
348        {
349            dbgmsg( "found it!  it's open, but checked out.  waiting..." );
350            tr_lockUnlock( gFd->lock );
351            tr_wait( 200 );
352            tr_lockLock( gFd->lock );
353            i = -1; /* reloop */
354            continue;
355        }
356
357        if( doWrite && !o->isWritable )
358        {
359            dbgmsg(
360                "found it!  it's open and available, but isn't writable. closing..." );
361            TrCloseFile( i );
362            break;
363        }
364
365        dbgmsg( "found it!  it's ready for use!" );
366        winner = i;
367        break;
368    }
369
370    dbgmsg(
371        "it's not already open.  looking for an open slot or an old file." );
372    while( winner < 0 )
373    {
374        uint64_t date = tr_date( ) + 1;
375
376        /* look for the file that's been open longest */
377        for( i = 0; i < gFd->openFileLimit; ++i )
378        {
379            o = &gFd->openFiles[i];
380
381            if( !fileIsOpen( o ) )
382            {
383                winner = i;
384                dbgmsg( "found an empty slot in %d", winner );
385                break;
386            }
387
388            if( date > o->date )
389            {
390                date = o->date;
391                winner = i;
392            }
393        }
394
395        if( winner >= 0 )
396        {
397            if( fileIsOpen( &gFd->openFiles[winner] ) )
398            {
399                dbgmsg( "closing file '%s', slot #%d",
400                        gFd->openFiles[winner].filename,
401                        winner );
402                TrCloseFile( winner );
403            }
404        }
405        else
406        {
407            dbgmsg( "everything's full!  waiting for someone else to finish something" );
408            tr_lockUnlock( gFd->lock );
409            tr_wait( 200 );
410            tr_lockLock( gFd->lock );
411        }
412    }
413
414    assert( winner >= 0 );
415    o = &gFd->openFiles[winner];
416    if( !fileIsOpen( o ) )
417    {
418        const int err = TrOpenFile( winner, folder, torrentFile, doWrite, preallocationMode, desiredFileSize );
419        if( err ) {
420            tr_lockUnlock( gFd->lock );
421            errno = err;
422            return -1;
423        }
424
425        dbgmsg( "opened '%s' in slot %d, doWrite %c", filename, winner,
426                doWrite ? 'y' : 'n' );
427        tr_strlcpy( o->filename, filename, sizeof( o->filename ) );
428        o->isWritable = doWrite;
429        o->syncAt = time( NULL ) + SYNC_INTERVAL;
430    }
431
432    dbgmsg( "checking out '%s' in slot %d", filename, winner );
433    o->isCheckedOut = 1;
434    o->closeWhenDone = 0;
435    o->date = tr_date( );
436    tr_lockUnlock( gFd->lock );
437    return o->fd;
438}
439
440void
441tr_fdFileReturn( int fd )
442{
443    int i;
444
445    tr_lockLock( gFd->lock );
446
447    for( i = 0; i < gFd->openFileLimit; ++i )
448    {
449        struct tr_openfile * o = &gFd->openFiles[i];
450        if( o->fd != fd )
451            continue;
452
453        dbgmsg( "releasing file '%s' in slot #%d", o->filename, i );
454        o->isCheckedOut = 0;
455        if( o->closeWhenDone )
456            TrCloseFile( i );
457        else if( o->syncAt <= time( NULL ) ) {
458            dbgmsg( "fsync()ing file '%s' in slot #%d", o->filename, i );
459            //fsync( o->fd );
460#ifdef HAVE_POSIX_FADVISE
461            /* TODO: test performance with and without this */
462            posix_fadvise( o->fd, 0, 0, POSIX_FADV_DONTNEED );
463#endif
464            o->syncAt = time( NULL ) + SYNC_INTERVAL;
465        }
466
467        break;
468    }
469
470    tr_lockUnlock( gFd->lock );
471}
472
473void
474tr_fdFileClose( const char * filename )
475{
476    int i;
477
478    tr_lockLock( gFd->lock );
479
480    for( i = 0; i < gFd->openFileLimit; ++i )
481    {
482        struct tr_openfile * o = &gFd->openFiles[i];
483        if( !fileIsOpen( o ) || strcmp( filename, o->filename ) )
484            continue;
485
486        dbgmsg( "tr_fdFileClose closing '%s'", filename );
487
488        if( !o->isCheckedOut )
489        {
490            dbgmsg( "not checked out, so closing it now... '%s'", filename );
491            TrCloseFile( i );
492        }
493        else
494        {
495            dbgmsg(
496                "flagging file '%s', slot #%d to be closed when checked in",
497                gFd->openFiles[i].filename, i );
498            o->closeWhenDone = 1;
499        }
500    }
501
502    tr_lockUnlock( gFd->lock );
503}
504
505/***
506****
507****  Sockets
508****
509***/
510
511static int
512getSocketMax( struct tr_fd_s * gFd )
513{
514    return gFd->socketLimit;
515}
516
517int
518tr_fdSocketCreate( int domain, int type )
519{
520    int s = -1;
521
522    tr_lockLock( gFd->lock );
523
524    if( gFd->socketCount < getSocketMax( gFd ) )
525        if( ( s = socket( domain, type, 0 ) ) < 0 )
526        {
527#ifdef SYS_DARWIN
528            if( sockerrno != EAFNOSUPPORT )
529#endif
530            tr_err( _( "Couldn't create socket: %s" ),
531                   tr_strerror( sockerrno ) );
532            s = -sockerrno;
533        }
534
535    if( s > -1 )
536        ++gFd->socketCount;
537
538    assert( gFd->socketCount >= 0 );
539
540    tr_lockUnlock( gFd->lock );
541    return s;
542}
543
544int
545tr_fdSocketAccept( int           b,
546                   tr_address  * addr,
547                   tr_port     * port )
548{
549    int                s = -1;
550    unsigned int       len;
551    struct sockaddr_storage sock;
552
553    assert( addr );
554    assert( port );
555
556    tr_lockLock( gFd->lock );
557    if( gFd->socketCount < getSocketMax( gFd ) )
558    {
559        len = sizeof( struct sockaddr_storage );
560        s = accept( b, (struct sockaddr *) &sock, &len );
561    }
562    if( s > -1 )
563    {
564        /* "The ss_family field of the sockaddr_storage structure will always
565         * align with the family field of any protocol-specific structure." */ 
566        if( sock.ss_family == AF_INET ) 
567        { 
568            struct sockaddr_in * sock4 = (struct sockaddr_in *)&sock; 
569            addr->type = TR_AF_INET; 
570            addr->addr.addr4.s_addr = sock4->sin_addr.s_addr; 
571            *port = sock4->sin_port; 
572        } 
573        else 
574        { 
575            struct sockaddr_in6 * sock6 = (struct sockaddr_in6 *)&sock; 
576            addr->type = TR_AF_INET6; 
577            addr->addr.addr6 = sock6->sin6_addr;
578            *port = sock6->sin6_port; 
579        } 
580        ++gFd->socketCount;
581    }
582    tr_lockUnlock( gFd->lock );
583
584    return s;
585}
586
587static void
588socketClose( int fd )
589{
590    EVUTIL_CLOSESOCKET( fd );
591}
592
593void
594tr_fdSocketClose( int s )
595{
596    tr_lockLock( gFd->lock );
597
598    if( s >= 0 )
599    {
600        socketClose( s );
601        --gFd->socketCount;
602    }
603
604    assert( gFd->socketCount >= 0 );
605
606    tr_lockUnlock( gFd->lock );
607}
608
609/***
610****
611****  Startup / Shutdown
612****
613***/
614
615void
616tr_fdInit( size_t openFileLimit, size_t socketLimit )
617{
618    int i;
619
620    assert( gFd == NULL );
621    gFd = tr_new0( struct tr_fd_s, 1 );
622    gFd->openFiles = tr_new0( struct tr_openfile, openFileLimit );
623    gFd->openFileLimit = openFileLimit;
624    gFd->lock = tr_lockNew( );
625
626#ifdef HAVE_GETRLIMIT
627    {
628        struct rlimit rlim;
629        getrlimit( RLIMIT_NOFILE, &rlim );
630        rlim.rlim_cur = MIN( rlim.rlim_max,
631                            (rlim_t)( socketLimit + NOFILE_BUFFER ) );
632        setrlimit( RLIMIT_NOFILE, &rlim );
633        gFd->socketLimit = rlim.rlim_cur - NOFILE_BUFFER;
634        tr_dbg( "setrlimit( RLIMIT_NOFILE, %d )", (int)rlim.rlim_cur );
635    }
636#else
637    gFd->socketLimit = socketLimit;
638#endif
639    tr_dbg( "%zu usable file descriptors", socketLimit );
640
641    for( i = 0; i < gFd->openFileLimit; ++i )
642        gFd->openFiles[i].fd = -1;
643}
644
645void
646tr_fdClose( void )
647{
648    int i = 0;
649
650    for( i = 0; i < gFd->openFileLimit; ++i )
651        if( fileIsOpen( &gFd->openFiles[i] ) )
652            TrCloseFile( i );
653
654    tr_lockFree( gFd->lock );
655
656    tr_free( gFd->openFiles );
657    tr_free( gFd );
658    gFd = NULL;
659}
660
661void
662tr_fdSetPeerLimit( uint16_t n )
663{
664    assert( gFd != NULL && "tr_fdInit() must be called first!" );
665    gFd->socketLimit = n;
666}
667
668uint16_t
669tr_fdGetPeerLimit( void )
670{
671    return gFd ? gFd->socketLimit : -1;
672}
673
Note: See TracBrowser for help on using the repository browser.