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