Annotation of src/sys/dev/dm/dm_target.c, revision 1.36

1.36    ! tkusumi     1: /*        $NetBSD: dm_target.c,v 1.35 2019/12/21 11:59:03 tkusumi Exp $      */
1.2       haad        2: 
                      3: /*
                      4:  * Copyright (c) 2008 The NetBSD Foundation, Inc.
                      5:  * All rights reserved.
                      6:  *
                      7:  * This code is derived from software contributed to The NetBSD Foundation
                      8:  * by Adam Hamsik.
                      9:  *
                     10:  * Redistribution and use in source and binary forms, with or without
                     11:  * modification, are permitted provided that the following conditions
                     12:  * are met:
                     13:  * 1. Redistributions of source code Must retain the above copyright
                     14:  *    notice, this list of conditions and the following disclaimer.
                     15:  * 2. Redistributions in binary form must reproduce the above copyright
                     16:  *    notice, this list of conditions and the following disclaimer in the
                     17:  *    documentation and/or other materials provided with the distribution.
                     18:  *
                     19:  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
                     20:  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
                     21:  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
                     22:  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
                     23:  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
                     24:  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
                     25:  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
                     26:  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
                     27:  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
                     28:  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
                     29:  * POSSIBILITY OF SUCH DAMAGE.
                     30:  */
1.20      christos   31: #include <sys/cdefs.h>
1.36    ! tkusumi    32: __KERNEL_RCSID(0, "$NetBSD: dm_target.c,v 1.35 2019/12/21 11:59:03 tkusumi Exp $");
1.2       haad       33: 
                     34: #include <sys/types.h>
                     35: #include <sys/param.h>
                     36: #include <sys/kmem.h>
1.7       haad       37: #include <sys/module.h>
                     38: 
1.2       haad       39: #include "netbsd-dm.h"
                     40: #include "dm.h"
                     41: 
1.12      haad       42: static dm_target_t *dm_target_lookup_name(const char *);
1.2       haad       43: 
                     44: TAILQ_HEAD(dm_target_head, dm_target);
                     45: 
                     46: static struct dm_target_head dm_target_list =
                     47: TAILQ_HEAD_INITIALIZER(dm_target_list);
                     48: 
1.21      tkusumi    49: static kmutex_t dm_target_mutex;
1.3       haad       50: 
                     51: /*
1.10      yamt       52:  * Called indirectly from dm_table_load_ioctl to mark target as used.
1.3       haad       53:  */
                     54: void
1.25      tkusumi    55: dm_target_busy(dm_target_t *target)
1.3       haad       56: {
1.32      tkusumi    57: 
1.7       haad       58:        atomic_inc_32(&target->ref_cnt);
1.3       haad       59: }
1.20      christos   60: 
1.7       haad       61: /*
                     62:  * Release reference counter on target.
                     63:  */
1.3       haad       64: void
1.25      tkusumi    65: dm_target_unbusy(dm_target_t *target)
1.3       haad       66: {
1.32      tkusumi    67: 
1.7       haad       68:        KASSERT(target->ref_cnt > 0);
                     69:        atomic_dec_32(&target->ref_cnt);
1.3       haad       70: }
1.20      christos   71: 
1.7       haad       72: /*
                     73:  * Try to autoload target module if it was not found in current
                     74:  * target list.
                     75:  */
                     76: dm_target_t *
                     77: dm_target_autoload(const char *dm_target_name)
                     78: {
1.8       haad       79:        char name[30];
1.34      tkusumi    80:        unsigned int gen;
1.7       haad       81:        dm_target_t *dmt;
                     82: 
1.8       haad       83:        snprintf(name, sizeof(name), "dm_target_%s", dm_target_name);
1.12      haad       84:        name[29] = '\0';
                     85: 
1.7       haad       86:        do {
                     87:                gen = module_gen;
1.12      haad       88: 
1.7       haad       89:                /* Try to autoload target module */
1.28      tkusumi    90:                module_autoload(name, MODULE_CLASS_MISC);
1.12      haad       91:        } while (gen != module_gen);
1.7       haad       92: 
                     93:        mutex_enter(&dm_target_mutex);
                     94:        dmt = dm_target_lookup_name(dm_target_name);
1.9       haad       95:        if (dmt != NULL)
                     96:                dm_target_busy(dmt);
1.7       haad       97:        mutex_exit(&dm_target_mutex);
1.12      haad       98: 
1.7       haad       99:        return dmt;
                    100: }
