| blob | 5e33caa0abd54b97431e03b597ecbd70d3945bb1 |
1 /* nbdkit
2 * Copyright Red Hat
3 *
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions are
6 * met:
7 *
8 * * Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 *
11 * * 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 * * Neither the name of Red Hat nor the names of its contributors may be
16 * used to endorse or promote products derived from this software without
17 * specific prior written permission.
18 *
19 * THIS SOFTWARE IS PROVIDED BY RED HAT AND CONTRIBUTORS ''AS IS'' AND
20 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
21 * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
22 * PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL RED HAT OR
23 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
24 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
25 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
26 * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
27 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
28 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
29 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30 * SUCH DAMAGE.
31 */
33 /* example1:
34 *
35 * This is (almost) the most minimal nbdkit plugin possible. It
36 * serves, readonly, from memory, a static blob of data.
37 */
39 #include <config.h>
41 #include <stdio.h>
42 #include <stdlib.h>
43 #include <string.h>
45 #define NBDKIT_API_VERSION 2
46 #include <nbdkit-plugin.h>
48 /* This looks like a 100MB disk with one empty partition. */
114 };
117 /* A '.load' callback is not generally required, but in this case we
118 * need to initialize the 'data' array once when the plugin is loaded
119 * into nbdkit.
120 */
121 static void
123 {
125 }
127 /* Because this plugin can only serve readonly, we can ignore the
128 * 'readonly' parameter.
129 */
132 {
133 /* In this trivial example we don't care about per-connection
134 * handles because every connection serves up the same content and
135 * there is no connection state.
136 */
138 }
140 /* Size of the data we are going to serve. */
141 static int64_t
143 {
145 }
147 /* In fact NBDKIT_THREAD_MODEL_PARALLEL would work here. However for
148 * the benefit of people who blindly cut and paste code without
149 * bothering to read any documentation, leave this at a safe default.
150 */
151 #define THREAD_MODEL NBDKIT_THREAD_MODEL_SERIALIZE_ALL_REQUESTS
153 /* Copy the static data at offset to the buffer. Note that nbdkit
154 * takes care of bounds- and sanity-checking the request.
155 */
156 static int
159 {
162 }
171 };