pm: Allow RCU lookups and qlocked updaters
[akaros.git] / kern / src / pagemap.c
1 /* Copyright (c) 2014 The Regents of the University of California
2  * Barret Rhoden <brho@cs.berkeley.edu>
3  * See LICENSE for details.
4  *
5  * Page mapping: maps an object (inode or block dev) in page size chunks.
6  * Analagous to Linux's "struct address space" */
7
8 #include <pmap.h>
9 #include <atomic.h>
10 #include <radix.h>
11 #include <kref.h>
12 #include <assert.h>
13 #include <stdio.h>
14 #include <pagemap.h>
15 #include <rcu.h>
16
17 void pm_add_vmr(struct page_map *pm, struct vm_region *vmr)
18 {
19         /* note that the VMR being reverse-mapped by the PM is protected by the PM's
20          * lock.  we clearly need a write lock here, but removal also needs a write
21          * lock, so later when removal holds this, it delays munmaps and keeps the
22          * VMR connected. */
23         spin_lock(&pm->pm_lock);
24         TAILQ_INSERT_TAIL(&pm->pm_vmrs, vmr, vm_pm_link);
25         spin_unlock(&pm->pm_lock);
26 }
27
28 void pm_remove_vmr(struct page_map *pm, struct vm_region *vmr)
29 {
30         spin_lock(&pm->pm_lock);
31         TAILQ_REMOVE(&pm->pm_vmrs, vmr, vm_pm_link);
32         spin_unlock(&pm->pm_lock);
33 }
34
35 /* PM slot void *s look like this:
36  *
37  * |--11--|--1--|----52 or 20 bits--|
38  * | ref  | flag|    ppn of page    |
39  *              \  <--- meta shift -/
40  *
41  * The setter funcs return the void* that should update slot_val; it doesn't
42  * change slot_val in place (it's a val, not the addr) */
43
44 #ifdef CONFIG_64BIT
45 # define PM_FLAGS_SHIFT 52
46 #else
47 # define PM_FLAGS_SHIFT 20
48 #endif
49 #define PM_REFCNT_SHIFT (PM_FLAGS_SHIFT + 1)
50
51 #define PM_REMOVAL (1UL << PM_FLAGS_SHIFT)
52
53 static bool pm_slot_check_removal(void *slot_val)
54 {
55         return (unsigned long)slot_val & PM_REMOVAL ? TRUE : FALSE;
56 }
57
58 static void *pm_slot_set_removal(void *slot_val)
59 {
60         return (void*)((unsigned long)slot_val | PM_REMOVAL);
61 }
62
63 static void *pm_slot_clear_removal(void *slot_val)
64 {
65         return (void*)((unsigned long)slot_val & ~PM_REMOVAL);
66 }
67
68 static int pm_slot_check_refcnt(void *slot_val)
69 {
70         return (unsigned long)slot_val >> PM_REFCNT_SHIFT;
71 }
72
73 static void *pm_slot_inc_refcnt(void *slot_val)
74 {
75         void *ret;
76
77         ret = (void*)((unsigned long)slot_val + (1UL << PM_REFCNT_SHIFT));
78         /* Catches previously negative refcnts */
79         assert(pm_slot_check_refcnt(ret) > 0);
80         return ret;
81 }
82
83 static void *pm_slot_dec_refcnt(void *slot_val)
84 {
85         assert(pm_slot_check_refcnt(slot_val) > 0);
86         return (void*)((unsigned long)slot_val - (1UL << PM_REFCNT_SHIFT));
87 }
88
89 static struct page *pm_slot_get_page(void *slot_val)
90 {
91         if (!slot_val)
92                 return 0;
93         return ppn2page((unsigned long)slot_val & ((1UL << PM_FLAGS_SHIFT) - 1));
94 }
95
96 static void *pm_slot_set_page(void *slot_val, struct page *pg)
97 {
98         assert(pg != pages);    /* we should never alloc page 0, for sanity */
99         return (void*)(page2ppn(pg) | ((unsigned long)slot_val &
100                                        ~((1UL << PM_FLAGS_SHIFT) - 1)));
101 }
102
103 /* Initializes a PM.  Host should be an fs_file.  The reference this stores is
104  * uncounted. */
105 void pm_init(struct page_map *pm, struct page_map_operations *op, void *host)
106 {
107         pm->pm_file = host;
108         radix_tree_init(&pm->pm_tree);
109         pm->pm_num_pages = 0;
110         pm->pm_op = op;
111         qlock_init(&pm->pm_qlock);
112         spinlock_init(&pm->pm_lock);
113         TAILQ_INIT(&pm->pm_vmrs);
114 }
115
116 /* Looks up the index'th page in the page map, returning a refcnt'd reference
117  * that need to be dropped with pm_put_page, or 0 if it was not in the map. */
118 static struct page *pm_find_page(struct page_map *pm, unsigned long index)
119 {
120         void **tree_slot;
121         void *old_slot_val, *slot_val;
122         struct page *page = 0;
123
124         /* We use rcu to protect our radix walk, specifically the tree_slot pointer.
125          * We get our own 'pm refcnt' on the slot itself, which doesn't need RCU. */
126         rcu_read_lock();
127         /* We're syncing with removal.  The deal is that if we grab the page (and
128          * we'd only do that if the page != 0), we up the slot ref and clear
129          * removal.  A remover will only remove it if removal is still set.  If we
130          * grab and release while removal is in progress, even though we no longer
131          * hold the ref, we have unset removal.  Also, to prevent removal where we
132          * get a page well before the removal process, the removal won't even bother
133          * when the slot refcnt is upped. */
134         tree_slot = radix_lookup_slot(&pm->pm_tree, index);
135         if (!tree_slot)
136                 goto out;
137         do {
138                 old_slot_val = ACCESS_ONCE(*tree_slot);
139                 slot_val = old_slot_val;
140                 page = pm_slot_get_page(slot_val);
141                 if (!page)
142                         goto out;
143                 slot_val = pm_slot_clear_removal(slot_val);
144                 slot_val = pm_slot_inc_refcnt(slot_val);        /* not a page kref */
145         } while (!atomic_cas_ptr(tree_slot, old_slot_val, slot_val));
146         assert(page->pg_tree_slot == tree_slot);
147 out:
148         rcu_read_unlock();
149         return page;
150 }
151
152 /* Attempts to insert the page into the page_map, returns 0 for success, or an
153  * error code if there was one already (EEXIST) or we ran out of memory
154  * (ENOMEM).
155  *
156  * On success, callers *lose* their page ref, but get a PM slot ref.  This slot
157  * ref is sufficient to keep the page alive (slot ref protects the page ref)..
158  *
159  * Makes no assumptions about the quality of the data loaded, that's up to the
160  * caller. */
161 static int pm_insert_page(struct page_map *pm, unsigned long index,
162                           struct page *page)
163 {
164         int ret;
165         void **tree_slot;
166         void *slot_val = 0;
167
168         page->pg_mapping = pm;  /* debugging */
169         page->pg_index = index;
170         /* no one should be looking at the tree slot til we stop write locking.  the
171          * only other one who looks is removal, who requires a PM write lock. */
172         page->pg_tree_slot = (void*)0xdeadbeef; /* poison */
173         slot_val = pm_slot_inc_refcnt(slot_val);
174         /* passing the page ref from the caller to the slot */
175         slot_val = pm_slot_set_page(slot_val, page);
176         qlock(&pm->pm_qlock);
177         ret = radix_insert(&pm->pm_tree, index, slot_val, &tree_slot);
178         if (ret) {
179                 qunlock(&pm->pm_qlock);
180                 return ret;
181         }
182         page->pg_tree_slot = tree_slot;
183         pm->pm_num_pages++;
184         qunlock(&pm->pm_qlock);
185         return 0;
186 }
187
188 /* Decrefs the PM slot ref (usage of a PM page).  The PM's page ref remains. */
189 void pm_put_page(struct page *page)
190 {
191         void **tree_slot = page->pg_tree_slot;
192
193         assert(tree_slot);
194         assert(pm_slot_get_page(*tree_slot) == page);
195         assert(pm_slot_check_refcnt(*tree_slot) > 0);
196         /* decref, don't care about CASing */
197         atomic_add((atomic_t*)tree_slot, -(1UL << PM_REFCNT_SHIFT));
198 }
199
200 /* Makes sure the index'th page of the mapped object is loaded in the page cache
201  * and returns its location via **pp.
202  *
203  * You'll get a pm-slot refcnt back, which you need to put when you're done. */
204 int pm_load_page(struct page_map *pm, unsigned long index, struct page **pp)
205 {
206         struct page *page;
207         int error;
208
209         page = pm_find_page(pm, index);
210         while (!page) {
211                 if (kpage_alloc(&page))
212                         return -ENOMEM;
213                 /* important that UP_TO_DATE is not set.  once we put it in the PM,
214                  * others can find it, and we still need to fill it. */
215                 atomic_set(&page->pg_flags, PG_LOCKED | PG_PAGEMAP);
216                 /* The sem needs to be initted before anyone can try to lock it, meaning
217                  * before it is in the page cache.  We also want it locked preemptively,
218                  * by setting signals = 0. */
219                 sem_init(&page->pg_sem, 0);
220                 error = pm_insert_page(pm, index, page);
221                 switch (error) {
222                         case 0:
223                                 goto load_locked_page;
224                                 break;
225                         case -EEXIST:
226                                 /* the page was mapped already (benign race), just get rid of
227                                  * our page and try again (the only case that uses the while) */
228                                 atomic_set(&page->pg_flags, 0);
229                                 page_decref(page);
230                                 page = pm_find_page(pm, index);
231                                 break;
232                         default:
233                                 atomic_set(&page->pg_flags, 0);
234                                 page_decref(page);
235                                 return error;
236                 }
237         }
238         assert(page);
239         assert(pm_slot_check_refcnt(*page->pg_tree_slot));
240         assert(pm_slot_get_page(*page->pg_tree_slot) == page);
241         if (atomic_read(&page->pg_flags) & PG_UPTODATE) {
242                 *pp = page;
243                 printd("pm %p FOUND page %p, addr %p, idx %d\n", pm, page,
244                        page2kva(page), index);
245                 return 0;
246         }
247         lock_page(page);
248         /* double-check.  if we we blocked on lock_page, it was probably for someone
249          * else loading.  plus, we can't load a page more than once (it could
250          * clobber newer writes) */
251         if (atomic_read(&page->pg_flags) & PG_UPTODATE) {
252                 unlock_page(page);
253                 *pp = page;
254                 return 0;
255         }
256         /* fall through */
257 load_locked_page:
258         error = pm->pm_op->readpage(pm, page);
259         assert(!error);
260         assert(atomic_read(&page->pg_flags) & PG_UPTODATE);
261         unlock_page(page);
262         *pp = page;
263         printd("pm %p LOADS page %p, addr %p, idx %d\n", pm, page,
264                page2kva(page), index);
265         return 0;
266 }
267
268 int pm_load_page_nowait(struct page_map *pm, unsigned long index,
269                         struct page **pp)
270 {
271         struct page *page = pm_find_page(pm, index);
272         if (!page)
273                 return -EAGAIN;
274         if (!(atomic_read(&page->pg_flags) & PG_UPTODATE)) {
275                 /* TODO: could have a read_nowait pm_op */
276                 pm_put_page(page);
277                 return -EAGAIN;
278         }
279         *pp = page;
280         return 0;
281 }
282
283 static bool vmr_has_page_idx(struct vm_region *vmr, unsigned long pg_idx)
284 {
285         unsigned long nr_pgs = (vmr->vm_end - vmr->vm_base) >> PGSHIFT;
286         unsigned long start_pg = vmr->vm_foff >> PGSHIFT;
287
288         if (!vmr->vm_ready)
289                 return false;
290         return ((start_pg <= pg_idx) && (pg_idx < start_pg + nr_pgs));
291 }
292
293 static void *vmr_idx_to_va(struct vm_region *vmr, unsigned long pg_idx)
294 {
295         uintptr_t va = vmr->vm_base + ((pg_idx << PGSHIFT) - vmr->vm_foff);
296         assert(va < vmr->vm_end);
297         return (void*)va;
298 }
299
300 static unsigned long vmr_get_end_idx(struct vm_region *vmr)
301 {
302         return ((vmr->vm_end - vmr->vm_base) + vmr->vm_foff) >> PGSHIFT;
303 }
304
305 static void vmr_for_each(struct vm_region *vmr, unsigned long pg_idx,
306                          unsigned long max_nr_pgs, mem_walk_callback_t callback)
307 {
308         void *start_va = vmr_idx_to_va(vmr, pg_idx);
309         size_t len = vmr->vm_end - (uintptr_t)start_va;
310         len = MIN(len, max_nr_pgs << PGSHIFT);
311         /* TODO: start using pml_for_each, across all arches */
312         env_user_mem_walk(vmr->vm_proc, start_va, len, callback, 0);
313 }
314
315 /* These next two helpers are called on a VMR's range of VAs corresponding to a
316  * pages in a PM undergoing removal.
317  *
318  * In general, it is safe to mark !P or 0 a PTE so long as the page the PTE
319  * points to belongs to a PM.  We'll refault, find the page, and rebuild the
320  * PTE.  This allows us to handle races like: {pm marks !p, {fault, find page,
321  * abort removal, write new pte}, pm clears pte}.
322  *
323  * In that race, HPF is writing the PTE, which removal code subsequently looks
324  * at to determine if the underlying page is dirty.  We need to make sure no one
325  * clears dirty bits unless they handle the WB (or discard).  HPF preserves the
326  * dirty bit for this reason. */
327 static int __pm_mark_not_present(struct proc *p, pte_t pte, void *va, void *arg)
328 {
329         struct page *page;
330         /* mapped includes present.  Any PTE pointing to a page (mapped) will get
331          * flagged for removal and have its access prots revoked.  We need to deal
332          * with mapped-but-maybe-not-present in case of a dirtied file that was
333          * mprotected to PROT_NONE (which is not present) */
334         if (pte_is_unmapped(pte))
335                 return 0;
336         page = pa2page(pte_get_paddr(pte));
337         if (atomic_read(&page->pg_flags) & PG_REMOVAL)
338                 pte_clear_present(pte);
339         return 0;
340 }
341
342 static int __pm_mark_dirty_pgs_unmap(struct proc *p, pte_t pte, void *va,
343                                      void *arg)
344 {
345         struct page *page;
346         /* we're not checking for 'present' or not, since we marked them !P earlier.
347          * but the CB is still called on everything in the range.  we can tell the
348          * formerly-valid PTEs from the completely unmapped, since the latter are
349          * unmapped, while the former have other things in them, but just are !P. */
350         if (pte_is_unmapped(pte))
351                 return 0;
352         page = pa2page(pte_get_paddr(pte));
353         /* need to check for removal again, just like in mark_not_present */
354         if (atomic_read(&page->pg_flags) & PG_REMOVAL) {
355                 if (pte_is_dirty(pte))
356                         atomic_or(&page->pg_flags, PG_DIRTY);
357                 pte_clear(pte);
358         }
359         return 0;
360 }
361
362 static int __pm_mark_unmap(struct proc *p, pte_t pte, void *va, void *arg)
363 {
364         struct page *page;
365         if (pte_is_unmapped(pte))
366                 return 0;
367         page = pa2page(pte_get_paddr(pte));
368         if (atomic_read(&page->pg_flags) & PG_REMOVAL)
369                 pte_clear(pte);
370         return 0;
371 }
372
373 static void shootdown_and_reset_ptrstore(void *proc_ptrs[], int *arr_idx)
374 {
375         for (int i = 0; i < *arr_idx; i++)
376                 proc_tlbshootdown((struct proc*)proc_ptrs[i], 0, 0);
377         *arr_idx = 0;
378 }
379
380 /* Attempts to remove pages from the pm, from [index, index + nr_pgs).  Returns
381  * the number of pages removed.  There can only be one remover at a time per PM
382  * - others will return 0. */
383 int pm_remove_contig(struct page_map *pm, unsigned long index,
384                      unsigned long nr_pgs)
385 {
386         unsigned long i;
387         int nr_removed = 0;
388         void **tree_slot;
389         void *old_slot_val, *slot_val;
390         struct vm_region *vmr_i;
391         bool pm_has_pinned_vmrs = FALSE;
392         /* using this for both procs and later WBs */
393         #define PTR_ARR_LEN 10
394         void *ptr_store[PTR_ARR_LEN];
395         int ptr_free_idx = 0;
396         struct page *page;
397
398         /* could also call a simpler remove if nr_pgs == 1 */
399         if (!nr_pgs)
400                 return 0;
401
402         /* This is a mess.  Qlock due to the radix_delete later.  spinlock for the
403          * VMR lists. */
404         qlock(&pm->pm_qlock);
405         spin_lock(&pm->pm_lock);
406         assert(index + nr_pgs > index); /* til we figure out who validates */
407         /* check for any pinned VMRs.  if we have none, then we can skip some loops
408          * later */
409         TAILQ_FOREACH(vmr_i, &pm->pm_vmrs, vm_pm_link) {
410                 if (vmr_i->vm_flags & MAP_LOCKED)
411                         pm_has_pinned_vmrs = TRUE;
412         }
413         /* this pass, we mark pages for removal */
414         for (i = index; i < index + nr_pgs; i++) {
415                 if (pm_has_pinned_vmrs) {
416                         /* for pinned pages, we don't even want to attempt to remove them */
417                         TAILQ_FOREACH(vmr_i, &pm->pm_vmrs, vm_pm_link) {
418                                 /* once we've found a pinned page, we can skip over the rest of
419                                  * the range of pages mapped by this vmr - even if the vmr
420                                  * hasn't actually faulted them in yet. */
421                                 if ((vmr_i->vm_flags & MAP_LOCKED) &&
422                                     (vmr_has_page_idx(vmr_i, i))) {
423                                         i = vmr_get_end_idx(vmr_i) - 1; /* loop will +1 */
424                                         goto next_loop_mark_rm;
425                                 }
426                         }
427                 }
428                 /* TODO: would like a radix_next_slot() iterator (careful with skipping
429                  * chunks of the loop) */
430                 tree_slot = radix_lookup_slot(&pm->pm_tree, i);
431                 if (!tree_slot)
432                         continue;
433                 old_slot_val = ACCESS_ONCE(*tree_slot);
434                 slot_val = old_slot_val;
435                 page = pm_slot_get_page(slot_val);
436                 if (!page)
437                         continue;
438                 /* syncing with lookups, writebacks, etc.  only one remover per pm in
439                  * general.  any new ref-getter (WB, lookup, etc) will clear removal,
440                  * causing us to abort later. */
441                 if (pm_slot_check_refcnt(slot_val))
442                         continue;
443                 /* it's possible that removal is already set, if we happened to repeat a
444                  * loop (due to running out of space in the proc arr) */
445                 slot_val = pm_slot_set_removal(slot_val);
446                 if (!atomic_cas_ptr(tree_slot, old_slot_val, slot_val))
447                         continue;
448                 /* mark the page itself.  this isn't used for syncing - just out of
449                  * convenience for ourselves (memwalk callbacks are easier).  need the
450                  * atomic in case a new user comes in and tries mucking with the flags*/
451                 atomic_or(&page->pg_flags, PG_REMOVAL);
452 next_loop_mark_rm:
453                 ;
454         }
455         /* second pass, over VMRs instead of pages.  we remove the marked pages from
456          * all VMRs, collecting the procs for batch shootdowns.  not sure how often
457          * we'll have more than one VMR (for a PM) per proc.  shared libs tend to
458          * have a couple, so we'll still batch things up */
459         TAILQ_FOREACH(vmr_i, &pm->pm_vmrs, vm_pm_link) {
460                 /* might have some pinned VMRs that only map part of the file we aren't
461                  * messing with (so they didn't trigger earlier). */
462                 if (vmr_i->vm_flags & MAP_LOCKED)
463                         continue;
464                 /* Private mappings: for each page, either PMs have a separate copy
465                  * hanging off their PTE (in which case they aren't using the PM page,
466                  * and the actual page in use won't have PG_REMOVAL set, and the CB will
467                  * ignore it), or they are still using the shared version.  In which
468                  * case they haven't written it yet, and we can remove it.  If they
469                  * concurrently are performing a write fault to CoW the page, they will
470                  * incref and clear REMOVAL, thereby aborting the remove anyways.
471                  *
472                  * Though if the entire mapping is unique-copies of private pages, we
473                  * won't need a shootdown.  mem_walk can't handle this yet though. */
474                 if (!vmr_has_page_idx(vmr_i, index))
475                         continue;
476                 spin_lock(&vmr_i->vm_proc->pte_lock);
477                 /* all PTEs for pages marked for removal are marked !P for the entire
478                  * range.  it's possible we'll remove some extra PTEs (races with
479                  * loaders, etc), but those pages will remain in the PM and should get
480                  * soft-faulted back in. */
481                 vmr_for_each(vmr_i, index, nr_pgs, __pm_mark_not_present);
482                 spin_unlock(&vmr_i->vm_proc->pte_lock);
483                 /* batching TLB shootdowns for a given proc (continue if found).
484                  * the proc stays alive while we hold a read lock on the PM tree,
485                  * since the VMR can't get yanked out yet. */
486                 for (i = 0; i < ptr_free_idx; i++) {
487                         if (ptr_store[i] == vmr_i->vm_proc)
488                                 break;
489                 }
490                 if (i != ptr_free_idx)
491                         continue;
492                 if (ptr_free_idx == PTR_ARR_LEN)
493                         shootdown_and_reset_ptrstore(ptr_store, &ptr_free_idx);
494                 ptr_store[ptr_free_idx++] = vmr_i->vm_proc;
495         }
496         /* Need to shootdown so that all TLBs have the page marked absent.  Then we
497          * can check the dirty bit, now that concurrent accesses will fault.  btw,
498          * we have a lock ordering: pm (RCU) -> proc lock (state, vcmap, etc) */
499         shootdown_and_reset_ptrstore(ptr_store, &ptr_free_idx);
500         /* Now that we've shotdown, we can check for dirtiness.  One downside to
501          * this approach is we check every VMR for a page, even once we know the
502          * page is dirty.  We also need to unmap the pages (set ptes to 0) for any
503          * that we previously marked not present (complete the unmap).  We're racing
504          * with munmap here, which treats the PTE as a weak ref on a page. */
505         TAILQ_FOREACH(vmr_i, &pm->pm_vmrs, vm_pm_link) {
506                 if (vmr_i->vm_flags & MAP_LOCKED)
507                         continue;
508                 if (!vmr_has_page_idx(vmr_i, index))
509                         continue;
510                 spin_lock(&vmr_i->vm_proc->pte_lock);
511                 if (vmr_i->vm_prot & PROT_WRITE)
512                         vmr_for_each(vmr_i, index, nr_pgs, __pm_mark_dirty_pgs_unmap);
513                 else
514                         vmr_for_each(vmr_i, index, nr_pgs, __pm_mark_unmap);
515                 spin_unlock(&vmr_i->vm_proc->pte_lock);
516         }
517         /* Now we'll go through from the PM again and deal with pages are dirty. */
518         i = index;
519 handle_dirty:
520         for (/* i set already */; i < index + nr_pgs; i++) {
521                 /* TODO: consider putting in the pinned check & advance again.  Careful,
522                  * since we could unlock on a handle_dirty loop, and skipping could skip
523                  * over a new VMR, but those pages would still be marked for removal.
524                  * It's not wrong, currently, to have spurious REMOVALs. */
525                 tree_slot = radix_lookup_slot(&pm->pm_tree, i);
526                 if (!tree_slot)
527                         continue;
528                 page = pm_slot_get_page(*tree_slot);
529                 if (!page)
530                         continue;
531                 /* only operate on pages we marked earlier */
532                 if (!(atomic_read(&page->pg_flags) & PG_REMOVAL))
533                         continue;
534                 /* if someone has used it since we grabbed it, we lost the race and
535                  * won't remove it later.  no sense writing it back now either. */
536                 if (!pm_slot_check_removal(*tree_slot)) {
537                         /* since we set PG_REMOVAL, we're the ones to clear it */
538                         atomic_and(&page->pg_flags, ~PG_REMOVAL);
539                         continue;
540                 }
541                 /* this dirty flag could also be set by write()s, not just VMRs */
542                 if (atomic_read(&page->pg_flags) & PG_DIRTY) {
543                         /* need to bail out.  after we WB, we'll restart this big loop where
544                          * we left off ('i' is still set) */
545                         if (ptr_free_idx == PTR_ARR_LEN)
546                                 break;
547                         ptr_store[ptr_free_idx++] = page;
548                         /* once we've decided to WB, we can clear the dirty flag.  might
549                          * have an extra WB later, but we won't miss new data */
550                         atomic_and(&page->pg_flags, ~PG_DIRTY);
551                 }
552         }
553         /* we're unlocking, meaning VMRs and the radix tree can be changed, but we
554          * are still the only remover. still can have new refs that clear REMOVAL */
555         spin_unlock(&pm->pm_lock);
556         /* could batch these up, etc. */
557         for (int j = 0; j < ptr_free_idx; j++)
558                 pm->pm_op->writepage(pm, (struct page*)ptr_store[j]);
559         ptr_free_idx = 0;
560         spin_lock(&pm->pm_lock);
561         /* bailed out of the dirty check loop earlier, need to finish and WB.  i is
562          * still set to where we failed and left off in the big loop. */
563         if (i < index + nr_pgs)
564                 goto handle_dirty;
565         /* TODO: RCU - we need a write lock here (the current spinlock is fine) */
566         /* All dirty pages were WB, anything left as REMOVAL can be removed */
567         for (i = index; i < index + nr_pgs; i++) {
568                 /* TODO: consider putting in the pinned check & advance again */
569                 tree_slot = radix_lookup_slot(&pm->pm_tree, i);
570                 if (!tree_slot)
571                         continue;
572                 old_slot_val = ACCESS_ONCE(*tree_slot);
573                 slot_val = old_slot_val;
574                 page = pm_slot_get_page(*tree_slot);
575                 if (!page)
576                         continue;
577                 if (!(atomic_read(&page->pg_flags) & PG_REMOVAL))
578                         continue;
579                 /* syncing with lookups, writebacks, etc.  if someone has used it since
580                  * we started removing, they would have cleared the slot's REMOVAL (but
581                  * not PG_REMOVAL), though the refcnt could be back down to 0 again. */
582                 if (!pm_slot_check_removal(slot_val)) {
583                         /* since we set PG_REMOVAL, we're the ones to clear it */
584                         atomic_and(&page->pg_flags, ~PG_REMOVAL);
585                         continue;
586                 }
587                 if (pm_slot_check_refcnt(slot_val))
588                         warn("Unexpected refcnt in PM remove!");
589                 /* Note that we keep slot REMOVAL set, so the radix tree thinks it's
590                  * still an item (artifact of that implementation). */
591                 slot_val = pm_slot_set_page(slot_val, 0);
592                 if (!atomic_cas_ptr(tree_slot, old_slot_val, slot_val)) {
593                         atomic_and(&page->pg_flags, ~PG_REMOVAL);
594                         continue;
595                 }
596                 /* at this point, we're free at last!  When we update the radix tree, it
597                  * still thinks it has an item.  This is fine.  Lookups will now fail
598                  * (since the page is 0), and insertions will block on the write lock.*/
599                 atomic_set(&page->pg_flags, 0); /* cause/catch bugs */
600                 page_decref(page);
601                 nr_removed++;
602                 radix_delete(&pm->pm_tree, i);
603         }
604         pm->pm_num_pages -= nr_removed;
605         spin_unlock(&pm->pm_lock);
606         qunlock(&pm->pm_qlock);
607         return nr_removed;
608 }
609
610 static bool pm_has_vmr_with_page(struct page_map *pm, unsigned long pg_idx)
611 {
612         struct vm_region *vmr_i;
613
614         spin_lock(&pm->pm_lock);
615         TAILQ_FOREACH(vmr_i, &pm->pm_vmrs, vm_pm_link) {
616                 if (vmr_has_page_idx(vmr_i, pg_idx)) {
617                         spin_unlock(&pm->pm_lock);
618                         return true;
619                 }
620         }
621         spin_unlock(&pm->pm_lock);
622         return false;
623 }
624
625 static bool __remove_or_zero_cb(void **slot, unsigned long tree_idx, void *arg)
626 {
627         struct page_map *pm = arg;
628         struct page *page;
629         void *old_slot_val, *slot_val;
630
631         old_slot_val = ACCESS_ONCE(*slot);
632         slot_val = old_slot_val;
633         page = pm_slot_get_page(slot_val);
634         /* We shouldn't have an item in the tree without a page, unless there's
635          * another removal.  Currently, this CB is called with a qlock. */
636         assert(page);
637         /* Don't even bother with VMRs that might have faulted in the page */
638         if (pm_has_vmr_with_page(pm, tree_idx)) {
639                 memset(page2kva(page), 0, PGSIZE);
640                 return false;
641         }
642         /* syncing with lookups, writebacks, etc - anyone who gets a ref on a PM
643          * leaf/page (e.g. pm_load_page / pm_find_page. */
644         slot_val = pm_slot_set_page(slot_val, NULL);
645         if (pm_slot_check_refcnt(slot_val) ||
646                 !atomic_cas_ptr(slot, old_slot_val, slot_val)) {
647                 memset(page2kva(page), 0, PGSIZE);
648                 return false;
649         }
650         /* We yanked the page out.  The radix tree still has an item until we return
651          * true, but this is fine.  Future lock-free lookups will now fail (since
652          * the page is 0), and insertions will block on the write lock. */
653         atomic_set(&page->pg_flags, 0); /* cause/catch bugs */
654         page_decref(page);
655         return true;
656 }
657
658 void pm_remove_or_zero_pages(struct page_map *pm, unsigned long start_idx,
659                              unsigned long nr_pgs)
660 {
661         unsigned long end_idx = start_idx + nr_pgs;
662
663         assert(end_idx > start_idx);
664         qlock(&pm->pm_qlock);
665         radix_for_each_slot_in_range(&pm->pm_tree, start_idx, end_idx,
666                                      __remove_or_zero_cb, pm);
667         qunlock(&pm->pm_qlock);
668 }
669
670 static bool __destroy_cb(void **slot, unsigned long tree_idx, void *arg)
671 {
672         struct page *page = pm_slot_get_page(*slot);
673
674         /* Should be no users or need to sync */
675         assert(pm_slot_check_refcnt(*slot) == 0);
676         atomic_set(&page->pg_flags, 0); /* catch bugs */
677         page_decref(page);
678         return true;
679 }
680
681 void pm_destroy(struct page_map *pm)
682 {
683         radix_for_each_slot(&pm->pm_tree, __destroy_cb, pm);
684         radix_tree_destroy(&pm->pm_tree);
685 }
686
687 void print_page_map_info(struct page_map *pm)
688 {
689         struct vm_region *vmr_i;
690         printk("Page Map %p\n", pm);
691         printk("\tNum pages: %lu\n", pm->pm_num_pages);
692         spin_lock(&pm->pm_lock);
693         TAILQ_FOREACH(vmr_i, &pm->pm_vmrs, vm_pm_link) {
694                 printk("\tVMR proc %d: (%p - %p): 0x%08x, 0x%08x, %p, %p\n",
695                        vmr_i->vm_proc->pid, vmr_i->vm_base, vmr_i->vm_end,
696                        vmr_i->vm_prot, vmr_i->vm_flags, foc_pointer(vmr_i->__vm_foc),
697                            vmr_i->vm_foff);
698         }
699         spin_unlock(&pm->pm_lock);
700 }
701
702 void pm_page_asserter(struct page *page, char *str)
703 {
704         void **tree_slot = page->pg_tree_slot;
705
706         if (!page_is_pagemap(page))
707                 return;
708         assert(tree_slot);
709         assert(pm_slot_get_page(*tree_slot) == page);
710         assert(pm_slot_check_refcnt(*tree_slot) > 0);
711 }