xref: /OK3568_Linux_fs/kernel/Documentation/target/target-export-device (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1*4882a593Smuzhiyun#!/bin/sh
2*4882a593Smuzhiyun#
3*4882a593Smuzhiyun# This script illustrates the sequence of operations in configfs to
4*4882a593Smuzhiyun# create a very simple LIO iSCSI target with a file or block device
5*4882a593Smuzhiyun# backstore.
6*4882a593Smuzhiyun#
7*4882a593Smuzhiyun# (C) Copyright 2014 Christophe Vu-Brugier <cvubrugier@fastmail.fm>
8*4882a593Smuzhiyun#
9*4882a593Smuzhiyun
10*4882a593Smuzhiyunprint_usage() {
11*4882a593Smuzhiyun    cat <<EOF
12*4882a593SmuzhiyunUsage: $(basename $0) [-p PORTAL] DEVICE|FILE
13*4882a593SmuzhiyunExport a block device or a file as an iSCSI target with a single LUN
14*4882a593SmuzhiyunEOF
15*4882a593Smuzhiyun}
16*4882a593Smuzhiyun
17*4882a593Smuzhiyundie() {
18*4882a593Smuzhiyun    echo $1
19*4882a593Smuzhiyun    exit 1
20*4882a593Smuzhiyun}
21*4882a593Smuzhiyun
22*4882a593Smuzhiyunwhile getopts "hp:" arg; do
23*4882a593Smuzhiyun    case $arg in
24*4882a593Smuzhiyun        h) print_usage; exit 0;;
25*4882a593Smuzhiyun        p) PORTAL=${OPTARG};;
26*4882a593Smuzhiyun    esac
27*4882a593Smuzhiyundone
28*4882a593Smuzhiyunshift $(($OPTIND - 1))
29*4882a593Smuzhiyun
30*4882a593SmuzhiyunDEVICE=$1
31*4882a593Smuzhiyun[ -n "$DEVICE" ] || die "Missing device or file argument"
32*4882a593Smuzhiyun[ -b $DEVICE -o -f $DEVICE ] || die "Invalid device or file: ${DEVICE}"
33*4882a593SmuzhiyunIQN="iqn.2003-01.org.linux-iscsi.$(hostname):$(basename $DEVICE)"
34*4882a593Smuzhiyun[ -n "$PORTAL" ] || PORTAL="0.0.0.0:3260"
35*4882a593Smuzhiyun
36*4882a593SmuzhiyunCONFIGFS=/sys/kernel/config
37*4882a593SmuzhiyunCORE_DIR=$CONFIGFS/target/core
38*4882a593SmuzhiyunISCSI_DIR=$CONFIGFS/target/iscsi
39*4882a593Smuzhiyun
40*4882a593Smuzhiyun# Load the target modules and mount the config file system
41*4882a593Smuzhiyunlsmod | grep -q configfs || modprobe configfs
42*4882a593Smuzhiyunlsmod | grep -q target_core_mod || modprobe target_core_mod
43*4882a593Smuzhiyunmount | grep -q ^configfs || mount -t configfs none $CONFIGFS
44*4882a593Smuzhiyunmkdir -p $ISCSI_DIR
45*4882a593Smuzhiyun
46*4882a593Smuzhiyun# Create a backstore
47*4882a593Smuzhiyunif [ -b $DEVICE ]; then
48*4882a593Smuzhiyun    BACKSTORE_DIR=$CORE_DIR/iblock_0/data
49*4882a593Smuzhiyun    mkdir -p $BACKSTORE_DIR
50*4882a593Smuzhiyun    echo "udev_path=${DEVICE}" > $BACKSTORE_DIR/control
51*4882a593Smuzhiyunelse
52*4882a593Smuzhiyun    BACKSTORE_DIR=$CORE_DIR/fileio_0/data
53*4882a593Smuzhiyun    mkdir -p $BACKSTORE_DIR
54*4882a593Smuzhiyun    DEVICE_SIZE=$(du -b $DEVICE | cut -f1)
55*4882a593Smuzhiyun    echo "fd_dev_name=${DEVICE}" > $BACKSTORE_DIR/control
56*4882a593Smuzhiyun    echo "fd_dev_size=${DEVICE_SIZE}" > $BACKSTORE_DIR/control
57*4882a593Smuzhiyun    echo 1 > $BACKSTORE_DIR/attrib/emulate_write_cache
58*4882a593Smuzhiyunfi
59*4882a593Smuzhiyunecho 1 > $BACKSTORE_DIR/enable
60*4882a593Smuzhiyun
61*4882a593Smuzhiyun# Create an iSCSI target and a target portal group (TPG)
62*4882a593Smuzhiyunmkdir $ISCSI_DIR/$IQN
63*4882a593Smuzhiyunmkdir $ISCSI_DIR/$IQN/tpgt_1/
64*4882a593Smuzhiyun
65*4882a593Smuzhiyun# Create a LUN
66*4882a593Smuzhiyunmkdir $ISCSI_DIR/$IQN/tpgt_1/lun/lun_0
67*4882a593Smuzhiyunln -s $BACKSTORE_DIR $ISCSI_DIR/$IQN/tpgt_1/lun/lun_0/data
68*4882a593Smuzhiyunecho 1 > $ISCSI_DIR/$IQN/tpgt_1/enable
69*4882a593Smuzhiyun
70*4882a593Smuzhiyun# Create a network portal
71*4882a593Smuzhiyunmkdir $ISCSI_DIR/$IQN/tpgt_1/np/$PORTAL
72*4882a593Smuzhiyun
73*4882a593Smuzhiyun# Disable authentication
74*4882a593Smuzhiyunecho 0 > $ISCSI_DIR/$IQN/tpgt_1/attrib/authentication
75*4882a593Smuzhiyunecho 1 > $ISCSI_DIR/$IQN/tpgt_1/attrib/generate_node_acls
76*4882a593Smuzhiyun
77*4882a593Smuzhiyun# Allow write access for non authenticated initiators
78*4882a593Smuzhiyunecho 0 > $ISCSI_DIR/$IQN/tpgt_1/attrib/demo_mode_write_protect
79*4882a593Smuzhiyun
80*4882a593Smuzhiyunecho "Target ${IQN}, portal ${PORTAL} has been created"
81