source: trunk/libtransmission/fdlimit.c @ 8300

Last change on this file since 8300 was 8300, checked in by charles, 12 years ago

(trunk libT) prevent stupid double-close error introduced a few minutes ago :/

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