Don't include linux/config.h from anywhere else in include/
[linux-2.6.git] / include / linux / swap.h
1 #ifndef _LINUX_SWAP_H
2 #define _LINUX_SWAP_H
3
4 #include <linux/spinlock.h>
5 #include <linux/linkage.h>
6 #include <linux/mmzone.h>
7 #include <linux/list.h>
8 #include <linux/sched.h>
9
10 #include <asm/atomic.h>
11 #include <asm/page.h>
12
13 #define SWAP_FLAG_PREFER        0x8000  /* set if swap priority specified */
14 #define SWAP_FLAG_PRIO_MASK     0x7fff
15 #define SWAP_FLAG_PRIO_SHIFT    0
16
17 static inline int current_is_kswapd(void)
18 {
19         return current->flags & PF_KSWAPD;
20 }
21
22 /*
23  * MAX_SWAPFILES defines the maximum number of swaptypes: things which can
24  * be swapped to.  The swap type and the offset into that swap type are
25  * encoded into pte's and into pgoff_t's in the swapcache.  Using five bits
26  * for the type means that the maximum number of swapcache pages is 27 bits
27  * on 32-bit-pgoff_t architectures.  And that assumes that the architecture packs
28  * the type/offset into the pte as 5/27 as well.
29  */
30 #define MAX_SWAPFILES_SHIFT     5
31 #define MAX_SWAPFILES           (1 << MAX_SWAPFILES_SHIFT)
32
33 /*
34  * Magic header for a swap area. The first part of the union is
35  * what the swap magic looks like for the old (limited to 128MB)
36  * swap area format, the second part of the union adds - in the
37  * old reserved area - some extra information. Note that the first
38  * kilobyte is reserved for boot loader or disk label stuff...
39  *
40  * Having the magic at the end of the PAGE_SIZE makes detecting swap
41  * areas somewhat tricky on machines that support multiple page sizes.
42  * For 2.5 we'll probably want to move the magic to just beyond the
43  * bootbits...
44  */
45 union swap_header {
46         struct {
47                 char reserved[PAGE_SIZE - 10];
48                 char magic[10];                 /* SWAP-SPACE or SWAPSPACE2 */
49         } magic;
50         struct {
51                 char         bootbits[1024];    /* Space for disklabel etc. */
52                 unsigned int version;
53                 unsigned int last_page;
54                 unsigned int nr_badpages;
55                 unsigned int padding[125];
56                 unsigned int badpages[1];
57         } info;
58 };
59
60  /* A swap entry has to fit into a "unsigned long", as
61   * the entry is hidden in the "index" field of the
62   * swapper address space.
63   */
64 typedef struct {
65         unsigned long val;
66 } swp_entry_t;
67
68 /*
69  * current->reclaim_state points to one of these when a task is running
70  * memory reclaim
71  */
72 struct reclaim_state {
73         unsigned long reclaimed_slab;
74 };
75
76 #ifdef __KERNEL__
77
78 struct address_space;
79 struct sysinfo;
80 struct writeback_control;
81 struct zone;
82
83 /*
84  * A swap extent maps a range of a swapfile's PAGE_SIZE pages onto a range of
85  * disk blocks.  A list of swap extents maps the entire swapfile.  (Where the
86  * term `swapfile' refers to either a blockdevice or an IS_REG file.  Apart
87  * from setup, they're handled identically.
88  *
89  * We always assume that blocks are of size PAGE_SIZE.
90  */
91 struct swap_extent {
92         struct list_head list;
93         pgoff_t start_page;
94         pgoff_t nr_pages;
95         sector_t start_block;
96 };
97
98 /*
99  * Max bad pages in the new format..
100  */
101 #define __swapoffset(x) ((unsigned long)&((union swap_header *)0)->x)
102 #define MAX_SWAP_BADPAGES \
103         ((__swapoffset(magic.magic) - __swapoffset(info.badpages)) / sizeof(int))
104
105 enum {
106         SWP_USED        = (1 << 0),     /* is slot in swap_info[] used? */
107         SWP_WRITEOK     = (1 << 1),     /* ok to write to this swap?    */
108         SWP_ACTIVE      = (SWP_USED | SWP_WRITEOK),
109                                         /* add others here before... */
110         SWP_SCANNING    = (1 << 8),     /* refcount in scan_swap_map */
111 };
112
113 #define SWAP_CLUSTER_MAX 32
114
115 #define SWAP_MAP_MAX    0x7fff
116 #define SWAP_MAP_BAD    0x8000
117
118 /*
119  * The in-memory structure used to track swap areas.
120  */
121 struct swap_info_struct {
122         unsigned int flags;
123         int prio;                       /* swap priority */
124         struct file *swap_file;
125         struct block_device *bdev;
126         struct list_head extent_list;
127         struct swap_extent *curr_swap_extent;
128         unsigned old_block_size;
129         unsigned short * swap_map;
130         unsigned int lowest_bit;
131         unsigned int highest_bit;
132         unsigned int cluster_next;
133         unsigned int cluster_nr;
134         unsigned int pages;
135         unsigned int max;
136         unsigned int inuse_pages;
137         int next;                       /* next entry on swap list */
138 };
139
140 struct swap_list_t {
141         int head;       /* head of priority-ordered swapfile list */
142         int next;       /* swapfile to be used next */
143 };
144
145 /* Swap 50% full? Release swapcache more aggressively.. */
146 #define vm_swap_full() (nr_swap_pages*2 < total_swap_pages)
147
148 /* linux/mm/oom_kill.c */
149 extern void out_of_memory(struct zonelist *zonelist, gfp_t gfp_mask, int order);
150
151 /* linux/mm/memory.c */
152 extern void swapin_readahead(swp_entry_t, unsigned long, struct vm_area_struct *);
153
154 /* linux/mm/page_alloc.c */
155 extern unsigned long totalram_pages;
156 extern unsigned long totalhigh_pages;
157 extern unsigned long totalreserve_pages;
158 extern long nr_swap_pages;
159 extern unsigned int nr_free_pages(void);
160 extern unsigned int nr_free_pages_pgdat(pg_data_t *pgdat);
161 extern unsigned int nr_free_buffer_pages(void);
162 extern unsigned int nr_free_pagecache_pages(void);
163
164 /* linux/mm/swap.c */
165 extern void FASTCALL(lru_cache_add(struct page *));
166 extern void FASTCALL(lru_cache_add_active(struct page *));
167 extern void FASTCALL(activate_page(struct page *));
168 extern void FASTCALL(mark_page_accessed(struct page *));
169 extern void lru_add_drain(void);
170 extern int lru_add_drain_all(void);
171 extern int rotate_reclaimable_page(struct page *page);
172 extern void swap_setup(void);
173
174 /* linux/mm/vmscan.c */
175 extern unsigned long try_to_free_pages(struct zone **, gfp_t);
176 extern unsigned long shrink_all_memory(unsigned long nr_pages);
177 extern int vm_swappiness;
178 extern int remove_mapping(struct address_space *mapping, struct page *page);
179
180 /* possible outcome of pageout() */
181 typedef 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
192 extern pageout_t pageout(struct page *page, struct address_space *mapping);
193
194 #ifdef CONFIG_NUMA
195 extern int zone_reclaim_mode;
196 extern int zone_reclaim_interval;
197 extern int zone_reclaim(struct zone *, gfp_t, unsigned int);
198 #else
199 #define zone_reclaim_mode 0
200 static inline int zone_reclaim(struct zone *z, gfp_t mask, unsigned int order)
201 {
202         return 0;
203 }
204 #endif
205
206 #ifdef CONFIG_MMU
207 /* linux/mm/shmem.c */
208 extern int shmem_unuse(swp_entry_t entry, struct page *page);
209 #endif /* CONFIG_MMU */
210
211 extern void swap_unplug_io_fn(struct backing_dev_info *, struct page *);
212
213 #ifdef CONFIG_SWAP
214 /* linux/mm/page_io.c */
215 extern int swap_readpage(struct file *, struct page *);
216 extern int swap_writepage(struct page *page, struct writeback_control *wbc);
217 extern int rw_swap_page_sync(int, swp_entry_t, struct page *);
218
219 /* linux/mm/swap_state.c */
220 extern struct address_space swapper_space;
221 #define total_swapcache_pages  swapper_space.nrpages
222 extern void show_swap_cache_info(void);
223 extern int add_to_swap(struct page *, gfp_t);
224 extern void __delete_from_swap_cache(struct page *);
225 extern void delete_from_swap_cache(struct page *);
226 extern int move_to_swap_cache(struct page *, swp_entry_t);
227 extern int move_from_swap_cache(struct page *, unsigned long,
228                 struct address_space *);
229 extern void free_page_and_swap_cache(struct page *);
230 extern void free_pages_and_swap_cache(struct page **, int);
231 extern struct page * lookup_swap_cache(swp_entry_t);
232 extern struct page * read_swap_cache_async(swp_entry_t, struct vm_area_struct *vma,
233                                            unsigned long addr);
234 /* linux/mm/swapfile.c */
235 extern long total_swap_pages;
236 extern unsigned int nr_swapfiles;
237 extern void si_swapinfo(struct sysinfo *);
238 extern swp_entry_t get_swap_page(void);
239 extern swp_entry_t get_swap_page_of_type(int);
240 extern int swap_duplicate(swp_entry_t);
241 extern int valid_swaphandles(swp_entry_t, unsigned long *);
242 extern void swap_free(swp_entry_t);
243 extern void free_swap_and_cache(swp_entry_t);
244 extern int swap_type_of(dev_t);
245 extern unsigned int count_swap_pages(int, int);
246 extern sector_t map_swap_page(struct swap_info_struct *, pgoff_t);
247 extern struct swap_info_struct *get_swap_info_struct(unsigned);
248 extern int can_share_swap_page(struct page *);
249 extern int remove_exclusive_swap_page(struct page *);
250 struct backing_dev_info;
251
252 extern spinlock_t swap_lock;
253 extern int remove_vma_swap(struct vm_area_struct *vma, struct page *page);
254
255 /* linux/mm/thrash.c */
256 extern struct mm_struct * swap_token_mm;
257 extern unsigned long swap_token_default_timeout;
258 extern void grab_swap_token(void);
259 extern void __put_swap_token(struct mm_struct *);
260
261 static inline int has_swap_token(struct mm_struct *mm)
262 {
263         return (mm == swap_token_mm);
264 }
265
266 static inline void put_swap_token(struct mm_struct *mm)
267 {
268         if (has_swap_token(mm))
269                 __put_swap_token(mm);
270 }
271
272 static inline void disable_swap_token(void)
273 {
274         put_swap_token(swap_token_mm);
275 }
276
277 #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)
284 /* only sparc can not include linux/pagemap.h in this file
285  * so leave page_cache_release and release_pages undeclared... */
286 #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
305 static inline int remove_exclusive_swap_page(struct page *p)
306 {
307         return 0;
308 }
309
310 static 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
321 #define disable_swap_token() do { } while(0)
322
323 #endif /* CONFIG_SWAP */
324 #endif /* __KERNEL__*/
325 #endif /* _LINUX_SWAP_H */