root/sys/sys/disk.h
/*      $OpenBSD: disk.h,v 1.42 2025/09/15 10:33:03 krw Exp $   */
/*      $NetBSD: disk.h,v 1.11 1996/04/28 20:22:50 thorpej Exp $        */

/*
 * Copyright (c) 1995 Jason R. Thorpe.  All rights reserved.
 * Copyright (c) 1992, 1993
 *      The Regents of the University of California.  All rights reserved.
 *
 * This software was developed by the Computer Systems Engineering group
 * at Lawrence Berkeley Laboratory under DARPA contract BG 91-66 and
 * contributed to Berkeley.
 *
 * All advertising materials mentioning features or use of this software
 * must display the following acknowledgement:
 *      This product includes software developed by the University of
 *      California, Lawrence Berkeley Laboratory.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 * 3. Neither the name of the University nor the names of its contributors
 *    may be used to endorse or promote products derived from this software
 *    without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 *
 * from: Header: disk.h,v 1.5 92/11/19 04:33:03 torek Exp  (LBL)
 *
 *      @(#)disk.h      8.1 (Berkeley) 6/2/93
 */

/*
 * Disk device structures.
 */

#include <sys/device.h>
#include <sys/time.h>
#include <sys/queue.h>
#include <sys/rwlock.h>
#include <sys/mutex.h>

struct disklabel;

#define DS_DISKNAMELEN  16

struct diskstats {
        char            ds_name[DS_DISKNAMELEN];
        int             ds_busy;        /* busy counter */
        u_int64_t       ds_rxfer;       /* total number of read transfers */
        u_int64_t       ds_wxfer;       /* total number of write transfers */
        u_int64_t       ds_seek;        /* total independent seek operations */
        u_int64_t       ds_rbytes;      /* total bytes read */
        u_int64_t       ds_wbytes;      /* total bytes written */
        struct timeval  ds_attachtime;  /* time disk was attached */
        struct timeval  ds_timestamp;   /* time of first busy or any unbusy */
        struct timeval  ds_time;        /* total time spent busy */
};

struct disk {
        TAILQ_ENTRY(disk) dk_link;      /* link in global disklist */
        struct rwlock   dk_lock;        /* disk lock */
        struct mutex    dk_mtx;         /* busy/unbusy mtx */
        char            *dk_name;       /* disk name */
        struct device   *dk_device;     /* disk device structure. */
        dev_t           dk_devno;       /* disk device number. */
        int             dk_flags;       /* disk flags */
#define DKF_CONSTRUCTED 0x0001
#define DKF_OPENED      0x0002
#define DKF_NOLABELREAD 0x0004

        /*
         * Metrics data; note that some metrics may have no meaning
         * on certain types of disks.
         */
        int             dk_busy;        /* busy counter */
        u_int64_t       dk_rxfer;       /* total number of read transfers */
        u_int64_t       dk_wxfer;       /* total number of write transfers */
        u_int64_t       dk_seek;        /* total independent seek operations */
        u_int64_t       dk_rbytes;      /* total bytes read */
        u_int64_t       dk_wbytes;      /* total bytes written */
        struct timeval  dk_attachtime;  /* time disk was attached */
        struct timeval  dk_timestamp;   /* time of first busy or any unbusy */
        struct timeval  dk_time;        /* total time spent busy */

        uint64_t        dk_bopenmask;   /* block devices open */
        uint64_t        dk_copenmask;   /* character devices open */
        uint64_t        dk_openmask;    /* composite (bopen|copen) */
        int             dk_state;       /* label state   ### */
        int             dk_blkshift;    /* shift to convert DEV_BSIZE to blks*/
        int             dk_byteshift;   /* shift to convert bytes to blks */

        /*
         * Disk label information.  Storage for the in-core disk label
         * must be dynamically allocated, otherwise the size of this
         * structure becomes machine-dependent.
         */
        struct disklabel *dk_label;
};

/* states */
#define DK_CLOSED       0               /* drive is closed */
#define DK_WANTOPEN     1               /* drive being opened */
#define DK_WANTOPENRAW  2               /* drive being opened */
#define DK_RDLABEL      3               /* label being read */
#define DK_OPEN         4               /* label read, drive open */
#define DK_OPENRAW      5               /* open without label */

/* Disk map flags. */
#define DM_OPENPART     0x1             /* Open raw partition. */
#define DM_OPENBLCK     0x2             /* Open block device. */

/*
 * disklist_head is defined here so that user-land has access to it.
 */
TAILQ_HEAD(disklist_head, disk);        /* the disklist is a TAILQ */

#ifdef _KERNEL
extern  struct disklist_head disklist;  /* list of disks attached to system */
extern  int disk_count;                 /* number of disks in global disklist */
extern  int disk_change;                /* disk attached/detached */

void    disk_init(void);
int     disk_construct(struct disk *);
void    disk_attach(struct device *, struct disk *);
void    disk_detach(struct disk *);
int     disk_openpart(struct disk *, int, int, int);
void    disk_closepart(struct disk *, int, int);
void    disk_gone(int (*)(dev_t, int, int, struct proc *), int);
void    disk_busy(struct disk *);
void    disk_unbusy(struct disk *, long, daddr_t, int);

int     disk_lock(struct disk *);
void    disk_lock_nointr(struct disk *);
void    disk_unlock(struct disk *);
struct device *disk_lookup(struct cfdriver *, int);

char    *disk_readlabel(struct disklabel *, dev_t, char *, size_t);

int     disk_map(const char *, char *, int, int);

int     duid_iszero(u_char *);
const char *duid_format(u_char *);
#endif