blob: 54eac8a39a4c11d8c760064a8f2fa987ce45d13a [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001#ifndef _LINUX_SWAP_H
2#define _LINUX_SWAP_H
3
4#include <linux/config.h>
5#include <linux/spinlock.h>
6#include <linux/linkage.h>
7#include <linux/mmzone.h>
8#include <linux/list.h>
9#include <linux/sched.h>
Andrew Morton542d1c82005-07-12 13:58:31 -070010
Linus Torvalds1da177e2005-04-16 15:20:36 -070011#include <asm/atomic.h>
12#include <asm/page.h>
13
14#define SWAP_FLAG_PREFER 0x8000 /* set if swap priority specified */
15#define SWAP_FLAG_PRIO_MASK 0x7fff
16#define SWAP_FLAG_PRIO_SHIFT 0
17
18static inline int current_is_kswapd(void)
19{
20 return current->flags & PF_KSWAPD;
21}
22
23/*
24 * MAX_SWAPFILES defines the maximum number of swaptypes: things which can
25 * be swapped to. The swap type and the offset into that swap type are
26 * encoded into pte's and into pgoff_t's in the swapcache. Using five bits
27 * for the type means that the maximum number of swapcache pages is 27 bits
28 * on 32-bit-pgoff_t architectures. And that assumes that the architecture packs
29 * the type/offset into the pte as 5/27 as well.
30 */
31#define MAX_SWAPFILES_SHIFT 5
32#define MAX_SWAPFILES (1 << MAX_SWAPFILES_SHIFT)
33
34/*
35 * Magic header for a swap area. The first part of the union is
36 * what the swap magic looks like for the old (limited to 128MB)
37 * swap area format, the second part of the union adds - in the
38 * old reserved area - some extra information. Note that the first
39 * kilobyte is reserved for boot loader or disk label stuff...
40 *
41 * Having the magic at the end of the PAGE_SIZE makes detecting swap
42 * areas somewhat tricky on machines that support multiple page sizes.
43 * For 2.5 we'll probably want to move the magic to just beyond the
44 * bootbits...
45 */
46union swap_header {
47 struct {
48 char reserved[PAGE_SIZE - 10];
49 char magic[10]; /* SWAP-SPACE or SWAPSPACE2 */
50 } magic;
51 struct {
52 char bootbits[1024]; /* Space for disklabel etc. */
53 unsigned int version;
54 unsigned int last_page;
55 unsigned int nr_badpages;
56 unsigned int padding[125];
57 unsigned int badpages[1];
58 } info;
59};
60
61 /* A swap entry has to fit into a "unsigned long", as
62 * the entry is hidden in the "index" field of the
63 * swapper address space.
64 */
65typedef struct {
66 unsigned long val;
67} swp_entry_t;
68
69/*
70 * current->reclaim_state points to one of these when a task is running
71 * memory reclaim
72 */
73struct reclaim_state {
74 unsigned long reclaimed_slab;
75};
76
77#ifdef __KERNEL__
78
79struct address_space;
80struct sysinfo;
81struct writeback_control;
82struct zone;
83
84/*
85 * A swap extent maps a range of a swapfile's PAGE_SIZE pages onto a range of
86 * disk blocks. A list of swap extents maps the entire swapfile. (Where the
87 * term `swapfile' refers to either a blockdevice or an IS_REG file. Apart
88 * from setup, they're handled identically.
89 *
90 * We always assume that blocks are of size PAGE_SIZE.
91 */
92struct swap_extent {
93 struct list_head list;
94 pgoff_t start_page;
95 pgoff_t nr_pages;
96 sector_t start_block;
97};
98
99/*
100 * Max bad pages in the new format..
101 */
102#define __swapoffset(x) ((unsigned long)&((union swap_header *)0)->x)
103#define MAX_SWAP_BADPAGES \
104 ((__swapoffset(magic.magic) - __swapoffset(info.badpages)) / sizeof(int))
105
106enum {
107 SWP_USED = (1 << 0), /* is slot in swap_info[] used? */
108 SWP_WRITEOK = (1 << 1), /* ok to write to this swap? */
109 SWP_ACTIVE = (SWP_USED | SWP_WRITEOK),
Hugh Dickins52b7efdb2005-09-03 15:54:39 -0700110 /* add others here before... */
111 SWP_SCANNING = (1 << 8), /* refcount in scan_swap_map */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700112};
113
114#define SWAP_CLUSTER_MAX 32
115
116#define SWAP_MAP_MAX 0x7fff
117#define SWAP_MAP_BAD 0x8000
118
119/*
120 * The in-memory structure used to track swap areas.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700121 */
122struct swap_info_struct {
123 unsigned int flags;
Hugh Dickins5d337b92005-09-03 15:54:41 -0700124 int prio; /* swap priority */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700125 struct file *swap_file;
126 struct block_device *bdev;
127 struct list_head extent_list;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700128 struct swap_extent *curr_swap_extent;
129 unsigned old_block_size;
130 unsigned short * swap_map;
131 unsigned int lowest_bit;
132 unsigned int highest_bit;
133 unsigned int cluster_next;
134 unsigned int cluster_nr;
Hugh Dickins6eb396d2005-09-03 15:54:35 -0700135 unsigned int pages;
136 unsigned int max;
137 unsigned int inuse_pages;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700138 int next; /* next entry on swap list */
139};
140
141struct swap_list_t {
142 int head; /* head of priority-ordered swapfile list */
143 int next; /* swapfile to be used next */
144};
145
146/* Swap 50% full? Release swapcache more aggressively.. */
147#define vm_swap_full() (nr_swap_pages*2 < total_swap_pages)
148
149/* linux/mm/oom_kill.c */
Christoph Lameter9b0f8b02006-02-20 18:27:52 -0800150extern void out_of_memory(struct zonelist *zonelist, gfp_t gfp_mask, int order);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700151
152/* linux/mm/memory.c */
153extern void swapin_readahead(swp_entry_t, unsigned long, struct vm_area_struct *);
154
155/* linux/mm/page_alloc.c */
156extern unsigned long totalram_pages;
157extern unsigned long totalhigh_pages;
158extern long nr_swap_pages;
159extern unsigned int nr_free_pages(void);
160extern unsigned int nr_free_pages_pgdat(pg_data_t *pgdat);
161extern unsigned int nr_free_buffer_pages(void);
162extern unsigned int nr_free_pagecache_pages(void);
163
164/* linux/mm/swap.c */
165extern void FASTCALL(lru_cache_add(struct page *));
166extern void FASTCALL(lru_cache_add_active(struct page *));
167extern void FASTCALL(activate_page(struct page *));
168extern void FASTCALL(mark_page_accessed(struct page *));
169extern void lru_add_drain(void);
Nick Piggin053837f2006-01-18 17:42:27 -0800170extern int lru_add_drain_all(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700171extern int rotate_reclaimable_page(struct page *page);
172extern void swap_setup(void);
173
174/* linux/mm/vmscan.c */
Andrew Morton69e05942006-03-22 00:08:19 -0800175extern unsigned long try_to_free_pages(struct zone **, gfp_t);
176extern unsigned long shrink_all_memory(unsigned long nr_pages);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700177extern int vm_swappiness;
Christoph Lameterb20a3502006-03-22 00:09:12 -0800178extern int remove_mapping(struct address_space *mapping, struct page *page);
179
180/* possible outcome of pageout() */
181typedef enum {
182 /* failed to write page out, page is locked */
183 PAGE_KEEP,
184 /* move page to the active list, page is locked */
185 PAGE_ACTIVATE,
186 /* page has been sent to the disk successfully, page is unlocked */
187 PAGE_SUCCESS,
188 /* page is clean and locked */
189 PAGE_CLEAN,
190} pageout_t;
191
192extern pageout_t pageout(struct page *page, struct address_space *mapping);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700193
Christoph Lameter9eeff232006-01-18 17:42:31 -0800194#ifdef CONFIG_NUMA
195extern int zone_reclaim_mode;
Christoph Lameter2a11ff02006-02-01 03:05:33 -0800196extern int zone_reclaim_interval;
Christoph Lameter9eeff232006-01-18 17:42:31 -0800197extern int zone_reclaim(struct zone *, gfp_t, unsigned int);
198#else
199#define zone_reclaim_mode 0
200static inline int zone_reclaim(struct zone *z, gfp_t mask, unsigned int order)
201{
202 return 0;
203}
204#endif
205
Linus Torvalds1da177e2005-04-16 15:20:36 -0700206#ifdef CONFIG_MMU
207/* linux/mm/shmem.c */
208extern int shmem_unuse(swp_entry_t entry, struct page *page);
209#endif /* CONFIG_MMU */
210
211extern void swap_unplug_io_fn(struct backing_dev_info *, struct page *);
212
213#ifdef CONFIG_SWAP
214/* linux/mm/page_io.c */
215extern int swap_readpage(struct file *, struct page *);
216extern int swap_writepage(struct page *page, struct writeback_control *wbc);
217extern int rw_swap_page_sync(int, swp_entry_t, struct page *);
218
219/* linux/mm/swap_state.c */
220extern struct address_space swapper_space;
221#define total_swapcache_pages swapper_space.nrpages
222extern void show_swap_cache_info(void);
Christoph Lameter1480a542006-01-08 01:00:53 -0800223extern int add_to_swap(struct page *, gfp_t);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700224extern void __delete_from_swap_cache(struct page *);
225extern void delete_from_swap_cache(struct page *);
226extern int move_to_swap_cache(struct page *, swp_entry_t);
227extern int move_from_swap_cache(struct page *, unsigned long,
228 struct address_space *);
229extern void free_page_and_swap_cache(struct page *);
230extern void free_pages_and_swap_cache(struct page **, int);
231extern struct page * lookup_swap_cache(swp_entry_t);
232extern struct page * read_swap_cache_async(swp_entry_t, struct vm_area_struct *vma,
233 unsigned long addr);
234/* linux/mm/swapfile.c */
235extern long total_swap_pages;
236extern unsigned int nr_swapfiles;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700237extern void si_swapinfo(struct sysinfo *);
238extern swp_entry_t get_swap_page(void);
Rafael J. Wysockif577eb32006-03-23 02:59:59 -0800239extern swp_entry_t get_swap_page_of_type(int);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700240extern int swap_duplicate(swp_entry_t);
241extern int valid_swaphandles(swp_entry_t, unsigned long *);
242extern void swap_free(swp_entry_t);
243extern void free_swap_and_cache(swp_entry_t);
Rafael J. Wysockif577eb32006-03-23 02:59:59 -0800244extern int swap_type_of(dev_t);
245extern unsigned int count_swap_pages(int, int);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700246extern sector_t map_swap_page(struct swap_info_struct *, pgoff_t);
247extern struct swap_info_struct *get_swap_info_struct(unsigned);
248extern int can_share_swap_page(struct page *);
249extern int remove_exclusive_swap_page(struct page *);
250struct backing_dev_info;
251
Hugh Dickins5d337b92005-09-03 15:54:41 -0700252extern spinlock_t swap_lock;
Christoph Lametera3351e52006-02-01 03:05:39 -0800253extern int remove_vma_swap(struct vm_area_struct *vma, struct page *page);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700254
255/* linux/mm/thrash.c */
256extern struct mm_struct * swap_token_mm;
257extern unsigned long swap_token_default_timeout;
258extern void grab_swap_token(void);
259extern void __put_swap_token(struct mm_struct *);
260
261static inline int has_swap_token(struct mm_struct *mm)
262{
263 return (mm == swap_token_mm);
264}
265
266static inline void put_swap_token(struct mm_struct *mm)
267{
268 if (has_swap_token(mm))
269 __put_swap_token(mm);
270}
271
Rik van Rielf7b7fd82005-11-28 13:44:07 -0800272static inline void disable_swap_token(void)
273{
274 put_swap_token(swap_token_mm);
275}
276
Linus Torvalds1da177e2005-04-16 15:20:36 -0700277#else /* CONFIG_SWAP */
278
279#define total_swap_pages 0
280#define total_swapcache_pages 0UL
281
282#define si_swapinfo(val) \
283 do { (val)->freeswap = (val)->totalswap = 0; } while (0)
Olaf Hering9ae5b3c2005-08-07 09:42:24 -0700284/* only sparc can not include linux/pagemap.h in this file
285 * so leave page_cache_release and release_pages undeclared... */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700286#define free_page_and_swap_cache(page) \
287 page_cache_release(page)
288#define free_pages_and_swap_cache(pages, nr) \
289 release_pages((pages), (nr), 0);
290
291#define show_swap_cache_info() /*NOTHING*/
292#define free_swap_and_cache(swp) /*NOTHING*/
293#define swap_duplicate(swp) /*NOTHING*/
294#define swap_free(swp) /*NOTHING*/
295#define read_swap_cache_async(swp,vma,addr) NULL
296#define lookup_swap_cache(swp) NULL
297#define valid_swaphandles(swp, off) 0
298#define can_share_swap_page(p) 0
299#define move_to_swap_cache(p, swp) 1
300#define move_from_swap_cache(p, i, m) 1
301#define __delete_from_swap_cache(p) /*NOTHING*/
302#define delete_from_swap_cache(p) /*NOTHING*/
303#define swap_token_default_timeout 0
304
305static inline int remove_exclusive_swap_page(struct page *p)
306{
307 return 0;
308}
309
310static inline swp_entry_t get_swap_page(void)
311{
312 swp_entry_t entry;
313 entry.val = 0;
314 return entry;
315}
316
317/* linux/mm/thrash.c */
318#define put_swap_token(x) do { } while(0)
319#define grab_swap_token() do { } while(0)
320#define has_swap_token(x) 0
Rik van Rielf7b7fd82005-11-28 13:44:07 -0800321#define disable_swap_token() do { } while(0)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700322
323#endif /* CONFIG_SWAP */
324#endif /* __KERNEL__*/
325#endif /* _LINUX_SWAP_H */