libmodprobe/include/modprobe/modprobe.h

/*
 * Copyright (C) 2018 The Android Open Source Project
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

#pragma once

#include <modprobe/module_config.h>

#include <atomic>
#include <mutex>
#include <set>
#include <string>
#include <unordered_map>
#include <unordered_set>
#include <vector>

#include <android-base/thread_annotations.h>

class Modprobe {
  public:
    Modprobe(const std::vector<std::string>&, const std::string load_file = "modules.load",
             bool use_blocklist = true);
    Modprobe(ModuleConfig config, bool use_blocklist = true);

    bool LoadModulesParallel(int num_threads) EXCLUDES(module_loaded_lock_);
    bool LoadListedModules(bool strict = true);
    bool LoadWithAliases(const std::string& module_name, bool strict,
                         const std::string& parameters = "") EXCLUDES(module_loaded_lock_);
    bool Remove(const std::string& module_name);
    std::vector<std::string> ListModules(const std::string& pattern);
    bool GetAllDependencies(const std::string& module, std::vector<std::string>* pre_dependencies,
                            std::vector<std::string>* dependencies,
                            std::vector<std::string>* post_dependencies);
    int GetModuleCount() { return module_count_; }
    bool IsBlocklisted(const std::string& module_name);

  private:
    bool InsmodWithDeps(const std::string& module_name, const std::string& parameters);
    bool Insmod(const std::string& path_name, const std::string& parameters)
            EXCLUDES(module_loaded_lock_);
    bool Rmmod(const std::string& module_name) EXCLUDES(module_loaded_lock_);
    std::vector<std::string> GetDependencies(const std::string& module);
    bool ModuleExists(const std::string& module_name);

    // These non const fields are initialized by the constructor and never be modified.
    std::vector<std::pair<std::string, std::string>> module_aliases_;
    std::unordered_map<std::string, std::vector<std::string>> module_deps_;
    std::vector<std::pair<std::string, std::string>> module_pre_softdep_;
    std::vector<std::pair<std::string, std::string>> module_post_softdep_;
    std::vector<std::string> module_load_;
    std::unordered_map<std::string, std::string> module_options_;
    std::set<std::string> module_blocklist_;

    std::mutex module_loaded_lock_;
    std::unordered_set<std::string> module_loaded_ GUARDED_BY(module_loaded_lock_);
    std::unordered_set<std::string> module_loaded_paths_ GUARDED_BY(module_loaded_lock_);
    std::atomic_int module_count_ = 0;
    const bool blocklist_enabled = false;
};