Annotation of src/sys/dev/dm/dm_table.c, revision 1.10

1.10    ! tkusumi     1: /*        $NetBSD: dm_table.c,v 1.9 2019/12/04 15:31:12 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.8       christos   31: #include <sys/cdefs.h>
1.10    ! tkusumi    32: __KERNEL_RCSID(0, "$NetBSD: dm_table.c,v 1.9 2019/12/04 15:31:12 tkusumi Exp $");
1.2       haad       33: 
                     34: #include <sys/types.h>
                     35: #include <sys/param.h>
                     36: 
                     37: #include <sys/kmem.h>
                     38: 
                     39: #include "dm.h"
                     40: 
                     41: /*
                     42:  * There are two types of users of this interface:
1.5       haad       43:  *
1.2       haad       44:  * a) Readers such as
                     45:  *    dmstrategy, dmgetdisklabel, dmsize, dm_dev_status_ioctl,
                     46:  *    dm_table_deps_ioctl, dm_table_status_ioctl, dm_table_reload_ioctl
                     47:  *
                     48:  * b) Writers such as
                     49:  *    dm_dev_remove_ioctl, dm_dev_resume_ioctl, dm_table_clear_ioctl
                     50:  *
                     51:  * Writers can work with table_head only when there are no readers. I
                     52:  * use reference counting on io_cnt.
                     53:  *
                     54:  */
                     55: 
1.5       haad       56: static int dm_table_busy(dm_table_head_t *, uint8_t);
1.2       haad       57: static void dm_table_unbusy(dm_table_head_t *);
                     58: 
                     59: /*
                     60:  * Function to increment table user reference counter. Return id
                     61:  * of table_id table.
                     62:  * DM_TABLE_ACTIVE will return active table id.
                     63:  * DM_TABLE_INACTIVE will return inactive table id.
                     64:  */
                     65: static int
1.5       haad       66: dm_table_busy(dm_table_head_t * head, uint8_t table_id)
1.2       haad       67: {
                     68:        uint8_t id;
                     69: 
                     70:        mutex_enter(&head->table_mtx);
                     71: 
                     72:        if (table_id == DM_TABLE_ACTIVE)
                     73:                id = head->cur_active_table;
                     74:        else
                     75:                id = 1 - head->cur_active_table;
                     76: 
                     77:        head->io_cnt++;
                     78: 
                     79:        mutex_exit(&head->table_mtx);
                     80:        return id;
                     81: }
1.8       christos   82: 
1.2       haad       83: /*
                     84:  * Function release table lock and eventually wakeup all waiters.
                     85:  */
                     86: static void
1.5       haad       87: dm_table_unbusy(dm_table_head_t * head)
1.2       haad       88: {
                     89:        KASSERT(head->io_cnt != 0);
                     90: 
                     91:        mutex_enter(&head->table_mtx);
1.5       haad       92: 
1.2       haad       93:        if (--head->io_cnt == 0)
                     94:                cv_broadcast(&head->table_cv);
1.5       haad       95: 
1.2       haad       96:        mutex_exit(&head->table_mtx);
                     97: }
1.8       christos   98: 
1.2       haad       99: /*
                    100:  * Return current active table to caller, increment io_cnt reference counter.
                    101:  */
                    102: dm_table_t *
1.5       haad      103: dm_table_get_entry(dm_table_head_t * head, uint8_t table_id)
1.2       haad      104: {
                    105:        uint8_t id;
                    106: 
                    107:        id = dm_table_busy(head, table_id);
1.5       haad      108: 
1.2       haad      109:        return &head->tables[id];
                    110: }
                    111: /*
                    112:  * Decrement io reference counter and wake up all callers, with table_head cv.
                    113:  */
                    114: void
1.5       haad      115: dm_table_release(dm_table_head_t * head, uint8_t table_id)
1.2       haad      116: {
                    117:        dm_table_unbusy(head);
                    118: }
1.8       christos  119: 
1.2       haad      120: /*
                    121:  * Switch table from inactive to active mode. Have to wait until io_cnt is 0.
                    122:  */
                    123: void
