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

1.29    ! tkusumi     1: /*        $NetBSD: dm_target.c,v 1.28 2019/12/14 10:49:30 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.29    ! tkusumi    32: __KERNEL_RCSID(0, "$NetBSD: dm_target.c,v 1.28 2019/12/14 10:49:30 tkusumi Exp $");
1.2       haad       33: 
                     34: #include <sys/types.h>
                     35: #include <sys/param.h>
                     36: 
                     37: #include <sys/kmem.h>
1.7       haad       38: #include <sys/module.h>
                     39: 
1.2       haad       40: 
                     41: #include "netbsd-dm.h"
                     42: #include "dm.h"
                     43: 
1.12      haad       44: static dm_target_t *dm_target_lookup_name(const char *);
1.2       haad       45: 
                     46: TAILQ_HEAD(dm_target_head, dm_target);
                     47: 
                     48: static struct dm_target_head dm_target_list =
                     49: TAILQ_HEAD_INITIALIZER(dm_target_list);
                     50: 
1.21      tkusumi    51: static kmutex_t dm_target_mutex;
1.3       haad       52: 
                     53: /*
1.10      yamt       54:  * Called indirectly from dm_table_load_ioctl to mark target as used.
1.3       haad       55:  */
                     56: void
1.25      tkusumi    57: dm_target_busy(dm_target_t *target)
1.3       haad       58: {
1.7       haad       59:        atomic_inc_32(&target->ref_cnt);
1.3       haad       60: }
1.20      christos   61: 
1.7       haad       62: /*
                     63:  * Release reference counter on target.
                     64:  */
1.3       haad       65: void
1.25      tkusumi    66: dm_target_unbusy(dm_target_t *target)
1.3       haad       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.7       haad       80:        u_int gen;
                     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->deps == NULL) {
                    172:                printf("%s missing deps\n", dm_target->name);
                    173:                return EINVAL;
                    174:        }
                    175:        if (dm_target->destroy == NULL) {
                    176:                printf("%s missing destroy\n", dm_target->name);
                    177:                return EINVAL;
                    178:        }
                    179:        if (dm_target->upcall == NULL) {
                    180:                printf("%s missing upcall\n", dm_target->name);
                    181:                return EINVAL;
                    182:        }
                    183:        if (dm_target->sync == NULL) {
                    184:                printf("%s missing sync\n", dm_target->name);
                    185:                return EINVAL;
                    186:        }
                    187:        if (dm_target->secsize == NULL) {
                    188:                printf("%s missing secsize\n", dm_target->name);
                    189:                return EINVAL;
                    190:        }
1.18      ahoka     191: 
1.3       haad      192:        mutex_enter(&dm_target_mutex);
1.2       haad      193: 
                    194:        dmt = dm_target_lookup_name(dm_target->name);
1.3       haad      195:        if (dmt != NULL) {
                    196:                mutex_exit(&dm_target_mutex);
1.2       haad      197:                return EEXIST;
1.3       haad      198:        }
1.2       haad      199:        TAILQ_INSERT_TAIL(&dm_target_list, dm_target, dm_target_next);
1.3       haad      200: 
                    201:        mutex_exit(&dm_target_mutex);
1.12      haad      202: 
1.2       haad      203:        return 0;
                    204: }
                    205: 
                    206: /*
1.19      snj       207:  * Remove target from TAIL, target is selected with its name.
1.2       haad      208:  */
                    209: int
1.26      tkusumi   210: dm_target_rem(const char *dm_target_name)
1.2       haad      211: {
1.3       haad      212:        dm_target_t *dmt;
1.12      haad      213: 
1.2       haad      214:        KASSERT(dm_target_name != NULL);
1.3       haad      215: 
                    216:        mutex_enter(&dm_target_mutex);
1.12      haad      217: 
1.3       haad      218:        dmt = dm_target_lookup_name(dm_target_name);
                    219:        if (dmt == NULL) {
                    220:                mutex_exit(&dm_target_mutex);
1.2       haad      221:                return ENOENT;
1.3       haad      222:        }
                    223:        if (dmt->ref_cnt > 0) {
                    224:                mutex_exit(&dm_target_mutex);
                    225:                return EBUSY;
                    226:        }
1.22      tkusumi   227:        TAILQ_REMOVE(&dm_target_list, dmt, dm_target_next);
1.3       haad      228: 
                    229:        mutex_exit(&dm_target_mutex);
1.12      haad      230: 
1.28      tkusumi   231:        kmem_free(dmt, sizeof(dm_target_t));
1.2       haad      232: 
                    233:        return 0;
                    234: }
1.20      christos  235: 
1.2       haad      236: /*
                    237:  * Destroy all targets and remove them from queue.
                    238:  * This routine is called from dm_detach, before module
                    239:  * is unloaded.
                    240:  */
                    241: int
                    242: dm_target_destroy(void)
                    243: {
                    244:        dm_target_t *dm_target;
                    245: 
1.3       haad      246:        mutex_enter(&dm_target_mutex);
1.12      haad      247: 
1.24      tkusumi   248:        while ((dm_target = TAILQ_FIRST(&dm_target_list)) != NULL) {
                    249:                TAILQ_REMOVE(&dm_target_list, dm_target, dm_target_next);
1.28      tkusumi   250:                kmem_free(dm_target, sizeof(dm_target_t));
1.2       haad      251:        }
1.24      tkusumi   252:        KASSERT(TAILQ_EMPTY(&dm_target_list));
                    253: 
1.3       haad      254:        mutex_exit(&dm_target_mutex);
1.12      haad      255: 
1.4       haad      256:        mutex_destroy(&dm_target_mutex);
1.12      haad      257: 
1.2       haad      258:        return 0;
                    259: }
