old-www/HOWTO/SCSI-Generic-HOWTO/write.html

243 lines
4.5 KiB
HTML

<HTML
><HEAD
><TITLE
>write()</TITLE
><META
NAME="GENERATOR"
CONTENT="Modular DocBook HTML Stylesheet Version 1.76b+
"><LINK
REL="HOME"
TITLE="The Linux SCSI Generic (sg) HOWTO"
HREF="index.html"><LINK
REL="UP"
TITLE="System calls"
HREF="syscalls.html"><LINK
REL="PREVIOUS"
TITLE="open()"
HREF="open.html"><LINK
REL="NEXT"
TITLE="read()"
HREF="read.html"></HEAD
><BODY
CLASS="SECT1"
BGCOLOR="#FFFFFF"
TEXT="#000000"
LINK="#0000FF"
VLINK="#840084"
ALINK="#0000FF"
><DIV
CLASS="NAVHEADER"
><TABLE
SUMMARY="Header navigation table"
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
><TR
><TH
COLSPAN="3"
ALIGN="center"
>The Linux SCSI Generic (sg) HOWTO</TH
></TR
><TR
><TD
WIDTH="10%"
ALIGN="left"
VALIGN="bottom"
><A
HREF="open.html"
ACCESSKEY="P"
>Prev</A
></TD
><TD
WIDTH="80%"
ALIGN="center"
VALIGN="bottom"
>Chapter 7. System calls</TD
><TD
WIDTH="10%"
ALIGN="right"
VALIGN="bottom"
><A
HREF="read.html"
ACCESSKEY="N"
>Next</A
></TD
></TR
></TABLE
><HR
ALIGN="LEFT"
WIDTH="100%"></DIV
><DIV
CLASS="SECT1"
><H1
CLASS="SECT1"
><A
NAME="WRITE">7.2. write()</H1
><DIV
CLASS="FORMALPARA"
><P
><B
>write(int sg_fd, const void * buffer, size_t count). </B
>The action of write() with a control block based on struct sg_header is
discussed in the earlier document:
<A
HREF="http://www.torque.net/sg/p/scsi-generic.txt"
TARGET="_top"
><TT
CLASS="LITERAL"
>www.torque.net/sg/p/scsi-generic.txt</TT
></A
>
(i.e the sg version 2 documentation). This section describes the action of
write() when it is given a control block based on struct sg_io_hdr.</P
></DIV
><P
>The 'buffer' should point to an object of type sg_io_hdr_t and 'count'
should be sizeof(sg_io_hdr_t) [it can be larger but the excess is ignored].
If the write() call succeeds then the 'count' is returned as the result.</P
><P
>Up to SG_MAX_QUEUE (16) write()s can be queued up before any finished
requests are completed by read(). An attempt to queue more than that will
result in an EDOM error.
<A
NAME="AEN425"
HREF="#FTN.AEN425"
>[1]</A
>
The write() command should return more or
less immediately.
<A
NAME="AEN427"
HREF="#FTN.AEN427"
>[2]</A
></P
><P
>The version 2 sg driver defaulted the maximum queue length to 1 (and
made available the SG_SET_COMMAND_Q ioctl() to switch it to SG_MAX_QUEUE).
So for backward compatibility a file descriptor that only receives
sg_header structures in its write() will have a default "max" queue length
of 1. As soon as a sg_io_hdr_t structure is seen by a write() then the
maximum queue length is switched to SG_MAX_QUEUE on that file descriptor.</P
><P
>The "const" on the 'buffer' pointer is respected by the sg driver. Data
is read in from the sg_io_hdr object that is pointed to. Significantly
this is when the 'sbp' and the 'dxferp' are recorded internally (i.e.
not from the sg_io_hdr object given to the corresponding read() ).</P
></DIV
><H3
CLASS="FOOTNOTES"
>Notes</H3
><TABLE
BORDER="0"
CLASS="FOOTNOTES"
WIDTH="100%"
><TR
><TD
ALIGN="LEFT"
VALIGN="TOP"
WIDTH="5%"
><A
NAME="FTN.AEN425"
HREF="write.html#AEN425"
>[1]</A
></TD
><TD
ALIGN="LEFT"
VALIGN="TOP"
WIDTH="95%"
><P
>The command queuing capabilities of the SCSI device and the adapter driver
should also be taken into account. To this end the sg_scsi_id::h_cmd_per_lun
and sg_scsi_id::d_queue_depth values returned bu ioctl(SG_GET_SCSI_ID) may
be useful. Also some devices that indicate in their INQUIRY response that
they can accept command queuing react badly when queuing is actually
attempted.</P
></TD
></TR
><TR
><TD
ALIGN="LEFT"
VALIGN="TOP"
WIDTH="5%"
><A
NAME="FTN.AEN427"
HREF="write.html#AEN427"
>[2]</A
></TD
><TD
ALIGN="LEFT"
VALIGN="TOP"
WIDTH="95%"
><P
>There is a small probability it will spend some time waiting for a
command block to become available. In this case the wait is interruptible.
If O_NONBLOCK is active then this scenario will cause a EAGAIN.</P
></TD
></TR
></TABLE
><DIV
CLASS="NAVFOOTER"
><HR
ALIGN="LEFT"
WIDTH="100%"><TABLE
SUMMARY="Footer navigation table"
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
><A
HREF="open.html"
ACCESSKEY="P"
>Prev</A
></TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
><A
HREF="index.html"
ACCESSKEY="H"
>Home</A
></TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
><A
HREF="read.html"
ACCESSKEY="N"
>Next</A
></TD
></TR
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
>open()</TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
><A
HREF="syscalls.html"
ACCESSKEY="U"
>Up</A
></TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
>read()</TD
></TR
></TABLE
></DIV
></BODY
></HTML
>