| blob | ff198d9b02b258703a4a2ca2145b0c9d21528c7f |
1 /* nbdkit
2 * Copyright (C) 2013 Red Hat Inc.
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 are
7 * met:
8 *
9 * * Redistributions of source code must retain the above copyright
10 * notice, this list of conditions and the following disclaimer.
11 *
12 * * Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in the
14 * documentation and/or other materials provided with the distribution.
15 *
16 * * Neither the name of Red Hat nor the names of its contributors may be
17 * used to endorse or promote products derived from this software without
18 * specific prior written permission.
19 *
20 * THIS SOFTWARE IS PROVIDED BY RED HAT AND CONTRIBUTORS ''AS IS'' AND
21 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
22 * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
23 * PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL RED HAT OR
24 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
25 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
26 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
27 * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
28 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
29 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
30 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
31 * SUCH DAMAGE.
32 */
34 /* example1:
35 *
36 * This is (almost) the most minimal nbdkit plugin possible. It
37 * serves, readonly, from memory, a static blob of data.
38 */
40 #include <config.h>
42 #include <stdio.h>
43 #include <stdlib.h>
44 #include <string.h>
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 }
129 {
130 /* In this trivial example we don't care about per-connection
131 * handles (every connection serves up the same content and there is
132 * no connection state), so we just have to return something that is
133 * non-NULL and doesn't need to be freed.
134 */
136 }
138 /* Size of the data we are going to serve. */
139 static off_t
141 {
143 }
145 /* In fact NBDKIT_THREAD_MODEL_PARALLEL would work here. However for
146 * the benefit of people who blindly cut and paste code without
147 * bothering to read any documentation, leave this at a safe default.
148 */
149 #define THREAD_MODEL NBDKIT_THREAD_MODEL_SERIALIZE_ALL_REQUESTS
151 /* Copy the static data at offset to the buffer. Note that nbdkit
152 * takes care of bounds- and sanity-checking the request.
153 */
154 static int
156 {
159 }
167 };