1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
|
//===--- JSONRPCDispatcher.cpp - Main JSON parser entry point -------------===//
//
// The LLVM Compiler Infrastructure
//
// This file is distributed under the University of Illinois Open Source
// License. See LICENSE.TXT for details.
//
//===----------------------------------------------------------------------===//
#include "JSONRPCDispatcher.h"
#include "ProtocolHandlers.h"
#include "llvm/ADT/SmallString.h"
#include "llvm/Support/SourceMgr.h"
#include "llvm/Support/YAMLParser.h"
#include <istream>
using namespace clang;
using namespace clangd;
void JSONOutput::writeMessage(const Twine &Message) {
llvm::SmallString<128> Storage;
StringRef M = Message.toStringRef(Storage);
std::lock_guard<std::mutex> Guard(StreamMutex);
// Log without headers.
Logs << "--> " << M << '\n';
Logs.flush();
// Emit message with header.
Outs << "Content-Length: " << M.size() << "\r\n\r\n" << M;
Outs.flush();
}
void JSONOutput::log(const Twine &Message) {
std::lock_guard<std::mutex> Guard(StreamMutex);
Logs << Message;
Logs.flush();
}
void Handler::handleMethod(llvm::yaml::MappingNode *Params, StringRef ID) {
Output.log("Method ignored.\n");
// Return that this method is unsupported.
writeMessage(
R"({"jsonrpc":"2.0","id":)" + ID +
R"(,"error":{"code":-32601}})");
}
void Handler::handleNotification(llvm::yaml::MappingNode *Params) {
Output.log("Notification ignored.\n");
}
void JSONRPCDispatcher::registerHandler(StringRef Method,
std::unique_ptr<Handler> H) {
assert(!Handlers.count(Method) && "Handler already registered!");
Handlers[Method] = std::move(H);
}
static void
callHandler(const llvm::StringMap<std::unique_ptr<Handler>> &Handlers,
llvm::yaml::ScalarNode *Method, llvm::yaml::ScalarNode *Id,
llvm::yaml::MappingNode *Params, Handler *UnknownHandler) {
llvm::SmallString<10> MethodStorage;
auto I = Handlers.find(Method->getValue(MethodStorage));
auto *Handler = I != Handlers.end() ? I->second.get() : UnknownHandler;
if (Id)
Handler->handleMethod(Params, Id->getRawValue());
else
Handler->handleNotification(Params);
}
bool JSONRPCDispatcher::call(StringRef Content) const {
llvm::SourceMgr SM;
llvm::yaml::Stream YAMLStream(Content, SM);
auto Doc = YAMLStream.begin();
if (Doc == YAMLStream.end())
return false;
auto *Root = Doc->getRoot();
if (!Root)
return false;
auto *Object = dyn_cast<llvm::yaml::MappingNode>(Root);
if (!Object)
return false;
llvm::yaml::ScalarNode *Version = nullptr;
llvm::yaml::ScalarNode *Method = nullptr;
llvm::yaml::MappingNode *Params = nullptr;
llvm::yaml::ScalarNode *Id = nullptr;
for (auto &NextKeyValue : *Object) {
auto *KeyString = dyn_cast<llvm::yaml::ScalarNode>(NextKeyValue.getKey());
if (!KeyString)
return false;
llvm::SmallString<10> KeyStorage;
StringRef KeyValue = KeyString->getValue(KeyStorage);
llvm::yaml::Node *Value = NextKeyValue.getValue();
if (!Value)
return false;
if (KeyValue == "jsonrpc") {
// This should be "2.0". Always.
Version = dyn_cast<llvm::yaml::ScalarNode>(Value);
if (!Version || Version->getRawValue() != "\"2.0\"")
return false;
} else if (KeyValue == "method") {
Method = dyn_cast<llvm::yaml::ScalarNode>(Value);
} else if (KeyValue == "id") {
Id = dyn_cast<llvm::yaml::ScalarNode>(Value);
} else if (KeyValue == "params") {
if (!Method)
return false;
// We have to interleave the call of the function here, otherwise the
// YAMLParser will die because it can't go backwards. This is unfortunate
// because it will break clients that put the id after params. A possible
// fix would be to split the parsing and execution phases.
Params = dyn_cast<llvm::yaml::MappingNode>(Value);
callHandler(Handlers, Method, Id, Params, UnknownHandler.get());
return true;
} else {
return false;
}
}
// In case there was a request with no params, call the handler on the
// leftovers.
if (!Method)
return false;
callHandler(Handlers, Method, Id, nullptr, UnknownHandler.get());
return true;
}
void clangd::runLanguageServerLoop(std::istream &In, JSONOutput &Out,
JSONRPCDispatcher &Dispatcher,
bool &IsDone) {
while (In.good()) {
// A Language Server Protocol message starts with a HTTP header, delimited
// by \r\n.
std::string Line;
std::getline(In, Line);
if (!In.good() && errno == EINTR) {
In.clear();
continue;
}
// Skip empty lines.
llvm::StringRef LineRef(Line);
if (LineRef.trim().empty())
continue;
// We allow YAML-style comments. Technically this isn't part of the
// LSP specification, but makes writing tests easier.
if (LineRef.startswith("#"))
continue;
unsigned long long Len = 0;
// FIXME: Content-Type is a specified header, but does nothing.
// Content-Length is a mandatory header. It specifies the length of the
// following JSON.
if (LineRef.consume_front("Content-Length: "))
llvm::getAsUnsignedInteger(LineRef.trim(), 0, Len);
// Check if the next line only contains \r\n. If not this is another header,
// which we ignore.
char NewlineBuf[2];
In.read(NewlineBuf, 2);
if (std::memcmp(NewlineBuf, "\r\n", 2) != 0)
continue;
// Now read the JSON. Insert a trailing null byte as required by the YAML
// parser.
std::vector<char> JSON(Len + 1, '\0');
In.read(JSON.data(), Len);
if (Len > 0) {
llvm::StringRef JSONRef(JSON.data(), Len);
// Log the message.
Out.log("<-- " + JSONRef + "\n");
// Finally, execute the action for this JSON message.
if (!Dispatcher.call(JSONRef))
Out.log("JSON dispatch failed!\n");
// If we're done, exit the loop.
if (IsDone)
break;
}
}
}
|