intel_gas.c revision 280425
1235783Skib/*-
2235783Skib * Copyright (c) 2013 The FreeBSD Foundation
3235783Skib * All rights reserved.
4235783Skib *
5235783Skib * This software was developed by Konstantin Belousov <kib@FreeBSD.org>
6235783Skib * under sponsorship from the FreeBSD Foundation.
7235783Skib *
8235783Skib * Redistribution and use in source and binary forms, with or without
9235783Skib * modification, are permitted provided that the following conditions
10235783Skib * are met:
11235783Skib * 1. Redistributions of source code must retain the above copyright
12235783Skib *    notice, this list of conditions and the following disclaimer.
13235783Skib * 2. Redistributions in binary form must reproduce the above copyright
14235783Skib *    notice, this list of conditions and the following disclaimer in the
15235783Skib *    documentation and/or other materials provided with the distribution.
16235783Skib *
17235783Skib * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
18235783Skib * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19235783Skib * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20235783Skib * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
21235783Skib * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22235783Skib * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23235783Skib * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24235783Skib * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25235783Skib * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26235783Skib * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27235783Skib * SUCH DAMAGE.
28235783Skib */
29235783Skib
30235783Skib#include <sys/cdefs.h>
31235783Skib__FBSDID("$FreeBSD: stable/10/sys/x86/iommu/intel_gas.c 280425 2015-03-24 08:21:36Z kib $");
32235783Skib
33235783Skib#define	RB_AUGMENT(entry) dmar_gas_augment_entry(entry)
34235783Skib
35235783Skib#include <sys/param.h>
36235783Skib#include <sys/systm.h>
37235783Skib#include <sys/malloc.h>
38235783Skib#include <sys/bus.h>
39235783Skib#include <sys/interrupt.h>
40235783Skib#include <sys/kernel.h>
41235783Skib#include <sys/ktr.h>
42235783Skib#include <sys/lock.h>
43235783Skib#include <sys/proc.h>
44235783Skib#include <sys/rwlock.h>
45235783Skib#include <sys/memdesc.h>
46235783Skib#include <sys/mutex.h>
47235783Skib#include <sys/sysctl.h>
48235783Skib#include <sys/rman.h>
49235783Skib#include <sys/taskqueue.h>
50235783Skib#include <sys/tree.h>
51235783Skib#include <sys/uio.h>
52235783Skib#include <dev/pci/pcivar.h>
53235783Skib#include <vm/vm.h>
54235783Skib#include <vm/vm_extern.h>
55235783Skib#include <vm/vm_kern.h>
56235783Skib#include <vm/vm_object.h>
57235783Skib#include <vm/vm_page.h>
58235783Skib#include <vm/vm_map.h>
59235783Skib#include <vm/uma.h>
60235783Skib#include <machine/atomic.h>
61235783Skib#include <machine/bus.h>
62235783Skib#include <machine/md_var.h>
63235783Skib#include <machine/specialreg.h>
64235783Skib#include <x86/include/busdma_impl.h>
65235783Skib#include <x86/iommu/intel_reg.h>
66235783Skib#include <x86/iommu/busdma_dmar.h>
67235783Skib#include <x86/iommu/intel_dmar.h>
68235783Skib
69235783Skib/*
70235783Skib * Guest Address Space management.
71235783Skib */
72235783Skib
73235783Skibstatic uma_zone_t dmar_map_entry_zone;
74235783Skib
75235783Skibstatic void
76235783Skibintel_gas_init(void)
77235783Skib{
78235783Skib
79235783Skib	dmar_map_entry_zone = uma_zcreate("DMAR_MAP_ENTRY",
80235783Skib	    sizeof(struct dmar_map_entry), NULL, NULL,
81235783Skib	    NULL, NULL, UMA_ALIGN_PTR, 0);
82235783Skib}
83235783SkibSYSINIT(intel_gas, SI_SUB_DRIVERS, SI_ORDER_FIRST, intel_gas_init, NULL);
84235783Skib
85235783Skibstruct dmar_map_entry *
86235783Skibdmar_gas_alloc_entry(struct dmar_ctx *ctx, u_int flags)
87235783Skib{
88235783Skib	struct dmar_map_entry *res;
89235783Skib
90235783Skib	KASSERT((flags & ~(DMAR_PGF_WAITOK)) == 0,
91235783Skib	    ("unsupported flags %x", flags));
92235783Skib
93235783Skib	res = uma_zalloc(dmar_map_entry_zone, ((flags & DMAR_PGF_WAITOK) !=
94235783Skib	    0 ? M_WAITOK : M_NOWAIT) | M_ZERO);
95235783Skib	if (res != NULL) {
96235783Skib		res->ctx = ctx;
97235783Skib		atomic_add_int(&ctx->entries_cnt, 1);
98235783Skib	}
99235783Skib	return (res);
100235783Skib}
101235783Skib
102235783Skibvoid
103235783Skibdmar_gas_free_entry(struct dmar_ctx *ctx, struct dmar_map_entry *entry)
104235783Skib{
105235783Skib
106235783Skib	KASSERT(ctx == entry->ctx,
107235783Skib	    ("mismatched free ctx %p entry %p entry->ctx %p", ctx,
108235783Skib	    entry, entry->ctx));
109235783Skib	atomic_subtract_int(&ctx->entries_cnt, 1);
110235783Skib	uma_zfree(dmar_map_entry_zone, entry);
111235783Skib}
112235783Skib
113235783Skibstatic int
114235783Skibdmar_gas_cmp_entries(struct dmar_map_entry *a, struct dmar_map_entry *b)
115235783Skib{
116235783Skib
117235783Skib	/* Last entry have zero size, so <= */
118235783Skib	KASSERT(a->start <= a->end, ("inverted entry %p (%jx, %jx)",
119235783Skib	    a, (uintmax_t)a->start, (uintmax_t)a->end));
120235783Skib	KASSERT(b->start <= b->end, ("inverted entry %p (%jx, %jx)",
121235783Skib	    b, (uintmax_t)b->start, (uintmax_t)b->end));
122235783Skib	KASSERT(a->end <= b->start || b->end <= a->start ||
123235783Skib	    a->end == a->start || b->end == b->start,
124235783Skib	    ("overlapping entries %p (%jx, %jx) %p (%jx, %jx)",
125271816Sdumbbell	    a, (uintmax_t)a->start, (uintmax_t)a->end,
126271816Sdumbbell	    b, (uintmax_t)b->start, (uintmax_t)b->end));
127271816Sdumbbell
128271816Sdumbbell	if (a->end < b->end)
129271816Sdumbbell		return (-1);
130271816Sdumbbell	else if (b->end < a->end)
131271816Sdumbbell		return (1);
132235783Skib	return (0);
133235783Skib}
134235783Skib
135235783Skibstatic void
136235783Skibdmar_gas_augment_entry(struct dmar_map_entry *entry)
137271816Sdumbbell{
138271816Sdumbbell	struct dmar_map_entry *l, *r;
139271816Sdumbbell
140271816Sdumbbell	for (; entry != NULL; entry = RB_PARENT(entry, rb_entry)) {
141271816Sdumbbell		l = RB_LEFT(entry, rb_entry);
142271816Sdumbbell		r = RB_RIGHT(entry, rb_entry);
143235783Skib		if (l == NULL && r == NULL) {
144235783Skib			entry->free_down = entry->free_after;
145235783Skib		} else if (l == NULL && r != NULL) {
146235783Skib			entry->free_down = MAX(entry->free_after, r->free_down);
147235783Skib		} else if (/*l != NULL && */ r == NULL) {
148235783Skib			entry->free_down = MAX(entry->free_after, l->free_down);
149235783Skib		} else /* if (l != NULL && r != NULL) */ {
150235783Skib			entry->free_down = MAX(entry->free_after, l->free_down);
151235783Skib			entry->free_down = MAX(entry->free_down, r->free_down);
152235783Skib		}
153235783Skib	}
154235783Skib}
155235783Skib
156235783SkibRB_GENERATE(dmar_gas_entries_tree, dmar_map_entry, rb_entry,
157235783Skib    dmar_gas_cmp_entries);
158235783Skib
159235783Skibstatic void
160235783Skibdmar_gas_fix_free(struct dmar_ctx *ctx, struct dmar_map_entry *entry)
161235783Skib{
162235783Skib	struct dmar_map_entry *next;
163235783Skib
164235783Skib	next = RB_NEXT(dmar_gas_entries_tree, &ctx->rb_root, entry);
165235783Skib	entry->free_after = (next != NULL ? next->start : ctx->end) -
166235783Skib	    entry->end;
167235783Skib	dmar_gas_augment_entry(entry);
168235783Skib}
169235783Skib
170235783Skib#ifdef INVARIANTS
171235783Skibstatic void
172235783Skibdmar_gas_check_free(struct dmar_ctx *ctx)
173235783Skib{
174235783Skib	struct dmar_map_entry *entry, *next, *l, *r;
175235783Skib	dmar_gaddr_t v;
176235783Skib
177235783Skib	RB_FOREACH(entry, dmar_gas_entries_tree, &ctx->rb_root) {
178235783Skib		KASSERT(ctx == entry->ctx,
179235783Skib		    ("mismatched free ctx %p entry %p entry->ctx %p", ctx,
180235783Skib		    entry, entry->ctx));
181235783Skib		next = RB_NEXT(dmar_gas_entries_tree, &ctx->rb_root, entry);
182235783Skib		if (next == NULL) {
183235783Skib			MPASS(entry->free_after == ctx->end - entry->end);
184235783Skib		} else {
185235783Skib			MPASS(entry->free_after = next->start - entry->end);
186235783Skib			MPASS(entry->end <= next->start);
187235783Skib		}
188235783Skib		l = RB_LEFT(entry, rb_entry);
189235783Skib		r = RB_RIGHT(entry, rb_entry);
190235783Skib		if (l == NULL && r == NULL) {
191235783Skib			MPASS(entry->free_down == entry->free_after);
192235783Skib		} else if (l == NULL && r != NULL) {
193235783Skib			MPASS(entry->free_down = MAX(entry->free_after,
194235783Skib			    r->free_down));
195235783Skib		} else if (r == NULL) {
196235783Skib			MPASS(entry->free_down = MAX(entry->free_after,
197235783Skib			    l->free_down));
198235783Skib		} else {
199235783Skib			v = MAX(entry->free_after, l->free_down);
200235783Skib			v = MAX(entry->free_down, r->free_down);
201235783Skib			MPASS(entry->free_down == v);
202235783Skib		}
203235783Skib	}
204235783Skib}
205235783Skib#endif
206235783Skib
207235783Skibstatic bool
208235783Skibdmar_gas_rb_insert(struct dmar_ctx *ctx, struct dmar_map_entry *entry)
209235783Skib{
210235783Skib	struct dmar_map_entry *prev, *found;
211235783Skib
212235783Skib	found = RB_INSERT(dmar_gas_entries_tree, &ctx->rb_root, entry);
213235783Skib	dmar_gas_fix_free(ctx, entry);
214235783Skib	prev = RB_PREV(dmar_gas_entries_tree, &ctx->rb_root, entry);
215235783Skib	if (prev != NULL)
216235783Skib		dmar_gas_fix_free(ctx, prev);
217	return (found == NULL);
218}
219
220static void
221dmar_gas_rb_remove(struct dmar_ctx *ctx, struct dmar_map_entry *entry)
222{
223	struct dmar_map_entry *prev;
224
225	prev = RB_PREV(dmar_gas_entries_tree, &ctx->rb_root, entry);
226	RB_REMOVE(dmar_gas_entries_tree, &ctx->rb_root, entry);
227	if (prev != NULL)
228		dmar_gas_fix_free(ctx, prev);
229}
230
231void
232dmar_gas_init_ctx(struct dmar_ctx *ctx)
233{
234	struct dmar_map_entry *begin, *end;
235
236	begin = dmar_gas_alloc_entry(ctx, DMAR_PGF_WAITOK);
237	end = dmar_gas_alloc_entry(ctx, DMAR_PGF_WAITOK);
238
239	DMAR_CTX_LOCK(ctx);
240	KASSERT(ctx->entries_cnt == 2, ("dirty ctx %p", ctx));
241	KASSERT(RB_EMPTY(&ctx->rb_root), ("non-empty entries %p", ctx));
242
243	begin->start = 0;
244	begin->end = DMAR_PAGE_SIZE;
245	begin->free_after = ctx->end - begin->end;
246	begin->flags = DMAR_MAP_ENTRY_PLACE | DMAR_MAP_ENTRY_UNMAPPED;
247	dmar_gas_rb_insert(ctx, begin);
248
249	end->start = ctx->end;
250	end->end = ctx->end;
251	end->free_after = 0;
252	end->flags = DMAR_MAP_ENTRY_PLACE | DMAR_MAP_ENTRY_UNMAPPED;
253	dmar_gas_rb_insert(ctx, end);
254
255	ctx->first_place = begin;
256	ctx->last_place = end;
257	DMAR_CTX_UNLOCK(ctx);
258}
259
260void
261dmar_gas_fini_ctx(struct dmar_ctx *ctx)
262{
263	struct dmar_map_entry *entry, *entry1;
264
265	DMAR_CTX_ASSERT_LOCKED(ctx);
266	KASSERT(ctx->entries_cnt == 2, ("ctx still in use %p", ctx));
267
268	entry = RB_MIN(dmar_gas_entries_tree, &ctx->rb_root);
269	KASSERT(entry->start == 0, ("start entry start %p", ctx));
270	KASSERT(entry->end == DMAR_PAGE_SIZE, ("start entry end %p", ctx));
271	KASSERT(entry->flags == DMAR_MAP_ENTRY_PLACE,
272	    ("start entry flags %p", ctx));
273	RB_REMOVE(dmar_gas_entries_tree, &ctx->rb_root, entry);
274	dmar_gas_free_entry(ctx, entry);
275
276	entry = RB_MAX(dmar_gas_entries_tree, &ctx->rb_root);
277	KASSERT(entry->start == ctx->end, ("end entry start %p", ctx));
278	KASSERT(entry->end == ctx->end, ("end entry end %p", ctx));
279	KASSERT(entry->free_after == 0, ("end entry free_after%p", ctx));
280	KASSERT(entry->flags == DMAR_MAP_ENTRY_PLACE,
281	    ("end entry flags %p", ctx));
282	RB_REMOVE(dmar_gas_entries_tree, &ctx->rb_root, entry);
283	dmar_gas_free_entry(ctx, entry);
284
285	RB_FOREACH_SAFE(entry, dmar_gas_entries_tree, &ctx->rb_root, entry1) {
286		KASSERT((entry->flags & DMAR_MAP_ENTRY_RMRR) != 0,
287		    ("non-RMRR entry left %p", ctx));
288		RB_REMOVE(dmar_gas_entries_tree, &ctx->rb_root, entry);
289		dmar_gas_free_entry(ctx, entry);
290	}
291}
292
293struct dmar_gas_match_args {
294	struct dmar_ctx *ctx;
295	dmar_gaddr_t size;
296	const struct bus_dma_tag_common *common;
297	u_int gas_flags;
298	struct dmar_map_entry *entry;
299};
300
301static bool
302dmar_gas_match_one(struct dmar_gas_match_args *a, struct dmar_map_entry *prev,
303    dmar_gaddr_t end)
304{
305	dmar_gaddr_t bs, start;
306
307	if (a->entry->start + a->size > end)
308		return (false);
309
310	/* DMAR_PAGE_SIZE to create gap after new entry. */
311	if (a->entry->start < prev->end + DMAR_PAGE_SIZE ||
312	    a->entry->start + a->size + DMAR_PAGE_SIZE > prev->end +
313	    prev->free_after)
314		return (false);
315
316	/* No boundary crossing. */
317	if (dmar_test_boundary(a->entry->start, a->size, a->common->boundary))
318		return (true);
319
320	/*
321	 * The start to start + size region crosses the boundary.
322	 * Check if there is enough space after the next boundary
323	 * after the prev->end.
324	 */
325	bs = (a->entry->start + a->common->boundary) & ~(a->common->boundary
326	    - 1);
327	start = roundup2(bs, a->common->alignment);
328	/* DMAR_PAGE_SIZE to create gap after new entry. */
329	if (start + a->size + DMAR_PAGE_SIZE <= prev->end + prev->free_after &&
330	    start + a->size <= end && dmar_test_boundary(start, a->size,
331	    a->common->boundary)) {
332		a->entry->start = start;
333		return (true);
334	}
335
336	/*
337	 * Not enough space to align at the requested boundary, or
338	 * boundary is smaller than the size, but allowed to split.
339	 * We already checked that start + size does not overlap end.
340	 *
341	 * XXXKIB. It is possible that bs is exactly at the start of
342	 * the next entry, then we do not have gap.  Ignore for now.
343	 */
344	if ((a->gas_flags & DMAR_GM_CANSPLIT) != 0) {
345		a->size = bs - a->entry->start;
346		return (true);
347	}
348
349	return (false);
350}
351
352static void
353dmar_gas_match_insert(struct dmar_gas_match_args *a,
354    struct dmar_map_entry *prev)
355{
356	struct dmar_map_entry *next;
357	bool found;
358
359	/*
360	 * The prev->end is always aligned on the page size, which
361	 * causes page alignment for the entry->start too.  The size
362	 * is checked to be multiple of the page size.
363	 *
364	 * The page sized gap is created between consequent
365	 * allocations to ensure that out-of-bounds accesses fault.
366	 */
367	a->entry->end = a->entry->start + a->size;
368
369	next = RB_NEXT(dmar_gas_entries_tree, &a->ctx->rb_root, prev);
370	KASSERT(next->start >= a->entry->end &&
371	    next->start - a->entry->start >= a->size &&
372	    prev->end <= a->entry->end,
373	    ("dmar_gas_match_insert hole failed %p prev (%jx, %jx) "
374	    "free_after %jx next (%jx, %jx) entry (%jx, %jx)", a->ctx,
375	    (uintmax_t)prev->start, (uintmax_t)prev->end,
376	    (uintmax_t)prev->free_after,
377	    (uintmax_t)next->start, (uintmax_t)next->end,
378	    (uintmax_t)a->entry->start, (uintmax_t)a->entry->end));
379
380	prev->free_after = a->entry->start - prev->end;
381	a->entry->free_after = next->start - a->entry->end;
382
383	found = dmar_gas_rb_insert(a->ctx, a->entry);
384	KASSERT(found, ("found dup %p start %jx size %jx",
385	    a->ctx, (uintmax_t)a->entry->start, (uintmax_t)a->size));
386	a->entry->flags = DMAR_MAP_ENTRY_MAP;
387
388	KASSERT(RB_PREV(dmar_gas_entries_tree, &a->ctx->rb_root,
389	    a->entry) == prev,
390	    ("entry %p prev %p inserted prev %p", a->entry, prev,
391	    RB_PREV(dmar_gas_entries_tree, &a->ctx->rb_root, a->entry)));
392	KASSERT(RB_NEXT(dmar_gas_entries_tree, &a->ctx->rb_root,
393	    a->entry) == next,
394	    ("entry %p next %p inserted next %p", a->entry, next,
395	    RB_NEXT(dmar_gas_entries_tree, &a->ctx->rb_root, a->entry)));
396}
397
398static int
399dmar_gas_lowermatch(struct dmar_gas_match_args *a, struct dmar_map_entry *prev)
400{
401	struct dmar_map_entry *l;
402	int ret;
403
404	if (prev->end < a->common->lowaddr) {
405		a->entry->start = roundup2(prev->end + DMAR_PAGE_SIZE,
406		    a->common->alignment);
407		if (dmar_gas_match_one(a, prev, a->common->lowaddr)) {
408			dmar_gas_match_insert(a, prev);
409			return (0);
410		}
411	}
412	if (prev->free_down < a->size + DMAR_PAGE_SIZE)
413		return (ENOMEM);
414	l = RB_LEFT(prev, rb_entry);
415	if (l != NULL) {
416		ret = dmar_gas_lowermatch(a, l);
417		if (ret == 0)
418			return (0);
419	}
420	l = RB_RIGHT(prev, rb_entry);
421	if (l != NULL)
422		return (dmar_gas_lowermatch(a, l));
423	return (ENOMEM);
424}
425
426static int
427dmar_gas_uppermatch(struct dmar_gas_match_args *a)
428{
429	struct dmar_map_entry *next, *prev, find_entry;
430
431	find_entry.start = a->common->highaddr;
432	next = RB_NFIND(dmar_gas_entries_tree, &a->ctx->rb_root, &find_entry);
433	if (next == NULL)
434		return (ENOMEM);
435	prev = RB_PREV(dmar_gas_entries_tree, &a->ctx->rb_root, next);
436	KASSERT(prev != NULL, ("no prev %p %jx", a->ctx,
437	    (uintmax_t)find_entry.start));
438	for (;;) {
439		a->entry->start = prev->start + DMAR_PAGE_SIZE;
440		if (a->entry->start < a->common->highaddr)
441			a->entry->start = a->common->highaddr;
442		a->entry->start = roundup2(a->entry->start,
443		    a->common->alignment);
444		if (dmar_gas_match_one(a, prev, a->ctx->end)) {
445			dmar_gas_match_insert(a, prev);
446			return (0);
447		}
448
449		/*
450		 * XXXKIB.  This falls back to linear iteration over
451		 * the free space in the high region.  But high
452		 * regions are almost unused, the code should be
453		 * enough to cover the case, although in the
454		 * non-optimal way.
455		 */
456		prev = next;
457		next = RB_NEXT(dmar_gas_entries_tree, &a->ctx->rb_root, prev);
458		KASSERT(next != NULL, ("no next %p %jx", a->ctx,
459		    (uintmax_t)find_entry.start));
460		if (next->end >= a->ctx->end)
461			return (ENOMEM);
462	}
463}
464
465static int
466dmar_gas_find_space(struct dmar_ctx *ctx,
467    const struct bus_dma_tag_common *common, dmar_gaddr_t size,
468    u_int flags, struct dmar_map_entry *entry)
469{
470	struct dmar_gas_match_args a;
471	int error;
472
473	DMAR_CTX_ASSERT_LOCKED(ctx);
474	KASSERT(entry->flags == 0, ("dirty entry %p %p", ctx, entry));
475	KASSERT((size & DMAR_PAGE_MASK) == 0, ("size %jx", (uintmax_t)size));
476
477	a.ctx = ctx;
478	a.size = size;
479	a.common = common;
480	a.gas_flags = flags;
481	a.entry = entry;
482
483	/* Handle lower region. */
484	if (common->lowaddr > 0) {
485		error = dmar_gas_lowermatch(&a, RB_ROOT(&ctx->rb_root));
486		if (error == 0)
487			return (0);
488		KASSERT(error == ENOMEM,
489		    ("error %d from dmar_gas_lowermatch", error));
490	}
491	/* Handle upper region. */
492	if (common->highaddr >= ctx->end)
493		return (ENOMEM);
494	error = dmar_gas_uppermatch(&a);
495	KASSERT(error == ENOMEM,
496	    ("error %d from dmar_gas_uppermatch", error));
497	return (error);
498}
499
500static int
501dmar_gas_alloc_region(struct dmar_ctx *ctx, struct dmar_map_entry *entry,
502    u_int flags)
503{
504	struct dmar_map_entry *next, *prev;
505	bool found;
506
507	DMAR_CTX_ASSERT_LOCKED(ctx);
508
509	if ((entry->start & DMAR_PAGE_MASK) != 0 ||
510	    (entry->end & DMAR_PAGE_MASK) != 0)
511		return (EINVAL);
512	if (entry->start >= entry->end)
513		return (EINVAL);
514	if (entry->end >= ctx->end)
515		return (EINVAL);
516
517	next = RB_NFIND(dmar_gas_entries_tree, &ctx->rb_root, entry);
518	KASSERT(next != NULL, ("next must be non-null %p %jx", ctx,
519	    (uintmax_t)entry->start));
520	prev = RB_PREV(dmar_gas_entries_tree, &ctx->rb_root, next);
521	/* prev could be NULL */
522
523	/*
524	 * Adapt to broken BIOSes which specify overlapping RMRR
525	 * entries.
526	 *
527	 * XXXKIB: this does not handle a case when prev or next
528	 * entries are completely covered by the current one, which
529	 * extends both ways.
530	 */
531	if (prev != NULL && prev->end > entry->start &&
532	    (prev->flags & DMAR_MAP_ENTRY_PLACE) == 0) {
533		if ((prev->flags & DMAR_MAP_ENTRY_RMRR) == 0)
534			return (EBUSY);
535		entry->start = prev->end;
536	}
537	if (next != NULL && next->start < entry->end &&
538	    (next->flags & DMAR_MAP_ENTRY_PLACE) == 0) {
539		if ((next->flags & DMAR_MAP_ENTRY_RMRR) == 0)
540			return (EBUSY);
541		entry->end = next->start;
542	}
543	if (entry->end == entry->start)
544		return (0);
545
546	if (prev != NULL && prev->end > entry->start) {
547		/* This assumes that prev is the placeholder entry. */
548		dmar_gas_rb_remove(ctx, prev);
549		prev = NULL;
550	}
551	if (next != NULL && next->start < entry->end) {
552		dmar_gas_rb_remove(ctx, next);
553		next = NULL;
554	}
555
556	found = dmar_gas_rb_insert(ctx, entry);
557	KASSERT(found, ("found RMRR dup %p start %jx end %jx",
558	    ctx, (uintmax_t)entry->start, (uintmax_t)entry->end));
559	entry->flags = DMAR_MAP_ENTRY_RMRR;
560
561#ifdef INVARIANTS
562	struct dmar_map_entry *ip, *in;
563	ip = RB_PREV(dmar_gas_entries_tree, &ctx->rb_root, entry);
564	in = RB_NEXT(dmar_gas_entries_tree, &ctx->rb_root, entry);
565	KASSERT(prev == NULL || ip == prev,
566	    ("RMRR %p (%jx %jx) prev %p (%jx %jx) ins prev %p (%jx %jx)",
567	    entry, entry->start, entry->end, prev,
568	    prev == NULL ? 0 : prev->start, prev == NULL ? 0 : prev->end,
569	    ip, ip == NULL ? 0 : ip->start, ip == NULL ? 0 : ip->end));
570	KASSERT(next == NULL || in == next,
571	    ("RMRR %p (%jx %jx) next %p (%jx %jx) ins next %p (%jx %jx)",
572	    entry, entry->start, entry->end, next,
573	    next == NULL ? 0 : next->start, next == NULL ? 0 : next->end,
574	    in, in == NULL ? 0 : in->start, in == NULL ? 0 : in->end));
575#endif
576
577	return (0);
578}
579
580void
581dmar_gas_free_space(struct dmar_ctx *ctx, struct dmar_map_entry *entry)
582{
583
584	DMAR_CTX_ASSERT_LOCKED(ctx);
585	KASSERT((entry->flags & (DMAR_MAP_ENTRY_PLACE | DMAR_MAP_ENTRY_RMRR |
586	    DMAR_MAP_ENTRY_MAP)) == DMAR_MAP_ENTRY_MAP,
587	    ("permanent entry %p %p", ctx, entry));
588
589	dmar_gas_rb_remove(ctx, entry);
590	entry->flags &= ~DMAR_MAP_ENTRY_MAP;
591#ifdef INVARIANTS
592	if (dmar_check_free)
593		dmar_gas_check_free(ctx);
594#endif
595}
596
597void
598dmar_gas_free_region(struct dmar_ctx *ctx, struct dmar_map_entry *entry)
599{
600	struct dmar_map_entry *next, *prev;
601
602	DMAR_CTX_ASSERT_LOCKED(ctx);
603	KASSERT((entry->flags & (DMAR_MAP_ENTRY_PLACE | DMAR_MAP_ENTRY_RMRR |
604	    DMAR_MAP_ENTRY_MAP)) == DMAR_MAP_ENTRY_RMRR,
605	    ("non-RMRR entry %p %p", ctx, entry));
606
607	prev = RB_PREV(dmar_gas_entries_tree, &ctx->rb_root, entry);
608	next = RB_NEXT(dmar_gas_entries_tree, &ctx->rb_root, entry);
609	dmar_gas_rb_remove(ctx, entry);
610	entry->flags &= ~DMAR_MAP_ENTRY_RMRR;
611
612	if (prev == NULL)
613		dmar_gas_rb_insert(ctx, ctx->first_place);
614	if (next == NULL)
615		dmar_gas_rb_insert(ctx, ctx->last_place);
616}
617
618int
619dmar_gas_map(struct dmar_ctx *ctx, const struct bus_dma_tag_common *common,
620    dmar_gaddr_t size, u_int eflags, u_int flags, vm_page_t *ma,
621    struct dmar_map_entry **res)
622{
623	struct dmar_map_entry *entry;
624	int error;
625
626	KASSERT((flags & ~(DMAR_GM_CANWAIT | DMAR_GM_CANSPLIT)) == 0,
627	    ("invalid flags 0x%x", flags));
628
629	entry = dmar_gas_alloc_entry(ctx, (flags & DMAR_GM_CANWAIT) != 0 ?
630	    DMAR_PGF_WAITOK : 0);
631	if (entry == NULL)
632		return (ENOMEM);
633	DMAR_CTX_LOCK(ctx);
634	error = dmar_gas_find_space(ctx, common, size, flags, entry);
635	if (error == ENOMEM) {
636		DMAR_CTX_UNLOCK(ctx);
637		dmar_gas_free_entry(ctx, entry);
638		return (error);
639	}
640#ifdef INVARIANTS
641	if (dmar_check_free)
642		dmar_gas_check_free(ctx);
643#endif
644	KASSERT(error == 0,
645	    ("unexpected error %d from dmar_gas_find_entry", error));
646	KASSERT(entry->end < ctx->end, ("allocated GPA %jx, max GPA %jx",
647	    (uintmax_t)entry->end, (uintmax_t)ctx->end));
648	entry->flags |= eflags;
649	DMAR_CTX_UNLOCK(ctx);
650
651	error = ctx_map_buf(ctx, entry->start, size, ma,
652	    ((eflags & DMAR_MAP_ENTRY_READ) != 0 ? DMAR_PTE_R : 0) |
653	    ((eflags & DMAR_MAP_ENTRY_WRITE) != 0 ? DMAR_PTE_W : 0) |
654	    ((eflags & DMAR_MAP_ENTRY_SNOOP) != 0 ? DMAR_PTE_SNP : 0) |
655	    ((eflags & DMAR_MAP_ENTRY_TM) != 0 ? DMAR_PTE_TM : 0),
656	    (flags & DMAR_GM_CANWAIT) != 0 ? DMAR_PGF_WAITOK : 0);
657	if (error == ENOMEM) {
658		dmar_ctx_unload_entry(entry, true);
659		return (error);
660	}
661	KASSERT(error == 0,
662	    ("unexpected error %d from ctx_map_buf", error));
663
664	*res = entry;
665	return (0);
666}
667
668int
669dmar_gas_map_region(struct dmar_ctx *ctx, struct dmar_map_entry *entry,
670    u_int eflags, u_int flags, vm_page_t *ma)
671{
672	dmar_gaddr_t start;
673	int error;
674
675	KASSERT(entry->flags == 0, ("used RMRR entry %p %p %x", ctx,
676	    entry, entry->flags));
677	KASSERT((flags & ~(DMAR_GM_CANWAIT)) == 0,
678	    ("invalid flags 0x%x", flags));
679
680	start = entry->start;
681	DMAR_CTX_LOCK(ctx);
682	error = dmar_gas_alloc_region(ctx, entry, flags);
683	if (error != 0) {
684		DMAR_CTX_UNLOCK(ctx);
685		return (error);
686	}
687	entry->flags |= eflags;
688	DMAR_CTX_UNLOCK(ctx);
689	if (entry->end == entry->start)
690		return (0);
691
692	error = ctx_map_buf(ctx, entry->start, entry->end - entry->start,
693	    ma + OFF_TO_IDX(start - entry->start),
694	    ((eflags & DMAR_MAP_ENTRY_READ) != 0 ? DMAR_PTE_R : 0) |
695	    ((eflags & DMAR_MAP_ENTRY_WRITE) != 0 ? DMAR_PTE_W : 0) |
696	    ((eflags & DMAR_MAP_ENTRY_SNOOP) != 0 ? DMAR_PTE_SNP : 0) |
697	    ((eflags & DMAR_MAP_ENTRY_TM) != 0 ? DMAR_PTE_TM : 0),
698	    (flags & DMAR_GM_CANWAIT) != 0 ? DMAR_PGF_WAITOK : 0);
699	if (error == ENOMEM) {
700		dmar_ctx_unload_entry(entry, false);
701		return (error);
702	}
703	KASSERT(error == 0,
704	    ("unexpected error %d from ctx_map_buf", error));
705
706	return (0);
707}
708
709int
710dmar_gas_reserve_region(struct dmar_ctx *ctx, dmar_gaddr_t start,
711    dmar_gaddr_t end)
712{
713	struct dmar_map_entry *entry;
714	int error;
715
716	entry = dmar_gas_alloc_entry(ctx, DMAR_PGF_WAITOK);
717	entry->start = start;
718	entry->end = end;
719	DMAR_CTX_LOCK(ctx);
720	error = dmar_gas_alloc_region(ctx, entry, DMAR_GM_CANWAIT);
721	if (error == 0)
722		entry->flags |= DMAR_MAP_ENTRY_UNMAPPED;
723	DMAR_CTX_UNLOCK(ctx);
724	if (error != 0)
725		dmar_gas_free_entry(ctx, entry);
726	return (error);
727}
728