libraries/liblmdb/mdb_stat.c

   1 /* mdb_stat.c - memory-mapped database status tool */
   2 /*
   3  * Copyright 2011-2016 Howard Chu, Symas Corp.
   4  * All rights reserved.
   5  *
   6  * Redistribution and use in source and binary forms, with or without
   7  * modification, are permitted only as authorized by the OpenLDAP
   8  * Public License.
   9  *
  10  * A copy of this license is available in the file LICENSE in the
  11  * top-level directory of the distribution or, alternatively, at
  12  * <http://www.OpenLDAP.org/license.html>.
  13  */
  14 #include <stdio.h>
  15 #include <stdlib.h>
  16 #include <string.h>
  17 #include <unistd.h>
  18 #include "lmdb.h"
  19
  20 #define Z       MDB_FMT_Z
  21 #define Y       MDB_FMT_Y
  22
  23 static void prstat(MDB_stat *ms)
  24 {
  25 #if 0
  26         printf("  Page size: %u\n", ms->ms_psize);
  27 #endif
  28         printf("  Tree depth: %u\n", ms->ms_depth);
  29         printf("  Branch pages: %"Y"u\n", ms->ms_branch_pages);
  30         printf("  Leaf pages: %"Y"u\n", ms->ms_leaf_pages);
  31         printf("  Overflow pages: %"Y"u\n", ms->ms_overflow_pages);
  32         printf("  Entries: %"Y"u\n", ms->ms_entries);
  33 }
  34
  35 static void usage(char *prog)
  36 {
  37         fprintf(stderr, "usage: %s [-V] [-n] [-e] [-r[r]] [-f[f[f]]] [-a|-s subdb] dbpath\n", prog);
  38         exit(EXIT_FAILURE);
  39 }
  40
  41 int main(int argc, char *argv[])
  42 {
  43         int i, rc;
  44         MDB_env *env;
  45         MDB_txn *txn;
  46         MDB_dbi dbi;
  47         MDB_stat mst;
  48         MDB_envinfo mei;
  49         char *prog = argv[0];
  50         char *envname;
  51         char *subname = NULL;
  52         int alldbs = 0, envinfo = 0, envflags = 0, freinfo = 0, rdrinfo = 0;
  53
  54         if (argc < 2) {
  55                 usage(prog);
  56         }
  57
  58         /* -a: print stat of main DB and all subDBs
  59          * -s: print stat of only the named subDB
  60          * -e: print env info
  61          * -f: print freelist info
  62          * -r: print reader info
  63          * -n: use NOSUBDIR flag on env_open
  64          * -V: print version and exit
  65          * (default) print stat of only the main DB
  66          */
  67         while ((i = getopt(argc, argv, "Vaefnrs:")) != EOF) {
  68                 switch(i) {
  69                 case 'V':
  70                         printf("%s\n", MDB_VERSION_STRING);
  71                         exit(0);
  72                         break;
  73                 case 'a':
  74                         if (subname)
  75                                 usage(prog);
  76                         alldbs++;
  77                         break;
  78                 case 'e':
  79                         envinfo++;
  80                         break;
  81                 case 'f':
  82                         freinfo++;
  83                         break;
  84                 case 'n':
  85                         envflags |= MDB_NOSUBDIR;
  86                         break;
  87                 case 'r':
  88                         rdrinfo++;
  89                         break;
  90                 case 's':
  91                         if (alldbs)
  92                                 usage(prog);
  93                         subname = optarg;
  94                         break;
  95                 default:
  96                         usage(prog);
  97                 }
  98         }
  99
 100         if (optind != argc - 1)
 101                 usage(prog);
 102
 103         envname = argv[optind];
 104         rc = mdb_env_create(&env);
 105         if (rc) {
 106                 fprintf(stderr, "mdb_env_create failed, error %d %s\n", rc, mdb_strerror(rc));
 107                 return EXIT_FAILURE;
 108         }
 109
 110         if (alldbs || subname) {
 111                 mdb_env_set_maxdbs(env, 4);
 112         }
 113
 114         rc = mdb_env_open(env, envname, envflags | MDB_RDONLY, 0664);
 115         if (rc) {
 116                 fprintf(stderr, "mdb_env_open failed, error %d %s\n", rc, mdb_strerror(rc));
 117                 goto env_close;
 118         }
 119
 120         if (envinfo) {
 121                 (void)mdb_env_stat(env, &mst);
 122                 (void)mdb_env_info(env, &mei);
 123                 printf("Environment Info\n");
 124                 printf("  Map address: %p\n", mei.me_mapaddr);
 125                 printf("  Map size: %"Y"u\n", mei.me_mapsize);
 126                 printf("  Page size: %u\n", mst.ms_psize);
 127                 printf("  Max pages: %"Y"u\n", mei.me_mapsize / mst.ms_psize);
 128                 printf("  Number of pages used: %"Y"u\n", mei.me_last_pgno+1);
 129                 printf("  Last transaction ID: %"Y"u\n", mei.me_last_txnid);
 130                 printf("  Max readers: %u\n", mei.me_maxreaders);
 131                 printf("  Number of readers used: %u\n", mei.me_numreaders);
 132         }
 133
 134         if (rdrinfo) {
 135                 printf("Reader Table Status\n");
 136                 rc = mdb_reader_list(env, (MDB_msg_func *)fputs, stdout);
 137                 if (rdrinfo > 1) {
 138                         int dead;
 139                         mdb_reader_check(env, &dead);
 140                         printf("  %d stale readers cleared.\n", dead);
 141                         rc = mdb_reader_list(env, (MDB_msg_func *)fputs, stdout);
 142                 }
 143                 if (!(subname || alldbs || freinfo))
 144                         goto env_close;
 145         }
 146
 147         rc = mdb_txn_begin(env, NULL, MDB_RDONLY, &txn);
 148         if (rc) {
 149                 fprintf(stderr, "mdb_txn_begin failed, error %d %s\n", rc, mdb_strerror(rc));
 150                 goto env_close;
 151         }
 152
 153         if (freinfo) {
 154                 MDB_cursor *cursor;
 155                 MDB_val key, data;
 156                 size_t pages = 0, *iptr;
 157
 158                 printf("Freelist Status\n");
 159                 dbi = 0;
 160                 rc = mdb_cursor_open(txn, dbi, &cursor);
 161                 if (rc) {
 162                         fprintf(stderr, "mdb_cursor_open failed, error %d %s\n", rc, mdb_strerror(rc));
 163                         goto txn_abort;
 164                 }
 165                 rc = mdb_stat(txn, dbi, &mst);
 166                 if (rc) {
 167                         fprintf(stderr, "mdb_stat failed, error %d %s\n", rc, mdb_strerror(rc));
 168                         goto txn_abort;
 169                 }
 170                 prstat(&mst);
 171                 while ((rc = mdb_cursor_get(cursor, &key, &data, MDB_NEXT)) == 0) {
 172                         iptr = data.mv_data;
 173                         pages += *iptr;
 174                         if (freinfo > 1) {
 175                                 char *bad = "";
 176                                 size_t pg, prev;
 177                                 ssize_t i, j, span = 0;
 178                                 j = *iptr++;
 179                                 for (i = j, prev = 1; --i >= 0; ) {
 180                                         pg = iptr[i];
 181                                         if (pg <= prev)
 182                                                 bad = " [bad sequence]";
 183                                         prev = pg;
 184                                         pg += span;
 185                                         for (; i >= span && iptr[i-span] == pg; span++, pg++) ;
 186                                 }
 187                                 printf("    Transaction %"Z"u, %"Z"d pages, maxspan %"Z"d%s\n",
 188                                         *(size_t *)key.mv_data, j, span, bad);
 189                                 if (freinfo > 2) {
 190                                         for (--j; j >= 0; ) {
 191                                                 pg = iptr[j];
 192                                                 for (span=1; --j >= 0 && iptr[j] == pg+span; span++) ;
 193                                                 printf(span>1 ? "     %9"Z"u[%"Z"d]\n" : "     %9"Z"u\n",
 194                                                         pg, span);
 195                                         }
 196                                 }
 197                         }
 198                 }
 199                 mdb_cursor_close(cursor);
 200                 printf("  Free pages: %"Z"u\n", pages);
 201         }
 202
 203         rc = mdb_open(txn, subname, 0, &dbi);
 204         if (rc) {
 205                 fprintf(stderr, "mdb_open failed, error %d %s\n", rc, mdb_strerror(rc));
 206                 goto txn_abort;
 207         }
 208
 209         rc = mdb_stat(txn, dbi, &mst);
 210         if (rc) {
 211                 fprintf(stderr, "mdb_stat failed, error %d %s\n", rc, mdb_strerror(rc));
 212                 goto txn_abort;
 213         }
 214         printf("Status of %s\n", subname ? subname : "Main DB");
 215         prstat(&mst);
 216
 217         if (alldbs) {
 218                 MDB_cursor *cursor;
 219                 MDB_val key;
 220
 221                 rc = mdb_cursor_open(txn, dbi, &cursor);
 222                 if (rc) {
 223                         fprintf(stderr, "mdb_cursor_open failed, error %d %s\n", rc, mdb_strerror(rc));
 224                         goto txn_abort;
 225                 }
 226                 while ((rc = mdb_cursor_get(cursor, &key, NULL, MDB_NEXT_NODUP)) == 0) {
 227                         char *str;
 228                         MDB_dbi db2;
 229                         if (memchr(key.mv_data, '\0', key.mv_size))
 230                                 continue;
 231                         str = malloc(key.mv_size+1);
 232                         memcpy(str, key.mv_data, key.mv_size);
 233                         str[key.mv_size] = '\0';
 234                         rc = mdb_open(txn, str, 0, &db2);
 235                         if (rc == MDB_SUCCESS)
 236                                 printf("Status of %s\n", str);
 237                         free(str);
 238                         if (rc) continue;
 239                         rc = mdb_stat(txn, db2, &mst);
 240                         if (rc) {
 241                                 fprintf(stderr, "mdb_stat failed, error %d %s\n", rc, mdb_strerror(rc));
 242                                 goto txn_abort;
 243                         }
 244                         prstat(&mst);
 245                         mdb_close(env, db2);
 246                 }
 247                 mdb_cursor_close(cursor);
 248         }
 249
 250         if (rc == MDB_NOTFOUND)
 251                 rc = MDB_SUCCESS;
 252
 253         mdb_close(env, dbi);
 254 txn_abort:
 255         mdb_txn_abort(txn);
 256 env_close:
 257         mdb_env_close(env);
 258
 259         return rc ? EXIT_FAILURE : EXIT_SUCCESS;
 260 }