source: trunk/libtransmission/fdlimit.c @ 8175

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

(trunk libT) #1976: build problem with r8173: "erreur: ‘POSIX_FADV_SEQUENTIAL’ undeclared"

  • Property svn:keywords set to Date Rev Author Id
File size: 17.1 KB
Line 
1/******************************************************************************
2 * $Id: fdlimit.c 8175 2009-04-07 20:25:32Z 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
208FILE*
209tr_open_file_for_reading( const char * filename, tr_bool sequential )
210{
211    int fd;
212    int flags;
213
214    /* build the flags */
215    flags = O_RDONLY;
216#ifdef O_SEQUENTIAL
217    if( sequential ) flags |= O_SEQUENTIAL;
218#endif
219#ifdef O_RANDOM
220    if( !sequential ) flags |= O_RANDOM
221#endif
222#ifdef O_BINARY
223    flags |= O_BINARY;
224#endif
225#ifdef O_LARGEFILE
226    flags |= O_LARGEFILE;
227#endif
228
229    /* open the file */
230    fd = open( filename, flags, 0666 );
231    if( fd < 0 )
232        return NULL;
233
234#if defined( SYS_DARWIN )
235    fcntl( fd, F_NOCACHE, 1 );
236    fcntl( fd, F_RDAHEAD, sequential );
237#elif defined( HAVE_POSIX_FADVISE )
238    posix_fadvise( fd, 0, 0, sequential ? POSIX_FADV_SEQUENTIAL : POSIX_FADV_RANDOM );
239#endif
240
241    return fdopen( fd, "r" );
242}
243
244/**
245 * returns 0 on success, or an errno value on failure.
246 * errno values include ENOENT if the parent folder doesn't exist,
247 * plus the errno values set by tr_mkdirp() and open().
248 */
249static int
250TrOpenFile( int                      i,
251            const char             * folder,
252            const char             * torrentFile,
253            tr_bool                  doWrite,
254            tr_preallocation_mode    preallocationMode,
255            uint64_t                 desiredFileSize )
256{
257    struct tr_openfile * file = &gFd->openFiles[i];
258    int                  flags;
259    char               * filename;
260    struct stat          sb;
261    int                  alreadyExisted;
262
263    /* confirm the parent folder exists */
264    if( stat( folder, &sb ) || !S_ISDIR( sb.st_mode ) )
265    {
266        tr_err( _( "Couldn't create \"%1$s\": parent folder \"%2$s\" does not exist" ), torrentFile, folder );
267        return ENOENT;
268    }
269
270    /* create subfolders, if any */
271    filename = tr_buildPath( folder, torrentFile, NULL );
272    if( doWrite )
273    {
274        char * tmp = tr_dirname( filename );
275        const int err = tr_mkdirp( tmp, 0777 ) ? errno : 0;
276        if( err ) {
277            tr_err( _( "Couldn't create \"%1$s\": %2$s" ), tmp, tr_strerror( err ) );
278            tr_free( tmp );
279            tr_free( filename );
280            return err;
281        }
282        tr_free( tmp );
283    }
284
285    alreadyExisted = !stat( filename, &sb ) && S_ISREG( sb.st_mode );
286
287    if( doWrite && !alreadyExisted && ( preallocationMode == TR_PREALLOCATE_FULL ) )
288        if( preallocateFileFull( filename, desiredFileSize ) )
289            tr_inf( _( "Preallocated file \"%s\"" ), filename );
290   
291    /* open the file */
292    flags = doWrite ? ( O_RDWR | O_CREAT ) : O_RDONLY;
293#ifdef O_RANDOM
294    flags |= O_RANDOM
295#endif
296#ifdef O_LARGEFILE
297    flags |= O_LARGEFILE;
298#endif
299#ifdef WIN32
300    flags |= O_BINARY;
301#endif
302    file->fd = open( filename, flags, 0666 );
303    if( file->fd == -1 )
304    {
305        const int err = errno;
306        tr_err( _( "Couldn't open \"%1$s\": %2$s" ), filename, tr_strerror( err ) );
307        tr_free( filename );
308        return err;
309    }
310
311    if( doWrite && !alreadyExisted && ( preallocationMode == TR_PREALLOCATE_SPARSE ) )
312        preallocateFileSparse( file->fd, desiredFileSize );
313
314#if defined( SYS_DARWIN )
315    fcntl( file->fd, F_NOCACHE, 1 );
316    fcntl( file->fd, F_RDAHEAD, 0 );
317#elif defined( HAVE_POSIX_FADVISE )
318    posix_fadvise( file->fd, 0, 0, POSIX_FADV_RANDOM );
319#endif
320
321    tr_free( filename );
322    return 0;
323}
324
325static int
326fileIsOpen( const struct tr_openfile * o )
327{
328    return o->fd >= 0;
329}
330
331static void
332TrCloseFile( int i )
333{
334    struct tr_openfile * o = &gFd->openFiles[i];
335
336    assert( i >= 0 );
337    assert( i < gFd->openFileLimit );
338    assert( fileIsOpen( o ) );
339
340    close( o->fd );
341    o->fd = -1;
342    o->isCheckedOut = 0;
343}
344
345static int
346fileIsCheckedOut( const struct tr_openfile * o )
347{
348    return fileIsOpen( o ) && o->isCheckedOut;
349}
350
351/* returns an fd on success, or a -1 on failure and sets errno */
352int
353tr_fdFileCheckout( const char             * folder,
354                   const char             * torrentFile,
355                   tr_bool                  doWrite,
356                   tr_preallocation_mode    preallocationMode,
357                   uint64_t                 desiredFileSize )
358{
359    int i, winner = -1;
360    struct tr_openfile * o;
361    char filename[MAX_PATH_LENGTH];
362
363    assert( folder && *folder );
364    assert( torrentFile && *torrentFile );
365    assert( doWrite == 0 || doWrite == 1 );
366
367    tr_snprintf( filename, sizeof( filename ), "%s%c%s", folder, TR_PATH_DELIMITER, torrentFile );
368    dbgmsg( "looking for file '%s', writable %c", filename, doWrite ? 'y' : 'n' );
369
370    tr_lockLock( gFd->lock );
371
372    /* Is it already open? */
373    for( i = 0; i < gFd->openFileLimit; ++i )
374    {
375        o = &gFd->openFiles[i];
376
377        if( !fileIsOpen( o ) )
378            continue;
379
380        if( strcmp( filename, o->filename ) )
381            continue;
382
383        if( fileIsCheckedOut( o ) )
384        {
385            dbgmsg( "found it!  it's open, but checked out.  waiting..." );
386            tr_lockUnlock( gFd->lock );
387            tr_wait( 200 );
388            tr_lockLock( gFd->lock );
389            i = -1; /* reloop */
390            continue;
391        }
392
393        if( doWrite && !o->isWritable )
394        {
395            dbgmsg(
396                "found it!  it's open and available, but isn't writable. closing..." );
397            TrCloseFile( i );
398            break;
399        }
400
401        dbgmsg( "found it!  it's ready for use!" );
402        winner = i;
403        break;
404    }
405
406    dbgmsg(
407        "it's not already open.  looking for an open slot or an old file." );
408    while( winner < 0 )
409    {
410        uint64_t date = tr_date( ) + 1;
411
412        /* look for the file that's been open longest */
413        for( i = 0; i < gFd->openFileLimit; ++i )
414        {
415            o = &gFd->openFiles[i];
416
417            if( !fileIsOpen( o ) )
418            {
419                winner = i;
420                dbgmsg( "found an empty slot in %d", winner );
421                break;
422            }
423
424            if( date > o->date )
425            {
426                date = o->date;
427                winner = i;
428            }
429        }
430
431        if( winner >= 0 )
432        {
433            if( fileIsOpen( &gFd->openFiles[winner] ) )
434            {
435                dbgmsg( "closing file '%s', slot #%d",
436                        gFd->openFiles[winner].filename,
437                        winner );
438                TrCloseFile( winner );
439            }
440        }
441        else
442        {
443            dbgmsg( "everything's full!  waiting for someone else to finish something" );
444            tr_lockUnlock( gFd->lock );
445            tr_wait( 200 );
446            tr_lockLock( gFd->lock );
447        }
448    }
449
450    assert( winner >= 0 );
451    o = &gFd->openFiles[winner];
452    if( !fileIsOpen( o ) )
453    {
454        const int err = TrOpenFile( winner, folder, torrentFile, doWrite, preallocationMode, desiredFileSize );
455        if( err ) {
456            tr_lockUnlock( gFd->lock );
457            errno = err;
458            return -1;
459        }
460
461        dbgmsg( "opened '%s' in slot %d, doWrite %c", filename, winner,
462                doWrite ? 'y' : 'n' );
463        tr_strlcpy( o->filename, filename, sizeof( o->filename ) );
464        o->isWritable = doWrite;
465        o->syncAt = time( NULL ) + SYNC_INTERVAL;
466    }
467
468    dbgmsg( "checking out '%s' in slot %d", filename, winner );
469    o->isCheckedOut = 1;
470    o->closeWhenDone = 0;
471    o->date = tr_date( );
472    tr_lockUnlock( gFd->lock );
473    return o->fd;
474}
475
476void
477tr_fdFileReturn( int fd )
478{
479    int i;
480
481    tr_lockLock( gFd->lock );
482
483    for( i = 0; i < gFd->openFileLimit; ++i )
484    {
485        struct tr_openfile * o = &gFd->openFiles[i];
486        if( o->fd != fd )
487            continue;
488
489        dbgmsg( "releasing file '%s' in slot #%d", o->filename, i );
490        o->isCheckedOut = 0;
491        if( o->closeWhenDone )
492            TrCloseFile( i );
493        else if( o->syncAt <= time( NULL ) ) {
494            dbgmsg( "fsync()ing file '%s' in slot #%d", o->filename, i );
495            //fsync( o->fd );
496#ifdef HAVE_POSIX_FADVISE
497            /* TODO: test performance with and without this */
498            posix_fadvise( o->fd, 0, 0, POSIX_FADV_DONTNEED );
499#endif
500            o->syncAt = time( NULL ) + SYNC_INTERVAL;
501        }
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.