1.5       haad      124: dm_table_switch_tables(dm_table_head_t * head)
1.2       haad      125: {
                    126:        mutex_enter(&head->table_mtx);
                    127: 
                    128:        while (head->io_cnt != 0)
                    129:                cv_wait(&head->table_cv, &head->table_mtx);
                    130: 
                    131:        head->cur_active_table = 1 - head->cur_active_table;
                    132: 
                    133:        mutex_exit(&head->table_mtx);
                    134: }
1.8       christos  135: 
1.2       haad      136: /*
                    137:  * Destroy all table data. This function can run when there are no
                    138:  * readers on table lists.
                    139:  *
                    140:  * XXX Is it ok to call kmem_free and potentialy VOP_CLOSE with held mutex ?xs
                    141:  */
                    142: int
1.5       haad      143: dm_table_destroy(dm_table_head_t * head, uint8_t table_id)
1.2       haad      144: {
1.5       haad      145:        dm_table_t *tbl;
1.2       haad      146:        dm_table_entry_t *table_en;
                    147:        uint8_t id;
                    148: 
                    149:        mutex_enter(&head->table_mtx);
                    150: 
1.4       joerg     151:        aprint_debug("dm_Table_destroy called with %d--%d\n", table_id, head->io_cnt);
                    152: 
1.2       haad      153:        while (head->io_cnt != 0)
                    154:                cv_wait(&head->table_cv, &head->table_mtx);
                    155: 
                    156:        if (table_id == DM_TABLE_ACTIVE)
                    157:                id = head->cur_active_table;
                    158:        else
                    159:                id = 1 - head->cur_active_table;
1.5       haad      160: 
1.2       haad      161:        tbl = &head->tables[id];
1.5       haad      162: 
                    163:        while (!SLIST_EMPTY(tbl)) {     /* List Deletion. */
1.2       haad      164:                table_en = SLIST_FIRST(tbl);
1.10    ! tkusumi   165:                if (table_en->target->destroy(table_en) == 0)
        !           166:                        table_en->target_config = NULL;
1.5       haad      167: 
1.2       haad      168:                SLIST_REMOVE_HEAD(tbl, next);
                    169: 
                    170:                kmem_free(table_en, sizeof(*table_en));
                    171:        }
                    172: 
                    173:        mutex_exit(&head->table_mtx);
1.5       haad      174: 
1.2       haad      175:        return 0;
                    176: }
1.8       christos  177: 
1.2       haad      178: /*
                    179:  * Return length of active table in device.
                    180:  */
1.7       ahoka     181: static inline uint64_t
                    182: dm_table_size_impl(dm_table_head_t * head, int table)
1.2       haad      183: {
1.5       haad      184:        dm_table_t *tbl;
1.2       haad      185:        dm_table_entry_t *table_en;
                    186:        uint64_t length;
                    187:        uint8_t id;
1.5       haad      188: 
1.2       haad      189:        length = 0;
                    190: 
1.7       ahoka     191:        id = dm_table_busy(head, table);
1.5       haad      192: 
1.2       haad      193:        /* Select active table */
                    194:        tbl = &head->tables[id];
1.5       haad      195: 
1.2       haad      196:        /*
                    197:         * Find out what tables I want to select.
                    198:         * if length => rawblkno then we should used that table.
                    199:         */
                    200:        SLIST_FOREACH(table_en, tbl, next)
1.9       tkusumi   201:                length += table_en->length;
1.2       haad      202: 
                    203:        dm_table_unbusy(head);
1.5       haad      204: 
1.3       jakllsch  205:        return length;
1.2       haad      206: }
1.7       ahoka     207: 
                    208: /*
                    209:  * Return length of active table in device.
                    210:  */
                    211: uint64_t
                    212: dm_table_size(dm_table_head_t * head)
                    213: {
                    214:        return dm_table_size_impl(head, DM_TABLE_ACTIVE);
                    215: }
                    216: 
                    217: /*
                    218:  * Return length of active table in device.
                    219:  */
                    220: uint64_t
                    221: dm_inactive_table_size(dm_table_head_t * head)
                    222: {
                    223:        return dm_table_size_impl(head, DM_TABLE_INACTIVE);
                    224: }
                    225: 
