diff options
Diffstat (limited to 'src/zenserver/storage/admin/admin.cpp')
| -rw-r--r-- | src/zenserver/storage/admin/admin.cpp | 243 |
1 files changed, 221 insertions, 22 deletions
diff --git a/src/zenserver/storage/admin/admin.cpp b/src/zenserver/storage/admin/admin.cpp index 6e78a6179..1de5f74fe 100644 --- a/src/zenserver/storage/admin/admin.cpp +++ b/src/zenserver/storage/admin/admin.cpp @@ -26,6 +26,60 @@ namespace zen { +#if ZEN_WITH_TRACE +namespace { + // Accept only loopback destinations for admin-triggered trace streams. Handles + // "localhost", "127.0.0.1", "::1", and bracketed IPv6 ("[::1]"), each optionally + // followed by ":<digits>". Rejects any control characters so the value is also + // safe to log. + bool IsLoopbackTraceHost(std::string_view Host) + { + if (Host.empty()) + { + return false; + } + for (char C : Host) + { + if (static_cast<unsigned char>(C) < 0x20 || C == 0x7F) + { + return false; + } + } + + std::string_view HostOnly = Host; + if (HostOnly.front() == '[') + { + const size_t Close = HostOnly.find(']'); + if (Close == std::string_view::npos) + { + return false; + } + const std::string_view Tail = HostOnly.substr(Close + 1); + if (!Tail.empty()) + { + if (Tail.front() != ':' || Tail.size() < 2 || Tail.find_first_not_of("0123456789", 1) != std::string_view::npos) + { + return false; + } + } + HostOnly = HostOnly.substr(1, Close - 1); + } + else if (const size_t Colon = HostOnly.find(':'); + Colon != std::string_view::npos && HostOnly.find(':', Colon + 1) == std::string_view::npos) + { + const std::string_view Port = HostOnly.substr(Colon + 1); + if (Port.empty() || Port.find_first_not_of("0123456789") != std::string_view::npos) + { + return false; + } + HostOnly = HostOnly.substr(0, Colon); + } + + return HostOnly == "localhost" || HostOnly == "127.0.0.1" || HostOnly == "::1"; + } +} // namespace +#endif // ZEN_WITH_TRACE + struct DirStats { uint64_t FileCount = 0; @@ -149,17 +203,13 @@ HttpAdminService::HttpAdminService(GcScheduler& Scheduler, [&](HttpRouterRequest& Req) { const auto& JobIdString = Req.GetCapture(1); std::optional<uint64_t> JobIdArg = ParseInt<uint64_t>(JobIdString); - if (!JobIdArg) - { - Req.ServerRequest().WriteResponse(HttpResponseCode::BadRequest); - } - JobId Id{.Id = JobIdArg.value_or(0)}; - if (Id.Id == 0) + if (!JobIdArg || JobIdArg.value() == 0) { return Req.ServerRequest().WriteResponse(HttpResponseCode::BadRequest, ZenContentType::kText, - fmt::format("Invalid Job Id: {}", Id.Id)); + fmt::format("Invalid Job Id: '{}'", JobIdString)); } + const JobId Id{.Id = JobIdArg.value()}; std::optional<JobQueue::JobDetails> CurrentState = m_BackgroundJobQueue.Get(Id); if (!CurrentState) @@ -271,11 +321,13 @@ HttpAdminService::HttpAdminService(GcScheduler& Scheduler, [&](HttpRouterRequest& Req) { const auto& JobIdString = Req.GetCapture(1); std::optional<uint64_t> JobIdArg = ParseInt<uint64_t>(JobIdString); - if (!JobIdArg) + if (!JobIdArg || JobIdArg.value() == 0) { - Req.ServerRequest().WriteResponse(HttpResponseCode::BadRequest); + return Req.ServerRequest().WriteResponse(HttpResponseCode::BadRequest, + ZenContentType::kText, + fmt::format("Invalid Job Id: '{}'", JobIdString)); } - JobId Id{.Id = JobIdArg.value_or(0)}; + const JobId Id{.Id = JobIdArg.value()}; if (m_BackgroundJobQueue.CancelJob(Id)) { Req.ServerRequest().WriteResponse(HttpResponseCode::OK); @@ -610,11 +662,6 @@ HttpAdminService::HttpAdminService(GcScheduler& Scheduler, const HttpServerRequest::QueryParams Params = HttpReq.GetQueryParams(); TraceOptions TraceOptions; - if (!IsTracing()) - { - TraceInit("zenserver"); - } - if (auto Channels = Params.GetValue("channels"); Channels.empty() == false) { TraceOptions.Channels = Channels; @@ -622,22 +669,41 @@ HttpAdminService::HttpAdminService(GcScheduler& Scheduler, if (auto File = Params.GetValue("file"); File.empty() == false) { - TraceOptions.File = File; + const std::filesystem::path TracesRoot = m_ServerOptions.DataDir / "traces"; + std::optional<std::filesystem::path> Resolved = ResolveSafeRelativePath(TracesRoot, File); + if (!Resolved) + { + ZEN_WARN("admin trace/start rejected unsafe 'file' parameter '{}'", File); + return HttpReq.WriteResponse(HttpResponseCode::BadRequest, HttpContentType::kText, "Invalid 'file' parameter"sv); + } + TraceOptions.File = Resolved->string(); } else if (auto Host = Params.GetValue("host"); Host.empty() == false) { + if (!IsLoopbackTraceHost(Host)) + { + ZEN_WARN("admin trace/start rejected non-loopback 'host' parameter '{}'", Host); + return HttpReq.WriteResponse(HttpResponseCode::BadRequest, + HttpContentType::kText, + "Invalid 'host' parameter (must be a loopback address)"sv); + } TraceOptions.Host = Host; } else { - return Req.ServerRequest().WriteResponse(HttpResponseCode::BadRequest, - HttpContentType::kText, - "Invalid trace type, use `file` or `host`"sv); + return HttpReq.WriteResponse(HttpResponseCode::BadRequest, + HttpContentType::kText, + "Invalid trace type, use `file` or `host`"sv); + } + + if (!IsTracing()) + { + TraceInit("zenserver"); } TraceConfigure(TraceOptions); - return Req.ServerRequest().WriteResponse(HttpResponseCode::OK, HttpContentType::kText, "Tracing started"); + return HttpReq.WriteResponse(HttpResponseCode::OK, HttpContentType::kText, "Tracing started"); }, HttpVerb::kPost); @@ -720,7 +786,7 @@ HttpAdminService::HttpAdminService(GcScheduler& Scheduler, "logs", [this](HttpRouterRequest& Req) { CbObjectWriter Obj; - auto LogLevel = logging::ToStringView(logging::GetLogLevel()); + auto LogLevel = logging::ToString(logging::GetLogLevel()); Obj.AddString("loglevel", std::string_view(LogLevel.data(), LogLevel.size())); Obj.AddString("Logfile", PathToUtf8(m_LogPaths.AbsLogPath)); Obj.BeginObject("cache"); @@ -772,7 +838,7 @@ HttpAdminService::HttpAdminService(GcScheduler& Scheduler, if (std::string Param(Params.GetValue("loglevel")); Param.empty() == false) { logging::LogLevel NewLevel = logging::ParseLogLevelString(Param); - std::string_view LogLevel = logging::ToStringView(NewLevel); + std::string_view LogLevel = logging::ToString(NewLevel); if (LogLevel != Param) { return Req.ServerRequest().WriteResponse(HttpResponseCode::BadRequest, @@ -791,6 +857,139 @@ HttpAdminService::HttpAdminService(GcScheduler& Scheduler, }, HttpVerb::kPost); m_Router.RegisterRoute( + "storage", + [this](HttpRouterRequest& Req) { + CbObjectWriter Obj; + + // Collect known storage directories + struct StorageDir + { + std::string_view Name; + std::filesystem::path Path; + }; + + std::vector<StorageDir> Dirs; + const std::filesystem::path& DataDir = m_ServerOptions.DataDir; + Dirs.push_back({"cache"sv, DataDir / "cache"}); + Dirs.push_back({"cas"sv, DataDir / "cas"}); + Dirs.push_back({"projects"sv, DataDir / "projects"}); + Dirs.push_back({"builds"sv, DataDir / "builds"}); + Dirs.push_back({"builds_cas"sv, DataDir / "builds_cas"}); + Dirs.push_back({"obj"sv, DataDir / "obj"}); + + // Group directories by volume (identified by total capacity) + struct VolumeInfo + { + DiskSpace Space; + std::vector<const StorageDir*> Directories; + }; + + // Use canonical path to identify volumes. Directories on the same volume + // will report the same total capacity from DiskSpaceInfo. + std::vector<VolumeInfo> Volumes; + auto FindOrAddVolume = [&](DiskSpace Space) -> VolumeInfo& { + for (VolumeInfo& V : Volumes) + { + if (V.Space.Total == Space.Total && V.Space.Free == Space.Free) + { + return V; + } + } + Volumes.push_back({Space, {}}); + return Volumes.back(); + }; + + for (StorageDir& Dir : Dirs) + { + if (!IsDir(Dir.Path)) + { + continue; + } + DiskSpace Space; + if (DiskSpaceInfo(Dir.Path, Space)) + { + FindOrAddVolume(Space).Directories.push_back(&Dir); + } + } + + Obj.BeginArray("volumes"sv); + for (const VolumeInfo& Vol : Volumes) + { + Obj.BeginObject(); + Obj << "total"sv << Vol.Space.Total; + Obj << "free"sv << Vol.Space.Free; + Obj << "used"sv << (Vol.Space.Total - Vol.Space.Free); + + Obj.BeginArray("directories"sv); + for (const StorageDir* Dir : Vol.Directories) + { + Obj.BeginObject(); + Obj << "name"sv << Dir->Name; + Obj << "path"sv << Dir->Path.string(); + + DirStats Stats = GetStatsForDirectory(Dir->Path); + Obj << "bytes"sv << Stats.ByteCount; + Obj << "files"sv << Stats.FileCount; + Obj.EndObject(); + } + Obj.EndArray(); + Obj.EndObject(); + } + Obj.EndArray(); + + Req.ServerRequest().WriteResponse(HttpResponseCode::OK, Obj.Save()); + }, + HttpVerb::kGet); + + m_Router.RegisterRoute( + "gclog", + [this](HttpRouterRequest& Req) { + const GcSchedulerState State = m_GcScheduler.GetState(); + const std::filesystem::path Path = State.Config.RootDirectory / "gc.log"; + + CbObjectWriter Response; + Response.BeginArray("entries"sv); + + try + { + if (IsFile(Path)) + { + IoBuffer FileData = ReadFile(Path).Flatten(); + + // The log file contains concatenated named CBO object fields. + // Each field is a complete entry: [type+name header][object payload]. + // We wrap each one in a CbObject and add it to the response array. + const uint8_t* Ptr = static_cast<const uint8_t*>(FileData.GetData()); + const uint8_t* End = Ptr + FileData.GetSize(); + + while (Ptr < End) + { + CbFieldView Field(Ptr); + uint64_t FieldSize = Field.GetSize(); + if (FieldSize == 0 || Ptr + FieldSize > End) + { + break; + } + + // Wrap the named field as an object and add it + CbObjectView ObjView = Field.AsObjectView(); + CbObject Entry = CbObject::Clone(ObjView); + Response.AddObject(Entry); + Ptr += FieldSize; + } + } + } + catch (const std::exception& Ex) + { + ZEN_WARN("failed to read gc log '{}': {}", Path, Ex.what()); + } + + Response.EndArray(); + Req.ServerRequest().WriteResponse(HttpResponseCode::OK, Response.Save()); + }, + HttpVerb::kGet); + + m_Router.RegisterRoute( "flush", [this](HttpRouterRequest& Req) { HttpServerRequest& HttpReq = Req.ServerRequest(); |