xref: /freebsd/sys/geom/part/g_part_if.m (revision 3157ba21)
1#-
2# Copyright (c) 2006-2009 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# Default implementations of methods.
44CODE {
45	static void
46	default_fullname(struct g_part_table *table,
47	    struct g_part_entry *entry, struct sbuf *sb, const char *pfx)
48	{
49		char buf[32];
50
51		sbuf_printf(sb, "%s%s", pfx,
52		    G_PART_NAME(table, entry, buf, sizeof(buf)));
53	}
54
55	static int
56	default_precheck(struct g_part_table *t __unused,
57	    enum g_part_ctl r __unused, struct g_part_parms *p __unused)
58	{
59		return (0);
60	}
61
62	static int
63	default_resize(struct g_part_table *t __unused,
64	    struct g_part_entry *e __unused, struct g_part_parms *p __unused)
65	{
66		return (ENOSYS);
67	}
68};
69
70# add() - scheme specific processing for the add verb.
71METHOD int add {
72	struct g_part_table *table;
73	struct g_part_entry *entry;
74	struct g_part_parms *gpp;
75};
76
77# bootcode() - scheme specific processing for the bootcode verb.
78METHOD int bootcode {
79	struct g_part_table *table;
80	struct g_part_parms *gpp;
81};
82
83# create() - scheme specific processing for the create verb.
84METHOD int create {
85	struct g_part_table *table;
86	struct g_part_parms *gpp;
87};
88
89# destroy() - scheme specific processing for the destroy verb.
90METHOD int destroy {
91	struct g_part_table *table;
92	struct g_part_parms *gpp;
93};
94
95# dumpconf()
96METHOD void dumpconf {
97	struct g_part_table *table;
98	struct g_part_entry *entry;
99	struct sbuf *sb;
100	const char *indent;
101};
102
103# dumpto() - return whether the partiton can be used for kernel dumps.
104METHOD int dumpto {
105	struct g_part_table *table;
106	struct g_part_entry *entry;
107};
108
109# fullname() - write the name of the given partition entry to the sbuf.
110METHOD void fullname {
111	struct g_part_table *table;
112	struct g_part_entry *entry;
113	struct sbuf *sb;
114	const char *pfx;
115} DEFAULT default_fullname;
116
117# modify() - scheme specific processing for the modify verb.
118METHOD int modify {
119	struct g_part_table *table;
120	struct g_part_entry *entry;
121	struct g_part_parms *gpp;
122};
123
124# resize() - scheme specific processing for the resize verb.
125METHOD int resize {
126	struct g_part_table *table;
127	struct g_part_entry *entry;
128	struct g_part_parms *gpp;
129} DEFAULT default_resize;
130
131# name() - return the name of the given partition entry.
132# Typical names are "p1", "s0" or "c".
133METHOD const char * name {
134	struct g_part_table *table;
135	struct g_part_entry *entry;
136	char *buf;
137	size_t bufsz;
138};
139
140# precheck() - method to allow schemes to check the parameters given
141# to the mentioned ctl request. This only applies to the requests that
142# operate on a GEOM. In other words, it does not apply to the create
143# request.
144# It is allowed (intended actually) to change the parameters according
145# to the schemes needs before they are used. Returning an error will
146# terminate the request immediately.
147METHOD int precheck {
148	struct g_part_table *table;
149	enum g_part_ctl req;
150	struct g_part_parms *gpp;
151} DEFAULT default_precheck;
152
153# probe() - probe the provider attached to the given consumer for the
154# existence of the scheme implemented by the G_PART interface handler.
155METHOD int probe {
156	struct g_part_table *table;
157	struct g_consumer *cp;
158};
159
160# read() - read the on-disk partition table into memory.
161METHOD int read {
162	struct g_part_table *table;
163	struct g_consumer *cp;
164};
165
166# setunset() - set or unset partition entry attributes.
167METHOD int setunset {
168	struct g_part_table *table;
169	struct g_part_entry *entry;
170	const char *attrib;
171	unsigned int set;
172};
173
174# type() - return a string representation of the partition type.
175# Preferrably, the alias names.
176METHOD const char * type {
177        struct g_part_table *table;
178        struct g_part_entry *entry;
179        char *buf;
180        size_t bufsz;
181};
182
183# write() - write the in-memory partition table to disk.
184METHOD int write {
185	struct g_part_table *table;
186	struct g_consumer *cp;
187};
188