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