1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
|
/*
* zramctl - control compressed block devices in RAM
*
* Copyright (c) 2014 Timofey Titovets <Nefelim4ag@gmail.com>
* Copyright (C) 2014 Karel Zak <kzak@redhat.com>
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License as
* published by the Free Software Foundation.
*
* This program is distributed in the hope that it would be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License along
* with this program; if not, write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
*/
#include <getopt.h>
#include <stdlib.h>
#include <string.h>
#include <stdarg.h>
#include <assert.h>
#include <libsmartcols.h>
#include "c.h"
#include "nls.h"
#include "closestream.h"
#include "strutils.h"
#include "xalloc.h"
#include "sysfs.h"
#include "optutils.h"
#include "ismounted.h"
/*#define CONFIG_ZRAM_DEBUG*/
#ifdef CONFIG_ZRAM_DEBUG
# define DBG(x) do { fputs("zram: ", stderr); x; fputc('\n', stderr); } while(0)
#else
# define DBG(x)
#endif
/* status output columns */
struct colinfo {
const char *name;
double whint;
int flags;
const char *help;
};
enum {
COL_NAME = 0,
COL_DISKSIZE,
COL_ORIG_SIZE,
COL_COMP_SIZE,
COL_ALGORITHM,
COL_STREAMS,
COL_ZEROPAGES,
COL_MEMTOTAL,
COL_MOUNTPOINT
};
static const struct colinfo infos[] = {
[COL_NAME] = { "NAME", 0.25, 0, N_("zram device name") },
[COL_DISKSIZE] = { "DISKSIZE", 5, SCOLS_FL_RIGHT, N_("limit on the uncompressed amount of data") },
[COL_ORIG_SIZE] = { "DATA", 5, SCOLS_FL_RIGHT, N_("uncompressed size of stored data") },
[COL_COMP_SIZE] = { "COMPR", 5, SCOLS_FL_RIGHT, N_("compressed size of stored data") },
[COL_ALGORITHM] = { "ALGORITHM", 3, 0, N_("the selected compression algorithm") },
[COL_STREAMS] = { "STREAMS", 3, SCOLS_FL_RIGHT, N_("number of concurrent compress operations") },
[COL_ZEROPAGES] = { "ZERO-PAGES", 3, SCOLS_FL_RIGHT, N_("empty pages with no allocated memory") },
[COL_MEMTOTAL] = { "TOTAL", 5, SCOLS_FL_RIGHT, N_("all memory including allocator fragmentation and metadata overhead") },
[COL_MOUNTPOINT]= { "MOUNTPOINT",0.10, SCOLS_FL_TRUNC, N_("where the device is mounted") },
};
static int columns[ARRAY_SIZE(infos) * 2] = {-1};
static int ncolumns;
struct zram {
char devname[32];
struct sysfs_cxt sysfs;
};
#define ZRAM_EMPTY { .devname = { '\0' }, .sysfs = UL_SYSFSCXT_EMPTY }
static unsigned int raw, no_headings, inbytes;
static int get_column_id(int num)
{
assert(num < ncolumns);
assert(columns[num] < (int) ARRAY_SIZE(infos));
return columns[num];
}
static const struct colinfo *get_column_info(int num)
{
return &infos[ get_column_id(num) ];
}
static int column_name_to_id(const char *name, size_t namesz)
{
size_t i;
for (i = 0; i < ARRAY_SIZE(infos); i++) {
const char *cn = infos[i].name;
if (!strncasecmp(name, cn, namesz) && !*(cn + namesz))
return i;
}
warnx(_("unknown column: %s"), name);
return -1;
}
static void zram_set_devname(struct zram *z, const char *devname, size_t n)
{
assert(z);
if (!devname)
snprintf(z->devname, sizeof(z->devname), "/dev/zram%zu", n);
else {
strncpy(z->devname, devname, sizeof(z->devname));
z->devname[sizeof(z->devname) - 1] = '\0';
}
DBG(fprintf(stderr, "set devname: %s", z->devname));
sysfs_deinit(&z->sysfs);
}
static struct zram *new_zram(const char *devname)
{
struct zram *z = xcalloc(1, sizeof(struct zram));
DBG(fprintf(stderr, "new: %p", z));
if (devname)
zram_set_devname(z, devname, 0);
return z;
}
static void free_zram(struct zram *z)
{
if (!z)
return;
DBG(fprintf(stderr, "free: %p", z));
sysfs_deinit(&z->sysfs);
free(z);
}
static struct sysfs_cxt *zram_get_sysfs(struct zram *z)
{
assert(z);
if (!z->sysfs.devno) {
dev_t devno = sysfs_devname_to_devno(z->devname, NULL);
if (!devno)
return NULL;
if (sysfs_init(&z->sysfs, devno, NULL))
return NULL;
if (*z->devname != '/') {
/* cannonicalize the device name according to /sys */
char name[PATH_MAX];
if (sysfs_get_devname(&z->sysfs, name, sizeof(name)))
snprintf(z->devname, sizeof(z->devname), "/dev/%s", name);
}
}
return &z->sysfs;
}
static inline int zram_exist(struct zram *z)
{
assert(z);
errno = 0;
if (zram_get_sysfs(z) == NULL) {
errno = ENODEV;
return 0;
}
DBG(fprintf(stderr, "%s exists", z->devname));
return 1;
}
static int zram_set_u64parm(struct zram *z, const char *attr, uint64_t num)
{
struct sysfs_cxt *sysfs = zram_get_sysfs(z);
if (!sysfs)
return -EINVAL;
DBG(fprintf(stderr, "%s writing %ju to %s", z->devname, num, attr));
return sysfs_write_u64(sysfs, attr, num);
}
static int zram_set_strparm(struct zram *z, const char *attr, const char *str)
{
struct sysfs_cxt *sysfs = zram_get_sysfs(z);
if (!sysfs)
return -EINVAL;
DBG(fprintf(stderr, "%s writing %s to %s", z->devname, str, attr));
return sysfs_write_string(sysfs, attr, str);
}
static int zram_used(struct zram *z)
{
uint64_t size;
struct sysfs_cxt *sysfs = zram_get_sysfs(z);
if (sysfs &&
sysfs_read_u64(sysfs, "disksize", &size) == 0 &&
size > 0) {
DBG(fprintf(stderr, "%s used", z->devname));
return 1;
}
DBG(fprintf(stderr, "%s unused", z->devname));
return 0;
}
static struct zram *find_free_zram(void)
{
struct zram *z = new_zram(NULL);
size_t i;
int isfree = 0;
for (i = 0; isfree == 0; i++) {
DBG(fprintf(stderr, "find free: checking zram%zu", i));
zram_set_devname(z, NULL, i);
if (!zram_exist(z))
break;
isfree = !zram_used(z);
}
if (!isfree) {
free_zram(z);
z = NULL;
}
return z;
}
static void fill_table_row(struct libscols_table *tb, struct zram *z)
{
static struct libscols_line *ln;
struct sysfs_cxt *sysfs;
size_t i;
uint64_t num;
assert(tb);
assert(z);
DBG(fprintf(stderr, "%s: filling status table", z->devname));
sysfs = zram_get_sysfs(z);
if (!sysfs)
return;
ln = scols_table_new_line(tb, NULL);
if (!ln)
err(EXIT_FAILURE, _("failed to initialize output line"));
for (i = 0; i < (size_t) ncolumns; i++) {
char *str = NULL;
switch (get_column_id(i)) {
case COL_NAME:
str = xstrdup(z->devname);
break;
case COL_DISKSIZE:
if (inbytes)
str = sysfs_strdup(sysfs, "disksize");
else if (sysfs_read_u64(sysfs, "disksize", &num) == 0)
str = size_to_human_string(SIZE_SUFFIX_1LETTER, num);
break;
case COL_ORIG_SIZE:
if (inbytes)
str = sysfs_strdup(sysfs, "orig_data_size");
else if (sysfs_read_u64(sysfs, "orig_data_size", &num) == 0)
str = size_to_human_string(SIZE_SUFFIX_1LETTER, num);
break;
case COL_COMP_SIZE:
if (inbytes)
str = sysfs_strdup(sysfs, "compr_data_size");
else if (sysfs_read_u64(sysfs, "compr_data_size", &num) == 0)
str = size_to_human_string(SIZE_SUFFIX_1LETTER, num);
break;
case COL_ALGORITHM:
{
char *alg = sysfs_strdup(sysfs, "comp_algorithm");
if (!alg)
break;
if (strstr(alg, "[lzo]") == NULL) {
if (strstr(alg, "[lz4]") == NULL)
;
else
str = xstrdup("lz4");
} else
str = xstrdup("lzo");
free(alg);
break;
}
case COL_MOUNTPOINT:
{
char path[PATH_MAX] = { '\0' };
int fl;
check_mount_point(z->devname, &fl, path, sizeof(path));
if (*path)
str = xstrdup(path);
break;
}
case COL_STREAMS:
str = sysfs_strdup(sysfs, "max_comp_streams");
break;
case COL_ZEROPAGES:
str = sysfs_strdup(sysfs, "zero_pages");
break;
case COL_MEMTOTAL:
if (inbytes)
str = sysfs_strdup(sysfs, "mem_used_total");
else if (sysfs_read_u64(sysfs, "mem_used_total", &num) == 0)
str = size_to_human_string(SIZE_SUFFIX_1LETTER, num);
break;
}
if (str)
scols_line_refer_data(ln, i, str);
}
}
static void status(struct zram *z)
{
struct libscols_table *tb;
size_t i;
scols_init_debug(0);
tb = scols_new_table();
if (!tb)
err(EXIT_FAILURE, _("failed to initialize output table"));
scols_table_enable_raw(tb, raw);
scols_table_enable_noheadings(tb, no_headings);
for (i = 0; i < (size_t) ncolumns; i++) {
const struct colinfo *col = get_column_info(i);
if (!scols_table_new_column(tb, col->name, col->whint, col->flags))
err(EXIT_FAILURE, _("failed to initialize output column"));
}
if (z)
fill_table_row(tb, z); /* just one device specified */
else {
size_t i; /* list all used devices */
z = new_zram(NULL);
for (i = 0; ; i++) {
zram_set_devname(z, NULL, i);
if (!zram_exist(z))
break;
if (zram_used(z))
fill_table_row(tb, z);
}
free_zram(z);
}
scols_print_table(tb);
scols_unref_table(tb);
}
static void __attribute__ ((__noreturn__)) usage(FILE * out)
{
size_t i;
fputs(USAGE_HEADER, out);
fprintf(out, _( " %1$s [options] <device>\n"
" %1$s -r <device> [...]\n"
" %1$s [options] -f | <device> -s <size>\n"),
program_invocation_short_name);
fputs(USAGE_OPTIONS, out);
fputs(_(" -a, --algorithm lzo|lz4 compression algorithm to use\n"), out);
fputs(_(" -b, --bytes print sizes in bytes rather than in human readable format\n"), out);
fputs(_(" -f, --find find a free device\n"), out);
fputs(_(" -n, --noheadings don't print headings\n"), out);
fputs(_(" -o, --output <list> columns to use for status output\n"), out);
fputs(_(" --raw use raw status output format\n"), out);
fputs(_(" -r, --reset reset all specified devices\n"), out);
fputs(_(" -s, --size <size> device size\n"), out);
fputs(_(" -t, --streams <number> number of compression streams\n"), out);
fputs(USAGE_SEPARATOR, out);
fputs(USAGE_HELP, out);
fputs(USAGE_VERSION, out);
fputs(_("\nAvailable columns (for --output):\n"), out);
for (i = 0; i < ARRAY_SIZE(infos); i++)
fprintf(out, " %11s %s\n", infos[i].name, _(infos[i].help));
fprintf(out, USAGE_MAN_TAIL("zramctl(8)"));
exit(out == stderr ? 1 : EXIT_SUCCESS);
}
/* actions */
enum {
A_NONE = 0,
A_STATUS,
A_CREATE,
A_FINDONLY,
A_RESET
};
int main(int argc, char **argv)
{
uintmax_t size = 0, nstreams = 0;
char *algorithm = NULL;
int rc = 0, c, find = 0, act = A_NONE;
struct zram *zram = NULL;
enum { OPT_RAW = CHAR_MAX + 1 };
static const struct option longopts[] = {
{ "algorithm", required_argument, NULL, 'a' },
{ "bytes", no_argument, NULL, 'b' },
{ "find", no_argument, NULL, 'f' },
{ "help", no_argument, NULL, 'h' },
{ "output", required_argument, NULL, 'o' },
{ "noheadings",no_argument, NULL, 'n' },
{ "reset", no_argument, NULL, 'r' },
{ "raw", no_argument, NULL, OPT_RAW },
{ "size", required_argument, NULL, 's' },
{ "streams", required_argument, NULL, 't' },
{ "version", no_argument, NULL, 'V' },
{ NULL, 0, NULL, 0 }
};
static const ul_excl_t excl[] = {
{ 'f', 'o', 'r' },
{ 'o', 'r', 's' },
{ 0 }
};
int excl_st[ARRAY_SIZE(excl)] = UL_EXCL_STATUS_INIT;
setlocale(LC_ALL, "");
bindtextdomain(PACKAGE, LOCALEDIR);
textdomain(PACKAGE);
atexit(close_stdout);
while ((c = getopt_long(argc, argv, "a:bfho:nrs:t:V", longopts, NULL)) != -1) {
err_exclusive_options(c, longopts, excl, excl_st);
switch (c) {
case 'a':
if (strcmp(optarg,"lzo") && strcmp(optarg,"lz4"))
errx(EXIT_FAILURE, _("unsupported algorithm: %s"),
optarg);
algorithm = optarg;
break;
case 'b':
inbytes = 1;
break;
case 'f':
find = 1;
break;
case 'o':
ncolumns = string_to_idarray(optarg,
columns, ARRAY_SIZE(columns),
column_name_to_id);
if (ncolumns < 0)
return EXIT_FAILURE;
break;
case 's':
size = strtosize_or_err(optarg, _("failed to parse size"));
act = A_CREATE;
break;
case 't':
nstreams = strtou64_or_err(optarg, _("failed to parse streams"));
break;
case 'r':
act = A_RESET;
break;
case OPT_RAW:
raw = 1;
break;
case 'n':
no_headings = 1;
break;
case 'V':
printf(UTIL_LINUX_VERSION);
return EXIT_SUCCESS;
case 'h':
usage(stdout);
default:
usage(stderr);
}
}
if (find && optind < argc)
errx(EXIT_FAILURE, _("option --find is mutually exclusive "
"with <device>"));
if (act == A_NONE)
act = find ? A_FINDONLY : A_STATUS;
if (act != A_RESET && optind + 1 < argc)
errx(EXIT_FAILURE, _("only one <device> at a time is allowed"));
if ((act == A_STATUS || act == A_FINDONLY) && (algorithm || nstreams))
errx(EXIT_FAILURE, _("options --algorithm and --streams "
"must be combined with --size"));
switch (act) {
case A_STATUS:
if (!ncolumns) { /* default columns */
columns[ncolumns++] = COL_NAME;
columns[ncolumns++] = COL_ALGORITHM;
columns[ncolumns++] = COL_DISKSIZE;
columns[ncolumns++] = COL_ORIG_SIZE;
columns[ncolumns++] = COL_COMP_SIZE;
columns[ncolumns++] = COL_MEMTOTAL;
columns[ncolumns++] = COL_STREAMS;
columns[ncolumns++] = COL_MOUNTPOINT;
}
if (optind < argc) {
zram = new_zram(argv[optind++]);
if (!zram_exist(zram))
err(EXIT_FAILURE, "%s", zram->devname);
}
status(zram);
free_zram(zram);
break;
case A_RESET:
if (optind == argc)
errx(EXIT_FAILURE, _("no device specified"));
while (optind < argc) {
zram = new_zram(argv[optind]);
if (!zram_exist(zram)
|| zram_set_u64parm(zram, "reset", 1)) {
warn(_("%s: failed to reset"), zram->devname);
rc = 1;
}
free_zram(zram);
optind++;
}
break;
case A_FINDONLY:
zram = find_free_zram();
if (!zram)
errx(EXIT_FAILURE, _("no free zram device found"));
printf("%s\n", zram->devname);
free_zram(zram);
break;
case A_CREATE:
if (find) {
zram = find_free_zram();
if (!zram)
errx(EXIT_FAILURE, _("no free zram device found"));
} else if (optind == argc)
errx(EXIT_FAILURE, _("no device specified"));
else {
zram = new_zram(argv[optind]);
if (!zram_exist(zram))
err(EXIT_FAILURE, "%s", zram->devname);
}
if (zram_set_u64parm(zram, "reset", 1))
err(EXIT_FAILURE, _("%s: failed to reset"), zram->devname);
if (nstreams &&
zram_set_u64parm(zram, "max_comp_streams", nstreams))
err(EXIT_FAILURE, _("%s: failed to set number of streams"), zram->devname);
if (algorithm &&
zram_set_strparm(zram, "comp_algorithm", algorithm))
err(EXIT_FAILURE, _("%s: failed to set algorithm"), zram->devname);
if (zram_set_u64parm(zram, "disksize", size))
err(EXIT_FAILURE, _("%s: failed to set disksize (%ju bytes)"),
zram->devname, size);
if (find)
printf("%s\n", zram->devname);
free_zram(zram);
break;
}
return rc ? EXIT_FAILURE : EXIT_SUCCESS;
}
|