blob: 972302a187d0d5ede77aac29a9900a59333b35c7 [file] [log] [blame]
Rob Landley0e4690d2006-08-20 22:12:18 +00001/* vi: set sw=4 ts=4: */
2/*
3 * readahead implementation for busybox
4 *
5 * Preloads the given files in RAM, to reduce access time.
6 * Does this by calling the readahead(2) system call.
7 *
8 * Copyright (C) 2006 Michael Opdenacker <michael@free-electrons.com>
9 *
Denys Vlasenko0ef64bd2010-08-16 20:14:46 +020010 * Licensed under GPLv2 or later, see file LICENSE in this source tree.
Rob Landley0e4690d2006-08-20 22:12:18 +000011 */
Denys Vlasenkofb4da162016-11-22 23:14:24 +010012//config:config READAHEAD
Denys Vlasenkoae178ce2017-07-19 14:32:54 +020013//config: bool "readahead (2 kb)"
Denys Vlasenkofb4da162016-11-22 23:14:24 +010014//config: default y
15//config: depends on LFS
16//config: select PLATFORM_LINUX
17//config: help
Denys Vlasenko72089cf2017-07-21 09:50:55 +020018//config: Preload the files listed on the command line into RAM cache so that
19//config: subsequent reads on these files will not block on disk I/O.
Denys Vlasenkofb4da162016-11-22 23:14:24 +010020//config:
Denys Vlasenko72089cf2017-07-21 09:50:55 +020021//config: This applet just calls the readahead(2) system call on each file.
22//config: It is mainly useful in system startup scripts to preload files
23//config: or executables before they are used. When used at the right time
24//config: (in particular when a CPU bound process is running) it can
25//config: significantly speed up system startup.
Denys Vlasenkofb4da162016-11-22 23:14:24 +010026//config:
Denys Vlasenko72089cf2017-07-21 09:50:55 +020027//config: As readahead(2) blocks until each file has been read, it is best to
28//config: run this applet as a background job.
Rob Landley0e4690d2006-08-20 22:12:18 +000029
Denys Vlasenkof88e3bf2016-11-22 23:54:17 +010030//applet:IF_READAHEAD(APPLET(readahead, BB_DIR_USR_SBIN, BB_SUID_DROP))
31
32//kbuild:lib-$(CONFIG_READAHEAD) += readahead.o
33
Pere Orga5bc8c002011-04-11 03:29:49 +020034//usage:#define readahead_trivial_usage
35//usage: "[FILE]..."
36//usage:#define readahead_full_usage "\n\n"
37//usage: "Preload FILEs to RAM"
38
Denis Vlasenkob6adbf12007-05-26 19:00:18 +000039#include "libbb.h"
Rob Landley0e4690d2006-08-20 22:12:18 +000040
Denis Vlasenko9b49a5e2007-10-11 10:05:36 +000041int readahead_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
Denys Vlasenko2ec91ae2010-01-04 14:15:38 +010042int readahead_main(int argc UNUSED_PARAM, char **argv)
Rob Landley0e4690d2006-08-20 22:12:18 +000043{
Rob Landley0e4690d2006-08-20 22:12:18 +000044 int retval = EXIT_SUCCESS;
45
Denys Vlasenko2ec91ae2010-01-04 14:15:38 +010046 if (!argv[1]) {
47 bb_show_usage();
48 }
Rob Landley0e4690d2006-08-20 22:12:18 +000049
50 while (*++argv) {
Denis Vlasenko6bef3d12007-11-06 03:05:54 +000051 int fd = open_or_warn(*argv, O_RDONLY);
52 if (fd >= 0) {
Denis Vlasenkob5c60fc2008-01-27 23:41:34 +000053 off_t len;
54 int r;
55
56 /* fdlength was reported to be unreliable - use seek */
57 len = xlseek(fd, 0, SEEK_END);
58 xlseek(fd, 0, SEEK_SET);
59 r = readahead(fd, 0, len);
Denis Vlasenko6bef3d12007-11-06 03:05:54 +000060 close(fd);
Denis Vlasenkob5c60fc2008-01-27 23:41:34 +000061 if (r >= 0)
62 continue;
Rob Landley0e4690d2006-08-20 22:12:18 +000063 }
64 retval = EXIT_FAILURE;
65 }
66
67 return retval;
68}