Changeset View
Changeset View
Standalone View
Standalone View
share/man/man9/sglist.9
Show All 20 Lines | |||||
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) | .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) | ||||
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT | .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT | ||||
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY | .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY | ||||
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF | .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF | ||||
.\" SUCH DAMAGE. | .\" SUCH DAMAGE. | ||||
.\" | .\" | ||||
.\" $FreeBSD$ | .\" $FreeBSD$ | ||||
.\" | .\" | ||||
.Dd April 24, 2020 | .Dd May 25, 2021 | ||||
.Dt SGLIST 9 | .Dt SGLIST 9 | ||||
.Os | .Os | ||||
.Sh NAME | .Sh NAME | ||||
.Nm sglist , | .Nm sglist , | ||||
.Nm sglist_alloc , | .Nm sglist_alloc , | ||||
.Nm sglist_append , | .Nm sglist_append , | ||||
.Nm sglist_append_bio , | .Nm sglist_append_bio , | ||||
.Nm sglist_append_mbuf , | .Nm sglist_append_mbuf , | ||||
.Nm sglist_append_mbuf_epg, | .Nm sglist_append_mbuf_epg, | ||||
.Nm sglist_append_phys , | .Nm sglist_append_phys , | ||||
.Nm sglist_append_sglist , | .Nm sglist_append_sglist , | ||||
.Nm sglist_append_single_mbuf , | |||||
.Nm sglist_append_uio , | .Nm sglist_append_uio , | ||||
.Nm sglist_append_user , | .Nm sglist_append_user , | ||||
.Nm sglist_append_vmpages , | .Nm sglist_append_vmpages , | ||||
.Nm sglist_build , | .Nm sglist_build , | ||||
.Nm sglist_clone , | .Nm sglist_clone , | ||||
.Nm sglist_consume_uio , | .Nm sglist_consume_uio , | ||||
.Nm sglist_count , | .Nm sglist_count , | ||||
.Nm sglist_count_mbuf_epg , | .Nm sglist_count_mbuf_epg , | ||||
Show All 20 Lines | |||||
.Fn sglist_append_mbuf_epg "struct sglist *sg" "struct mbuf *m" "size_t offset" "size_t len" | .Fn sglist_append_mbuf_epg "struct sglist *sg" "struct mbuf *m" "size_t offset" "size_t len" | ||||
.Ft int | .Ft int | ||||
.Fn sglist_append_mbuf "struct sglist *sg" "struct mbuf *m" | .Fn sglist_append_mbuf "struct sglist *sg" "struct mbuf *m" | ||||
.Ft int | .Ft int | ||||
.Fn sglist_append_phys "struct sglist *sg" "vm_paddr_t paddr" "size_t len" | .Fn sglist_append_phys "struct sglist *sg" "vm_paddr_t paddr" "size_t len" | ||||
.Ft int | .Ft int | ||||
.Fn sglist_append_sglist "struct sglist *sg" "struct sglist *source" "size_t offset" "size_t len" | .Fn sglist_append_sglist "struct sglist *sg" "struct sglist *source" "size_t offset" "size_t len" | ||||
.Ft int | .Ft int | ||||
.Fn sglist_append_single_mbuf "struct sglist *sg" "struct mbuf *m" | |||||
.Ft int | |||||
.Fn sglist_append_uio "struct sglist *sg" "struct uio *uio" | .Fn sglist_append_uio "struct sglist *sg" "struct uio *uio" | ||||
.Ft int | .Ft int | ||||
.Fn sglist_append_user "struct sglist *sg" "void *buf" "size_t len" "struct thread *td" | .Fn sglist_append_user "struct sglist *sg" "void *buf" "size_t len" "struct thread *td" | ||||
.Ft int | .Ft int | ||||
.Fn sglist_append_vmpages "struct sglist *sg" "vm_page_t *m" "size_t pgoff" "size_t len" | .Fn sglist_append_vmpages "struct sglist *sg" "vm_page_t *m" "size_t pgoff" "size_t len" | ||||
.Ft struct sglist * | .Ft struct sglist * | ||||
.Fn sglist_build "void *buf" "size_t len" "int mflags" | .Fn sglist_build "void *buf" "size_t len" "int mflags" | ||||
.Ft struct sglist * | .Ft struct sglist * | ||||
▲ Show 20 Lines • Show All 189 Lines • ▼ Show 20 Lines | |||||
.Nm sglist_append_mbuf_epg | .Nm sglist_append_mbuf_epg | ||||
only adds ranges for a single mbuf, | only adds ranges for a single mbuf, | ||||
not an entire mbuf chain. | not an entire mbuf chain. | ||||
.Pp | .Pp | ||||
The | The | ||||
.Nm sglist_append_mbuf | .Nm sglist_append_mbuf | ||||
function appends the physical address ranges described by an entire mbuf | function appends the physical address ranges described by an entire mbuf | ||||
chain | chain | ||||
.Fa m | |||||
to the scatter/gather list | |||||
.Fa sg . | |||||
.Pp | |||||
The | |||||
.Nm sglist_append_mbuf | |||||
function appends the physical address ranges described by a single mbuf | |||||
.Fa m | .Fa m | ||||
to the scatter/gather list | to the scatter/gather list | ||||
.Fa sg . | .Fa sg . | ||||
.Pp | .Pp | ||||
The | The | ||||
.Nm sglist_append_phys | .Nm sglist_append_phys | ||||
function appends a single physical address range to the scatter/gather list | function appends a single physical address range to the scatter/gather list | ||||
.Fa sg . | .Fa sg . | ||||
▲ Show 20 Lines • Show All 315 Lines • Show Last 20 Lines |