include/tst_module.h

/*
 * Copyright (c) 2013 Oracle and/or its affiliates. All Rights Reserved.
 *
 * 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; either version 2 of
 * the License, or (at your option) any later version.
 *
 * 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 the Free Software Foundation,
 * Inc.,  51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 *
 * Author:
 * Alexey Kodanev <alexey.kodanev@oracle.com>
 *
 * These functions help to load and unload kernel modules in the tests.
 *
 * tst_module_load function already includes tst_module_exists function,
 * which is checking the following possible module's locations:
 *
 * 1. Current working directory
 *
 * 2. LTP installation path (using env LTPROOT, which is usually /opt/ltp)
 *
 * 3. If tmp directory created, it'll look at the test start working directory
 *
 */

#ifndef TST_MODULE
#define TST_MODULE

/*
 * Check module existence.
 *
 * @mod_name: module's file name.
 * @mod_path: if it is not NULL, then tst_module_exists places the found
 * module's path into the location pointed to by *mod_path. It must be freed
 * with free() when it is no longer needed.
 *
 * In case of failure, test'll call cleanup_fn and exit with TCONF return value.
 */
void tst_module_exist(void (cleanup_fn)(void), const char *mod_name,
	char **mod_path);

/*
 * Load a module using insmod program.
 *
 * @mod_name: module's file name.
 * @argv: an array of pointers to null-terminated strings that represent the
 * additional parameters to the module. The array of pointers  must be
 * terminated by a NULL pointer. If argv points to NULL, it will be ignored.
 *
 * In case of insmod failure, test will call cleanup_fn and exit with TBROK
 * return value.
 */
void tst_module_load(void (cleanup_fn)(void),
	const char *mod_name, char *const argv[]);

/*
 * Unload a module using rmmod program. In case of failure, test will call
 * cleanup_fn and exit with TBROK return value.
 *
 * @mod_name: can be module name or module's file name.
 */
void tst_module_unload(void (cleanup_fn)(void), const char *mod_name);

#endif /* TST_MODULE */