source: trunk/libtransmission/fdlimit.c @ 8198

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

(trunk libT) possible IO speedup on OS X based on feedback from ticket #1967

  • Property svn:keywords set to Date Rev Author Id
File size: 16.3 KB
Line 
1/******************************************************************************
2 * $Id: fdlimit.c 8198 2009-04-10 14:26:01Z 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_reading( const char * filename, tr_bool sequential )
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, sequential ? POSIX_FADV_SEQUENTIAL : POSIX_FADV_RANDOM );
232#endif
233
234    return fdopen( fd, "r" );
235}
236
237/**
238 * returns 0 on success, or an errno value on failure.
239 * errno values include ENOENT if the parent folder doesn't exist,
240 * plus the errno values set by tr_mkdirp() and open().
241 */
242static int
243TrOpenFile( int                      i,
244            const char             * folder,
245            const char             * torrentFile,
246            tr_bool                  doWrite,
247            tr_preallocation_mode    preallocationMode,
248            uint64_t                 desiredFileSize )
249{
250    struct tr_openfile * file = &gFd->openFiles[i];
251    int                  flags;
252    char               * filename;
253    struct stat          sb;
254    int                  alreadyExisted;
255
256    /* confirm the parent folder exists */
257    if( stat( folder, &sb ) || !S_ISDIR( sb.st_mode ) )
258    {
259        tr_err( _( "Couldn't create \"%1$s\": parent folder \"%2$s\" does not exist" ), torrentFile, folder );
260        return ENOENT;
261    }
262
263    /* create subfolders, if any */
264    filename = tr_buildPath( folder, torrentFile, NULL );
265    if( doWrite )
266    {
267        char * tmp = tr_dirname( filename );
268        const int err = tr_mkdirp( tmp, 0777 ) ? errno : 0;
269        if( err ) {
270            tr_err( _( "Couldn't create \"%1$s\": %2$s" ), tmp, tr_strerror( err ) );
271            tr_free( tmp );
272            tr_free( filename );
273            return err;
274        }
275        tr_free( tmp );
276    }
277
278    alreadyExisted = !stat( filename, &sb ) && S_ISREG( sb.st_mode );
279
280    if( doWrite && !alreadyExisted && ( preallocationMode == TR_PREALLOCATE_FULL ) )
281        if( preallocateFileFull( filename, desiredFileSize ) )
282            tr_inf( _( "Preallocated file \"%s\"" ), filename );
283   
284    /* open the file */
285    flags = doWrite ? ( O_RDWR | O_CREAT ) : O_RDONLY;
286#ifdef O_RANDOM
287    flags |= O_RANDOM
288#endif
289#ifdef O_LARGEFILE
290    flags |= O_LARGEFILE;
291#endif
292#ifdef WIN32
293    flags |= O_BINARY;
294#endif
295    file->fd = open( filename, flags, 0666 );
296    if( file->fd == -1 )
297    {
298        const int err = errno;
299        tr_err( _( "Couldn't open \"%1$s\": %2$s" ), filename, tr_strerror( err ) );
300        tr_free( filename );
301        return err;
302    }
303
304    if( doWrite && !alreadyExisted && ( preallocationMode == TR_PREALLOCATE_SPARSE ) )
305        preallocateFileSparse( file->fd, desiredFileSize );
306
307#ifdef HAVE_POSIX_FADVISE
308    posix_fadvise( file->fd, 0, 0, POSIX_FADV_RANDOM );
309#endif
310
311    tr_free( filename );
312    return 0;
313}
314
315static int
316fileIsOpen( const struct tr_openfile * o )
317{
318    return o->fd >= 0;
319}
320
321static void
322TrCloseFile( int i )
323{
324    struct tr_openfile * o = &gFd->openFiles[i];
325
326    assert( i >= 0 );
327    assert( i < gFd->openFileLimit );
328    assert( fileIsOpen( o ) );
329
330    close( o->fd );
331    o->fd = -1;
332    o->isCheckedOut = 0;
333}
334
335static int
336fileIsCheckedOut( const struct tr_openfile * o )
337{
338    return fileIsOpen( o ) && o->isCheckedOut;
339}
340
341/* returns an fd on success, or a -1 on failure and sets errno */
342int
343tr_fdFileCheckout( const char             * folder,
344                   const char             * torrentFile,
345                   tr_bool                  doWrite,
346                   tr_preallocation_mode    preallocationMode,
347                   uint64_t                 desiredFileSize )
348{
349    int i, winner = -1;
350    struct tr_openfile * o;
351    char filename[MAX_PATH_LENGTH];
352
353    assert( folder && *folder );
354    assert( torrentFile && *torrentFile );
355    assert( doWrite == 0 || doWrite == 1 );
356
357    tr_snprintf( filename, sizeof( filename ), "%s%c%s", folder, TR_PATH_DELIMITER, torrentFile );
358    dbgmsg( "looking for file '%s', writable %c", filename, doWrite ? 'y' : 'n' );
359
360    tr_lockLock( gFd->lock );
361
362    /* Is it already open? */
363    for( i = 0; i < gFd->openFileLimit; ++i )
364    {
365        o = &gFd->openFiles[i];
366
367        if( !fileIsOpen( o ) )
368            continue;
369
370        if( strcmp( filename, o->filename ) )
371            continue;
372
373        if( fileIsCheckedOut( o ) )
374        {
375            dbgmsg( "found it!  it's open, but checked out.  waiting..." );
376            tr_lockUnlock( gFd->lock );
377            tr_wait( 200 );
378            tr_lockLock( gFd->lock );
379            i = -1; /* reloop */
380            continue;
381        }
382
383        if( doWrite && !o->isWritable )
384        {
385            dbgmsg(
386                "found it!  it's open and available, but isn't writable. closing..." );
387            TrCloseFile( i );
388            break;
389        }
390
391        dbgmsg( "found it!  it's ready for use!" );
392        winner = i;
393        break;
394    }
395
396    dbgmsg(
397        "it's not already open.  looking for an open slot or an old file." );
398    while( winner < 0 )
399    {
400        uint64_t date = tr_date( ) + 1;
401
402        /* look for the file that's been open longest */
403        for( i = 0; i < gFd->openFileLimit; ++i )
404        {
405            o = &gFd->openFiles[i];
406
407            if( !fileIsOpen( o ) )
408            {
409                winner = i;
410                dbgmsg( "found an empty slot in %d", winner );
411                break;
412            }
413
414            if( date > o->date )
415            {
416                date = o->date;
417                winner = i;
418            }
419        }
420
421        if( winner >= 0 )
422        {
423            if( fileIsOpen( &gFd->openFiles[winner] ) )
424            {
425                dbgmsg( "closing file '%s', slot #%d",
426                        gFd->openFiles[winner].filename,
427                        winner );
428                TrCloseFile( winner );
429            }
430        }
431        else
432        {
433            dbgmsg( "everything's full!  waiting for someone else to finish something" );
434            tr_lockUnlock( gFd->lock );
435            tr_wait( 200 );
436            tr_lockLock( gFd->lock );
437        }
438    }
439
440    assert( winner >= 0 );
441    o = &gFd->openFiles[winner];
442    if( !fileIsOpen( o ) )
443    {
444        const int err = TrOpenFile( winner, folder, torrentFile, doWrite, preallocationMode, desiredFileSize );
445        if( err ) {
446            tr_lockUnlock( gFd->lock );
447            errno = err;
448            return -1;
449        }
450
451        dbgmsg( "opened '%s' in slot %d, doWrite %c", filename, winner,
452                doWrite ? 'y' : 'n' );
453        tr_strlcpy( o->filename, filename, sizeof( o->filename ) );
454        o->isWritable = doWrite;
455    }
456
457    dbgmsg( "checking out '%s' in slot %d", filename, winner );
458    o->isCheckedOut = 1;
459    o->closeWhenDone = 0;
460    o->date = tr_date( );
461    tr_lockUnlock( gFd->lock );
462    return o->fd;
463}
464
465void
466tr_fdFileReturn( int fd )
467{
468    int i;
469
470    tr_lockLock( gFd->lock );
471
472    for( i = 0; i < gFd->openFileLimit; ++i )
473    {
474        struct tr_openfile * o = &gFd->openFiles[i];
475        if( o->fd != fd )
476            continue;
477
478        dbgmsg( "releasing file '%s' in slot #%d", o->filename, i );
479        o->isCheckedOut = 0;
480        if( o->closeWhenDone )
481            TrCloseFile( i );
482
483        break;
484    }
485
486    tr_lockUnlock( gFd->lock );
487}
488
489void
490tr_fdFileClose( const char * filename )
491{
492    int i;
493
494    tr_lockLock( gFd->lock );
495
496    for( i = 0; i < gFd->openFileLimit; ++i )
497    {
498        struct tr_openfile * o = &gFd->openFiles[i];
499        if( !fileIsOpen( o ) || strcmp( filename, o->filename ) )
500            continue;
501
502        dbgmsg( "tr_fdFileClose closing '%s'", filename );
503
504        if( !o->isCheckedOut )
505        {
506            dbgmsg( "not checked out, so closing it now... '%s'", filename );
507            TrCloseFile( i );
508        }
509        else
510        {
511            dbgmsg(
512                "flagging file '%s', slot #%d to be closed when checked in",
513                gFd->openFiles[i].filename, i );
514            o->closeWhenDone = 1;
515        }
516    }
517
518    tr_lockUnlock( gFd->lock );
519}
520
521/***
522****
523****  Sockets
524****
525***/
526
527static int
528getSocketMax( struct tr_fd_s * gFd )
529{
530    return gFd->socketLimit;
531}
532
533int
534tr_fdSocketCreate( int domain, int type )
535{
536    int s = -1;
537
538    tr_lockLock( gFd->lock );
539
540    if( gFd->socketCount < getSocketMax( gFd ) )
541        if( ( s = socket( domain, type, 0 ) ) < 0 )
542        {
543#ifdef SYS_DARWIN
544            if( sockerrno != EAFNOSUPPORT )
545#endif
546            tr_err( _( "Couldn't create socket: %s" ),
547                   tr_strerror( sockerrno ) );
548            s = -sockerrno;
549        }
550
551    if( s > -1 )
552        ++gFd->socketCount;
553
554    assert( gFd->socketCount >= 0 );
555
556    tr_lockUnlock( gFd->lock );
557    return s;
558}
559
560int
561tr_fdSocketAccept( int           b,
562                   tr_address  * addr,
563                   tr_port     * port )
564{
565    int                s = -1;
566    unsigned int       len;
567    struct sockaddr_storage sock;
568
569    assert( addr );
570    assert( port );
571
572    tr_lockLock( gFd->lock );
573    if( gFd->socketCount < getSocketMax( gFd ) )
574    {
575        len = sizeof( struct sockaddr_storage );
576        s = accept( b, (struct sockaddr *) &sock, &len );
577    }
578    if( s > -1 )
579    {
580        /* "The ss_family field of the sockaddr_storage structure will always
581         * align with the family field of any protocol-specific structure." */ 
582        if( sock.ss_family == AF_INET ) 
583        { 
584            struct sockaddr_in * sock4 = (struct sockaddr_in *)&sock; 
585            addr->type = TR_AF_INET; 
586            addr->addr.addr4.s_addr = sock4->sin_addr.s_addr; 
587            *port = sock4->sin_port; 
588        } 
589        else 
590        { 
591            struct sockaddr_in6 * sock6 = (struct sockaddr_in6 *)&sock; 
592            addr->type = TR_AF_INET6; 
593            addr->addr.addr6 = sock6->sin6_addr;
594            *port = sock6->sin6_port; 
595        } 
596        ++gFd->socketCount;
597    }
598    tr_lockUnlock( gFd->lock );
599
600    return s;
601}
602
603static void
604socketClose( int fd )
605{
606    EVUTIL_CLOSESOCKET( fd );
607}
608
609void
610tr_fdSocketClose( int s )
611{
612    tr_lockLock( gFd->lock );
613
614    if( s >= 0 )
615    {
616        socketClose( s );
617        --gFd->socketCount;
618    }
619
620    assert( gFd->socketCount >= 0 );
621
622    tr_lockUnlock( gFd->lock );
623}
624
625/***
626****
627****  Startup / Shutdown
628****
629***/
630
631void
632tr_fdInit( size_t openFileLimit, size_t socketLimit )
633{
634    int i;
635
636    assert( gFd == NULL );
637    gFd = tr_new0( struct tr_fd_s, 1 );
638    gFd->openFiles = tr_new0( struct tr_openfile, openFileLimit );
639    gFd->openFileLimit = openFileLimit;
640    gFd->lock = tr_lockNew( );
641
642#ifdef HAVE_GETRLIMIT
643    {
644        struct rlimit rlim;
645        getrlimit( RLIMIT_NOFILE, &rlim );
646        rlim.rlim_cur = MIN( rlim.rlim_max,
647                            (rlim_t)( socketLimit + NOFILE_BUFFER ) );
648        setrlimit( RLIMIT_NOFILE, &rlim );
649        gFd->socketLimit = rlim.rlim_cur - NOFILE_BUFFER;
650        tr_dbg( "setrlimit( RLIMIT_NOFILE, %d )", (int)rlim.rlim_cur );
651    }
652#else
653    gFd->socketLimit = socketLimit;
654#endif
655    tr_dbg( "%zu usable file descriptors", socketLimit );
656
657    for( i = 0; i < gFd->openFileLimit; ++i )
658        gFd->openFiles[i].fd = -1;
659}
660
661void
662tr_fdClose( void )
663{
664    int i = 0;
665
666    for( i = 0; i < gFd->openFileLimit; ++i )
667        if( fileIsOpen( &gFd->openFiles[i] ) )
668            TrCloseFile( i );
669
670    tr_lockFree( gFd->lock );
671
672    tr_free( gFd->openFiles );
673    tr_free( gFd );
674    gFd = NULL;
675}
676
677void
678tr_fdSetPeerLimit( uint16_t n )
679{
680    assert( gFd != NULL && "tr_fdInit() must be called first!" );
681    gFd->socketLimit = n;
682}
683
684uint16_t
685tr_fdGetPeerLimit( void )
686{
687    return gFd ? gFd->socketLimit : -1;
688}
689
Note: See TracBrowser for help on using the repository browser.