1.20      christos  260: 
1.2       haad      261: /*
                    262:  * Allocate new target entry.
                    263:  */
1.12      haad      264: dm_target_t *
1.2       haad      265: dm_target_alloc(const char *name)
                    266: {
1.23      tkusumi   267:        dm_target_t *dmt;
                    268: 
                    269:        dmt = kmem_zalloc(sizeof(dm_target_t), KM_SLEEP);
                    270:        if (dmt == NULL)
                    271:                return NULL;
                    272: 
                    273:        if (name)
                    274:                strlcpy(dmt->name, name, sizeof(dmt->name));
                    275: 
                    276:        return dmt;
1.2       haad      277: }
1.20      christos  278: 
1.2       haad      279: /*
                    280:  * Return prop_array of dm_target dictionaries.
                    281:  */
                    282: prop_array_t
                    283: dm_target_prop_list(void)
                    284: {
1.12      haad      285:        prop_array_t target_array, ver;
1.2       haad      286:        prop_dictionary_t target_dict;
                    287:        dm_target_t *dm_target;
                    288: 
                    289:        size_t i;
                    290: 
                    291:        target_array = prop_array_create();
1.3       haad      292: 
                    293:        mutex_enter(&dm_target_mutex);
1.2       haad      294: 
1.12      haad      295:        TAILQ_FOREACH(dm_target, &dm_target_list, dm_target_next) {
                    296:                target_dict = prop_dictionary_create();
1.2       haad      297:                ver = prop_array_create();
                    298:                prop_dictionary_set_cstring(target_dict, DM_TARGETS_NAME,
                    299:                    dm_target->name);
                    300: 
                    301:                for (i = 0; i < 3; i++)
                    302:                        prop_array_add_uint32(ver, dm_target->version[i]);
                    303: 
                    304:                prop_dictionary_set(target_dict, DM_TARGETS_VERSION, ver);
                    305:                prop_array_add(target_array, target_dict);
                    306: 
                    307:                prop_object_release(ver);
                    308:                prop_object_release(target_dict);
                    309:        }
                    310: 
1.3       haad      311:        mutex_exit(&dm_target_mutex);
1.12      haad      312: 
1.2       haad      313:        return target_array;
                    314: }
1.20      christos  315: 
1.2       haad      316: /* Initialize dm_target subsystem. */
                    317: int
                    318: dm_target_init(void)
                    319: {
1.12      haad      320:        dm_target_t *dmt, *dmt3;
1.2       haad      321:        int r;
                    322: 
                    323:        r = 0;
1.3       haad      324: 
                    325:        mutex_init(&dm_target_mutex, MUTEX_DEFAULT, IPL_NONE);
1.12      haad      326: 
1.2       haad      327:        dmt = dm_target_alloc("linear");
                    328:        dmt3 = dm_target_alloc("striped");
1.12      haad      329: 
1.2       haad      330:        dmt->version[0] = 1;
                    331:        dmt->version[1] = 0;
                    332:        dmt->version[2] = 2;
                    333:        dmt->init = &dm_target_linear_init;
1.29    ! tkusumi   334:        dmt->table = &dm_target_linear_table;
1.2       haad      335:        dmt->strategy = &dm_target_linear_strategy;
1.13      haad      336:        dmt->sync = &dm_target_linear_sync;
1.2       haad      337:        dmt->deps = &dm_target_linear_deps;
                    338:        dmt->destroy = &dm_target_linear_destroy;
                    339:        dmt->upcall = &dm_target_linear_upcall;
1.15      mlelstv   340:        dmt->secsize = &dm_target_linear_secsize;
1.12      haad      341: 
1.2       haad      342:        r = dm_target_insert(dmt);
1.12      haad      343: 
1.2       haad      344:        dmt3->version[0] = 1;
                    345:        dmt3->version[1] = 0;
                    346:        dmt3->version[2] = 3;
1.5       haad      347:        dmt3->init = &dm_target_stripe_init;
1.29    ! tkusumi   348:        dmt3->table = &dm_target_stripe_table;
1.5       haad      349:        dmt3->strategy = &dm_target_stripe_strategy;
1.13      haad      350:        dmt3->sync = &dm_target_stripe_sync;
1.5       haad      351:        dmt3->deps = &dm_target_stripe_deps;
                    352:        dmt3->destroy = &dm_target_stripe_destroy;
                    353:        dmt3->upcall = &dm_target_stripe_upcall;
1.15      mlelstv   354:        dmt3->secsize = &dm_target_stripe_secsize;
1.12      haad      355: 
1.2       haad      356:        r = dm_target_insert(dmt3);
                    357: 
                    358:        return r;
                    359: }

CVSweb <webmaster@jp.NetBSD.org>