process_spawn.h

Go to the documentation of this file.

// Copyright (C) 2015-2026 Internet Systems Consortium, Inc. ("ISC")
//
// This Source Code Form is subject to the terms of the Mozilla Public
// License, v. 2.0. If a copy of the MPL was not distributed with this
// file, You can obtain one at http://mozilla.org/MPL/2.0/.
 
#ifndef PROCESS_SPAWN_H
#define PROCESS_SPAWN_H
 
#include <asiolink/io_service.h>
#include <exceptions/exceptions.h>
 
#include <cstdint>
#include <string>
#include <unordered_set>
#include <vector>
 
#include <boost/noncopyable.hpp>
#include <boost/shared_ptr.hpp>
 
#include <sys/types.h>
 
namespace isc {
namespace asiolink {

class ProcessSpawnError : public Exception {
public:
    ProcessSpawnError(const char* file, size_t line, const char* what) :
        isc::Exception(file, line, what) { }
};

class ProcessSpawnImpl;

typedef boost::shared_ptr<ProcessSpawnImpl> ProcessSpawnImplPtr;

typedef std::vector<std::string> ProcessArgs;

typedef std::vector<std::string> ProcessEnvVars;

class ProcessSpawn : boost::noncopyable {
public:

    enum SpawnMode : uint16_t {
       ASYNC, // thread continues without waiting for the child to finish.
       SYNC   // thread waits for the child to finish.
    };

    ProcessSpawn(const SpawnMode mode,
                 const std::string& executable,
                 const ProcessArgs& args = ProcessArgs(),
                 const ProcessEnvVars& vars = ProcessEnvVars(),
                 const bool inherit_env = false);

    ~ProcessSpawn() = default;

    std::string getCommandLine(std::unordered_set<std::string> redact_args = {}) const;

    pid_t spawn(bool dismiss = false);

    bool isRunning(const pid_t pid) const;

    bool isAnyRunning() const;

    int getExitStatus(const pid_t pid) const;

    void clearState(const pid_t pid);

    static isc::asiolink::IOServicePtr getIOService() {
        return (io_service_);
    }

    static void setIOService(isc::asiolink::IOServicePtr io_service) {
        io_service_ = io_service;
    }
 
private:

    static isc::asiolink::IOServicePtr io_service_;

    ProcessSpawnImplPtr impl_;
};
 
} // namespace asiolink
} // namespace isc
 
#endif // PROCESS_SPAWN_H