1.2       haad      226: /*
1.6       mlelstv   227:  * Return combined disk geometry
                    228:  */
                    229: void
                    230: dm_table_disksize(dm_table_head_t * head, uint64_t *numsecp, unsigned *secsizep)
                    231: {
                    232:        dm_table_t *tbl;
                    233:        dm_table_entry_t *table_en;
                    234:        uint64_t length;
                    235:        unsigned secsize, tsecsize;
                    236:        uint8_t id;
                    237: 
                    238:        length = 0;
                    239: 
                    240:        id = dm_table_busy(head, DM_TABLE_ACTIVE);
                    241: 
                    242:        /* Select active table */
                    243:        tbl = &head->tables[id];
                    244: 
                    245:        /*
                    246:         * Find out what tables I want to select.
                    247:         * if length => rawblkno then we should used that table.
                    248:         */
                    249:        secsize = 0;
                    250:        SLIST_FOREACH(table_en, tbl, next) {
1.9       tkusumi   251:                length += table_en->length;
                    252:                (void)table_en->target->secsize(table_en, &tsecsize);
                    253:                if (secsize < tsecsize)
                    254:                        secsize = tsecsize;
1.6       mlelstv   255:        }
                    256:        *numsecp = secsize > 0 ? dbtob(length) / secsize : 0;
                    257:        *secsizep = secsize;
                    258: 
                    259:        dm_table_unbusy(head);
                    260: }
1.8       christos  261: 
1.6       mlelstv   262: /*
1.2       haad      263:  * Return > 0 if table is at least one table entry (returns number of entries)
                    264:  * and return 0 if there is not. Target count returned from this function
                    265:  * doesn't need to be true when userspace user receive it (after return
                    266:  * there can be dm_dev_resume_ioctl), therfore this isonly informative.
                    267:  */
                    268: int
1.5       haad      269: dm_table_get_target_count(dm_table_head_t * head, uint8_t table_id)
                    270: {
1.2       haad      271:        dm_table_entry_t *table_en;
                    272:        dm_table_t *tbl;
                    273:        uint32_t target_count;
                    274:        uint8_t id;
                    275: 
                    276:        target_count = 0;
                    277: 
                    278:        id = dm_table_busy(head, table_id);
                    279: 
                    280:        tbl = &head->tables[id];
                    281: 
                    282:        SLIST_FOREACH(table_en, tbl, next)
1.9       tkusumi   283:                target_count++;
1.2       haad      284: 
                    285:        dm_table_unbusy(head);
1.5       haad      286: 
1.2       haad      287:        return target_count;
                    288: }
                    289: 
                    290: 
                    291: /*
                    292:  * Initialize table_head structures, I'm trying to keep this structure as
                    293:  * opaque as possible.
                    294:  */
                    295: void
1.5       haad      296: dm_table_head_init(dm_table_head_t * head)
1.2       haad      297: {
                    298:        head->cur_active_table = 0;
                    299:        head->io_cnt = 0;
1.5       haad      300: 
1.2       haad      301:        /* Initialize tables. */
                    302:        SLIST_INIT(&head->tables[0]);
                    303:        SLIST_INIT(&head->tables[1]);
                    304: 
                    305:        mutex_init(&head->table_mtx, MUTEX_DEFAULT, IPL_NONE);
                    306:        cv_init(&head->table_cv, "dm_io");
                    307: }
1.8       christos  308: 
1.2       haad      309: /*
                    310:  * Destroy all variables in table_head
                    311:  */
                    312: void
1.5       haad      313: dm_table_head_destroy(dm_table_head_t * head)
1.2       haad      314: {
                    315:        KASSERT(!mutex_owned(&head->table_mtx));
                    316:        KASSERT(!cv_has_waiters(&head->table_cv));
1.5       haad      317:        /* tables doens't exists when I call this routine, therefore it
                    318:         * doesn't make sense to have io_cnt != 0 */
                    319:        KASSERT(head->io_cnt == 0);
                    320: 
1.2       haad      321:        cv_destroy(&head->table_cv);
                    322:        mutex_destroy(&head->table_mtx);
                    323: }

CVSweb <webmaster@jp.NetBSD.org>