transmission/libtransmission/cache.h

/*
 * This file Copyright (C) 2010-2014 Mnemosyne LLC
 *
 * It may be used under the GNU GPL versions 2 or 3
 * or any future license endorsed by Mnemosyne LLC.
 *
 */

#pragma once

#ifndef __TRANSMISSION__
#error only libtransmission should #include this header.
#endif

#include "tr-macros.h"

struct evbuffer;
struct tr_cache;

/***
****
***/

tr_cache* tr_cacheNew(int64_t max_bytes);

void tr_cacheFree(tr_cache*);

/***
****
***/

int tr_cacheSetLimit(tr_cache* cache, int64_t max_bytes);

int64_t tr_cacheGetLimit(tr_cache const*);

int tr_cacheWriteBlock(
    tr_cache* cache,
    tr_torrent* torrent,
    tr_piece_index_t piece,
    uint32_t offset,
    uint32_t len,
    struct evbuffer* writeme);

int tr_cacheReadBlock(
    tr_cache* cache,
    tr_torrent* torrent,
    tr_piece_index_t piece,
    uint32_t offset,
    uint32_t len,
    uint8_t* setme);

int tr_cachePrefetchBlock(tr_cache* cache, tr_torrent* torrent, tr_piece_index_t piece, uint32_t offset, uint32_t len);

/***
****
***/

int tr_cacheFlushDone(tr_cache* cache);

int tr_cacheFlushTorrent(tr_cache* cache, tr_torrent* torrent);

int tr_cacheFlushFile(tr_cache* cache, tr_torrent* torrent, tr_file_index_t file);
(trunk) #1521 "memory cache to reduce disk IO" -- commit block-cache-rc1.diff to trunk for the nightlies. 2010-06-19 14:25:11 +00:00			`/*`
(trunk) restore copyright year as suggested in email by rms 2014-01-18 20:56:57 +00:00			`* This file Copyright (C) 2010-2014 Mnemosyne LLC`
(trunk) #1521 "memory cache to reduce disk IO" -- commit block-cache-rc1.diff to trunk for the nightlies. 2010-06-19 14:25:11 +00:00			`*`
Copyedit the license's revised text: (1) remove unnecessary repitition use of the word 'license' from the top of the header and source files (2) add the standard 'we hope it's useful, but no warranty' clause to COPYING (3) make explicit that linking OpenSSL is allowed (see https://people.gnome.org/~markmc/openssl-and-the-gpl.html for background) (4) sync the Qt and GTK+ clients' license popups with COPYING's revised text 2014-01-21 03:10:30 +00:00			`* It may be used under the GNU GPL versions 2 or 3`
Licensing changes: 1. add the option the code to be used under GPLv2 or GPLv3; previously only GPLv2 was allowed 2. add the "proxy option" as described in GPLv3 so we can add future licenses without having to bulk-edit everything again :) 3. remove the awkward "exception for MIT code in Mac client" clause; it was unnecessary and confusing. 2014-01-19 01:09:44 +00:00			`* or any future license endorsed by Mnemosyne LLC.`
(trunk) #1521 "memory cache to reduce disk IO" -- commit block-cache-rc1.diff to trunk for the nightlies. 2010-06-19 14:25:11 +00:00			`*`
			`*/`

Ensure include guard is the first non-comment line 2017-11-14 20:21:28 +00:00			`#pragma once`

(trunk) #1521 "memory cache to reduce disk IO" -- commit block-cache-rc1.diff to trunk for the nightlies. 2010-06-19 14:25:11 +00:00			`#ifndef __TRANSMISSION__`
Adjust uncrustify config, reformat all but Mac client There're places where manual intervention is still required as uncrustify is not ideal (unfortunately), but at least one may rely on it to do the right thing most of the time (e.g. when sending in a patch). The style itself is quite different from what we had before but making it uniform across all the codebase is the key. I also hope that it'll make the code more readable (YMMV) and less sensitive to further changes. 2017-04-19 12:04:45 +00:00			`#error only libtransmission should #include this header.`
(trunk) #1521 "memory cache to reduce disk IO" -- commit block-cache-rc1.diff to trunk for the nightlies. 2010-06-19 14:25:11 +00:00			`#endif`

