UBI: create ltree_entry slab on initialization
[linux-2.6.git] / drivers / mtd / ubi / ubi.h
1 /*
2  * Copyright (c) International Business Machines Corp., 2006
3  * Copyright (c) Nokia Corporation, 2006, 2007
4  *
5  * This program is free software; you can redistribute it and/or modify
6  * it under the terms of the GNU General Public License as published by
7  * the Free Software Foundation; either version 2 of the License, or
8  * (at your option) any later version.
9  *
10  * This program is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See
13  * the GNU General Public License for more details.
14  *
15  * You should have received a copy of the GNU General Public License
16  * along with this program; if not, write to the Free Software
17  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
18  *
19  * Author: Artem Bityutskiy (Битюцкий Артём)
20  */
21
22 #ifndef __UBI_UBI_H__
23 #define __UBI_UBI_H__
24
25 #include <linux/init.h>
26 #include <linux/types.h>
27 #include <linux/list.h>
28 #include <linux/rbtree.h>
29 #include <linux/sched.h>
30 #include <linux/wait.h>
31 #include <linux/mutex.h>
32 #include <linux/rwsem.h>
33 #include <linux/spinlock.h>
34 #include <linux/fs.h>
35 #include <linux/cdev.h>
36 #include <linux/device.h>
37 #include <linux/string.h>
38 #include <linux/vmalloc.h>
39 #include <linux/mtd/mtd.h>
40
41 #include <mtd/ubi-header.h>
42 #include <linux/mtd/ubi.h>
43
44 #include "scan.h"
45 #include "debug.h"
46
47 /* Maximum number of supported UBI devices */
48 #define UBI_MAX_DEVICES 32
49
50 /* UBI name used for character devices, sysfs, etc */
51 #define UBI_NAME_STR "ubi"
52
53 /* Normal UBI messages */
54 #define ubi_msg(fmt, ...) printk(KERN_NOTICE "UBI: " fmt "\n", ##__VA_ARGS__)
55 /* UBI warning messages */
56 #define ubi_warn(fmt, ...) printk(KERN_WARNING "UBI warning: %s: " fmt "\n", \
57                                   __FUNCTION__, ##__VA_ARGS__)
58 /* UBI error messages */
59 #define ubi_err(fmt, ...) printk(KERN_ERR "UBI error: %s: " fmt "\n", \
60                                  __FUNCTION__, ##__VA_ARGS__)
61
62 /* Lowest number PEBs reserved for bad PEB handling */
63 #define MIN_RESEVED_PEBS 2
64
65 /* Background thread name pattern */
66 #define UBI_BGT_NAME_PATTERN "ubi_bgt%dd"
67
68 /* This marker in the EBA table means that the LEB is um-mapped */
69 #define UBI_LEB_UNMAPPED -1
70
71 /*
72  * In case of errors, UBI tries to repeat the operation several times before
73  * returning error. The below constant defines how many times UBI re-tries.
74  */
75 #define UBI_IO_RETRIES 3
76
77 /*
78  * Error codes returned by the I/O unit.
79  *
80  * UBI_IO_PEB_EMPTY: the physical eraseblock is empty, i.e. it contains only
81  * 0xFF bytes
82  * UBI_IO_PEB_FREE: the physical eraseblock is free, i.e. it contains only a
83  * valid erase counter header, and the rest are %0xFF bytes
84  * UBI_IO_BAD_EC_HDR: the erase counter header is corrupted (bad magic or CRC)
85  * UBI_IO_BAD_VID_HDR: the volume identifier header is corrupted (bad magic or
86  * CRC)
87  * UBI_IO_BITFLIPS: bit-flips were detected and corrected
88  */
89 enum {
90         UBI_IO_PEB_EMPTY = 1,
91         UBI_IO_PEB_FREE,
92         UBI_IO_BAD_EC_HDR,
93         UBI_IO_BAD_VID_HDR,
94         UBI_IO_BITFLIPS
95 };
96
97 extern int ubi_devices_cnt;
98 extern struct ubi_device *ubi_devices[];
99
100 /**
101  * struct ubi_ltree_entry - an entry in the lock tree.
102  * @rb: links RB-tree nodes
103  * @vol_id: volume ID of the locked logical eraseblock
104  * @lnum: locked logical eraseblock number
105  * @users: how many tasks are using this logical eraseblock or wait for it
106  * @mutex: read/write mutex to implement read/write access serialization to
107  *         the (@vol_id, @lnum) logical eraseblock
108  *
109  * This data structure is used in the EBA unit to implement per-LEB locking.
110  * When a logical eraseblock is being locked - corresponding
111  * &struct ubi_ltree_entry object is inserted to the lock tree (@ubi->ltree).
112  * See EBA unit for details.
113  */
114 struct ubi_ltree_entry {
115         struct rb_node rb;
116         int vol_id;
117         int lnum;
118         int users;
119         struct rw_semaphore mutex;
120 };
121
122 struct ubi_volume_desc;
123
124 /**
125  * struct ubi_volume - UBI volume description data structure.
126  * @dev: device object to make use of the the Linux device model
127  * @cdev: character device object to create character device
128  * @ubi: reference to the UBI device description object
129  * @vol_id: volume ID
130  * @readers: number of users holding this volume in read-only mode
131  * @writers: number of users holding this volume in read-write mode
132  * @exclusive: whether somebody holds this volume in exclusive mode
133  * @removed: if the volume was removed
134  * @checked: if this static volume was checked
135  *
136  * @reserved_pebs: how many physical eraseblocks are reserved for this volume
137  * @vol_type: volume type (%UBI_DYNAMIC_VOLUME or %UBI_STATIC_VOLUME)
138  * @usable_leb_size: logical eraseblock size without padding
139  * @used_ebs: how many logical eraseblocks in this volume contain data
140  * @last_eb_bytes: how many bytes are stored in the last logical eraseblock
141  * @used_bytes: how many bytes of data this volume contains
142  * @upd_marker: non-zero if the update marker is set for this volume
143  * @corrupted: non-zero if the volume is corrupted (static volumes only)
144  * @alignment: volume alignment
145  * @data_pad: how many bytes are not used at the end of physical eraseblocks to
146  * satisfy the requested alignment
147  * @name_len: volume name length
148  * @name: volume name
149  *
150  * @updating: whether the volume is being updated
151  * @upd_ebs: how many eraseblocks are expected to be updated
152  * @upd_bytes: how many bytes are expected to be received
153  * @upd_received: how many update bytes were already received
154  * @upd_buf: update buffer which is used to collect update data
155  *
156  * @eba_tbl: EBA table of this volume (LEB->PEB mapping)
157  *
158  * @gluebi_desc: gluebi UBI volume descriptor
159  * @gluebi_refcount: reference count of the gluebi MTD device
160  * @gluebi_mtd: MTD device description object of the gluebi MTD device
161  *
162  * The @corrupted field indicates that the volume's contents is corrupted.
163  * Since UBI protects only static volumes, this field is not relevant to
164  * dynamic volumes - it is user's responsibility to assure their data
165  * integrity.
166  *
167  * The @upd_marker flag indicates that this volume is either being updated at
168  * the moment or is damaged because of an unclean reboot.
169  */
170 struct ubi_volume {
171         struct device dev;
172         struct cdev cdev;
173         struct ubi_device *ubi;
174         int vol_id;
175         int readers;
176         int writers;
177         int exclusive;
178         int removed;
179         int checked;
180
181         int reserved_pebs;
182         int vol_type;
183         int usable_leb_size;
184         int used_ebs;
185         int last_eb_bytes;
186         long long used_bytes;
187         int upd_marker;
188         int corrupted;
189         int alignment;
190         int data_pad;
191         int name_len;
192         char name[UBI_VOL_NAME_MAX+1];
193
194         int updating;
195         int upd_ebs;
196         long long upd_bytes;
197         long long upd_received;
198         void *upd_buf;
199
200         int *eba_tbl;
201
202 #ifdef CONFIG_MTD_UBI_GLUEBI
203         /* Gluebi-related stuff may be compiled out */
204         struct ubi_volume_desc *gluebi_desc;
205         int gluebi_refcount;
206         struct mtd_info gluebi_mtd;
207 #endif
208 };
209
210 /**
211  * struct ubi_volume_desc - descriptor of the UBI volume returned when it is
212  * opened.
213  * @vol: reference to the corresponding volume description object
214  * @mode: open mode (%UBI_READONLY, %UBI_READWRITE, or %UBI_EXCLUSIVE)
215  */
216 struct ubi_volume_desc {
217         struct ubi_volume *vol;
218         int mode;
219 };
220
221 struct ubi_wl_entry;
222
223 /**
224  * struct ubi_device - UBI device description structure
225  * @dev: class device object to use the the Linux device model
226  * @cdev: character device object to create character device
227  * @ubi_num: UBI device number
228  * @ubi_name: UBI device name
229  * @vol_count: number of volumes in this UBI device
230  * @volumes: volumes of this UBI device
231  * @volumes_lock: protects @volumes, @rsvd_pebs, @avail_pebs, beb_rsvd_pebs,
232  * @beb_rsvd_level, @bad_peb_count, @good_peb_count, @vol_count, @vol->readers,
233  * @vol->writers, @vol->exclusive, @vol->removed, @vol->mapping and
234  * @vol->eba_tbl.
235  *
236  * @rsvd_pebs: count of reserved physical eraseblocks
237  * @avail_pebs: count of available physical eraseblocks
238  * @beb_rsvd_pebs: how many physical eraseblocks are reserved for bad PEB
239  * handling
240  * @beb_rsvd_level: normal level of PEBs reserved for bad PEB handling
241  *
242  * @vtbl_slots: how many slots are available in the volume table
243  * @vtbl_size: size of the volume table in bytes
244  * @vtbl: in-RAM volume table copy
245  * @vtbl_mutex: protects on-flash volume table
246  *
247  * @max_ec: current highest erase counter value
248  * @mean_ec: current mean erase counter value
249  *
250  * @global_sqnum: global sequence number
251  * @ltree_lock: protects the lock tree and @global_sqnum
252  * @ltree: the lock tree
253  * @alc_mutex: serializes "atomic LEB change" operations
254  *
255  * @used: RB-tree of used physical eraseblocks
256  * @free: RB-tree of free physical eraseblocks
257  * @scrub: RB-tree of physical eraseblocks which need scrubbing
258  * @prot: protection trees
259  * @prot.pnum: protection tree indexed by physical eraseblock numbers
260  * @prot.aec: protection tree indexed by absolute erase counter value
261  * @wl_lock: protects the @used, @free, @prot, @lookuptbl, @abs_ec, @move_from,
262  * @move_to, @move_to_put @erase_pending, @wl_scheduled, and @works
263  * fields
264  * @wl_scheduled: non-zero if the wear-leveling was scheduled
265  * @lookuptbl: a table to quickly find a &struct ubi_wl_entry object for any
266  * physical eraseblock
267  * @abs_ec: absolute erase counter
268  * @move_from: physical eraseblock from where the data is being moved
269  * @move_to: physical eraseblock where the data is being moved to
270  * @move_from_put: if the "from" PEB was put
271  * @move_to_put: if the "to" PEB was put
272  * @works: list of pending works
273  * @works_count: count of pending works
274  * @bgt_thread: background thread description object
275  * @thread_enabled: if the background thread is enabled
276  * @bgt_name: background thread name
277  *
278  * @flash_size: underlying MTD device size (in bytes)
279  * @peb_count: count of physical eraseblocks on the MTD device
280  * @peb_size: physical eraseblock size
281  * @bad_peb_count: count of bad physical eraseblocks
282  * @good_peb_count: count of good physical eraseblocks
283  * @min_io_size: minimal input/output unit size of the underlying MTD device
284  * @hdrs_min_io_size: minimal I/O unit size used for VID and EC headers
285  * @ro_mode: if the UBI device is in read-only mode
286  * @leb_size: logical eraseblock size
287  * @leb_start: starting offset of logical eraseblocks within physical
288  * eraseblocks
289  * @ec_hdr_alsize: size of the EC header aligned to @hdrs_min_io_size
290  * @vid_hdr_alsize: size of the VID header aligned to @hdrs_min_io_size
291  * @vid_hdr_offset: starting offset of the volume identifier header (might be
292  * unaligned)
293  * @vid_hdr_aloffset: starting offset of the VID header aligned to
294  * @hdrs_min_io_size
295  * @vid_hdr_shift: contains @vid_hdr_offset - @vid_hdr_aloffset
296  * @bad_allowed: whether the MTD device admits of bad physical eraseblocks or
297  * not
298  * @mtd: MTD device descriptor
299  *
300  * @peb_buf1: a buffer of PEB size used for different purposes
301  * @peb_buf2: another buffer of PEB size used for different purposes
302  * @buf_mutex: proptects @peb_buf1 and @peb_buf2
303  * @dbg_peb_buf:  buffer of PEB size used for debugging
304  * @dbg_buf_mutex: proptects @dbg_peb_buf
305  */
306 struct ubi_device {
307         struct cdev cdev;
308         struct device dev;
309         int ubi_num;
310         char ubi_name[sizeof(UBI_NAME_STR)+5];
311         int vol_count;
312         struct ubi_volume *volumes[UBI_MAX_VOLUMES+UBI_INT_VOL_COUNT];
313         spinlock_t volumes_lock;
314
315         int rsvd_pebs;
316         int avail_pebs;
317         int beb_rsvd_pebs;
318         int beb_rsvd_level;
319
320         int vtbl_slots;
321         int vtbl_size;
322         struct ubi_vtbl_record *vtbl;
323         struct mutex vtbl_mutex;
324
325         int max_ec;
326         int mean_ec;
327
328         /* EBA unit's stuff */
329         unsigned long long global_sqnum;
330         spinlock_t ltree_lock;
331         struct rb_root ltree;
332         struct mutex alc_mutex;
333
334         /* Wear-leveling unit's stuff */
335         struct rb_root used;
336         struct rb_root free;
337         struct rb_root scrub;
338         struct {
339                 struct rb_root pnum;
340                 struct rb_root aec;
341         } prot;
342         spinlock_t wl_lock;
343         int wl_scheduled;
344         struct ubi_wl_entry **lookuptbl;
345         unsigned long long abs_ec;
346         struct ubi_wl_entry *move_from;
347         struct ubi_wl_entry *move_to;
348         int move_from_put;
349         int move_to_put;
350         struct list_head works;
351         int works_count;
352         struct task_struct *bgt_thread;
353         int thread_enabled;
354         char bgt_name[sizeof(UBI_BGT_NAME_PATTERN)+2];
355
356         /* I/O unit's stuff */
357         long long flash_size;
358         int peb_count;
359         int peb_size;
360         int bad_peb_count;
361         int good_peb_count;
362         int min_io_size;
363         int hdrs_min_io_size;
364         int ro_mode;
365         int leb_size;
366         int leb_start;
367         int ec_hdr_alsize;
368         int vid_hdr_alsize;
369         int vid_hdr_offset;
370         int vid_hdr_aloffset;
371         int vid_hdr_shift;
372         int bad_allowed;
373         struct mtd_info *mtd;
374
375         void *peb_buf1;
376         void *peb_buf2;
377         struct mutex buf_mutex;
378 #ifdef CONFIG_MTD_UBI_DEBUG
379         void *dbg_peb_buf;
380         struct mutex dbg_buf_mutex;
381 #endif
382 };
383
384 extern struct kmem_cache *ubi_ltree_slab;
385 extern struct file_operations ubi_cdev_operations;
386 extern struct file_operations ubi_vol_cdev_operations;
387 extern struct class *ubi_class;
388
389 /* vtbl.c */
390 int ubi_change_vtbl_record(struct ubi_device *ubi, int idx,
391                            struct ubi_vtbl_record *vtbl_rec);
392 int ubi_read_volume_table(struct ubi_device *ubi, struct ubi_scan_info *si);
393
394 /* vmt.c */
395 int ubi_create_volume(struct ubi_device *ubi, struct ubi_mkvol_req *req);
396 int ubi_remove_volume(struct ubi_volume_desc *desc);
397 int ubi_resize_volume(struct ubi_volume_desc *desc, int reserved_pebs);
398 int ubi_add_volume(struct ubi_device *ubi, int vol_id);
399 void ubi_free_volume(struct ubi_device *ubi, int vol_id);
400
401 /* upd.c */
402 int ubi_start_update(struct ubi_device *ubi, int vol_id, long long bytes);
403 int ubi_more_update_data(struct ubi_device *ubi, int vol_id,
404                          const void __user *buf, int count);
405
406 /* misc.c */
407 int ubi_calc_data_len(const struct ubi_device *ubi, const void *buf, int length);
408 int ubi_check_volume(struct ubi_device *ubi, int vol_id);
409 void ubi_calculate_reserved(struct ubi_device *ubi);
410
411 /* gluebi.c */
412 #ifdef CONFIG_MTD_UBI_GLUEBI
413 int ubi_create_gluebi(struct ubi_device *ubi, struct ubi_volume *vol);
414 int ubi_destroy_gluebi(struct ubi_volume *vol);
415 void ubi_gluebi_updated(struct ubi_volume *vol);
416 #else
417 #define ubi_create_gluebi(ubi, vol) 0
418 #define ubi_destroy_gluebi(vol) 0
419 #define ubi_gluebi_updated(vol)
420 #endif
421
422 /* eba.c */
423 int ubi_eba_unmap_leb(struct ubi_device *ubi, int vol_id, int lnum);
424 int ubi_eba_read_leb(struct ubi_device *ubi, int vol_id, int lnum, void *buf,
425                      int offset, int len, int check);
426 int ubi_eba_write_leb(struct ubi_device *ubi, int vol_id, int lnum,
427                       const void *buf, int offset, int len, int dtype);
428 int ubi_eba_write_leb_st(struct ubi_device *ubi, int vol_id, int lnum,
429                          const void *buf, int len, int dtype,
430                          int used_ebs);
431 int ubi_eba_atomic_leb_change(struct ubi_device *ubi, int vol_id, int lnum,
432                               const void *buf, int len, int dtype);
433 int ubi_eba_copy_leb(struct ubi_device *ubi, int from, int to,
434                      struct ubi_vid_hdr *vid_hdr);
435 int ubi_eba_init_scan(struct ubi_device *ubi, struct ubi_scan_info *si);
436 void ubi_eba_close(const struct ubi_device *ubi);
437
438 /* wl.c */
439 int ubi_wl_get_peb(struct ubi_device *ubi, int dtype);
440 int ubi_wl_put_peb(struct ubi_device *ubi, int pnum, int torture);
441 int ubi_wl_flush(struct ubi_device *ubi);
442 int ubi_wl_scrub_peb(struct ubi_device *ubi, int pnum);
443 int ubi_wl_init_scan(struct ubi_device *ubi, struct ubi_scan_info *si);
444 void ubi_wl_close(struct ubi_device *ubi);
445
446 /* io.c */
447 int ubi_io_read(const struct ubi_device *ubi, void *buf, int pnum, int offset,
448                 int len);
449 int ubi_io_write(struct ubi_device *ubi, const void *buf, int pnum, int offset,
450                  int len);
451 int ubi_io_sync_erase(struct ubi_device *ubi, int pnum, int torture);
452 int ubi_io_is_bad(const struct ubi_device *ubi, int pnum);
453 int ubi_io_mark_bad(const struct ubi_device *ubi, int pnum);
454 int ubi_io_read_ec_hdr(struct ubi_device *ubi, int pnum,
455                        struct ubi_ec_hdr *ec_hdr, int verbose);
456 int ubi_io_write_ec_hdr(struct ubi_device *ubi, int pnum,
457                         struct ubi_ec_hdr *ec_hdr);
458 int ubi_io_read_vid_hdr(struct ubi_device *ubi, int pnum,
459                         struct ubi_vid_hdr *vid_hdr, int verbose);
460 int ubi_io_write_vid_hdr(struct ubi_device *ubi, int pnum,
461                          struct ubi_vid_hdr *vid_hdr);
462
463 /*
464  * ubi_rb_for_each_entry - walk an RB-tree.
465  * @rb: a pointer to type 'struct rb_node' to to use as a loop counter
466  * @pos: a pointer to RB-tree entry type to use as a loop counter
467  * @root: RB-tree's root
468  * @member: the name of the 'struct rb_node' within the RB-tree entry
469  */
470 #define ubi_rb_for_each_entry(rb, pos, root, member)                         \
471         for (rb = rb_first(root),                                            \
472              pos = (rb ? container_of(rb, typeof(*pos), member) : NULL);     \
473              rb;                                                             \
474              rb = rb_next(rb), pos = container_of(rb, typeof(*pos), member))
475
476 /**
477  * ubi_zalloc_vid_hdr - allocate a volume identifier header object.
478  * @ubi: UBI device description object
479  * @gfp_flags: GFP flags to allocate with
480  *
481  * This function returns a pointer to the newly allocated and zero-filled
482  * volume identifier header object in case of success and %NULL in case of
483  * failure.
484  */
485 static inline struct ubi_vid_hdr *
486 ubi_zalloc_vid_hdr(const struct ubi_device *ubi, gfp_t gfp_flags)
487 {
488         void *vid_hdr;
489
490         vid_hdr = kzalloc(ubi->vid_hdr_alsize, gfp_flags);
491         if (!vid_hdr)
492                 return NULL;
493
494         /*
495          * VID headers may be stored at un-aligned flash offsets, so we shift
496          * the pointer.
497          */
498         return vid_hdr + ubi->vid_hdr_shift;
499 }
500
501 /**
502  * ubi_free_vid_hdr - free a volume identifier header object.
503  * @ubi: UBI device description object
504  * @vid_hdr: the object to free
505  */
506 static inline void ubi_free_vid_hdr(const struct ubi_device *ubi,
507                                     struct ubi_vid_hdr *vid_hdr)
508 {
509         void *p = vid_hdr;
510
511         if (!p)
512                 return;
513
514         kfree(p - ubi->vid_hdr_shift);
515 }
516
517 /*
518  * This function is equivalent to 'ubi_io_read()', but @offset is relative to
519  * the beginning of the logical eraseblock, not to the beginning of the
520  * physical eraseblock.
521  */
522 static inline int ubi_io_read_data(const struct ubi_device *ubi, void *buf,
523                                    int pnum, int offset, int len)
524 {
525         ubi_assert(offset >= 0);
526         return ubi_io_read(ubi, buf, pnum, offset + ubi->leb_start, len);
527 }
528
529 /*
530  * This function is equivalent to 'ubi_io_write()', but @offset is relative to
531  * the beginning of the logical eraseblock, not to the beginning of the
532  * physical eraseblock.
533  */
534 static inline int ubi_io_write_data(struct ubi_device *ubi, const void *buf,
535                                     int pnum, int offset, int len)
536 {
537         ubi_assert(offset >= 0);
538         return ubi_io_write(ubi, buf, pnum, offset + ubi->leb_start, len);
539 }
540
541 /**
542  * ubi_ro_mode - switch to read-only mode.
543  * @ubi: UBI device description object
544  */
545 static inline void ubi_ro_mode(struct ubi_device *ubi)
546 {
547         ubi->ro_mode = 1;
548         ubi_warn("switch to read-only mode");
549 }
550
551 /**
552  * vol_id2idx - get table index by volume ID.
553  * @ubi: UBI device description object
554  * @vol_id: volume ID
555  */
556 static inline int vol_id2idx(const struct ubi_device *ubi, int vol_id)
557 {
558         if (vol_id >= UBI_INTERNAL_VOL_START)
559                 return vol_id - UBI_INTERNAL_VOL_START + ubi->vtbl_slots;
560         else
561                 return vol_id;
562 }
563
564 /**
565  * idx2vol_id - get volume ID by table index.
566  * @ubi: UBI device description object
567  * @idx: table index
568  */
569 static inline int idx2vol_id(const struct ubi_device *ubi, int idx)
570 {
571         if (idx >= ubi->vtbl_slots)
572                 return idx - ubi->vtbl_slots + UBI_INTERNAL_VOL_START;
573         else
574                 return idx;
575 }
576
577 #endif /* !__UBI_UBI_H__ */