linuXperts.org

SPUFS(7) Linux Programmer's Manual SPUFS(7) NAME spufs - the SPU file system DESCRIPTION The SPU file system is used on PowerPC machines that implement the Cell Broadband Engine Architecture in order to access Synergistic Processor Units (SPUs). The file system provides a name space similar to POSIX shared memory or message queues. Users that have write permissions on the file system can use spu_create(2) to establish SPU contexts under the spufs root directory. Every SPU context is represented by a directory containing a predefined set of files. These files can be used for manipulating the state of the logical SPU. Users can change permissions on those files, but can't add or remove files. Mount Options uid=<uid> set the user owning the mount point; the default is 0 (root). gid=<gid> set the group owning the mount point; the default is 0 (root). Files The files in spufs mostly follow the standard behavior for regular sys- tem calls like read(2) or write(2), but often support only a subset of the operations supported on regular file systems. This list details the supported operations and the deviations from the standard behavior described in the respective man pages. All files that support the read(2) operation also support readv(2) and all files that support the write(2) operation also support writev(2). All files support the access(2) and stat(2) family of operations, but for the latter call, the only fields of the returned stat structure that contain reliable information are st_mode, st_nlink, st_uid, and st_gid. All files support the chmod(2)/fchmod(2) and chown(2)/fchown(2) opera- tions, but will not be able to grant permissions that contradict the possible operations (e.g., read access on the wbox file). The current set of files is: /mem the contents of the local storage memory of the SPU. This can be accessed like a regular shared memory file and contains both code and data in the address space of the SPU. The possible operations on an open mem file are: read(2), pread(2), write(2), pwrite(2), lseek(2) These operate as usual, with the exception that lseek(2), write(2) and pwrite(2) are not supported beyond the end of the file. The file size is the size of the local storage of the SPU, which is normally 256 kilobytes. mmap(2) Mapping mem into the process address space provides access to the SPU local storage within the process address space. Only MAP_SHARED mappings are allowed. /mbox The first SPU-to-CPU communication mailbox. This file is read- only and can be read in units of 32 bits. The file can only be used in non-blocking mode and not even poll(2) will block on it. The only possible operation on an open mbox file is: read(2) If count is smaller than four, read(2) returns -1 and sets errno to EINVAL. If there is no data available in the mailbox, the return value is set to -1 and errno is set to EAGAIN. When data has been read successfully, four bytes are placed in the data buffer and the value four is returned. /ibox The second SPU-to-CPU communication mailbox. This file is simi- lar to the first mailbox file, but can be read in blocking I/O mode, thus poll(2) and similar system calls can be used to moni- tor this file. The possible operations on an open ibox file are: read(2) If count is smaller than four, read(2) returns -1 and sets errno to EINVAL. If there is no data available in the mailbox and the file descriptor has been opened with O_NONBLOCK, the return value is set to -1 and errno is set to EAGAIN. If there is no data available in the mailbox and the file descriptor has been opened without O_NONBLOCK, the call will block until the SPU writes to its interrupt mailbox channel. When data has been read successfully, four bytes are placed in the data buffer and the value four is returned. poll(2) Poll on the ibox file returns (POLLIN | POLLRDNORM) when- ever data is available for reading. /wbox The CPU-to-SPU communication mailbox. It is write-only and can be written in units of 32 bits. If the mailbox is full, write(2) will block and poll(2) can be used to wait for it to become empty again. The possible operations on an open wbox file are: write(2) If count is smaller than four, write(2) returns -1 and sets errno to EINVAL. If there is no space available in the mailbox and the file descriptor has been opened with O_NONBLOCK, the return value is set to -1 and errno is set to EAGAIN. If there is no space available in the mailbox and the file descriptor has been opened without O_NONBLOCK, the call will block until the SPU reads from its PPE mailbox channel. When data has been written successfully, the system call returns four as its function result. poll(2) A poll on the wbox file returns (POLLOUT | POLLWRNORM) whenever space is available for writing. /mbox_stat, /ibox_stat, /wbox_stat These are read-only files that contain the length of the current queue of each mailbox, i.e., how many words can be read from mbox or ibox or how many words can be written to wbox without blocking. The files can be read only in four-byte units and return a big-endian binary integer number. The possible operations on an open *box_stat file are: read(2) If count is smaller than four, read(2) returns -1 and sets errno to EINVAL. Otherwise, a four-byte value is placed in the data buffer. This value is the number of elements that can be read from (for mbox_stat and ibox_stat) or written to (for wbox_stat) the respective mailbox without blocking or getting an EAGAIN error. /npc, /decr, /decr_status, /spu_tag_mask, /event_mask, /srr0 These files expose internal registers of the SPU. The values are represented as ASCII strings containing the numeric value of each register. These can be used in read/write mode for debug- ging, but normal operation of programs should not rely on these files because accesses to any of them except npc require an SPU context save, which is very inefficient. The contents of these files are: npc Next Program Counter decr SPU Decrementer decr_status Decrementer Status spu_tag_mask MFC tag mask for SPU DMA event_mask Event mask for SPU interrupts srr0 Interrupt Return address register The possible operations on one of these files are: read(2) When the count supplied to the read(2) call is shorter than the required length for the register value plus a newline character, subsequent reads from the same file descriptor will complete the string, regardless of changes to the register by a running SPU task. When a complete string has been read, all subsequent read opera- tions will return zero bytes and a new file descriptor needs to be opened to read a new value. write(2) A write(2) operation on the file sets the register to the value given in the string. The string is parsed from the beginning until the first non-numeric character or the end of the buffer. Subsequent writes to the same file descriptor overwrite the previous setting. /fpcr This file provides access to the Floating Point Status and Con- trol Register as a four-byte file. The operations on the fpcr file are: read(2) If count is smaller than four, read(2) returns -1 and sets errno to EINVAL. Otherwise, a four-byte value is placed in the data buffer; this is the current value of the fpcr register. write(2) If count is smaller than four, write(2) returns -1 and sets errno to EINVAL. Otherwise, a four-byte value is copied from the data buffer, updating the value of the fpcr register. /signal1, /signal2 The files provide access to the two signal notification channels of an SPU. These are read-write files that operate on 32-bit words. Writing to one of these files triggers an interrupt on the SPU. The value written to the signal files can be read from the SPU through a channel read or from host user space through the file. After the value has been read by the SPU, it is reset to zero. The possible operations on an open signal1 or signal2 file are: read(2) If count is smaller than four, read(2) returns -1 and sets errno to EINVAL. Otherwise, a four-byte value is placed in the data buffer; this is the current value of the specified signal notification register. write(2) If count is smaller than four, write(2) returns -1 and sets errno to EINVAL. Otherwise, a four-byte value is copied from the data buffer, updating the value of the specified signal notification register. The signal noti- fication register will either be replaced with the input data or will be updated to the bitwise OR operation of the old value and the input data, depending on the con- tents of the signal1_type or signal2_type files respec- tively. /signal1_type, /signal2_type These two files change the behavior of the signal1 and signal2 notification files. They contain a numerical ASCII string which is read as either "1" or "0". In mode 0 (overwrite), the hard- ware replaces the contents of the signal channel with the data that is written to it. In mode 1 (logical OR), the hardware accumulates the bits that are subsequently written to it. The possible operations on an open signal1_type or signal2_type file are: read(2) When the count supplied to the read(2) call is shorter than the required length for the digit plus a newline character, subsequent reads from the same file descriptor will complete the string. When a complete string has been read, all subsequent read operations will return zero bytes and a new file descriptor needs to be opened to read the value again. write(2) A write(2) operation on the file sets the register to the value given in the string. The string is parsed from the beginning until the first non-numeric character or the end of the buffer. Subsequent writes to the same file descriptor overwrite the previous setting. EXAMPLE /etc/fstab entry none /spu spufs gid=spu 0 0 SEE ALSO close(2), spu_create(2), spu_run(2) Linux 2007-07-10 SPUFS(7)