1.20      christos  101: 
1.7       haad      102: /*
                    103:  * Lookup for target in global target list.
                    104:  */
1.3       haad      105: dm_target_t *
                    106: dm_target_lookup(const char *dm_target_name)
                    107: {
                    108:        dm_target_t *dmt;
                    109: 
1.7       haad      110:        if (dm_target_name == NULL)
                    111:                return NULL;
                    112: 
1.3       haad      113:        mutex_enter(&dm_target_mutex);
                    114: 
1.7       haad      115:        dmt = dm_target_lookup_name(dm_target_name);
1.3       haad      116:        if (dmt != NULL)
                    117:                dm_target_busy(dmt);
1.12      haad      118: 
1.3       haad      119:        mutex_exit(&dm_target_mutex);
1.12      haad      120: 
                    121:        return dmt;
1.3       haad      122: }
1.20      christos  123: 
1.2       haad      124: /*
                    125:  * Search for name in TAIL and return apropriate pointer.
                    126:  */
1.12      haad      127: static dm_target_t *
1.2       haad      128: dm_target_lookup_name(const char *dm_target_name)
                    129: {
                    130:        dm_target_t *dm_target;
1.20      christos  131:        size_t dlen;
                    132:        size_t slen;
1.2       haad      133: 
1.3       haad      134:        slen = strlen(dm_target_name) + 1;
1.2       haad      135: 
1.3       haad      136:        TAILQ_FOREACH(dm_target, &dm_target_list, dm_target_next) {
                    137:                dlen = strlen(dm_target->name) + 1;
1.2       haad      138:                if (dlen != slen)
                    139:                        continue;
1.12      haad      140: 
1.7       haad      141:                if (strncmp(dm_target_name, dm_target->name, slen) == 0)
1.3       haad      142:                        return dm_target;
1.2       haad      143:        }
                    144: 
                    145:        return NULL;
                    146: }
1.20      christos  147: 
1.2       haad      148: /*
                    149:  * Insert new target struct into the TAIL.
                    150:  * dm_target
                    151:  *   contains name, version, function pointer to specifif target functions.
                    152:  */
                    153: int
1.25      tkusumi   154: dm_target_insert(dm_target_t *dm_target)
1.2       haad      155: {
                    156:        dm_target_t *dmt;
1.12      haad      157: 
1.18      ahoka     158:        /* Sanity check for any missing function */
1.27      tkusumi   159:        if (dm_target->init == NULL) {
                    160:                printf("%s missing init\n", dm_target->name);
                    161:                return EINVAL;
                    162:        }
1.29      tkusumi   163:        if (dm_target->table == NULL) {
                    164:                printf("%s missing table\n", dm_target->name);
1.27      tkusumi   165:                return EINVAL;
                    166:        }
                    167:        if (dm_target->strategy == NULL) {
                    168:                printf("%s missing strategy\n", dm_target->name);
                    169:                return EINVAL;
                    170:        }
                    171:        if (dm_target->destroy == NULL) {
                    172:                printf("%s missing destroy\n", dm_target->name);
                    173:                return EINVAL;
                    174:        }
                    175:        if (dm_target->upcall == NULL) {
                    176:                printf("%s missing upcall\n", dm_target->name);
                    177:                return EINVAL;
                    178:        }
1.18      ahoka     179: 
1.3       haad      180:        mutex_enter(&dm_target_mutex);
1.2       haad      181: 
                    182:        dmt = dm_target_lookup_name(dm_target->name);
1.3       haad      183:        if (dmt != NULL) {
                    184:                mutex_exit(&dm_target_mutex);
1.2       haad      185:                return EEXIST;
1.3       haad      186:        }
1.2       haad      187:        TAILQ_INSERT_TAIL(&dm_target_list, dm_target, dm_target_next);
1.3       haad      188: 
                    189:        mutex_exit(&dm_target_mutex);
1.12      haad      190: 
1.2       haad      191:        return 0;
                    192: }
                    193: 
                    194: /*
1.19      snj       195:  * Remove target from TAIL, target is selected with its name.
1.2       haad      196:  */
                    197: int
