CRC module.
[ccan] / ccan / alloc / _info.c
1 #include <stdio.h>
2 #include <string.h>
3 #include "config.h"
4
5 /**
6  * alloc - memory allocator routines
7  *
8  * The alloc module implements a simple allocator which you can use to
9  * dynamically allocate space within a region of memory.  This can be useful
10  * for suballocations within a given region, or a memory-mapped file.
11  *
12  * All metadata is kept within the memory handed to the allocator: you only
13  * need hand the pointer and the size of the memory to each call.
14  *
15  * The region contents is always in offsets, so it can be mapped in different
16  * places, but is not endian-safe.
17  *
18  * Example:
19  *      #include <sys/mman.h>
20  *      #include <unistd.h>
21  *      #include <sys/types.h>
22  *      #include <err.h>
23  *      #include <sys/stat.h>
24  *      #include <fcntl.h>
25  *      #include <string.h>
26  *      #include <ccan/alloc/alloc.h>
27  *
28  *      static void usage(const char *name)
29  *      {
30  *              errx(1, "Usage: %s --create <mapfile>\n"
31  *                   " %s --check <mapfile>\n"
32  *                   " %s --alloc <mapfile>\n"
33  *                   " %s --free=<offset> <mapfile>\n", name, name, name, name);
34  *      }
35  *
36  *      // Create a memory mapped file, and allocate from within it
37  *      int main(int argc, char *argv[])
38  *      {
39  *              void *a, *p;
40  *              int fd;
41  *              enum { CREATE, CHECK, ALLOC, FREE } cmd;
42  *
43  *              if (argc != 3)
44  *                      usage(argv[0]);
45  *
46  *              if (strcmp(argv[1], "--create") == 0)
47  *                      cmd = CREATE;
48  *              else if (strcmp(argv[1], "--check") == 0)
49  *                      cmd = CHECK;
50  *              else if (strcmp(argv[1], "--alloc") == 0)
51  *                      cmd = ALLOC;
52  *              else if (strncmp(argv[1], "--free=", strlen("--free=")) == 0)
53  *                      cmd = FREE;
54  *              else
55  *                      usage(argv[0]);
56  *
57  *              if (cmd == CREATE) {
58  *                      fd = open(argv[2], O_RDWR|O_CREAT|O_EXCL, 0600);
59  *                      if (fd < 0)
60  *                              err(1, "Could not create %s", argv[2]);
61  *                      if (ftruncate(fd, 1048576) != 0)
62  *                              err(1, "Could not set length on %s", argv[2]);
63  *              } else {
64  *                      fd = open(argv[2], O_RDWR);
65  *                      if (fd < 0)
66  *                              err(1, "Could not open %s", argv[2]);
67  *              }
68  *
69  *              a = mmap(NULL, 1048576, PROT_READ|PROT_WRITE, MAP_SHARED, fd,0);
70  *              if (a == MAP_FAILED)
71  *                      err(1, "Could not map %s", argv[2]);
72  *
73  *              switch (cmd) {
74  *              case CREATE:
75  *                      alloc_init(a, 1048576);
76  *                      break;
77  *              case CHECK:
78  *                      if (!alloc_check(a, 1048576))
79  *                              err(1, "Region is corrupt");
80  *                      break;
81  *              case ALLOC:
82  *                      p = alloc_get(a, 1048576, 1024, 16);
83  *                      if (!p)
84  *                              errx(1, "Could not allocate");
85  *                      printf("%zu\n", (char *)p - (char *)a);
86  *                      break;
87  *              case FREE:
88  *                      p = (char *)a + atol(argv[1] + strlen("--free="));
89  *                      alloc_free(a, 1048576, p);
90  *                      break;
91  *              }
92  *              return 0;
93  *      }
94  *
95  * Licence: LGPL (2 or any later version)
96  */
97 int main(int argc, char *argv[])
98 {
99         if (argc != 2)
100                 return 1;
101
102         if (strcmp(argv[1], "depends") == 0) {
103                 printf("ccan/build_assert\n");
104                 return 0;
105         }
106
107         return 1;
108 }