refactor: use GTest for running tests (#1383) * refactor: use google-test on libtransmission tests 2020-08-11 18:11:55 +00:00			`#include "tr-macros.h"`

(trunk libT) memory cache should use evbuffers to avoid unnecessary calls to memcpy -- done. 2011-01-29 18:56:53 +00:00			`struct evbuffer;`
refactor: prefer "using" over "typedef" (#1883) * refactor: prefer "using" over "typedef" 2021-10-06 14:26:07 +00:00			`struct tr_cache;`
(trunk) #1521 "memory cache to reduce disk IO" -- commit block-cache-rc1.diff to trunk for the nightlies. 2010-06-19 14:25:11 +00:00
			`/***`
			`****`
			`***/`

Adjust uncrustify config, reformat all but Mac client There're places where manual intervention is still required as uncrustify is not ideal (unfortunately), but at least one may rely on it to do the right thing most of the time (e.g. when sending in a patch). The style itself is quite different from what we had before but making it uniform across all the codebase is the key. I also hope that it'll make the code more readable (YMMV) and less sensitive to further changes. 2017-04-19 12:04:45 +00:00			`tr_cache* tr_cacheNew(int64_t max_bytes);`
(trunk) #1521 "memory cache to reduce disk IO" -- commit block-cache-rc1.diff to trunk for the nightlies. 2010-06-19 14:25:11 +00:00
Adjust uncrustify config, reformat all but Mac client There're places where manual intervention is still required as uncrustify is not ideal (unfortunately), but at least one may rely on it to do the right thing most of the time (e.g. when sending in a patch). The style itself is quite different from what we had before but making it uniform across all the codebase is the key. I also hope that it'll make the code more readable (YMMV) and less sensitive to further changes. 2017-04-19 12:04:45 +00:00			`void tr_cacheFree(tr_cache*);`
(trunk) #1521 "memory cache to reduce disk IO" -- commit block-cache-rc1.diff to trunk for the nightlies. 2010-06-19 14:25:11 +00:00
			`/***`
			`****`
			`***/`

Adjust uncrustify config, reformat all but Mac client There're places where manual intervention is still required as uncrustify is not ideal (unfortunately), but at least one may rely on it to do the right thing most of the time (e.g. when sending in a patch). The style itself is quite different from what we had before but making it uniform across all the codebase is the key. I also hope that it'll make the code more readable (YMMV) and less sensitive to further changes. 2017-04-19 12:04:45 +00:00			`int tr_cacheSetLimit(tr_cache* cache, int64_t max_bytes);`
(trunk) #1521 "memory cache to reduce disk IO" -- commit block-cache-rc1.diff to trunk for the nightlies. 2010-06-19 14:25:11 +00:00
Align type qualifiers to the right (code style) This way all the qualifiers (`const`, `volatile`, `mutable`) are grouped together, e.g. `T const* const x` vs. `const T* const x`. Also helps reading types right-to-left, e.g. "constant pointer to constant T" vs. "constant pointer to T which is constant". 2017-04-20 16:02:19 +00:00			`int64_t tr_cacheGetLimit(tr_cache const*);`
(trunk) #1521 "memory cache to reduce disk IO" -- commit block-cache-rc1.diff to trunk for the nightlies. 2010-06-19 14:25:11 +00:00
Switch to clang-format for code formatting, include Mac client 2021-08-15 09:41:48 +00:00			`int tr_cacheWriteBlock(`
			`tr_cache* cache,`
			`tr_torrent* torrent,`
			`tr_piece_index_t piece,`
			`uint32_t offset,`
			`uint32_t len,`
Adjust uncrustify config, reformat all but Mac client There're places where manual intervention is still required as uncrustify is not ideal (unfortunately), but at least one may rely on it to do the right thing most of the time (e.g. when sending in a patch). The style itself is quite different from what we had before but making it uniform across all the codebase is the key. I also hope that it'll make the code more readable (YMMV) and less sensitive to further changes. 2017-04-19 12:04:45 +00:00			`struct evbuffer* writeme);`
(trunk) #1521 "memory cache to reduce disk IO" -- commit block-cache-rc1.diff to trunk for the nightlies. 2010-06-19 14:25:11 +00:00
Switch to clang-format for code formatting, include Mac client 2021-08-15 09:41:48 +00:00			`int tr_cacheReadBlock(`
			`tr_cache* cache,`
			`tr_torrent* torrent,`
			`tr_piece_index_t piece,`
			`uint32_t offset,`
			`uint32_t len,`
Adjust uncrustify config, reformat all but Mac client There're places where manual intervention is still required as uncrustify is not ideal (unfortunately), but at least one may rely on it to do the right thing most of the time (e.g. when sending in a patch). The style itself is quite different from what we had before but making it uniform across all the codebase is the key. I also hope that it'll make the code more readable (YMMV) and less sensitive to further changes. 2017-04-19 12:04:45 +00:00			`uint8_t* setme);`
(trunk) #1521 "memory cache to reduce disk IO" -- commit block-cache-rc1.diff to trunk for the nightlies. 2010-06-19 14:25:11 +00:00
Adjust uncrustify config, reformat all but Mac client There're places where manual intervention is still required as uncrustify is not ideal (unfortunately), but at least one may rely on it to do the right thing most of the time (e.g. when sending in a patch). The style itself is quite different from what we had before but making it uniform across all the codebase is the key. I also hope that it'll make the code more readable (YMMV) and less sensitive to further changes. 2017-04-19 12:04:45 +00:00			`int tr_cachePrefetchBlock(tr_cache* cache, tr_torrent* torrent, tr_piece_index_t piece, uint32_t offset, uint32_t len);`
(trunk) #1521 "memory cache to reduce disk IO" -- commit block-cache-rc1.diff to trunk for the nightlies. 2010-06-19 14:25:11 +00:00
			`/***`
			`****`
			`***/`

Adjust uncrustify config, reformat all but Mac client There're places where manual intervention is still required as uncrustify is not ideal (unfortunately), but at least one may rely on it to do the right thing most of the time (e.g. when sending in a patch). The style itself is quite different from what we had before but making it uniform across all the codebase is the key. I also hope that it'll make the code more readable (YMMV) and less sensitive to further changes. 2017-04-19 12:04:45 +00:00			`int tr_cacheFlushDone(tr_cache* cache);`
(trunk) #1521 "memory cache to reduce disk IO" -- commit block-cache-rc1.diff to trunk for the nightlies. 2010-06-19 14:25:11 +00:00
Adjust uncrustify config, reformat all but Mac client There're places where manual intervention is still required as uncrustify is not ideal (unfortunately), but at least one may rely on it to do the right thing most of the time (e.g. when sending in a patch). The style itself is quite different from what we had before but making it uniform across all the codebase is the key. I also hope that it'll make the code more readable (YMMV) and less sensitive to further changes. 2017-04-19 12:04:45 +00:00			`int tr_cacheFlushTorrent(tr_cache* cache, tr_torrent* torrent);`
(trunk) #1521 "memory cache to reduce disk IO" -- commit block-cache-rc1.diff to trunk for the nightlies. 2010-06-19 14:25:11 +00:00
Adjust uncrustify config, reformat all but Mac client There're places where manual intervention is still required as uncrustify is not ideal (unfortunately), but at least one may rely on it to do the right thing most of the time (e.g. when sending in a patch). The style itself is quite different from what we had before but making it uniform across all the codebase is the key. I also hope that it'll make the code more readable (YMMV) and less sensitive to further changes. 2017-04-19 12:04:45 +00:00			`int tr_cacheFlushFile(tr_cache* cache, tr_torrent* torrent, tr_file_index_t file);`