1.26      tkusumi   198: dm_target_rem(const char *dm_target_name)
1.2       haad      199: {
1.3       haad      200:        dm_target_t *dmt;
1.12      haad      201: 
1.2       haad      202:        KASSERT(dm_target_name != NULL);
1.3       haad      203: 
                    204:        mutex_enter(&dm_target_mutex);
1.12      haad      205: 
1.3       haad      206:        dmt = dm_target_lookup_name(dm_target_name);
                    207:        if (dmt == NULL) {
                    208:                mutex_exit(&dm_target_mutex);
1.2       haad      209:                return ENOENT;
1.3       haad      210:        }
                    211:        if (dmt->ref_cnt > 0) {
                    212:                mutex_exit(&dm_target_mutex);
                    213:                return EBUSY;
                    214:        }
1.22      tkusumi   215:        TAILQ_REMOVE(&dm_target_list, dmt, dm_target_next);
1.3       haad      216: 
                    217:        mutex_exit(&dm_target_mutex);
1.12      haad      218: 
1.28      tkusumi   219:        kmem_free(dmt, sizeof(dm_target_t));
1.2       haad      220: 
                    221:        return 0;
                    222: }
1.20      christos  223: 
1.2       haad      224: /*
                    225:  * Destroy all targets and remove them from queue.
                    226:  * This routine is called from dm_detach, before module
                    227:  * is unloaded.
                    228:  */
                    229: int
                    230: dm_target_destroy(void)
                    231: {
                    232:        dm_target_t *dm_target;
                    233: 
1.3       haad      234:        mutex_enter(&dm_target_mutex);
1.12      haad      235: 
1.24      tkusumi   236:        while ((dm_target = TAILQ_FIRST(&dm_target_list)) != NULL) {
                    237:                TAILQ_REMOVE(&dm_target_list, dm_target, dm_target_next);
1.28      tkusumi   238:                kmem_free(dm_target, sizeof(dm_target_t));
1.2       haad      239:        }
1.24      tkusumi   240:        KASSERT(TAILQ_EMPTY(&dm_target_list));
                    241: 
1.3       haad      242:        mutex_exit(&dm_target_mutex);
1.12      haad      243: 
1.4       haad      244:        mutex_destroy(&dm_target_mutex);
1.12      haad      245: 
1.2       haad      246:        return 0;
                    247: }
1.20      christos  248: 
1.2       haad      249: /*
                    250:  * Allocate new target entry.
                    251:  */
1.12      haad      252: dm_target_t *
1.2       haad      253: dm_target_alloc(const char *name)
                    254: {
1.23      tkusumi   255:        dm_target_t *dmt;
                    256: 
                    257:        dmt = kmem_zalloc(sizeof(dm_target_t), KM_SLEEP);
                    258:        if (dmt == NULL)
                    259:                return NULL;
                    260: 
                    261:        if (name)
                    262:                strlcpy(dmt->name, name, sizeof(dmt->name));
                    263: 
                    264:        return dmt;
1.2       haad      265: }
1.20      christos  266: 
1.2       haad      267: /*
                    268:  * Return prop_array of dm_target dictionaries.
                    269:  */
                    270: prop_array_t
                    271: dm_target_prop_list(void)
                    272: {
1.32      tkusumi   273:        prop_array_t target_array;
1.2       haad      274:        dm_target_t *dm_target;
                    275: 
                    276:        target_array = prop_array_create();
1.3       haad      277: 
                    278:        mutex_enter(&dm_target_mutex);
1.2       haad      279: 
1.12      haad      280:        TAILQ_FOREACH(dm_target, &dm_target_list, dm_target_next) {
1.32      tkusumi   281:                prop_array_t ver;
                    282:                prop_dictionary_t target_dict;
                    283:                int i;
                    284: 
1.12      haad      285:                target_dict = prop_dictionary_create();
1.2       haad      286:                ver = prop_array_create();
                    287:                prop_dictionary_set_cstring(target_dict, DM_TARGETS_NAME,
                    288:                    dm_target->name);
                    289: 
                    290:                for (i = 0; i < 3; i++)
                    291:                        prop_array_add_uint32(ver, dm_target->version[i]);
                    292: 
                    293:                prop_dictionary_set(target_dict, DM_TARGETS_VERSION, ver);
                    294:                prop_array_add(target_array, target_dict);
                    295: 
                    296:                prop_object_release(ver);
                    297:                prop_object_release(target_dict);
                    298:        }
                    299: 
1.3       haad      300:        mutex_exit(&dm_target_mutex);
1.12      haad      301: 
1.2       haad      302:        return target_array;
                    303: }
