regenerated html
This commit is contained in:
Arvid Norberg
parent
8b8e8df798
commit
206b736632
|
|
@ -78,7 +78,7 @@
|
|||
<li><a class="reference internal" href="#get-cache-info" id="id32">get_cache_info()</a></li>
|
||||
<li><a class="reference internal" href="#is-listening-listen-port-listen-on" id="id33">is_listening() listen_port() listen_on()</a></li>
|
||||
<li><a class="reference internal" href="#set-alert-mask" id="id34">set_alert_mask()</a></li>
|
||||
<li><a class="reference internal" href="#pop-alert-wait-for-alert" id="id35">pop_alert() wait_for_alert()</a></li>
|
||||
<li><a class="reference internal" href="#pop-alerts-pop-alert-wait-for-alert" id="id35">pop_alerts() pop_alert() wait_for_alert()</a></li>
|
||||
<li><a class="reference internal" href="#add-feed" id="id36">add_feed()</a></li>
|
||||
<li><a class="reference internal" href="#remove-feed" id="id37">remove_feed()</a></li>
|
||||
<li><a class="reference internal" href="#get-feeds" id="id38">get_feeds()</a></li>
|
||||
|
|
@ -1101,6 +1101,9 @@ struct cache_status
|
|||
int total_used_buffers;
|
||||
int average_queue_time;
|
||||
int average_read_time;
|
||||
int average_write_time;
|
||||
int average_hash_time;
|
||||
int average_cache_time;
|
||||
int job_queue_length;
|
||||
};
|
||||
</pre>
|
||||
|
|
@ -1125,9 +1128,18 @@ This includes the read/write disk cache as well as send and receive buffers
|
|||
used in peer connections.</p>
|
||||
<p><tt class="docutils literal"><span class="pre">average_queue_time</span></tt> is the number of microseconds an average disk I/O job
|
||||
has to wait in the job queue before it get processed.</p>
|
||||
<p><tt class="docutils literal"><span class="pre">average_read_time</span></tt> is the number of microseconds a read job takes to
|
||||
wait in the queue and complete, in microseconds. This only includes
|
||||
cache misses.</p>
|
||||
<p><tt class="docutils literal"><span class="pre">average_read_time</span></tt> is the time read jobs takes on average to complete
|
||||
(not including the time in the queue), in microseconds. This only measures
|
||||
read cache misses.</p>
|
||||
<p><tt class="docutils literal"><span class="pre">average_write_time</span></tt> is the time write jobs takes to complete, on average,
|
||||
in microseconds. This does not include the time the job sits in the disk job
|
||||
queue or in the write cache, only blocks that are flushed to disk.</p>
|
||||
<p><tt class="docutils literal"><span class="pre">average_hash_time</span></tt> is the time hash jobs takes to complete on average, in
|
||||
microseconds. Hash jobs include running SHA-1 on the data (which for the most
|
||||
part is done incrementally) and sometimes reading back parts of the piece. It
|
||||
also includes checking files without valid resume data.</p>
|
||||
<p><tt class="docutils literal"><span class="pre">average_cache_time</span></tt> is the average amuount of time spent evicting cached
|
||||
blocks that have expired from the disk cache.</p>
|
||||
<p><tt class="docutils literal"><span class="pre">job_queue_length</span></tt> is the number of jobs in the job queue.</p>
|
||||
</div>
|
||||
<div class="section" id="get-cache-info">
|
||||
|
|
@ -1238,17 +1250,32 @@ void set_alert_mask(int m);
|
|||
<tt class="docutils literal"><span class="pre">m</span></tt> is a bitmask where each bit represents a category of alerts.</p>
|
||||
<p>See <a class="reference internal" href="#alerts">alerts</a> for mor information on the alert categories.</p>
|
||||
</div>
|
||||
<div class="section" id="pop-alert-wait-for-alert">
|
||||
<h2>pop_alert() wait_for_alert()</h2>
|
||||
<div class="section" id="pop-alerts-pop-alert-wait-for-alert">
|
||||
<h2>pop_alerts() pop_alert() wait_for_alert()</h2>
|
||||
<blockquote>
|
||||
<pre class="literal-block">
|
||||
std::auto_ptr<alert> pop_alert();
|
||||
void pop_alerts(std::deque<alert*>* alerts);
|
||||
alert const* wait_for_alert(time_duration max_wait);
|
||||
</pre>
|
||||
</blockquote>
|
||||
<p><tt class="docutils literal"><span class="pre">pop_alert()</span></tt> is used to ask the session if any errors or events has occurred. With
|
||||
<a class="reference internal" href="#set-alert-mask">set_alert_mask()</a> you can filter which alerts to receive through <tt class="docutils literal"><span class="pre">pop_alert()</span></tt>.
|
||||
For information about the alert categories, see <a class="reference internal" href="#alerts">alerts</a>.</p>
|
||||
<p><tt class="docutils literal"><span class="pre">pop_alerts()</span></tt> pops all pending alerts in a single call. In high performance environments
|
||||
with a very high alert churn rate, this can save significant amount of time compared to
|
||||
popping alerts one at a time. Each call requires one round-trip to the network thread. If
|
||||
alerts are produced in a higher rate than they can be popped (when popped one at a time)
|
||||
it's easy to get stuck in an infinite loop, trying to drain the alert queue. Popping the entire
|
||||
queue at once avoids this problem.</p>
|
||||
<p>However, the <tt class="docutils literal"><span class="pre">pop_alerts</span></tt> function comes with significantly more responsibility. You pass
|
||||
in an <em>empty</em> <tt class="docutils literal"><span class="pre">std::dequeue<alert*></span></tt> to it. If it's not empty, all elements in it will
|
||||
be deleted and then cleared. All currently pending alerts are returned by being swapped
|
||||
into the passed in container. The responsibility of deleting the alerts is transferred
|
||||
to the caller. This means you need to call delete for each item in the returned dequeue.
|
||||
It's probably a good idea to delete the alerts as you handle them, to save one extra
|
||||
pass over the dequeue.</p>
|
||||
<p>Alternatively, you can pass in the same container the next time you call <tt class="docutils literal"><span class="pre">pop_alerts</span></tt>.</p>
|
||||
<p><tt class="docutils literal"><span class="pre">wait_for_alert</span></tt> blocks until an alert is available, or for no more than <tt class="docutils literal"><span class="pre">max_wait</span></tt>
|
||||
time. If <tt class="docutils literal"><span class="pre">wait_for_alert</span></tt> returns because of the time-out, and no alerts are available,
|
||||
it returns 0. If at least one alert was generated, a pointer to that alert is returned.
|
||||
|
|
@ -4258,7 +4285,7 @@ struct session_settings
|
|||
int file_checks_delay_per_block;
|
||||
|
||||
enum disk_cache_algo_t
|
||||
{ lru, largest_contiguous };
|
||||
{ lru, largest_contiguous, avoid_readback };
|
||||
|
||||
disk_cache_algo_t disk_cache_algorithm;
|
||||
|
||||
|
|
@ -4309,6 +4336,7 @@ struct session_settings
|
|||
int download_rate_limit;
|
||||
int local_upload_rate_limit;
|
||||
int local_download_rate_limit;
|
||||
int dht_upload_rate_limit;
|
||||
int unchoke_slots_limit;
|
||||
int half_open_limit;
|
||||
int connections_limit;
|
||||
|
|
@ -4344,6 +4372,7 @@ struct session_settings
|
|||
bool smooth_connects;
|
||||
bool always_send_user_agent;
|
||||
bool apply_ip_filter_to_trackers;
|
||||
int read_job_every;
|
||||
};
|
||||
</pre>
|
||||
<p><tt class="docutils literal"><span class="pre">version</span></tt> is automatically set to the libtorrent version you're using
|
||||
|
|
@ -4779,7 +4808,10 @@ flushes the entire piece, in the write cache, that was least recently
|
|||
written to. This is specified by the <tt class="docutils literal"><span class="pre">session_settings::lru</span></tt> enum
|
||||
value. <tt class="docutils literal"><span class="pre">session_settings::largest_contiguous</span></tt> will flush the largest
|
||||
sequences of contiguous blocks from the write cache, regarless of the
|
||||
piece's last use time.</p>
|
||||
piece's last use time. <tt class="docutils literal"><span class="pre">session_settings::avoid_readback</span></tt> will prioritize
|
||||
flushing blocks that will avoid having to read them back in to verify
|
||||
the hash of the piece once it's done. This is especially useful for high
|
||||
throughput setups, where reading from the disk is especially expensive.</p>
|
||||
<p><tt class="docutils literal"><span class="pre">read_cache_line_size</span></tt> is the number of blocks to read into the read
|
||||
cache when a read cache miss occurs. Setting this to 0 is essentially
|
||||
the same thing as disabling read cache. The number of blocks read
|
||||
|
|
@ -4952,6 +4984,9 @@ is set to true (which it is by default). These rate limits default to unthrottle
|
|||
but can be useful in case you want to treat local peers preferentially, but not
|
||||
quite unthrottled.</p>
|
||||
<p>A value of 0 means unlimited.</p>
|
||||
<p><tt class="docutils literal"><span class="pre">dht_upload_rate_limit</span></tt> sets the rate limit on the DHT. This is specified in
|
||||
bytes per second and defaults to 4000. For busy boxes with lots of torrents
|
||||
that requires more DHT traffic, this should be raised.</p>
|
||||
<p><tt class="docutils literal"><span class="pre">unchoke_slots_limit</span></tt> is the mac number of unchoked peers in the session.</p>
|
||||
<p>The number of unchoke slots may be ignored depending on what
|
||||
<tt class="docutils literal"><span class="pre">choking_algorithm</span></tt> is set to.</p>
|
||||
|
|
@ -5050,6 +5085,12 @@ request in a connection.</p>
|
|||
IP filter applies to trackers as well as peers. If this is set to false,
|
||||
trackers are exempt from the IP filter (if there is one). If no IP filter
|
||||
is set, this setting is irrelevant.</p>
|
||||
<p><tt class="docutils literal"><span class="pre">read_job_every</span></tt> is used to avoid starvation of read jobs in the disk I/O
|
||||
thread. By default, read jobs are deferred, sorted by physical disk location
|
||||
and serviced once all write jobs have been issued. In scenarios where the
|
||||
download rate is enough to saturate the disk, there's a risk the read jobs will
|
||||
never be serviced. With this setting, every <em>x</em> write job, issued in a row, will
|
||||
instead pick one read job off of the sorted queue, where <em>x</em> is <tt class="docutils literal"><span class="pre">read_job_every</span></tt>.</p>
|
||||
</div>
|
||||
</div>
|
||||
<div class="section" id="pe-settings">
|
||||
|
|
@ -6233,7 +6274,7 @@ struct peer_disconnected_alert: peer_alert
|
|||
<div class="section" id="invalid-request-alert">
|
||||
<h2>invalid_request_alert</h2>
|
||||
<p>This is a debug alert that is generated by an incoming invalid piece request.
|
||||
<tt class="docutils literal"><span class="pre">ìp</span></tt> is the address of the peer and the <tt class="docutils literal"><span class="pre">request</span></tt> is the actual incoming
|
||||
<tt class="docutils literal"><span class="pre">Ïp</span></tt> is the address of the peer and the <tt class="docutils literal"><span class="pre">request</span></tt> is the actual incoming
|
||||
request from the peer.</p>
|
||||
<pre class="literal-block">
|
||||
struct invalid_request_alert: peer_alert
|
||||
|
|
@ -6392,7 +6433,8 @@ struct performance_alert: torrent_alert
|
|||
upload_limit_too_low,
|
||||
download_limit_too_low,
|
||||
send_buffer_watermark_too_low,
|
||||
too_many_optimistic_unchoke_slots
|
||||
too_many_optimistic_unchoke_slots,
|
||||
too_high_disk_queue_limit
|
||||
};
|
||||
|
||||
performance_warning_t warning_code;
|
||||
|
|
@ -6451,6 +6493,12 @@ or <tt class="docutils literal"><span class="pre">send_buffer_watermark_factor</
|
|||
<dt>too_many_optimistic_unchoke_slots</dt>
|
||||
<dd>If the half (or more) of all upload slots are set as optimistic unchoke slots, this
|
||||
warning is issued. You probably want more regular (rate based) unchoke slots.</dd>
|
||||
<dt>too_high_disk_queue_limit</dt>
|
||||
<dd>If the disk write queue ever grows larger than half of the cache size, this warning
|
||||
is posted. The disk write queue eats into the total disk cache and leaves very little
|
||||
left for the actual cache. This causes the disk cache to oscillate in evicting large
|
||||
portions of the cache before allowing peers to download any more, onto the disk write
|
||||
queue. Either lower <tt class="docutils literal"><span class="pre">max_queued_disk_bytes</span></tt> or increase <tt class="docutils literal"><span class="pre">cache_size</span></tt>.</dd>
|
||||
</dl>
|
||||
</div>
|
||||
<div class="section" id="state-changed-alert">
|
||||
|
|
@ -7675,13 +7723,13 @@ std::string error_code_to_string(boost::system::error_code const& ec)
|
|||
static const char const* swedish[] =
|
||||
{
|
||||
"inget fel",
|
||||
"en fil i torrenten kolliderar med en fil från en annan torrent",
|
||||
"en fil i torrenten kolliderar med en fil frÂn en annan torrent",
|
||||
"hash check misslyckades",
|
||||
"torrent filen är inte en dictionary",
|
||||
"'info'-nyckeln saknas eller är korrupt i torrentfilen",
|
||||
"'info'-fältet är inte en dictionary",
|
||||
"'piece length' fältet saknas eller är korrupt i torrentfilen",
|
||||
"torrentfilen saknar namnfältet",
|
||||
"torrent filen ‰r inte en dictionary",
|
||||
"'info'-nyckeln saknas eller ‰r korrupt i torrentfilen",
|
||||
"'info'-f‰ltet ‰r inte en dictionary",
|
||||
"'piece length' f‰ltet saknas eller ‰r korrupt i torrentfilen",
|
||||
"torrentfilen saknar namnf‰ltet",
|
||||
"ogiltigt namn i torrentfilen (kan vara en attack)",
|
||||
// ... more strings here
|
||||
};
|
||||
|
|
|
|||
|
|
@ -85,7 +85,8 @@
|
|||
<li><a class="reference internal" href="#session-stats" id="id22">session stats</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a class="reference internal" href="#contributions" id="id23">contributions</a></li>
|
||||
<li><a class="reference internal" href="#understanding-the-disk-thread" id="id23">understanding the disk thread</a></li>
|
||||
<li><a class="reference internal" href="#contributions" id="id24">contributions</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="section" id="tuning-libtorrent">
|
||||
|
|
@ -524,10 +525,9 @@ file, <tt class="docutils literal"><span class="pre">disk_access.gnuplot</span><
|
|||
</div>
|
||||
<div class="section" id="session-stats">
|
||||
<h2>session stats</h2>
|
||||
<p>By defining <tt class="docutils literal"><span class="pre">TORRENT_STATS</span></tt> libtorrent will write a log file called <tt class="docutils literal"><span class="pre">session_stats.log</span></tt> which
|
||||
<p>By defining <tt class="docutils literal"><span class="pre">TORRENT_STATS</span></tt> libtorrent will write a log file called <tt class="docutils literal"><span class="pre">session_stats/<pid>.<sequence>.log</span></tt> which
|
||||
is in a format ready to be passed directly into gnuplot. The parser script <tt class="docutils literal"><span class="pre">parse_session_stats.py</span></tt>
|
||||
will however parse out the field names and generate 3 different views of the data. This script
|
||||
is easy to modify to generate the particular view you're interested in.</p>
|
||||
generates a report in <tt class="docutils literal"><span class="pre">session_stats_report/index.html</span></tt>.</p>
|
||||
<p>The first line in the log contains all the field names, separated by colon:</p>
|
||||
<pre class="literal-block">
|
||||
second:upload rate:download rate:downloading torrents:seeding torrents:peers...
|
||||
|
|
@ -592,6 +592,18 @@ grows over time. This list is plotted against the right axis, as it has a differ
|
|||
as the other fields.</p>
|
||||
</div>
|
||||
</div>
|
||||
<div class="section" id="understanding-the-disk-thread">
|
||||
<h1>understanding the disk thread</h1>
|
||||
<p>All disk operations are funneled through a separate thread, referred to as the disk thread.
|
||||
The main interface to the disk thread is a queue where disk jobs are posted, and the results
|
||||
of these jobs are then posted back on the main thread's io_service.</p>
|
||||
<p>A disk job is essentially one of:</p>
|
||||
<ol class="arabic simple">
|
||||
<li>write this block to disk, i.e. a write job. For the most part this is just a matter of sticking the block in the disk cache, but if we've run out of cache space or completed a whole piece, we'll also flush blocks to disk. This is typically very fast, since the OS just sticks these buffers in its write cache which will be flushed at a later time, presumably when the drive head will pass the place on the platter where the blocks go.</li>
|
||||
<li>read this block from disk. The first thing that happens is we look in the cache to see if the block is already in RAM. If it is, we'll return immediately with this block. If it's a cache miss, we'll have to hit the disk. Here we decide to defer this job. We find the physical offset on the drive for this block and insert the job in an ordere queue, sorted by the physical location. At a later time, once we don't have any more non-read jobs left in the queue, we pick one read job out of the ordered queue and service it. The order we pick jobs out of the queue is according to an elevator cursor moving up and down along the ordered queue of read jobs. If we have enough space in the cache we'll read read_cache_line_size number of blocks and stick those in the cache. This defaults to 32 blocks.</li>
|
||||
</ol>
|
||||
<p>Other disk job consist of operations that needs to be synchronized with the disk I/O, like renaming files, closing files, flushing the cache, updating the settings etc. These are relatively rare though.</p>
|
||||
</div>
|
||||
<div class="section" id="contributions">
|
||||
<h1>contributions</h1>
|
||||
<p>If you have added instrumentation for some part of libtorrent that is not covered here, or
|
||||
|
|
|
|||
Loading…
Reference in New Issue