source: trunk/libtransmission/inout.c @ 8050

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

(trunk libT) make file preallocation optional via settings.json. choices are: full, sparse, and none

  • Property svn:keywords set to Date Rev Author Id
File size: 7.4 KB
Line 
1/*
2 * This file Copyright (C) 2007-2009 Charles Kerr <charles@transmissionbt.com>
3 *
4 * This file is licensed by the GPL version 2.  Works owned by the
5 * Transmission project are granted a special exemption to clause 2(b)
6 * so that the bulk of its code can remain under the MIT license.
7 * This exemption does not extend to derived works not owned by
8 * the Transmission project.
9 *
10 * $Id: inout.c 7720 2009-01-16 16:38:16Z charles $
11 */
12
13#include <assert.h>
14#include <errno.h>
15#include <stdlib.h> /* realloc */
16#include <string.h> /* memcmp */
17
18#include <sys/types.h>
19#include <sys/stat.h>
20#include <unistd.h>
21
22#include <openssl/sha.h>
23
24#include "transmission.h"
25#include "crypto.h"
26#include "fdlimit.h"
27#include "inout.h"
28#include "platform.h"
29#include "stats.h"
30#include "torrent.h"
31#include "utils.h"
32
33/****
34*****  Low-level IO functions
35****/
36
37#ifdef WIN32
38 #if defined(read)
39  #undef read
40 #endif
41 #define read  _read
42 
43 #if defined(write)
44  #undef write
45 #endif
46 #define write _write
47#endif
48
49enum { TR_IO_READ, TR_IO_WRITE };
50
51static int64_t
52tr_lseek( int fd, int64_t offset, int whence )
53{
54#if defined(_LARGEFILE_SOURCE)
55    return lseek64( fd, (off64_t)offset, whence );
56#elif defined(WIN32)
57    return _lseeki64( fd, offset, whence );
58#else
59    return lseek( fd, (off_t)offset, whence );
60#endif
61}
62
63/* returns 0 on success, or an errno on failure */
64static int
65readOrWriteBytes( const tr_torrent * tor,
66                  int                ioMode,
67                  tr_file_index_t    fileIndex,
68                  uint64_t           fileOffset,
69                  void *             buf,
70                  size_t             buflen )
71{
72    const tr_info * info = &tor->info;
73    const tr_file * file = &info->files[fileIndex];
74    tr_preallocation_mode preallocationMode;
75
76    typedef size_t ( *iofunc )( int, void *, size_t );
77    iofunc          func = ioMode == TR_IO_READ ? (iofunc)read : (iofunc)write;
78    struct stat     sb;
79    int             fd = -1;
80    int             err;
81    int             fileExists;
82
83    assert( tor->downloadDir && *tor->downloadDir );
84    assert( fileIndex < info->fileCount );
85    assert( !file->length || ( fileOffset < file->length ) );
86    assert( fileOffset + buflen <= file->length );
87
88    {
89        char path[MAX_PATH_LENGTH];
90        tr_snprintf( path, sizeof( path ), "%s%c%s", tor->downloadDir, TR_PATH_DELIMITER, file->name );
91        fileExists = !stat( path, &sb );
92    }
93
94    if( !file->length )
95        return 0;
96
97    if( ( file->dnd ) || ( ioMode != TR_IO_WRITE ) )
98        preallocationMode = TR_PREALLOCATE_NONE;
99    else
100        preallocationMode = tor->session->preallocationMode;
101
102    if( ( ioMode == TR_IO_READ ) && !fileExists ) /* does file exist? */
103        err = errno;
104    else if( ( fd = tr_fdFileCheckout ( tor->downloadDir, file->name, ioMode == TR_IO_WRITE, preallocationMode, file->length ) ) < 0 )
105        err = errno;
106    else if( tr_lseek( fd, (int64_t)fileOffset, SEEK_SET ) == -1 )
107        err = errno;
108    else if( func( fd, buf, buflen ) != buflen )
109        err = errno;
110    else
111        err = 0;
112
113    if( ( !err ) && ( !fileExists ) && ( ioMode == TR_IO_WRITE ) )
114        tr_statsFileCreated( tor->session );
115
116    if( fd >= 0 )
117        tr_fdFileReturn( fd );
118
119    return err;
120}
121
122static int
123compareOffsetToFile( const void * a,
124                     const void * b )
125{
126    const uint64_t  offset = *(const uint64_t*)a;
127    const tr_file * file = b;
128
129    if( offset < file->offset ) return -1;
130    if( offset >= file->offset + file->length ) return 1;
131    return 0;
132}
133
134void
135tr_ioFindFileLocation( const tr_torrent * tor,
136                       tr_piece_index_t   pieceIndex,
137                       uint32_t           pieceOffset,
138                       tr_file_index_t  * fileIndex,
139                       uint64_t         * fileOffset )
140{
141    const uint64_t  offset = tr_pieceOffset( tor, pieceIndex, pieceOffset, 0 );
142    const tr_file * file;
143
144    file = bsearch( &offset,
145                    tor->info.files, tor->info.fileCount, sizeof( tr_file ),
146                    compareOffsetToFile );
147
148    *fileIndex = file - tor->info.files;
149    *fileOffset = offset - file->offset;
150
151    assert( *fileIndex < tor->info.fileCount );
152    assert( *fileOffset < file->length );
153    assert( tor->info.files[*fileIndex].offset + *fileOffset == offset );
154}
155
156/* returns 0 on success, or an errno on failure */
157static int
158readOrWritePiece( const tr_torrent * tor,
159                  int                ioMode,
160                  tr_piece_index_t   pieceIndex,
161                  uint32_t           pieceOffset,
162                  uint8_t *          buf,
163                  size_t             buflen )
164{
165    int             err = 0;
166    tr_file_index_t fileIndex;
167    uint64_t        fileOffset;
168    const tr_info * info = &tor->info;
169
170    if( pieceIndex >= tor->info.pieceCount )
171        return EINVAL;
172    if( pieceOffset + buflen > tr_torPieceCountBytes( tor, pieceIndex ) )
173        return EINVAL;
174
175    tr_ioFindFileLocation( tor, pieceIndex, pieceOffset,
176                           &fileIndex, &fileOffset );
177
178    while( buflen && !err )
179    {
180        const tr_file * file = &info->files[fileIndex];
181        const uint64_t  bytesThisPass = MIN( buflen, file->length - fileOffset );
182
183        err = readOrWriteBytes( tor, ioMode, fileIndex, fileOffset, buf, bytesThisPass );
184        buf += bytesThisPass;
185        buflen -= bytesThisPass;
186        ++fileIndex;
187        fileOffset = 0;
188    }
189
190    return err;
191}
192
193int
194tr_ioRead( const tr_torrent * tor,
195           tr_piece_index_t   pieceIndex,
196           uint32_t           begin,
197           uint32_t           len,
198           uint8_t *          buf )
199{
200    return readOrWritePiece( tor, TR_IO_READ, pieceIndex, begin, buf, len );
201}
202
203int
204tr_ioWrite( const tr_torrent * tor,
205            tr_piece_index_t   pieceIndex,
206            uint32_t           begin,
207            uint32_t           len,
208            const uint8_t *    buf )
209{
210    return readOrWritePiece( tor, TR_IO_WRITE, pieceIndex, begin,
211                             (uint8_t*)buf,
212                             len );
213}
214
215/****
216*****
217****/
218
219static tr_bool
220recalculateHash( const tr_torrent * tor,
221                 tr_piece_index_t   pieceIndex,
222                 void             * buffer,
223                 size_t             buflen,
224                 uint8_t *          setme )
225{
226    size_t   bytesLeft;
227    uint32_t offset = 0;
228    tr_bool  success = TRUE;
229    uint8_t  stackbuf[MAX_STACK_ARRAY_SIZE];
230    SHA_CTX  sha;
231
232    /* fallback buffer */
233    if( ( buffer == NULL ) || ( buflen < 1 ) )
234    {
235        buffer = stackbuf;
236        buflen = sizeof( stackbuf );
237    }
238
239    assert( tor != NULL );
240    assert( pieceIndex < tor->info.pieceCount );
241    assert( buffer != NULL );
242    assert( buflen > 0 );
243    assert( setme != NULL );
244
245    SHA1_Init( &sha );
246    bytesLeft = tr_torPieceCountBytes( tor, pieceIndex );
247
248    while( bytesLeft )
249    {
250        const int len = MIN( bytesLeft, buflen );
251        success = !tr_ioRead( tor, pieceIndex, offset, len, buffer );
252        if( !success )
253            break;
254        SHA1_Update( &sha, buffer, len );
255        offset += len;
256        bytesLeft -= len;
257    }
258
259    if( success )
260        SHA1_Final( setme, &sha );
261
262    return success;
263}
264
265tr_bool
266tr_ioTestPiece( const tr_torrent  * tor,
267                tr_piece_index_t    pieceIndex,
268                void              * buffer,
269                size_t              buflen )
270{
271    uint8_t hash[SHA_DIGEST_LENGTH];
272
273    return recalculateHash( tor, pieceIndex, buffer, buflen, hash )
274           && !memcmp( hash, tor->info.pieces[pieceIndex].hash, SHA_DIGEST_LENGTH );
275}
Note: See TracBrowser for help on using the repository browser.