1.20      christos  304: 
1.32      tkusumi   305: /*
                    306:  * Initialize dm_target subsystem.
                    307:  */
1.2       haad      308: int
                    309: dm_target_init(void)
                    310: {
1.33      tkusumi   311:        dm_target_t *dmt;
1.2       haad      312: 
1.3       haad      313:        mutex_init(&dm_target_mutex, MUTEX_DEFAULT, IPL_NONE);
1.12      haad      314: 
1.2       haad      315:        dmt = dm_target_alloc("linear");
                    316:        dmt->version[0] = 1;
                    317:        dmt->version[1] = 0;
                    318:        dmt->version[2] = 2;
                    319:        dmt->init = &dm_target_linear_init;
1.29      tkusumi   320:        dmt->table = &dm_target_linear_table;
1.2       haad      321:        dmt->strategy = &dm_target_linear_strategy;
1.13      haad      322:        dmt->sync = &dm_target_linear_sync;
1.2       haad      323:        dmt->destroy = &dm_target_linear_destroy;
                    324:        dmt->upcall = &dm_target_linear_upcall;
1.15      mlelstv   325:        dmt->secsize = &dm_target_linear_secsize;
1.33      tkusumi   326:        if (dm_target_insert(dmt))
                    327:                printf("Failed to insert linear\n");
1.12      haad      328: 
1.33      tkusumi   329:        dmt = dm_target_alloc("striped");
                    330:        dmt->version[0] = 1;
                    331:        dmt->version[1] = 0;
                    332:        dmt->version[2] = 3;
                    333:        dmt->init = &dm_target_stripe_init;
1.36    ! tkusumi   334:        dmt->info = &dm_target_stripe_info;
1.33      tkusumi   335:        dmt->table = &dm_target_stripe_table;
                    336:        dmt->strategy = &dm_target_stripe_strategy;
                    337:        dmt->sync = &dm_target_stripe_sync;
                    338:        dmt->destroy = &dm_target_stripe_destroy;
                    339:        dmt->upcall = &dm_target_stripe_upcall;
                    340:        dmt->secsize = &dm_target_stripe_secsize;
                    341:        if (dm_target_insert(dmt))
                    342:                printf("Failed to insert striped\n");
1.12      haad      343: 
1.33      tkusumi   344:        dmt = dm_target_alloc("error");
                    345:        dmt->version[0] = 1;
                    346:        dmt->version[1] = 0;
                    347:        dmt->version[2] = 0;
                    348:        dmt->init = &dm_target_error_init;
                    349:        dmt->table = &dm_target_error_table;
                    350:        dmt->strategy = &dm_target_error_strategy;
                    351:        dmt->destroy = &dm_target_error_destroy;
                    352:        dmt->upcall = &dm_target_error_upcall;
                    353:        if (dm_target_insert(dmt))
                    354:                printf("Failed to insert error\n");
1.12      haad      355: 
1.33      tkusumi   356:        dmt = dm_target_alloc("zero");
                    357:        dmt->version[0] = 1;
                    358:        dmt->version[1] = 0;
                    359:        dmt->version[2] = 0;
                    360:        dmt->init = &dm_target_zero_init;
                    361:        dmt->table = &dm_target_zero_table;
                    362:        dmt->strategy = &dm_target_zero_strategy;
                    363:        dmt->destroy = &dm_target_zero_destroy;
                    364:        dmt->upcall = &dm_target_zero_upcall;
                    365:        if (dm_target_insert(dmt))
                    366:                printf("Failed to insert zero\n");
1.2       haad      367: 
1.33      tkusumi   368:        return 0;
1.2       haad      369: }

CVSweb <webmaster@jp.NetBSD.org>