// Copyright 2017-2018 ccls Authors // SPDX-License-Identifier: Apache-2.0 #include "pipeline.hh" #include "clang_complete.hh" #include "config.hh" #include "include_complete.hh" #include "log.hh" #include "lsp.hh" #include "match.hh" #include "message_handler.hh" #include "pipeline.hh" #include "platform.hh" #include "project.hh" #include "query_utils.hh" #include "serializers/json.hh" #include #include #include #include #include using namespace llvm; #include #include #include #include #ifndef _WIN32 #include #endif namespace ccls { namespace { struct PublishDiagnosticParam { DocumentUri uri; std::vector diagnostics; }; MAKE_REFLECT_STRUCT(PublishDiagnosticParam, uri, diagnostics); } // namespace void VFS::Clear() { std::lock_guard lock(mutex); state.clear(); } bool VFS::Loaded(const std::string &path) { std::lock_guard lock(mutex); return state[path].loaded; } bool VFS::Stamp(const std::string &path, int64_t ts, int step) { std::lock_guard lock(mutex); State &st = state[path]; if (st.timestamp < ts || (st.timestamp == ts && st.step < step)) { st.timestamp = ts; st.step = step; return true; } else return false; } struct MessageHandler; void StandaloneInitialize(MessageHandler &, const std::string &root); namespace pipeline { std::atomic loaded_ts = ATOMIC_VAR_INIT(0), pending_index_requests = ATOMIC_VAR_INIT(0); int64_t tick = 0; namespace { struct Index_Request { std::string path; std::vector args; IndexMode mode; RequestId id; int64_t ts = tick++; }; MultiQueueWaiter *main_waiter; MultiQueueWaiter *indexer_waiter; MultiQueueWaiter *stdout_waiter; ThreadedQueue *on_request; ThreadedQueue *index_request; ThreadedQueue *on_indexed; ThreadedQueue *for_stdout; struct InMemoryIndexFile { std::string content; IndexFile index; }; std::shared_mutex g_index_mutex; std::unordered_map g_index; bool CacheInvalid(VFS *vfs, IndexFile *prev, const std::string &path, const std::vector &args, const std::optional &from) { { std::lock_guard lock(vfs->mutex); if (prev->mtime < vfs->state[path].timestamp) { LOG_S(INFO) << "timestamp changed for " << path << (from ? " (via " + *from + ")" : std::string()); return true; } } bool changed = prev->args.size() != args.size(); for (size_t i = 0; !changed && i < args.size(); i++) if (strcmp(prev->args[i], args[i])) changed = true; if (changed) LOG_S(INFO) << "args changed for " << path << (from ? " (via " + *from + ")" : std::string()); return changed; }; std::string AppendSerializationFormat(const std::string &base) { switch (g_config->cacheFormat) { case SerializeFormat::Binary: return base + ".blob"; case SerializeFormat::Json: return base + ".json"; } } std::string GetCachePath(const std::string &source_file) { for (auto &root : g_config->workspaceFolders) if (StringRef(source_file).startswith(root)) { auto len = root.size(); return g_config->cacheDirectory + EscapeFileName(root.substr(0, len - 1)) + '/' + EscapeFileName(source_file.substr(len)); } return g_config->cacheDirectory + '@' + EscapeFileName(g_config->fallbackFolder.substr( 0, g_config->fallbackFolder.size() - 1)) + '/' + EscapeFileName(source_file); } std::unique_ptr RawCacheLoad(const std::string &path) { if (g_config->cacheDirectory.empty()) { std::shared_lock lock(g_index_mutex); auto it = g_index.find(path); if (it == g_index.end()) return nullptr; return std::make_unique(it->second.index); } std::string cache_path = GetCachePath(path); std::optional file_content = ReadContent(cache_path); std::optional serialized_indexed_content = ReadContent(AppendSerializationFormat(cache_path)); if (!file_content || !serialized_indexed_content) return nullptr; return ccls::Deserialize(g_config->cacheFormat, path, *serialized_indexed_content, *file_content, IndexFile::kMajorVersion); } std::mutex &GetFileMutex(const std::string &path) { const int N_MUTEXES = 256; static std::mutex mutexes[N_MUTEXES]; return mutexes[std::hash()(path) % N_MUTEXES]; } bool Indexer_Parse(CompletionManager *completion, WorkingFiles *wfiles, Project *project, VFS *vfs, const GroupMatch &matcher) { std::optional opt_request = index_request->TryPopFront(); if (!opt_request) return false; auto &request = *opt_request; bool loud = request.mode != IndexMode::OnChange; struct RAII { ~RAII() { pending_index_requests--; } } raii; // Dummy one to trigger refresh semantic highlight. if (request.path.empty()) { IndexUpdate dummy; dummy.refresh = true; on_indexed->PushBack(std::move(dummy), false); return false; } if (!matcher.IsMatch(request.path)) { LOG_IF_S(INFO, loud) << "skip " << request.path; return false; } Project::Entry entry = project->FindEntry(request.path, true); if (request.args.size()) entry.args = request.args; std::string path_to_index = entry.filename; std::unique_ptr prev; std::optional write_time = LastWriteTime(path_to_index); if (!write_time) return true; int reparse = vfs->Stamp(path_to_index, *write_time, 0); if (request.path != path_to_index) { std::optional mtime1 = LastWriteTime(request.path); if (!mtime1) return true; if (vfs->Stamp(request.path, *mtime1, 0)) reparse = 2; } if (g_config->index.onChange) { reparse = 2; std::lock_guard lock(vfs->mutex); vfs->state[path_to_index].step = 0; if (request.path != path_to_index) vfs->state[request.path].step = 0; } bool track = g_config->index.trackDependency > 1 || (g_config->index.trackDependency == 1 && request.ts < loaded_ts); if (!reparse && !track) return true; if (reparse < 2) do { std::unique_lock lock(GetFileMutex(path_to_index)); prev = RawCacheLoad(path_to_index); if (!prev || CacheInvalid(vfs, prev.get(), path_to_index, entry.args, std::nullopt)) break; if (track) for (const auto &dep : prev->dependencies) { if (auto mtime1 = LastWriteTime(dep.first.val().str())) { if (dep.second < *mtime1) { reparse = 2; break; } } else { reparse = 2; break; } } if (reparse == 0) return true; if (reparse == 2) break; if (vfs->Loaded(path_to_index)) return true; LOG_S(INFO) << "load cache for " << path_to_index; auto dependencies = prev->dependencies; IndexUpdate update = IndexUpdate::CreateDelta(nullptr, prev.get()); on_indexed->PushBack(std::move(update), request.mode != IndexMode::NonInteractive); { std::lock_guard lock1(vfs->mutex); vfs->state[path_to_index].loaded = true; } lock.unlock(); for (const auto &dep : dependencies) { std::string path = dep.first.val().str(); if (!vfs->Stamp(path, dep.second, 1)) continue; std::lock_guard lock1(GetFileMutex(path)); prev = RawCacheLoad(path); if (!prev) continue; { std::lock_guard lock2(vfs->mutex); VFS::State &st = vfs->state[path]; if (st.loaded) continue; st.loaded = true; st.timestamp = prev->mtime; } IndexUpdate update = IndexUpdate::CreateDelta(nullptr, prev.get()); on_indexed->PushBack(std::move(update), request.mode != IndexMode::NonInteractive); if (entry.id >= 0) { std::lock_guard lock2(project->mutex_); project->root2folder[entry.root].path2entry_index[path] = entry.id; } } return true; } while (0); LOG_IF_S(INFO, loud) << "parse " << path_to_index; std::vector> remapped; if (g_config->index.onChange) { std::string content = wfiles->GetContent(path_to_index); if (content.size()) remapped.emplace_back(path_to_index, content); } bool ok; auto indexes = idx::Index(completion, wfiles, vfs, entry.directory, path_to_index, entry.args, remapped, ok); if (!ok) { if (request.id.Valid()) { ResponseError err; err.code = ErrorCode::InternalError; err.message = "failed to index " + path_to_index; pipeline::ReplyError(request.id, err); } return true; } for (std::unique_ptr &curr : indexes) { std::string path = curr->path; if (!matcher.IsMatch(path)) { LOG_IF_S(INFO, loud) << "skip index for " << path; continue; } LOG_IF_S(INFO, loud) << "store index for " << path << " (delta: " << !!prev << ")"; { std::lock_guard lock(GetFileMutex(path)); if (vfs->Loaded(path)) prev = RawCacheLoad(path); else prev.reset(); if (g_config->cacheDirectory.empty()) { std::lock_guard lock(g_index_mutex); auto it = g_index.insert_or_assign( path, InMemoryIndexFile{curr->file_contents, *curr}); std::string().swap(it.first->second.index.file_contents); } else { std::string cache_path = GetCachePath(path); WriteToFile(cache_path, curr->file_contents); WriteToFile(AppendSerializationFormat(cache_path), Serialize(g_config->cacheFormat, *curr)); } on_indexed->PushBack(IndexUpdate::CreateDelta(prev.get(), curr.get()), request.mode != IndexMode::NonInteractive); { std::lock_guard lock1(vfs->mutex); vfs->state[path].loaded = true; } if (entry.id >= 0) { std::lock_guard lock(project->mutex_); auto &folder = project->root2folder[entry.root]; for (auto &dep : curr->dependencies) folder.path2entry_index[dep.first.val().str()] = entry.id; } } } return true; } } // namespace void Init() { main_waiter = new MultiQueueWaiter; on_request = new ThreadedQueue(main_waiter); on_indexed = new ThreadedQueue(main_waiter); indexer_waiter = new MultiQueueWaiter; index_request = new ThreadedQueue(indexer_waiter); stdout_waiter = new MultiQueueWaiter; for_stdout = new ThreadedQueue(stdout_waiter); } void Indexer_Main(CompletionManager *completion, VFS *vfs, Project *project, WorkingFiles *wfiles) { GroupMatch matcher(g_config->index.whitelist, g_config->index.blacklist); while (true) if (!Indexer_Parse(completion, wfiles, project, vfs, matcher)) indexer_waiter->Wait(index_request); } void Main_OnIndexed(DB *db, WorkingFiles *wfiles, IndexUpdate *update) { if (update->refresh) { LOG_S(INFO) << "loaded project. Refresh semantic highlight for all working file."; std::lock_guard lock(wfiles->files_mutex); for (auto &f : wfiles->files) { std::string filename = LowerPathIfInsensitive(f->filename); if (db->name2file_id.find(filename) == db->name2file_id.end()) continue; QueryFile &file = db->files[db->name2file_id[filename]]; EmitSemanticHighlight(db, f.get(), file); } return; } static Timer timer("apply", "apply index"); timer.startTimer(); db->ApplyIndexUpdate(update); timer.stopTimer(); // Update indexed content, skipped ranges, and semantic highlighting. if (update->files_def_update) { auto &def_u = *update->files_def_update; if (WorkingFile *wfile = wfiles->GetFileByFilename(def_u.first.path)) { // FIXME With index.onChange: true, use buffer_content only for // request.path wfile->SetIndexContent(g_config->index.onChange ? wfile->buffer_content : def_u.second); QueryFile &file = db->files[update->file_id]; EmitSkippedRanges(wfile, file); EmitSemanticHighlight(db, wfile, file); } } } void LaunchStdin() { std::thread([]() { set_thread_name("stdin"); std::string str; while (true) { constexpr std::string_view kContentLength("Content-Length: "); int len = 0; str.clear(); while (true) { int c = getchar(); if (c == EOF) return; if (c == '\n') { if (str.empty()) break; if (!str.compare(0, kContentLength.size(), kContentLength)) len = atoi(str.c_str() + kContentLength.size()); str.clear(); } else if (c != '\r') { str += c; } } str.resize(len); for (int i = 0; i < len; ++i) { int c = getchar(); if (c == EOF) return; str[i] = c; } auto message = std::make_unique(len); std::copy(str.begin(), str.end(), message.get()); auto document = std::make_unique(); document->Parse(message.get(), len); assert(!document->HasParseError()); JsonReader reader{document.get()}; if (!reader.HasMember("jsonrpc") || std::string(reader["jsonrpc"]->GetString()) != "2.0") return; RequestId id; std::string method; ReflectMember(reader, "id", id); ReflectMember(reader, "method", method); auto param = std::make_unique(); on_request->PushBack( {id, std::move(method), std::move(message), std::move(document)}); if (method == "exit") break; } }) .detach(); } void LaunchStdout() { std::thread([=]() { set_thread_name("stdout"); while (true) { std::vector messages = for_stdout->DequeueAll(); for (auto &s : messages) { llvm::outs() << "Content-Length: " << s.size() << "\r\n\r\n" << s; llvm::outs().flush(); } stdout_waiter->Wait(for_stdout); } }) .detach(); } void MainLoop() { Project project; WorkingFiles wfiles; VFS vfs; CompletionManager clang_complete( &project, &wfiles, [&](std::string path, std::vector diagnostics) { PublishDiagnosticParam params; params.uri = DocumentUri::FromPath(path); params.diagnostics = diagnostics; Notify("textDocument/publishDiagnostics", params); }, [](RequestId id) { if (id.Valid()) { ResponseError err; err.code = ErrorCode::InternalError; err.message = "drop older completion request"; ReplyError(id, err); } }); IncludeComplete include_complete(&project); DB db; // Setup shared references. MessageHandler handler; handler.db = &db; handler.project = &project; handler.vfs = &vfs; handler.wfiles = &wfiles; handler.clang_complete = &clang_complete; handler.include_complete = &include_complete; bool has_indexed = false; while (true) { std::vector messages = on_request->DequeueAll(); bool did_work = messages.size(); for (InMessage &message : messages) handler.Run(message); bool indexed = false; for (int i = 20; i--;) { std::optional update = on_indexed->TryPopFront(); if (!update) break; did_work = true; indexed = true; Main_OnIndexed(&db, &wfiles, &*update); } if (did_work) has_indexed |= indexed; else { if (has_indexed) { FreeUnusedMemory(); has_indexed = false; } main_waiter->Wait(on_indexed, on_request); } } } void Standalone(const std::string &root) { Project project; WorkingFiles wfiles; VFS vfs; IncludeComplete complete(&project); MessageHandler handler; handler.project = &project; handler.wfiles = &wfiles; handler.vfs = &vfs; handler.include_complete = &complete; StandaloneInitialize(handler, root); bool tty = sys::Process::StandardOutIsDisplayed(); if (tty) { int entries = 0; for (auto &[_, folder] : project.root2folder) entries += folder.entries.size(); printf("entries: %5d\n", entries); } while (1) { (void)on_indexed->DequeueAll(); int pending = pending_index_requests; if (tty) { printf("\rpending: %5d", pending); fflush(stdout); } if (!pending) break; std::this_thread::sleep_for(std::chrono::milliseconds(100)); } if (tty) puts(""); } void Index(const std::string &path, const std::vector &args, IndexMode mode, RequestId id) { pending_index_requests++; index_request->PushBack({path, args, mode, id}, mode != IndexMode::NonInteractive); } std::optional LoadIndexedContent(const std::string &path) { if (g_config->cacheDirectory.empty()) { std::shared_lock lock(g_index_mutex); auto it = g_index.find(path); if (it == g_index.end()) return {}; return it->second.content; } return ReadContent(GetCachePath(path)); } void Notify(const char *method, const std::function &fn) { rapidjson::StringBuffer output; rapidjson::Writer w(output); w.StartObject(); w.Key("jsonrpc"); w.String("2.0"); w.Key("method"); w.String(method); w.Key("params"); JsonWriter writer(&w); fn(writer); w.EndObject(); for_stdout->PushBack(output.GetString()); } static void Reply(RequestId id, const char *key, const std::function &fn) { rapidjson::StringBuffer output; rapidjson::Writer w(output); w.StartObject(); w.Key("jsonrpc"); w.String("2.0"); w.Key("id"); switch (id.type) { case RequestId::kNone: w.Null(); break; case RequestId::kInt: w.Int(id.value); break; case RequestId::kString: auto s = std::to_string(id.value); w.String(s.c_str(), s.length()); break; } w.Key(key); JsonWriter writer(&w); fn(writer); w.EndObject(); for_stdout->PushBack(output.GetString()); } void Reply(RequestId id, const std::function &fn) { Reply(id, "result", fn); } void ReplyError(RequestId id, const std::function &fn) { Reply(id, "error", fn); } } // namespace pipeline } // namespace ccls