usr/src/cmd/ndmpd/tlm/tlm_hardlink.c

   1 /*
   2  * Copyright 2008 Sun Microsystems, Inc.  All rights reserved.
   3  * Use is subject to license terms.
   4  */
   5
   6 /*
   7  * BSD 3 Clause License
   8  *
   9  * Copyright (c) 2007, The Storage Networking Industry Association.
  10  *
  11  * Redistribution and use in source and binary forms, with or without
  12  * modification, are permitted provided that the following conditions
  13  * are met:
  14  *      - Redistributions of source code must retain the above copyright
  15  *        notice, this list of conditions and the following disclaimer.
  16  *
  17  *      - Redistributions in binary form must reproduce the above copyright
  18  *        notice, this list of conditions and the following disclaimer in
  19  *        the documentation and/or other materials provided with the
  20  *        distribution.
  21  *
  22  *      - Neither the name of The Storage Networking Industry Association (SNIA)
  23  *        nor the names of its contributors may be used to endorse or promote
  24  *        products derived from this software without specific prior written
  25  *        permission.
  26  *
  27  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  28  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  29  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  30  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
  31  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  32  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  33  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  34  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  35  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  36  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  37  * POSSIBILITY OF SUCH DAMAGE.
  38  */
  39 #include <stdlib.h>
  40 #include <stdio.h>
  41 #include <string.h>
  42 #include <sys/queue.h>
  43 #include <sys/syslog.h>
  44 #include "tlm.h"
  45 #include "tlm_proto.h"
  46
  47 #define HL_DBG_INIT             0x0001
  48 #define HL_DBG_CLEANUP  0x0002
  49 #define HL_DBG_GET      0x0004
  50 #define HL_DBG_ADD      0x0008
  51
  52 static int hardlink_q_dbg = -1;
  53
  54
  55 struct hardlink_q *
  56 hardlink_q_init()
  57 {
  58         struct hardlink_q *qhead;
  59
  60         qhead = (struct hardlink_q *)malloc(sizeof (struct hardlink_q));
  61         if (qhead) {
  62                 SLIST_INIT(qhead);
  63         }
  64
  65         if (hardlink_q_dbg & HL_DBG_INIT)
  66                 NDMP_LOG(LOG_DEBUG, "qhead = %p", qhead);
  67
  68         return (qhead);
  69 }
  70
  71 void
  72 hardlink_q_cleanup(struct hardlink_q *hl_q)
  73 {
  74         struct hardlink_node *hl;
  75
  76         if (hardlink_q_dbg & HL_DBG_CLEANUP)
  77                 NDMP_LOG(LOG_DEBUG, "(1): qhead = %p", hl_q);
  78
  79         if (!hl_q)
  80                 return;
  81
  82         while (!SLIST_EMPTY(hl_q)) {
  83                 hl = SLIST_FIRST(hl_q);
  84
  85                 if (hardlink_q_dbg & HL_DBG_CLEANUP)
  86                         NDMP_LOG(LOG_DEBUG, "(2): remove node, inode = %lu",
  87                             hl->inode);
  88
  89                 SLIST_REMOVE_HEAD(hl_q, next_hardlink);
  90
  91                 /* remove the temporary file */
  92                 if (hl->is_tmp) {
  93                         if (hl->path) {
  94                                 NDMP_LOG(LOG_DEBUG, "(3): remove temp file %s",
  95                                     hl->path);
  96                                 if (remove(hl->path)) {
  97                                         NDMP_LOG(LOG_DEBUG,
  98                                             "error removing temp file");
  99                                 }
 100                         } else {
 101                                 NDMP_LOG(LOG_DEBUG, "no link name, inode = %lu",
 102                                     hl->inode);
 103                         }
 104                 }
 105
 106                 free(hl->path);
 107                 free(hl);
 108         }
 109
 110         free(hl_q);
 111 }
 112
 113 /*
 114  * Return 0 if a list node has the same inode, and initialize offset and path
 115  * with the information in the list node.
 116  * Return -1 if no matching node is found.
 117  */
 118 int
 119 hardlink_q_get(struct hardlink_q *hl_q, unsigned long inode,
 120     unsigned long long *offset, char **path)
 121 {
 122         struct hardlink_node *hl;
 123
 124         if (hardlink_q_dbg & HL_DBG_GET)
 125                 NDMP_LOG(LOG_DEBUG, "(1): qhead = %p, inode = %lu",
 126                     hl_q, inode);
 127
 128         if (!hl_q)
 129                 return (-1);
 130
 131         SLIST_FOREACH(hl, hl_q, next_hardlink) {
 132                 if (hardlink_q_dbg & HL_DBG_GET)
 133                         NDMP_LOG(LOG_DEBUG, "(2): checking, inode = %lu",
 134                             hl->inode);
 135
 136                 if (hl->inode != inode)
 137                         continue;
 138
 139                 if (offset)
 140                         *offset = hl->offset;
 141
 142                 if (path)
 143                         *path = hl->path;
 144
 145                 return (0);
 146         }
 147
 148         return (-1);
 149 }
 150
 151 /*
 152  * Add a node to hardlink_q.  Reject a duplicated entry.
 153  *
 154  * Return 0 if successful, and -1 if failed.
 155  */
 156 int
 157 hardlink_q_add(struct hardlink_q *hl_q, unsigned long inode,
 158     unsigned long long offset, char *path, int is_tmp_file)
 159 {
 160         struct hardlink_node *hl;
 161
 162         if (hardlink_q_dbg & HL_DBG_ADD)
 163                 NDMP_LOG(LOG_DEBUG,
 164                     "(1): qhead = %p, inode = %lu, path = %p (%s)",
 165                     hl_q, inode, path, path? path : "(--)");
 166
 167         if (!hl_q)
 168                 return (-1);
 169
 170         if (!hardlink_q_get(hl_q, inode, 0, 0)) {
 171                 NDMP_LOG(LOG_DEBUG, "hardlink (inode = %lu) exists in queue %p",
 172                     inode, hl_q);
 173                 return (-1);
 174         }
 175
 176         hl = (struct hardlink_node *)malloc(sizeof (struct hardlink_node));
 177         if (!hl)
 178                 return (-1);
 179
 180         hl->inode = inode;
 181         hl->offset = offset;
 182         hl->is_tmp = is_tmp_file;
 183         if (path)
 184                 hl->path = strdup(path);
 185         else
 186                 hl->path = NULL;
 187
 188         if (hardlink_q_dbg & HL_DBG_ADD)
 189                 NDMP_LOG(LOG_DEBUG,
 190                     "(2): added node, inode = %lu, path = %p (%s)",
 191                     hl->inode, hl->path, hl->path? hl->path : "(--)");
 192
 193         SLIST_INSERT_HEAD(hl_q, hl, next_hardlink);
 194
 195         return (0);
 196 }
 197
 198 int
 199 hardlink_q_dump(struct hardlink_q *hl_q)
 200 {
 201         struct hardlink_node *hl;
 202
 203         if (!hl_q)
 204                 return (0);
 205
 206         (void) printf("Dumping hardlink_q, head = %p:\n", (void *) hl_q);
 207
 208         SLIST_FOREACH(hl, hl_q, next_hardlink)
 209                 (void) printf(
 210                     "\t node = %lu, offset = %llu, path = %s, is_tmp = %d\n",
 211                     hl->inode, hl->offset, hl->path? hl->path : "--",
 212                     hl->is_tmp);
 213
 214         return (0);
 215 }