5fbb8099f56d8d460ea0bd3efafc8211fafb75f2Nobutomo Nakano * CDDL HEADER START
5fbb8099f56d8d460ea0bd3efafc8211fafb75f2Nobutomo Nakano * The contents of this file are subject to the terms of the
5fbb8099f56d8d460ea0bd3efafc8211fafb75f2Nobutomo Nakano * Common Development and Distribution License (the "License").
5fbb8099f56d8d460ea0bd3efafc8211fafb75f2Nobutomo Nakano * You may not use this file except in compliance with the License.
5fbb8099f56d8d460ea0bd3efafc8211fafb75f2Nobutomo Nakano * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
5fbb8099f56d8d460ea0bd3efafc8211fafb75f2Nobutomo Nakano * or http://www.opensolaris.org/os/licensing.
5fbb8099f56d8d460ea0bd3efafc8211fafb75f2Nobutomo Nakano * See the License for the specific language governing permissions
5fbb8099f56d8d460ea0bd3efafc8211fafb75f2Nobutomo Nakano * and limitations under the License.
5fbb8099f56d8d460ea0bd3efafc8211fafb75f2Nobutomo Nakano * When distributing Covered Code, include this CDDL HEADER in each
5fbb8099f56d8d460ea0bd3efafc8211fafb75f2Nobutomo Nakano * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
5fbb8099f56d8d460ea0bd3efafc8211fafb75f2Nobutomo Nakano * If applicable, add the following below this CDDL HEADER, with the
5fbb8099f56d8d460ea0bd3efafc8211fafb75f2Nobutomo Nakano * fields enclosed by brackets "[]" replaced with your own identifying
5fbb8099f56d8d460ea0bd3efafc8211fafb75f2Nobutomo Nakano * information: Portions Copyright [yyyy] [name of copyright owner]
5fbb8099f56d8d460ea0bd3efafc8211fafb75f2Nobutomo Nakano * CDDL HEADER END
5fbb8099f56d8d460ea0bd3efafc8211fafb75f2Nobutomo Nakano * Copyright 2009 Sun Microsystems, Inc. All rights reserved.
5fbb8099f56d8d460ea0bd3efafc8211fafb75f2Nobutomo Nakano * Use is subject to license terms.
5fbb8099f56d8d460ea0bd3efafc8211fafb75f2Nobutomo Nakano/* Copyright (c) 1983, 1984, 1985, 1986, 1987, 1988, 1989 AT&T */
5fbb8099f56d8d460ea0bd3efafc8211fafb75f2Nobutomo Nakano/* All Rights Reserved */
5fbb8099f56d8d460ea0bd3efafc8211fafb75f2Nobutomo Nakano * Portions of this source code were derived from Berkeley 4.3 BSD
5fbb8099f56d8d460ea0bd3efafc8211fafb75f2Nobutomo Nakano * under license from the Regents of the University of California.
5fbb8099f56d8d460ea0bd3efafc8211fafb75f2Nobutomo Nakano * Allocation wrappers. Used to centralize error handling for
5fbb8099f56d8d460ea0bd3efafc8211fafb75f2Nobutomo Nakano * failed allocations.
5fbb8099f56d8d460ea0bd3efafc8211fafb75f2Nobutomo Nakano * Note: unlike the other e_*lloc functions, e_realloc does not zero out the
5fbb8099f56d8d460ea0bd3efafc8211fafb75f2Nobutomo Nakano * additional memory it returns. Ensure that you do not trust its contents
5fbb8099f56d8d460ea0bd3efafc8211fafb75f2Nobutomo Nakano * when you call it.
5fbb8099f56d8d460ea0bd3efafc8211fafb75f2Nobutomo Nakanoe_realloc(int flag, void *old, size_t newsize)
5fbb8099f56d8d460ea0bd3efafc8211fafb75f2Nobutomo Nakano * Simple printf() which only support "%s" conversion.
5fbb8099f56d8d460ea0bd3efafc8211fafb75f2Nobutomo Nakano * We need secure version of printf since format string can be supplied
5fbb8099f56d8d460ea0bd3efafc8211fafb75f2Nobutomo Nakano * from gettext().
5fbb8099f56d8d460ea0bd3efafc8211fafb75f2Nobutomo Nakano const char *s = fmt;
5fbb8099f56d8d460ea0bd3efafc8211fafb75f2Nobutomo Nakano while (*s != '\0') {
5fbb8099f56d8d460ea0bd3efafc8211fafb75f2Nobutomo Nakano if (*s != '%') {
5fbb8099f56d8d460ea0bd3efafc8211fafb75f2Nobutomo Nakano if (*s != 's') {
5fbb8099f56d8d460ea0bd3efafc8211fafb75f2Nobutomo Nakano * Step through a file discovering and recording pairs of data and hole
5fbb8099f56d8d460ea0bd3efafc8211fafb75f2Nobutomo Nakano * offsets. Returns a linked list of data/hole offset pairs of a file.
5fbb8099f56d8d460ea0bd3efafc8211fafb75f2Nobutomo Nakano * If there is no holes found, NULL is returned.
5fbb8099f56d8d460ea0bd3efafc8211fafb75f2Nobutomo Nakano * Note: According to lseek(2), only filesystems which support
5fbb8099f56d8d460ea0bd3efafc8211fafb75f2Nobutomo Nakano * fpathconf(_PC_MIN_HOLE_SIZE) support SEEK_HOLE. For filesystems
5fbb8099f56d8d460ea0bd3efafc8211fafb75f2Nobutomo Nakano * that do not supply information about holes, the file will be
5fbb8099f56d8d460ea0bd3efafc8211fafb75f2Nobutomo Nakano * represented as one entire data region.
5fbb8099f56d8d460ea0bd3efafc8211fafb75f2Nobutomo Nakanoget_holes_list(int fd, off_t filesz, size_t *countp)
5fbb8099f56d8d460ea0bd3efafc8211fafb75f2Nobutomo Nakano if (filesz == 0 || fpathconf(fd, _PC_MIN_HOLE_SIZE) < 0)
5fbb8099f56d8d460ea0bd3efafc8211fafb75f2Nobutomo Nakano if ((data = lseek(fd, hole, SEEK_DATA)) == -1) {
5fbb8099f56d8d460ea0bd3efafc8211fafb75f2Nobutomo Nakano /* no more data till the end of file */
5fbb8099f56d8d460ea0bd3efafc8211fafb75f2Nobutomo Nakano /* assume data starts from the * beginning */
5fbb8099f56d8d460ea0bd3efafc8211fafb75f2Nobutomo Nakano if ((hole = lseek(fd, data, SEEK_HOLE)) == -1) {
5fbb8099f56d8d460ea0bd3efafc8211fafb75f2Nobutomo Nakano /* assume that data ends at the end of file */
5fbb8099f56d8d460ea0bd3efafc8211fafb75f2Nobutomo Nakano /* no holes */
5fbb8099f56d8d460ea0bd3efafc8211fafb75f2Nobutomo Nakano hl = e_zalloc(E_EXIT, sizeof (holes_list_t));
5fbb8099f56d8d460ea0bd3efafc8211fafb75f2Nobutomo Nakano /* set data and hole */
5fbb8099f56d8d460ea0bd3efafc8211fafb75f2Nobutomo Nakano * reset to the beginning, otherwise subsequent read calls would
5fbb8099f56d8d460ea0bd3efafc8211fafb75f2Nobutomo Nakano * Calculate the real data size in the sparse file.
5fbb8099f56d8d460ea0bd3efafc8211fafb75f2Nobutomo Nakano for (hl = hlh; hl != NULL; hl = hl->hl_next) {
5fbb8099f56d8d460ea0bd3efafc8211fafb75f2Nobutomo Nakano * Convert val to digit string and put it in str. The next address
5fbb8099f56d8d460ea0bd3efafc8211fafb75f2Nobutomo Nakano * of the last digit is returned.
5fbb8099f56d8d460ea0bd3efafc8211fafb75f2Nobutomo Nakano digp = ulltostr((u_longlong_t)val, &dbuf[ULL_MAX_SIZE]);
5fbb8099f56d8d460ea0bd3efafc8211fafb75f2Nobutomo Nakano * Put data/hole offset pair into string in the following
5fbb8099f56d8d460ea0bd3efafc8211fafb75f2Nobutomo Nakano * <data> <sp> <hole> <sp>
5fbb8099f56d8d460ea0bd3efafc8211fafb75f2Nobutomo Nakanostore_sparse_string(holes_list_t *hlh, char *str, size_t *szp)
5fbb8099f56d8d460ea0bd3efafc8211fafb75f2Nobutomo Nakano for (hl = hlh; hl != NULL; hl = hl->hl_next) {
5fbb8099f56d8d460ea0bd3efafc8211fafb75f2Nobutomo Nakano * Convert decimal str into unsigned long long value. The end pointer
5fbb8099f56d8d460ea0bd3efafc8211fafb75f2Nobutomo Nakano * is returned.
5fbb8099f56d8d460ea0bd3efafc8211fafb75f2Nobutomo Nakanostatic const char *
5fbb8099f56d8d460ea0bd3efafc8211fafb75f2Nobutomo Nakano for (hl = hi->holes_list; hl != NULL; hl = nhl) {
5fbb8099f56d8d460ea0bd3efafc8211fafb75f2Nobutomo Nakano * When a hole is detected, non NULL holes_info pointer is returned.
5fbb8099f56d8d460ea0bd3efafc8211fafb75f2Nobutomo Nakano * If we are in copy-out mode, holes_list is converted to string (holesdata)
5fbb8099f56d8d460ea0bd3efafc8211fafb75f2Nobutomo Nakano * which will be prepended to file contents. The holesdata is a character
5fbb8099f56d8d460ea0bd3efafc8211fafb75f2Nobutomo Nakano * string and in the format of:
5fbb8099f56d8d460ea0bd3efafc8211fafb75f2Nobutomo Nakano * <data size(%10u)><SP><file size(%llu)><SP>
5fbb8099f56d8d460ea0bd3efafc8211fafb75f2Nobutomo Nakano * <SP><data off><SP><hole off><SP><data off><SP><hole off> ...
5fbb8099f56d8d460ea0bd3efafc8211fafb75f2Nobutomo Nakano * This string is parsed by parse_holesholes() in copy-in mode to restore
5fbb8099f56d8d460ea0bd3efafc8211fafb75f2Nobutomo Nakano * the sparse info.
5fbb8099f56d8d460ea0bd3efafc8211fafb75f2Nobutomo Nakanoget_holes_info(int fd, off_t filesz, boolean_t pass_mode)
5fbb8099f56d8d460ea0bd3efafc8211fafb75f2Nobutomo Nakano if ((hl = get_holes_list(fd, filesz, &ninfo)) == NULL)
5fbb8099f56d8d460ea0bd3efafc8211fafb75f2Nobutomo Nakano hi = e_zalloc(E_EXIT, sizeof (holes_info_t));
5fbb8099f56d8d460ea0bd3efafc8211fafb75f2Nobutomo Nakano MIN_HOLES_HDRSIZE + ninfo * (ULL_MAX_SIZE * 2));
5fbb8099f56d8d460ea0bd3efafc8211fafb75f2Nobutomo Nakano * Convert into string data, and place it to after
5fbb8099f56d8d460ea0bd3efafc8211fafb75f2Nobutomo Nakano * the first 2 fixed entries.
5fbb8099f56d8d460ea0bd3efafc8211fafb75f2Nobutomo Nakano store_sparse_string(hl, str + MIN_HOLES_HDRSIZE, &len);
5fbb8099f56d8d460ea0bd3efafc8211fafb75f2Nobutomo Nakano * Add the first two fixed entries. The size of holesdata
5fbb8099f56d8d460ea0bd3efafc8211fafb75f2Nobutomo Nakano * includes '\0' at the end of data
5fbb8099f56d8d460ea0bd3efafc8211fafb75f2Nobutomo Nakano (ulong_t)MIN_HOLES_HDRSIZE + len + 1, filesz);
5fbb8099f56d8d460ea0bd3efafc8211fafb75f2Nobutomo Nakano (void) memcpy(str, hstr, MIN_HOLES_HDRSIZE);
5fbb8099f56d8d460ea0bd3efafc8211fafb75f2Nobutomo Nakano /* calc real file size without holes */
5fbb8099f56d8d460ea0bd3efafc8211fafb75f2Nobutomo Nakano hi->holesdata_sz = MIN_HOLES_HDRSIZE + len + 1;
5fbb8099f56d8d460ea0bd3efafc8211fafb75f2Nobutomo Nakano * The holesdata information is in the following format:
5fbb8099f56d8d460ea0bd3efafc8211fafb75f2Nobutomo Nakano * <data size(%10u)><SP><file size(%llu)><SP>
5fbb8099f56d8d460ea0bd3efafc8211fafb75f2Nobutomo Nakano * <SP><data off><SP><hole off><SP><data off><SP><hole off> ...
5fbb8099f56d8d460ea0bd3efafc8211fafb75f2Nobutomo Nakano * read_holes_header() allocates holes_info_t, and read the first 2
5fbb8099f56d8d460ea0bd3efafc8211fafb75f2Nobutomo Nakano * entries (data size and file size). The rest of holesdata is
5fbb8099f56d8d460ea0bd3efafc8211fafb75f2Nobutomo Nakano * read by parse_holesdata().
5fbb8099f56d8d460ea0bd3efafc8211fafb75f2Nobutomo Nakanoread_holes_header(const char *str, off_t filesz)
5fbb8099f56d8d460ea0bd3efafc8211fafb75f2Nobutomo Nakano hi = e_zalloc(E_EXIT, sizeof (holes_info_t));
5fbb8099f56d8d460ea0bd3efafc8211fafb75f2Nobutomo Nakano /* read prepended holes data size */
5fbb8099f56d8d460ea0bd3efafc8211fafb75f2Nobutomo Nakano if ((str = get_ull_tok(str, &ull)) == NULL || *str != ' ') {
5fbb8099f56d8d460ea0bd3efafc8211fafb75f2Nobutomo Nakano /* read original(expanded) file size */
5fbb8099f56d8d460ea0bd3efafc8211fafb75f2Nobutomo Nakano /* sanity check */
5fbb8099f56d8d460ea0bd3efafc8211fafb75f2Nobutomo Nakanoparse_holesdata(holes_info_t *hi, const char *str)
5fbb8099f56d8d460ea0bd3efafc8211fafb75f2Nobutomo Nakano /* create hole list */
5fbb8099f56d8d460ea0bd3efafc8211fafb75f2Nobutomo Nakano hl = e_zalloc(E_EXIT, sizeof (holes_list_t));
5fbb8099f56d8d460ea0bd3efafc8211fafb75f2Nobutomo Nakano /* link list */
5fbb8099f56d8d460ea0bd3efafc8211fafb75f2Nobutomo Nakano /* read the string token for data */
5fbb8099f56d8d460ea0bd3efafc8211fafb75f2Nobutomo Nakano /* there must be single blank space in between */
5fbb8099f56d8d460ea0bd3efafc8211fafb75f2Nobutomo Nakano /* read the string token for hole */
5fbb8099f56d8d460ea0bd3efafc8211fafb75f2Nobutomo Nakano /* check to see if offset is in ascending order */
5fbb8099f56d8d460ea0bd3efafc8211fafb75f2Nobutomo Nakano for (hl = hi->holes_list; hl != NULL; hl = hl->hl_next) {
5fbb8099f56d8d460ea0bd3efafc8211fafb75f2Nobutomo Nakano /* data and hole can be equal */
5fbb8099f56d8d460ea0bd3efafc8211fafb75f2Nobutomo Nakano /* The last hole offset should match original file size */