xref: /freebsd/sys/geom/part/g_part_if.m (revision 1e413cf93298b5b97441a21d9a50fdcd0ee9945e)
1#-
2# Copyright (c) 2006, 2007 Marcel Moolenaar
3# All rights reserved.
4#
5# Redistribution and use in source and binary forms, with or without
6# modification, are permitted provided that the following conditions
7# are met:
8#
9# 1. Redistributions of source code must retain the above copyright
10#    notice, this list of conditions and the following disclaimer.
11# 2. Redistributions in binary form must reproduce the above copyright
12#    notice, this list of conditions and the following disclaimer in the
13#    documentation and/or other materials provided with the distribution.
14#
15# THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
16# IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
17# OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
18# IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
19# INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
20# NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
21# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
22# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
24# THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
25#
26# $FreeBSD$
27
28#include <sys/param.h>
29#include <sys/lock.h>
30#include <sys/malloc.h>
31#include <sys/mutex.h>
32#include <sys/sbuf.h>
33#include <sys/bus.h>
34#include <machine/bus.h>
35#include <sys/systm.h>
36#include <geom/geom.h>
37#include <geom/part/g_part.h>
38
39# The G_PART scheme interface.
40
41INTERFACE g_part;
42
43# add() - scheme specific processing for the add verb.
44METHOD int add {
45	struct g_part_table *table;
46	struct g_part_entry *entry;
47	struct g_part_parms *gpp;
48};
49
50# create() - scheme specific processing for the create verb.
51METHOD int create {
52	struct g_part_table *table;
53	struct g_part_parms *gpp;
54};
55
56# destroy() - scheme specific processing for the destroy verb.
57METHOD int destroy {
58	struct g_part_table *table;
59	struct g_part_parms *gpp;
60};
61
62# dumpconf()
63METHOD void dumpconf {
64	struct g_part_table *table;
65	struct g_part_entry *entry;
66	struct sbuf *sb;
67	const char *indent;
68};
69
70# dumpto() - return whether the partiton can be used for kernel dumps.
71METHOD int dumpto {
72	struct g_part_table *table;
73	struct g_part_entry *entry;
74};
75
76# modify() - scheme specific processing for the modify verb.
77METHOD int modify {
78	struct g_part_table *table;
79	struct g_part_entry *entry;
80	struct g_part_parms *gpp;
81};
82
83# name() - return the name of the given partition entry.
84# Typical names are "p1", "s0" or "c".
85METHOD const char * name {
86	struct g_part_table *table;
87	struct g_part_entry *entry;
88	char *buf;
89	size_t bufsz;
90};
91
92# probe() - probe the provider attached to the given consumer for the
93# existence of the scheme implemented by the G_PART interface handler.
94METHOD int probe {
95	struct g_part_table *table;
96	struct g_consumer *cp;
97};
98
99# read() - read the on-disk partition table into memory.
100METHOD int read {
101	struct g_part_table *table;
102	struct g_consumer *cp;
103};
104
105# type() - return a string representation of the partition type.
106# Preferrably, the alias names.
107METHOD const char * type {
108        struct g_part_table *table;
109        struct g_part_entry *entry;
110        char *buf;
111        size_t bufsz;
112};
113
114# write() - write the in-memory partition table to disk.
115METHOD int write {
116	struct g_part_table *table;
117	struct g_consumer *cp;
118};
119