2 * SPDX-License-Identifier: BSD-3-Clause
4 * Copyright (c) 2008 Yahoo!, Inc.
6 * Written by: John Baldwin <jhb@FreeBSD.org>
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
11 * 1. Redistributions of source code must retain the above copyright
12 * notice, this list of conditions and the following disclaimer.
13 * 2. Redistributions in binary form must reproduce the above copyright
14 * notice, this list of conditions and the following disclaimer in the
15 * documentation and/or other materials provided with the distribution.
16 * 3. Neither the name of the author nor the names of any co-contributors
17 * may be used to endorse or promote products derived from this software
18 * without specific prior written permission.
20 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
21 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
24 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
36 * A scatter/gather list describes a group of physical address ranges.
37 * Each physical address range consists of a starting address and a
44 #include <sys/refcount.h>
52 struct sglist_seg *sg_segs;
64 sglist_init(struct sglist *sg, u_short maxsegs, struct sglist_seg *segs)
69 sg->sg_maxseg = maxsegs;
70 refcount_init(&sg->sg_refs, 1);
74 sglist_reset(struct sglist *sg)
80 static __inline struct sglist *
81 sglist_hold(struct sglist *sg)
84 refcount_acquire(&sg->sg_refs);
88 struct sglist *sglist_alloc(int nsegs, int mflags);
89 int sglist_append(struct sglist *sg, void *buf, size_t len);
90 int sglist_append_bio(struct sglist *sg, struct bio *bp);
91 int sglist_append_ext_pgs(struct sglist *sg, struct mbuf_ext_pgs *ext_pgs,
92 size_t off, size_t len);
93 int sglist_append_mb_ext_pgs(struct sglist *sg, struct mbuf *m);
94 int sglist_append_mbuf(struct sglist *sg, struct mbuf *m0);
95 int sglist_append_phys(struct sglist *sg, vm_paddr_t paddr,
97 int sglist_append_sglist(struct sglist *sg, struct sglist *source,
98 size_t offset, size_t length);
99 int sglist_append_uio(struct sglist *sg, struct uio *uio);
100 int sglist_append_user(struct sglist *sg, void *buf, size_t len,
102 int sglist_append_vmpages(struct sglist *sg, vm_page_t *m, size_t pgoff,
104 struct sglist *sglist_build(void *buf, size_t len, int mflags);
105 struct sglist *sglist_clone(struct sglist *sg, int mflags);
106 int sglist_consume_uio(struct sglist *sg, struct uio *uio, size_t resid);
107 int sglist_count(void *buf, size_t len);
108 int sglist_count_ext_pgs(struct mbuf_ext_pgs *ext_pgs, size_t off,
110 int sglist_count_mb_ext_pgs(struct mbuf *m);
111 int sglist_count_vmpages(vm_page_t *m, size_t pgoff, size_t len);
112 void sglist_free(struct sglist *sg);
113 int sglist_join(struct sglist *first, struct sglist *second);
114 size_t sglist_length(struct sglist *sg);
115 int sglist_slice(struct sglist *original, struct sglist **slice,
116 size_t offset, size_t length, int mflags);
117 int sglist_split(struct sglist *original, struct sglist **head,
118 size_t length, int mflags);
120 #endif /* !__SGLIST_H__ */