source: trunk/libtransmission/inout.c @ 12076

Last change on this file since 12076 was 12076, checked in by jordan, 11 years ago

(trunk libT) add an "existing dir" argument to tr_fdFileCheckout().

existing_dir: An ancestor of filename which must already exist and won't be created by tr_fdFileCheckout(). In implementation this is the download directory and prevents directories from being created in error, such as a mount point for an external drive when the drive is unplugged.

  • Property svn:keywords set to Date Rev Author Id
File size: 9.9 KB
Line 
1/*
2 * This file Copyright (C) Mnemosyne LLC
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 12076 2011-03-03 19:59:12Z jordan $
11 */
12
13#ifdef HAVE_LSEEK64
14 #define _LARGEFILE64_SOURCE
15#endif
16
17#include <assert.h>
18#include <errno.h>
19#include <stdlib.h> /* realloc */
20#include <string.h> /* memcmp */
21
22#include <sys/types.h>
23#include <sys/stat.h>
24#include <unistd.h>
25
26#include <openssl/sha.h>
27
28#include "transmission.h"
29#include "cache.h"
30#include "crypto.h"
31#include "fdlimit.h"
32#include "inout.h"
33#include "peer-common.h" /* MAX_BLOCK_SIZE */
34#include "platform.h"
35#include "stats.h"
36#include "torrent.h"
37#include "utils.h"
38
39/****
40*****  Low-level IO functions
41****/
42
43#ifdef WIN32
44 #if defined(read)
45  #undef read
46 #endif
47 #define read  _read
48
49 #if defined(write)
50  #undef write
51 #endif
52 #define write _write
53#endif
54
55enum { TR_IO_READ, TR_IO_PREFETCH,
56       /* Any operations that require write access must follow TR_IO_WRITE. */
57       TR_IO_WRITE
58};
59
60/* returns 0 on success, or an errno on failure */
61static int
62readOrWriteBytes( tr_session       * session,
63                  tr_torrent       * tor,
64                  int                ioMode,
65                  tr_file_index_t    fileIndex,
66                  uint64_t           fileOffset,
67                  void             * buf,
68                  size_t             buflen )
69{
70    const tr_info * info = &tor->info;
71    const tr_file * file = &info->files[fileIndex];
72
73    int             fd = -1;
74    int             err = 0;
75    const tr_bool doWrite = ioMode >= TR_IO_WRITE;
76
77//if( doWrite )
78//    fprintf( stderr, "in file %s at offset %zu, writing %zu bytes; file length is %zu\n", file->name, (size_t)fileOffset, buflen, (size_t)file->length );
79
80    assert( fileIndex < info->fileCount );
81    assert( !file->length || ( fileOffset < file->length ) );
82    assert( fileOffset + buflen <= file->length );
83
84    if( !file->length )
85        return 0;
86
87    fd = tr_fdFileGetCached( session, tr_torrentId( tor ), fileIndex, doWrite );
88
89    if( fd < 0 )
90    {
91        /* the fd cache doesn't have this file...
92         * we'll need to open it and maybe create it */
93        char * subpath;
94        const char * base;
95        tr_bool fileExists;
96        tr_preallocation_mode preallocationMode;
97
98        fileExists = tr_torrentFindFile2( tor, fileIndex, &base, &subpath );
99
100        if( !fileExists )
101        {
102            base = tr_torrentGetCurrentDir( tor );
103
104            if( tr_sessionIsIncompleteFileNamingEnabled( tor->session ) )
105                subpath = tr_torrentBuildPartial( tor, fileIndex );
106            else
107                subpath = tr_strdup( file->name );
108        }
109
110        if( ( file->dnd ) || ( ioMode < TR_IO_WRITE ) )
111            preallocationMode = TR_PREALLOCATE_NONE;
112        else
113            preallocationMode = tor->session->preallocationMode;
114
115        if( ( ioMode < TR_IO_WRITE ) && !fileExists ) /* does file exist? */
116        {
117            err = ENOENT;
118        }
119        else
120        {
121            char * filename = tr_buildPath( base, subpath, NULL );
122
123            if( ( fd = tr_fdFileCheckout( session, tor->uniqueId, fileIndex,
124                                          base, filename,
125                                          doWrite, preallocationMode, file->length ) ) < 0 )
126            {
127                err = errno;
128                tr_torerr( tor, "tr_fdFileCheckout failed for \"%s\": %s", filename, tr_strerror( err ) );
129            }
130
131            tr_free( filename );
132        }
133
134        if( doWrite && !err )
135            tr_statsFileCreated( tor->session );
136
137        tr_free( subpath );
138    }
139
140    /* check that the file corresponding to 'fd' still exists */
141    if( fd >= 0 )
142    {
143        struct stat sb;
144
145        if( !fstat( fd, &sb ) && sb.st_nlink < 1 )
146        {
147            tr_torrentSetLocalError( tor, "Please Verify Local Data! A file disappeared: \"%s\"", file->name );
148            err = ENOENT;
149        }
150    }
151
152    if( !err )
153    {
154        if( ioMode == TR_IO_READ ) {
155            const int rc = tr_pread( fd, buf, buflen, fileOffset );
156            if( rc < 0 ) {
157                err = errno;
158                tr_torerr( tor, "read failed for \"%s\": %s",
159                           file->name, tr_strerror( err ) );
160            }
161        } else if( ioMode == TR_IO_PREFETCH ) {
162            const int rc = tr_prefetch( fd, fileOffset, buflen );
163            if( rc < 0 ) {
164                /* (don't set "err" here... it's okay for prefetch to fail) */
165                tr_tordbg( tor, "prefetch failed for \"%s\": %s",
166                           file->name, tr_strerror( errno ) );
167            }
168        } else if( ioMode == TR_IO_WRITE ) {
169            const int rc = tr_pwrite( fd, buf, buflen, fileOffset );
170            if( rc < 0 ) {
171                err = errno;
172                tr_torerr( tor, "write failed for \"%s\": %s",
173                           file->name, tr_strerror( err ) );
174            }
175        } else {
176            abort();
177        }
178    }
179
180    return err;
181}
182
183static int
184compareOffsetToFile( const void * a, const void * b )
185{
186    const uint64_t  offset = *(const uint64_t*)a;
187    const tr_file * file = b;
188
189    if( offset < file->offset ) return -1;
190    if( offset >= file->offset + file->length ) return 1;
191    return 0;
192}
193
194void
195tr_ioFindFileLocation( const tr_torrent * tor,
196                       tr_piece_index_t   pieceIndex,
197                       uint32_t           pieceOffset,
198                       tr_file_index_t  * fileIndex,
199                       uint64_t         * fileOffset )
200{
201    const uint64_t  offset = tr_pieceOffset( tor, pieceIndex, pieceOffset, 0 );
202    const tr_file * file;
203
204    assert( tr_isTorrent( tor ) );
205    assert( offset < tor->info.totalSize );
206
207    file = bsearch( &offset,
208                    tor->info.files, tor->info.fileCount, sizeof( tr_file ),
209                    compareOffsetToFile );
210
211    assert( file != NULL );
212
213    *fileIndex = file - tor->info.files;
214    *fileOffset = offset - file->offset;
215
216    assert( *fileIndex < tor->info.fileCount );
217    assert( *fileOffset < file->length );
218    assert( tor->info.files[*fileIndex].offset + *fileOffset == offset );
219}
220
221/* returns 0 on success, or an errno on failure */
222static int
223readOrWritePiece( tr_torrent       * tor,
224                  int                ioMode,
225                  tr_piece_index_t   pieceIndex,
226                  uint32_t           pieceOffset,
227                  uint8_t          * buf,
228                  size_t             buflen )
229{
230    int             err = 0;
231    tr_file_index_t fileIndex;
232    uint64_t        fileOffset;
233    const tr_info * info = &tor->info;
234
235    if( pieceIndex >= tor->info.pieceCount )
236        return EINVAL;
237    //if( pieceOffset + buflen > tr_torPieceCountBytes( tor, pieceIndex ) )
238    //    return EINVAL;
239
240    tr_ioFindFileLocation( tor, pieceIndex, pieceOffset,
241                           &fileIndex, &fileOffset );
242
243    while( buflen && !err )
244    {
245        const tr_file * file = &info->files[fileIndex];
246        const uint64_t bytesThisPass = MIN( buflen, file->length - fileOffset );
247
248        err = readOrWriteBytes( tor->session, tor, ioMode, fileIndex, fileOffset, buf, bytesThisPass );
249        buf += bytesThisPass;
250        buflen -= bytesThisPass;
251//fprintf( stderr, "++fileIndex to %d\n", (int)fileIndex );
252        ++fileIndex;
253        fileOffset = 0;
254
255        if( ( err != 0 ) && (ioMode == TR_IO_WRITE ) && ( tor->error != TR_STAT_LOCAL_ERROR ) )
256        {
257            char * path = tr_buildPath( tor->downloadDir, file->name, NULL );
258            tr_torrentSetLocalError( tor, "%s (%s)", tr_strerror( err ), path );
259            tr_free( path );
260        }
261    }
262
263    return err;
264}
265
266int
267tr_ioRead( tr_torrent       * tor,
268           tr_piece_index_t   pieceIndex,
269           uint32_t           begin,
270           uint32_t           len,
271           uint8_t          * buf )
272{
273    return readOrWritePiece( tor, TR_IO_READ, pieceIndex, begin, buf, len );
274}
275
276int
277tr_ioPrefetch( tr_torrent       * tor,
278               tr_piece_index_t   pieceIndex,
279               uint32_t           begin,
280               uint32_t           len)
281{
282    return readOrWritePiece( tor, TR_IO_PREFETCH, pieceIndex, begin,
283                             NULL, len );
284}
285
286int
287tr_ioWrite( tr_torrent       * tor,
288            tr_piece_index_t   pieceIndex,
289            uint32_t           begin,
290            uint32_t           len,
291            const uint8_t    * buf )
292{
293    return readOrWritePiece( tor, TR_IO_WRITE, pieceIndex, begin,
294                             (uint8_t*)buf,
295                             len );
296}
297
298/****
299*****
300****/
301
302static tr_bool
303recalculateHash( tr_torrent       * tor,
304                 tr_piece_index_t   pieceIndex,
305                 uint8_t          * setme )
306{
307    size_t   bytesLeft;
308    uint32_t offset = 0;
309    tr_bool  success = TRUE;
310    const size_t buflen = tor->blockSize;
311    void * buffer = tr_valloc( buflen );
312    SHA_CTX  sha;
313
314    assert( tor != NULL );
315    assert( pieceIndex < tor->info.pieceCount );
316    assert( buffer != NULL );
317    assert( buflen > 0 );
318    assert( setme != NULL );
319
320    SHA1_Init( &sha );
321    bytesLeft = tr_torPieceCountBytes( tor, pieceIndex );
322
323    tr_ioPrefetch( tor, pieceIndex, offset, bytesLeft );
324
325    while( bytesLeft )
326    {
327        const int len = MIN( bytesLeft, buflen );
328        success = !tr_cacheReadBlock( tor->session->cache, tor, pieceIndex, offset, len, buffer );
329        if( !success )
330            break;
331        SHA1_Update( &sha, buffer, len );
332        offset += len;
333        bytesLeft -= len;
334    }
335
336    if( success )
337        SHA1_Final( setme, &sha );
338
339    tr_free( buffer );
340    return success;
341}
342
343tr_bool
344tr_ioTestPiece( tr_torrent * tor, tr_piece_index_t piece )
345{
346    uint8_t hash[SHA_DIGEST_LENGTH];
347
348    return recalculateHash( tor, piece, hash )
349           && !memcmp( hash, tor->info.pieces[piece].hash, SHA_DIGEST_LENGTH );
350}
Note: See TracBrowser for help on using the repository browser.