Clarify licensing for Debian.
[virt-df.git] / lib / diskimage_linux_swsuspend.ml
1 (* 'df' command for virtual domains.
2
3    (C) Copyright 2007 Richard W.M. Jones, Red Hat Inc.
4    http://libvirt.org/
5
6    This library is free software; you can redistribute it and/or
7    modify it under the terms of the GNU Lesser General Public
8    License as published by the Free Software Foundation; either
9    version 2 of the License, or (at your option) any later version,
10    with the OCaml linking exception described in ../COPYING.LIB.
11
12    This library is distributed in the hope that it will be useful,
13    but WITHOUT ANY WARRANTY; without even the implied warranty of
14    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
15    Lesser General Public License for more details.
16
17    You should have received a copy of the GNU Lesser General Public
18    License along with this library; if not, write to the Free Software
19    Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301  USA
20
21    Support for Linux software suspend partitions.
22 *)
23
24 open Diskimage_impl
25
26 open Int63.Operators
27
28 let id = "linux_swsuspend"
29 let blocksize = ~^4096                  (* XXX *)
30
31 let rec probe dev =
32   (* Load the "superblock" (ie. first 0x1000 bytes). *)
33   let bits = dev#read_bitstring ~^0 ~^0x1000 in
34
35   bitmatch bits with
36   | {
37       _ : 8*0x1000 - 10*8 : bitstring;
38       ("S1SUSPEND"|"S2SUSPEND") : 80 : string
39     } ->
40
41       let fs_dev = new blocksize_overlay blocksize dev in
42       {
43         fs_cb = callbacks ();
44         fs_dev = fs_dev;
45
46         fs_blocksize = blocksize;
47         fs_blocks_total = fs_dev#size /^ blocksize;
48
49         (* The remaining fields are ignored when fs_is_swap is true. *)
50         fs_is_swap = true;
51         fs_blocks_reserved = ~^0;
52         fs_blocks_avail = ~^0;
53         fs_blocks_used = ~^0;
54         fs_inodes_total = ~^0;
55         fs_inodes_reserved = ~^0;
56         fs_inodes_avail = ~^0;
57         fs_inodes_used = ~^0;
58       }
59
60   | { _ } ->
61       raise Not_found                   (* Not Linux software suspend. *)
62
63 (* Linux software suspend image is never free.
64  * Compare diskimage_linux_swap.ml
65  *)
66 and offset_is_free _ _ = false
67
68 and callbacks =
69   let i = ref 0 in
70   fun () -> {
71     fs_cb_uq = (incr i; !i);
72     fs_cb_name = id;
73     fs_cb_printable_name = "Linux s/w suspend";
74     fs_cb_offset_is_free = offset_is_free;
75   }
76
77 (* Register the plugin. *)
78 let () = register_plugin ~filesystem:probe id