qt-creator/src/tools/clangrefactoringbackend/source/symbolindexer.cpp

/****************************************************************************
**
** Copyright (C) 2017 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of Qt Creator.
**
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and The Qt Company. For licensing terms
** and conditions see https://www.qt.io/terms-conditions. For further
** information use the contact form at https://www.qt.io/contact-us.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 3 as published by the Free Software
** Foundation with exceptions as appearing in the file LICENSE.GPL3-EXCEPT
** included in the packaging of this file. Please review the following
** information to ensure the GNU General Public License requirements will
** be met: https://www.gnu.org/licenses/gpl-3.0.html.
**
****************************************************************************/

#include "symbolindexer.h"

#include <symbolscollectorinterface.h>
#include <symbolindexertaskqueue.h>

#include <chrono>
#include <iostream>

namespace ClangBackEnd {

using namespace std::chrono;

class Timer
{
public:
    Timer(Utils::SmallStringView name)
        : name(name)
    {}

    void commit()
    {
        auto end = steady_clock::now();
        auto time_difference = duration_cast<milliseconds>(end - begin);
        begin = end;
        std::cerr << name << " " << timePoint++ << ": " << time_difference.count() << "\n";
    }

private:
    Utils::SmallString name;
    time_point<steady_clock> begin{steady_clock::now()};
    int timePoint = 1;
};

SymbolIndexer::SymbolIndexer(SymbolIndexerTaskQueueInterface &symbolIndexerTaskQueue,
                             SymbolStorageInterface &symbolStorage,
                             ClangPathWatcherInterface &pathWatcher,
                             FilePathCachingInterface &filePathCache,
                             FileStatusCache &fileStatusCache,
                             Sqlite::TransactionInterface &transactionInterface)
    : m_symbolIndexerTaskQueue(symbolIndexerTaskQueue),
      m_symbolStorage(symbolStorage),
      m_pathWatcher(pathWatcher),
      m_filePathCache(filePathCache),
      m_fileStatusCache(fileStatusCache),
      m_transactionInterface(transactionInterface)
{
    pathWatcher.setNotifier(this);
}

void SymbolIndexer::updateProjectParts(V2::ProjectPartContainers &&projectParts)
{
        for (V2::ProjectPartContainer &projectPart : projectParts)
            updateProjectPart(std::move(projectPart));
}

void SymbolIndexer::updateProjectPart(V2::ProjectPartContainer &&projectPart)
{
    Sqlite::ImmediateTransaction transaction{m_transactionInterface};
    const auto optionalArtefact = m_symbolStorage.fetchProjectPartArtefact(projectPart.projectPartId);
    int projectPartId = m_symbolStorage.insertOrUpdateProjectPart(projectPart.projectPartId,
                                                                  projectPart.arguments,
                                                                  projectPart.compilerMacros,
                                                                  projectPart.includeSearchPaths);
    if (optionalArtefact)
        projectPartId = optionalArtefact->projectPartId;
    const Utils::optional<ProjectPartPch> optionalProjectPartPch = m_symbolStorage.fetchPrecompiledHeader(projectPartId);

    FilePathIds sourcePathIds = updatableFilePathIds(projectPart, optionalArtefact);
    transaction.commit();
    if (sourcePathIds.empty())
        return;

    const Utils::SmallStringVector arguments = compilerArguments(projectPart.arguments,
                                                                 optionalProjectPartPch);

    std::vector<SymbolIndexerTask> symbolIndexerTask;
    symbolIndexerTask.reserve(projectPart.sourcePathIds.size());
    for (FilePathId sourcePathId : projectPart.sourcePathIds) {
        auto indexing = [projectPartId, arguments, sourcePathId, this]
                (SymbolsCollectorInterface &symbolsCollector) {
            symbolsCollector.setFile(sourcePathId, arguments);

            symbolsCollector.collectSymbols();

            Sqlite::ImmediateTransaction transaction{m_transactionInterface};

            m_symbolStorage.addSymbolsAndSourceLocations(symbolsCollector.symbols(),
                                                         symbolsCollector.sourceLocations());

            m_symbolStorage.updateProjectPartSources(projectPartId,
                                                     symbolsCollector.sourceFiles());

            m_symbolStorage.insertOrUpdateUsedMacros(symbolsCollector.usedMacros());

            m_symbolStorage.insertFileStatuses(symbolsCollector.fileStatuses());

            m_symbolStorage.insertOrUpdateSourceDependencies(symbolsCollector.sourceDependencies());

            transaction.commit();
        };

        symbolIndexerTask.emplace_back(sourcePathId, projectPartId, std::move(indexing));
    }

    m_symbolIndexerTaskQueue.addOrUpdateTasks(std::move(symbolIndexerTask));
    m_symbolIndexerTaskQueue.processEntries();
}

void SymbolIndexer::pathsWithIdsChanged(const Utils::SmallStringVector &)
{
}

void SymbolIndexer::pathsChanged(const FilePathIds &filePathIds)
{
    std::vector<SymbolIndexerTask> symbolIndexerTask;
    symbolIndexerTask.reserve(filePathIds.size());

    for (FilePathId filePathId : filePathIds)
        updateChangedPath(filePathId, symbolIndexerTask);

    m_symbolIndexerTaskQueue.addOrUpdateTasks(std::move(symbolIndexerTask));
    m_symbolIndexerTaskQueue.processEntries();
}

void SymbolIndexer::updateChangedPath(FilePathId filePathId,
                                      std::vector<SymbolIndexerTask> &symbolIndexerTask)
{
    m_fileStatusCache.update(filePathId);

    Sqlite::DeferredTransaction transaction{m_transactionInterface};
    const Utils::optional<ProjectPartArtefact> optionalArtefact = m_symbolStorage.fetchProjectPartArtefact(filePathId);
    if (!optionalArtefact)
        return;

    const Utils::optional<ProjectPartPch> optionalProjectPartPch = m_symbolStorage.fetchPrecompiledHeader(optionalArtefact->projectPartId);
    transaction.commit();

    if (!optionalArtefact.value().compilerArguments.empty()) {

        const ProjectPartArtefact &artefact = optionalArtefact.value();

        const Utils::SmallStringVector arguments = compilerArguments(artefact.compilerArguments,
                                                                     optionalProjectPartPch);

        auto indexing = [projectPartId=artefact.projectPartId, arguments, filePathId, this]
                (SymbolsCollectorInterface &symbolsCollector) {
            symbolsCollector.setFile(filePathId, arguments);

            symbolsCollector.collectSymbols();

            Sqlite::ImmediateTransaction transaction{m_transactionInterface};

            m_symbolStorage.addSymbolsAndSourceLocations(symbolsCollector.symbols(),
                                                         symbolsCollector.sourceLocations());

            m_symbolStorage.updateProjectPartSources(projectPartId, symbolsCollector.sourceFiles());

            m_symbolStorage.insertOrUpdateUsedMacros(symbolsCollector.usedMacros());

            m_symbolStorage.insertFileStatuses(symbolsCollector.fileStatuses());

            m_symbolStorage.insertOrUpdateSourceDependencies(symbolsCollector.sourceDependencies());

            transaction.commit();
        };

        symbolIndexerTask.emplace_back(filePathId, optionalArtefact->projectPartId, std::move(indexing));
    }
}

bool SymbolIndexer::compilerMacrosOrIncludeSearchPathsAreDifferent(
        const V2::ProjectPartContainer &projectPart,
        const Utils::optional<ProjectPartArtefact> &optionalArtefact) const
{
    if (optionalArtefact) {
        const ProjectPartArtefact &artefact = optionalArtefact.value();
        return projectPart.compilerMacros != artefact.compilerMacros
             || projectPart.includeSearchPaths != artefact.includeSearchPaths;
    }

    return true;
}

FilePathIds SymbolIndexer::filterChangedFiles(const V2::ProjectPartContainer &projectPart) const
{
    FilePathIds ids;
    ids.reserve(projectPart.sourcePathIds.size());

    for (const FilePathId &sourceId : projectPart.sourcePathIds) {
        long long oldLastModified = m_symbolStorage.fetchLowestLastModifiedTime(sourceId);
        long long currentLastModified =  m_fileStatusCache.lastModifiedTime(sourceId);
        if (oldLastModified < currentLastModified)
            ids.push_back(sourceId);
    }

    return ids;
}

FilePathIds SymbolIndexer::updatableFilePathIds(const V2::ProjectPartContainer &projectPart,
                                                const Utils::optional<ProjectPartArtefact> &optionalArtefact) const
{
    if (compilerMacrosOrIncludeSearchPathsAreDifferent(projectPart, optionalArtefact))
        return projectPart.sourcePathIds;

    return filterChangedFiles(projectPart);
}

Utils::SmallStringVector SymbolIndexer::compilerArguments(
        Utils::SmallStringVector arguments,
        const Utils::optional<ProjectPartPch> optionalProjectPartPch) const
{
    if (optionalProjectPartPch) {
        arguments.emplace_back("-Xclang");
        arguments.emplace_back("-include-pch");
        arguments.emplace_back("-Xclang");
        arguments.emplace_back(std::move(optionalProjectPartPch.value().pchPath));
    }

    return arguments;
}

} // namespace ClangBackEnd