2 * Copyright (C) 2010 Red Hat Inc.
4 * This program is free software; you can redistribute it and/or modify
5 * it under the terms of the GNU General Public License as published by
6 * the Free Software Foundation; either version 2 of the License, or
7 * (at your option) any later version.
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
14 * You should have received a copy of the GNU General Public License along
15 * with this program; if not, write to the Free Software Foundation, Inc.,
16 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
30 let with_mount_ro g src (f : unit -> 'a) : 'a =
31 Std.finally (fun () -> g#umount_all ()) (
33 (* Do the mount - could be OS or single volume. *)
35 | Volume dev -> g#mount_ro dev "/";
36 | OS { insp_mountpoints = mps } ->
37 (* Sort the mountpoint keys by length, shortest first. *)
38 let cmp (a,_) (b,_) = compare (String.length a) (String.length b) in
39 let mps = List.sort ~cmp mps in
40 (* Mount the filesystems. *)
41 List.iter (fun (mp, dev) -> g#mount_ro dev mp) mps
47 * https://bugzilla.redhat.com/show_bug.cgi?id=663407
48 * http://git.annexia.org/?p=libguestfs.git;a=commit;h=3a3836b933b80c4f9f2c767fda4f8b459f998db2
49 * http://www.tuxera.com/community/ntfs-3g-advanced/junction-points-and-symbolic-links/
50 * http://www.tuxera.com/community/ntfs-3g-advanced/extended-attributes/
51 * http://www.codeproject.com/KB/winsdk/junctionpoints.aspx
53 let get_ntfs_reparse_data g path =
54 let data = g#lgetxattr path "system.ntfs_reparse_data" in
56 bitmatch Bitstring.bitstring_of_string data with
57 (* IO_REPARSE_TAG_MOUNT_POINT *)
58 | { 0xa0000003_l : 32 : littleendian;
59 _ : 16 : littleendian; (* data length - ignore it *)
60 _ : 16 : littleendian; (* reserved *)
61 link_offset : 16 : littleendian;
62 link_len : 16 : littleendian;
63 display_offset : 16 : littleendian;
64 display_len : 16 : littleendian;
66 string, offset (8 * (link_offset + 0x10));
67 display : display_len * 8 :
68 string, offset (8 * (display_offset + 0x10)) } ->
69 (* These strings should always be valid UTF16LE, but the caller
70 * is prepared to catch any exception if this fails.
72 let link = windows_string_to_utf8 link in
73 let display = windows_string_to_utf8 display in
75 | { 0xa0000003_l : 32 : littleendian } ->
77 sprintf "%s: could not parse IO_REPARSE_TAG_MOUNT_POINT data" path
80 (* IO_REPARSE_TAG_SYMLINK *)
81 | { 0xa000000c_l : 32 : littleendian;
82 _ : 16 : littleendian; (* data length - ignore it *)
83 _ : 16 : littleendian; (* reserved *)
84 link_offset : 16 : littleendian;
85 link_len : 16 : littleendian;
86 display_offset : 16 : littleendian;
87 display_len : 16 : littleendian;
89 string, offset (8 * (link_offset + 0x14));
90 display : display_len * 8 :
91 string, offset (8 * (display_offset + 0x14)) } ->
92 let link = windows_string_to_utf8 link in
93 let display = windows_string_to_utf8 display in
95 | { 0xa000000c_l : 32 : littleendian } ->
97 sprintf "%s: could not parse IO_REPARSE_TAG_SYMLINK data" path
100 | { i : 32 : littleendian } ->
102 sprintf "%s: reparse data of type 0x%lx is not supported" path i
105 invalid_arg (sprintf "%s: reparse data is too short" path) in
109 (* Given a path which is located somewhere on a mountpoint, return the
110 * device name. This works by using g#mountpoints and then looking for
111 * the mount path with the longest match.
113 let get_mounted_device g path =
114 let mps = g#mountpoints () in
117 if String.starts_with path mp then dev, String.length mp else dev, 0
119 let cmp (_,n1) (_,n2) = compare n2 n1 in
120 let mps = List.sort ~cmp mps in
123 invalid_arg (sprintf "%s: not mounted" path)
125 invalid_arg (sprintf "%s: not found on any filesystem" path)
126 | (dev,_) :: _ -> dev
128 let get_filesystem_type g path =
129 g#vfs_type (get_mounted_device g path)
131 (* guestfs_lstatlist has a "hidden" limit of the protocol message size.
132 * Call this function, but split the list of names into chunks.
134 let rec lstatlist g dir = function
137 let len = Array.length names in
139 if len <= 1000 then names, [| |]
141 Array.sub names 0 1000,
142 Array.sub names 1000 (len - 1000)
144 let stats = g#lstatlist dir first in
145 Array.to_list stats @ lstatlist g dir rest
147 (* For each entry which is a symlink, read the destination of the
148 * symlink. This is non-trivial because on Windows we cannot use
149 * readlink but need to instead parse the reparse data from NTFS.
151 let readlinks g dir names stats =
152 (* Is the directory on an NTFS filesystem? *)
153 let vfs_type = get_filesystem_type g dir in
154 if vfs_type <> "ntfs" then (
155 (* Not NTFS, use the fast g#readlinklist method. *)
156 let rec loop g dir = function
159 let len = Array.length names in
161 if len <= 1000 then names, [| |]
163 Array.sub names 0 1000,
164 Array.sub names 1000 (len - 1000)
166 let links = g#readlinklist dir first in
167 Array.to_list links @ loop g dir rest
172 (* NTFS: look up each symlink individually. *)
174 for i = 0 to Array.length names - 1 do
175 let name = names.(i) in
176 let stat = stats.(i) in
178 if not (is_symlink stat.G.mode) then ""
180 let path = if dir = "/" then dir ^ name else dir ^ "/" ^ name in
182 let _, display = get_ntfs_reparse_data g path in
185 debug "get_ntfs_reparse_data: %s: failed: %s"
186 path (Printexc.to_string exn);