osdfs

OSDFS

What is osdfs?

Osdfs is a file system that uses an OSD and exports the API of a normal Linux file system. Users access osdfs like any other local file system, and osdfs will in turn issue commands to the local initiator.

Download it!

You can go to the project page or download it and try it out (2.6.10 kernel)!
I am no longer maintaining osdfs, but others have taken over. You can find a more up-to-date version here, and some more information about the more recent effort here.

Environment

To use this file system, you need to have an object store to run it on. You may download IBM's OSD initiator and target.
Osdfs currently only works with this target because a user-defined attribute needs to be defined for the osdfs inode. The file system has not been tested in other environments.

Usage

Get the OSD initiator and target set up properly, including insmod'ing the OSD initiator kernel module, so_mod.ko (out of the scope of this README).
Execute 'make' in osdfs the osdfs directory. Note that you must set the EXPORT variable in the Makefile to point to the export directory of the initiator.
Insmod the file system kernel module (osdfs.ko).
Make the file system using osdfs/tools/mkosdfs.
Use the -h option for usage instructions. As an example, this will create the file system on LUN 0, target ID 0, partition ID 65540:
```
./mkosdfs -i 0 -l 0 -p 65540
```
Make sure the directory where you want to mount exists. If not, create it. (For example, /mnt/osdfs)
Mount the file system.
For example, to mount LUN 0, target ID 0, partition ID 65540 on /mnt/osdfs:
```
mount -t osdfs -o lun=0,tid=0,pid=65540 none /mnt/osdfs/
```
Make sure that the parameters match those that were specified to mkosdfs.
In addition you can specify the following parameters to the mount command:
- to=[integer] timeout for OSD commands in seconds
For reference (under osdfs/):
- doit.sh. - an example of how to perform the above steps.
- undoit.sh - will undo the steps.
Extra compilation flags:
- OSDFS_DEBUG - for debug messages and extra checks.

User-space tools

located in osdfs/tools

mkosdfs: creates an osdfs file system (described above).

	usage: mkosdfs -i  -l  -p  [-d]
		       [-h] [-f ] [-t ] [-q ]

	i: target ID (>= 0)
	l: target LUN (>= 0)
	p: ID for partition (>= 65536)
	d: print debug information
	h: print this menu and exit
	f: format the LUN to specified size in bytes (specify 0 for same size).
	t: timeout in seconds for OSD commands other than format (> 0)
	   (default=5)
	q: timeout in seconds for format OSD command, if specified (> 0)
	   (default=30)

osdfsexplore: explore an osdfs file system using the initiator API.

	usage: osdfsexplore -i  -l  -p  [-h]
	i: target ID (>= 0)
	l: target LUN (>= 0)
	p: ID for partition (>= 65536)
	h: print this menu and exit

	While at the program's prompt, you may use the following commands:
	help              print this menu
	list              list objects on the file system
	stat

OSDFS

What is osdfs?

Download it!

Environment

Usage

User-space tools

Design

License/Copyright

Credits