-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Linus Torvalds
committed
Mar 24, 2010
1 parent
deefca3
commit f0712c9
Showing
820 changed files
with
60,082 additions
and
8,657 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,2 +1,2 @@ | ||
--- | ||
refs/heads/master: 6e6c822868f113dabe3c33bdd91e883cc28fa11b | ||
refs/heads/master: 6467a71c56934251f3c917bd4386387c2a97b41e |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,234 @@ | ||
================ | ||
CIRCULAR BUFFERS | ||
================ | ||
|
||
By: David Howells <dhowells@redhat.com> | ||
Paul E. McKenney <paulmck@linux.vnet.ibm.com> | ||
|
||
|
||
Linux provides a number of features that can be used to implement circular | ||
buffering. There are two sets of such features: | ||
|
||
(1) Convenience functions for determining information about power-of-2 sized | ||
buffers. | ||
|
||
(2) Memory barriers for when the producer and the consumer of objects in the | ||
buffer don't want to share a lock. | ||
|
||
To use these facilities, as discussed below, there needs to be just one | ||
producer and just one consumer. It is possible to handle multiple producers by | ||
serialising them, and to handle multiple consumers by serialising them. | ||
|
||
|
||
Contents: | ||
|
||
(*) What is a circular buffer? | ||
|
||
(*) Measuring power-of-2 buffers. | ||
|
||
(*) Using memory barriers with circular buffers. | ||
- The producer. | ||
- The consumer. | ||
|
||
|
||
========================== | ||
WHAT IS A CIRCULAR BUFFER? | ||
========================== | ||
|
||
First of all, what is a circular buffer? A circular buffer is a buffer of | ||
fixed, finite size into which there are two indices: | ||
|
||
(1) A 'head' index - the point at which the producer inserts items into the | ||
buffer. | ||
|
||
(2) A 'tail' index - the point at which the consumer finds the next item in | ||
the buffer. | ||
|
||
Typically when the tail pointer is equal to the head pointer, the buffer is | ||
empty; and the buffer is full when the head pointer is one less than the tail | ||
pointer. | ||
|
||
The head index is incremented when items are added, and the tail index when | ||
items are removed. The tail index should never jump the head index, and both | ||
indices should be wrapped to 0 when they reach the end of the buffer, thus | ||
allowing an infinite amount of data to flow through the buffer. | ||
|
||
Typically, items will all be of the same unit size, but this isn't strictly | ||
required to use the techniques below. The indices can be increased by more | ||
than 1 if multiple items or variable-sized items are to be included in the | ||
buffer, provided that neither index overtakes the other. The implementer must | ||
be careful, however, as a region more than one unit in size may wrap the end of | ||
the buffer and be broken into two segments. | ||
|
||
|
||
============================ | ||
MEASURING POWER-OF-2 BUFFERS | ||
============================ | ||
|
||
Calculation of the occupancy or the remaining capacity of an arbitrarily sized | ||
circular buffer would normally be a slow operation, requiring the use of a | ||
modulus (divide) instruction. However, if the buffer is of a power-of-2 size, | ||
then a much quicker bitwise-AND instruction can be used instead. | ||
|
||
Linux provides a set of macros for handling power-of-2 circular buffers. These | ||
can be made use of by: | ||
|
||
#include <linux/circ_buf.h> | ||
|
||
The macros are: | ||
|
||
(*) Measure the remaining capacity of a buffer: | ||
|
||
CIRC_SPACE(head_index, tail_index, buffer_size); | ||
|
||
This returns the amount of space left in the buffer[1] into which items | ||
can be inserted. | ||
|
||
|
||
(*) Measure the maximum consecutive immediate space in a buffer: | ||
|
||
CIRC_SPACE_TO_END(head_index, tail_index, buffer_size); | ||
|
||
This returns the amount of consecutive space left in the buffer[1] into | ||
which items can be immediately inserted without having to wrap back to the | ||
beginning of the buffer. | ||
|
||
|
||
(*) Measure the occupancy of a buffer: | ||
|
||
CIRC_CNT(head_index, tail_index, buffer_size); | ||
|
||
This returns the number of items currently occupying a buffer[2]. | ||
|
||
|
||
(*) Measure the non-wrapping occupancy of a buffer: | ||
|
||
CIRC_CNT_TO_END(head_index, tail_index, buffer_size); | ||
|
||
This returns the number of consecutive items[2] that can be extracted from | ||
the buffer without having to wrap back to the beginning of the buffer. | ||
|
||
|
||
Each of these macros will nominally return a value between 0 and buffer_size-1, | ||
however: | ||
|
||
[1] CIRC_SPACE*() are intended to be used in the producer. To the producer | ||
they will return a lower bound as the producer controls the head index, | ||
but the consumer may still be depleting the buffer on another CPU and | ||
moving the tail index. | ||
|
||
To the consumer it will show an upper bound as the producer may be busy | ||
depleting the space. | ||
|
||
[2] CIRC_CNT*() are intended to be used in the consumer. To the consumer they | ||
will return a lower bound as the consumer controls the tail index, but the | ||
producer may still be filling the buffer on another CPU and moving the | ||
head index. | ||
|
||
To the producer it will show an upper bound as the consumer may be busy | ||
emptying the buffer. | ||
|
||
[3] To a third party, the order in which the writes to the indices by the | ||
producer and consumer become visible cannot be guaranteed as they are | ||
independent and may be made on different CPUs - so the result in such a | ||
situation will merely be a guess, and may even be negative. | ||
|
||
|
||
=========================================== | ||
USING MEMORY BARRIERS WITH CIRCULAR BUFFERS | ||
=========================================== | ||
|
||
By using memory barriers in conjunction with circular buffers, you can avoid | ||
the need to: | ||
|
||
(1) use a single lock to govern access to both ends of the buffer, thus | ||
allowing the buffer to be filled and emptied at the same time; and | ||
|
||
(2) use atomic counter operations. | ||
|
||
There are two sides to this: the producer that fills the buffer, and the | ||
consumer that empties it. Only one thing should be filling a buffer at any one | ||
time, and only one thing should be emptying a buffer at any one time, but the | ||
two sides can operate simultaneously. | ||
|
||
|
||
THE PRODUCER | ||
------------ | ||
|
||
The producer will look something like this: | ||
|
||
spin_lock(&producer_lock); | ||
|
||
unsigned long head = buffer->head; | ||
unsigned long tail = ACCESS_ONCE(buffer->tail); | ||
|
||
if (CIRC_SPACE(head, tail, buffer->size) >= 1) { | ||
/* insert one item into the buffer */ | ||
struct item *item = buffer[head]; | ||
|
||
produce_item(item); | ||
|
||
smp_wmb(); /* commit the item before incrementing the head */ | ||
|
||
buffer->head = (head + 1) & (buffer->size - 1); | ||
|
||
/* wake_up() will make sure that the head is committed before | ||
* waking anyone up */ | ||
wake_up(consumer); | ||
} | ||
|
||
spin_unlock(&producer_lock); | ||
|
||
This will instruct the CPU that the contents of the new item must be written | ||
before the head index makes it available to the consumer and then instructs the | ||
CPU that the revised head index must be written before the consumer is woken. | ||
|
||
Note that wake_up() doesn't have to be the exact mechanism used, but whatever | ||
is used must guarantee a (write) memory barrier between the update of the head | ||
index and the change of state of the consumer, if a change of state occurs. | ||
|
||
|
||
THE CONSUMER | ||
------------ | ||
|
||
The consumer will look something like this: | ||
|
||
spin_lock(&consumer_lock); | ||
|
||
unsigned long head = ACCESS_ONCE(buffer->head); | ||
unsigned long tail = buffer->tail; | ||
|
||
if (CIRC_CNT(head, tail, buffer->size) >= 1) { | ||
/* read index before reading contents at that index */ | ||
smp_read_barrier_depends(); | ||
|
||
/* extract one item from the buffer */ | ||
struct item *item = buffer[tail]; | ||
|
||
consume_item(item); | ||
|
||
smp_mb(); /* finish reading descriptor before incrementing tail */ | ||
|
||
buffer->tail = (tail + 1) & (buffer->size - 1); | ||
} | ||
|
||
spin_unlock(&consumer_lock); | ||
|
||
This will instruct the CPU to make sure the index is up to date before reading | ||
the new item, and then it shall make sure the CPU has finished reading the item | ||
before it writes the new tail pointer, which will erase the item. | ||
|
||
|
||
Note the use of ACCESS_ONCE() in both algorithms to read the opposition index. | ||
This prevents the compiler from discarding and reloading its cached value - | ||
which some compilers will do across smp_read_barrier_depends(). This isn't | ||
strictly needed if you can be sure that the opposition index will _only_ be | ||
used the once. | ||
|
||
|
||
=============== | ||
FURTHER READING | ||
=============== | ||
|
||
See also Documentation/memory-barriers.txt for a description of Linux's memory | ||
barrier facilities. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,139 @@ | ||
Ceph Distributed File System | ||
============================ | ||
|
||
Ceph is a distributed network file system designed to provide good | ||
performance, reliability, and scalability. | ||
|
||
Basic features include: | ||
|
||
* POSIX semantics | ||
* Seamless scaling from 1 to many thousands of nodes | ||
* High availability and reliability. No single points of failure. | ||
* N-way replication of data across storage nodes | ||
* Fast recovery from node failures | ||
* Automatic rebalancing of data on node addition/removal | ||
* Easy deployment: most FS components are userspace daemons | ||
|
||
Also, | ||
* Flexible snapshots (on any directory) | ||
* Recursive accounting (nested files, directories, bytes) | ||
|
||
In contrast to cluster filesystems like GFS, OCFS2, and GPFS that rely | ||
on symmetric access by all clients to shared block devices, Ceph | ||
separates data and metadata management into independent server | ||
clusters, similar to Lustre. Unlike Lustre, however, metadata and | ||
storage nodes run entirely as user space daemons. Storage nodes | ||
utilize btrfs to store data objects, leveraging its advanced features | ||
(checksumming, metadata replication, etc.). File data is striped | ||
across storage nodes in large chunks to distribute workload and | ||
facilitate high throughputs. When storage nodes fail, data is | ||
re-replicated in a distributed fashion by the storage nodes themselves | ||
(with some minimal coordination from a cluster monitor), making the | ||
system extremely efficient and scalable. | ||
|
||
Metadata servers effectively form a large, consistent, distributed | ||
in-memory cache above the file namespace that is extremely scalable, | ||
dynamically redistributes metadata in response to workload changes, | ||
and can tolerate arbitrary (well, non-Byzantine) node failures. The | ||
metadata server takes a somewhat unconventional approach to metadata | ||
storage to significantly improve performance for common workloads. In | ||
particular, inodes with only a single link are embedded in | ||
directories, allowing entire directories of dentries and inodes to be | ||
loaded into its cache with a single I/O operation. The contents of | ||
extremely large directories can be fragmented and managed by | ||
independent metadata servers, allowing scalable concurrent access. | ||
|
||
The system offers automatic data rebalancing/migration when scaling | ||
from a small cluster of just a few nodes to many hundreds, without | ||
requiring an administrator carve the data set into static volumes or | ||
go through the tedious process of migrating data between servers. | ||
When the file system approaches full, new nodes can be easily added | ||
and things will "just work." | ||
|
||
Ceph includes flexible snapshot mechanism that allows a user to create | ||
a snapshot on any subdirectory (and its nested contents) in the | ||
system. Snapshot creation and deletion are as simple as 'mkdir | ||
.snap/foo' and 'rmdir .snap/foo'. | ||
|
||
Ceph also provides some recursive accounting on directories for nested | ||
files and bytes. That is, a 'getfattr -d foo' on any directory in the | ||
system will reveal the total number of nested regular files and | ||
subdirectories, and a summation of all nested file sizes. This makes | ||
the identification of large disk space consumers relatively quick, as | ||
no 'du' or similar recursive scan of the file system is required. | ||
|
||
|
||
Mount Syntax | ||
============ | ||
|
||
The basic mount syntax is: | ||
|
||
# mount -t ceph monip[:port][,monip2[:port]...]:/[subdir] mnt | ||
|
||
You only need to specify a single monitor, as the client will get the | ||
full list when it connects. (However, if the monitor you specify | ||
happens to be down, the mount won't succeed.) The port can be left | ||
off if the monitor is using the default. So if the monitor is at | ||
1.2.3.4, | ||
|
||
# mount -t ceph 1.2.3.4:/ /mnt/ceph | ||
|
||
is sufficient. If /sbin/mount.ceph is installed, a hostname can be | ||
used instead of an IP address. | ||
|
||
|
||
|
||
Mount Options | ||
============= | ||
|
||
ip=A.B.C.D[:N] | ||
Specify the IP and/or port the client should bind to locally. | ||
There is normally not much reason to do this. If the IP is not | ||
specified, the client's IP address is determined by looking at the | ||
address it's connection to the monitor originates from. | ||
|
||
wsize=X | ||
Specify the maximum write size in bytes. By default there is no | ||
maximu. Ceph will normally size writes based on the file stripe | ||
size. | ||
|
||
rsize=X | ||
Specify the maximum readahead. | ||
|
||
mount_timeout=X | ||
Specify the timeout value for mount (in seconds), in the case | ||
of a non-responsive Ceph file system. The default is 30 | ||
seconds. | ||
|
||
rbytes | ||
When stat() is called on a directory, set st_size to 'rbytes', | ||
the summation of file sizes over all files nested beneath that | ||
directory. This is the default. | ||
|
||
norbytes | ||
When stat() is called on a directory, set st_size to the | ||
number of entries in that directory. | ||
|
||
nocrc | ||
Disable CRC32C calculation for data writes. If set, the OSD | ||
must rely on TCP's error correction to detect data corruption | ||
in the data payload. | ||
|
||
noasyncreaddir | ||
Disable client's use its local cache to satisfy readdir | ||
requests. (This does not change correctness; the client uses | ||
cached metadata only when a lease or capability ensures it is | ||
valid.) | ||
|
||
|
||
More Information | ||
================ | ||
|
||
For more information on Ceph, see the home page at | ||
http://ceph.newdream.net/ | ||
|
||
The Linux kernel client source tree is available at | ||
git://ceph.newdream.net/linux-ceph-client.git | ||
|
||
and the source for the full system is at | ||
git://ceph.newdream.net/ceph.git |
Oops, something went wrong.