source: trunk/libtransmission/fdlimit.c @ 8298

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

(trunk libT) tweak tr_open_file_for_scanning() on OS X for sequential, non-cached reading suitable for verify() and tr_fileLoad()

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