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 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663
|
#include <signal.h>
#include "Server.hh"
#include "InstallPrefix.hh"
#include <iostream>
#include <fstream>
#include <sstream>
#include <thread>
#include <regex>
#include <boost/uuid/uuid_generators.hpp> // generators
#include <boost/uuid/uuid_io.hpp> // streaming operators etc.
#include <boost/algorithm/string/replace.hpp>
#include <internal/uuid.h>
#include <internal/string_tools.h>
#include "Config.hh"
//#ifndef ENABLE_JUPYTER
//#include "Snoop.hh"
//#endif
#include "CdbPython.hh"
#include "SympyCdb.hh"
//#define DEBUG 1
using websocketpp::lib::placeholders::_1;
using websocketpp::lib::placeholders::_2;
using websocketpp::lib::bind;
Server::Server()
// : return_cell_id(std::numeric_limits<uint64_t>::max()/2)
{
boost::uuids::uuid authentication_uuid = boost::uuids::random_generator()();
authentication_token = boost::uuids::to_string( authentication_uuid );
// FIXME: we do not actually do anything with this.
socket_name="tcp://localhost:5454";
init();
}
Server::Server(const std::string& socket)
// : return_cell_id(std::numeric_limits<uint64_t>::max()/2)
{
socket_name=socket;
init();
}
Server::~Server()
{
}
Server::CatchOutput::CatchOutput()
{
}
Server::CatchOutput::CatchOutput(const CatchOutput&)
{
}
void Server::CatchOutput::write(const std::string& str)
{
// std::cerr << "Python wrote: " << str << std::endl;
collect+=str;
}
void Server::CatchOutput::clear()
{
// std::cerr << "Python clear" << std::endl;
collect="";
}
std::string Server::CatchOutput::str() const
{
return collect;
}
std::string Server::architecture() const
{
return "client-server";
}
PYBIND11_EMBEDDED_MODULE(cadabra2_internal, m)
{
// auto cadabra_module = pybind11::module::import("cadabra2");
pybind11::class_<Server::CatchOutput>(m, "CatchOutput")
.def("write", &Server::CatchOutput::write)
.def("clear", &Server::CatchOutput::clear)
;
pybind11::class_<Server>(m, "Server")
.def("send", &Server::send)
.def("handles", &Server::handles)
.def("architecture", &Server::architecture)
.def("send_progress_update", &Server::send_progress_update);
}
std::string parse_error(const std::string& error, const std::string& input)
{
try {
// Find syntax errors
std::regex syntax_error(R"(SyntaxError: \('([^']+)', \('<string>', (\d+), (\d+),.*)");
std::smatch sm;
if (std::regex_match(error, sm, syntax_error)) {
std::string error_type = sm[1];
size_t line_no = stoi(sm[2]) - 1;
size_t col_no = stoi(sm[3]);
return
"SyntaxError: " + error_type + "\n" +
"Line " + std::to_string(line_no) + ", column " + std::to_string(col_no) + "\n" +
nth_line(input, line_no - 1) + "\n" +
std::string(col_no > 1 ? col_no - 2 : 0, ' ') + "^";
}
// Find other errors
std::regex exception_name(R"(([a-zA-Z_][a-zA-Z0-9_]*):.*)");
std::string first_line = nth_line(error, 0);
if (std::regex_match(first_line, sm, exception_name)) {
std::string name = sm[1];
std::regex line_no(R"(<string>\((\d+)\): <module>)");
std::smatch lm;
if (std::regex_search(error, lm, line_no)) {
size_t l = stoi(lm[1]) - 1;
return std::regex_replace(error, line_no, "Notebook Cell (Line " + std::to_string(l) + "): " + nth_line(input, l - 1));
}
}
return error;
}
catch (std::exception& e) {
return error;
}
}
void Server::init()
{
started=false;
main_module = pybind11::module::import("__main__");
main_namespace = main_module.attr("__dict__");
// Make the C++ CatchOutput class visible on the Python side.
auto python_path = std::string(cadabra::install_prefix() + "/lib/python" + std::to_string(PY_MAJOR_VERSION) + "." + std::to_string(PY_MINOR_VERSION) + "/" + std::string(PYTHON_SITE_DIST));
std::string stdOutErr =
"import sys\n"
"sys.path.append(r'"+python_path+"')\n"
"from cadabra2_internal import Server, CatchOutput\n"
"server=0\n"
"def setup_catch(cO, cE, sE):\n"
" global server\n"
" sys.stdout=cO\n"
" sys.stderr=cE\n"
" server=sE\n";
run_string(stdOutErr, false);
// Setup the C++ output catching objects and setup the Python side to
// use these as stdout and stderr streams.
pybind11::object setup_catch = main_module.attr("setup_catch");
try {
setup_catch(std::ref(catchOut), std::ref(catchErr), std::ref(*this));
}
catch(pybind11::error_already_set& ex) {
//#ifndef ENABLE_JUPYTER
// snoop::log(snoop::fatal) << "Failed to initialise Python bridge." << snoop::flush;
//#endif
PyErr_Print();
throw;
}
// Call the Cadabra default initialisation script.
// pybind11::eval_file(PYTHON_SITE_PATH"/cadabra2_defaults.py");
// HERE: should use pybind11::eval_file instead, much simpler.
//
std::string startup =
"f=open(r'" + python_path + "/cadabra2_defaults.py'); "
"code=compile(f.read(), 'cadabra2_defaults.py', 'exec'); "
"exec(code); f.close()";
run_string(startup);
#ifdef DEBUG
std::cerr << "Server::init: completed" << std::endl;
#endif
}
std::string Server::run_string(const std::string& blk, bool handle_output)
{
//std::cerr << "RUN_STRING" << std::endl;
// snoop::log("run") << blk << snoop::flush;
std::string result;
// Preparse input block.
auto newblk = cadabra::cdb2python_string(blk, true);
// std::cerr << "PREPARSED:\n" << newblk << std::endl;
// snoop::log("preparsed") << newblk << snoop::flush;
// Run block. Catch output.
try {
// pybind11::object ignored = pybind11::eval<pybind11::eval_statements>(newblk.c_str(), main_namespace);
#ifdef DEBUG
std::cerr << "executing..." << std::endl;
std::cerr << newblk << std::endl;
#endif
PyErr_Clear();
pybind11::exec(newblk.c_str(), main_namespace);
#ifdef DEBUG
std::cerr << "exec done" << std::endl;
#endif
// std::string object_classname = ignored.attr("__class__").attr("__name__").cast<std::string>();
// std::cerr << "" << std::endl;
if(handle_output) {
result = catchOut.str();
catchOut.clear();
}
}
catch(pybind11::error_already_set& ex) {
#ifdef DEBUG
std::cerr << "Server::run_string: exception " << ex.what() << std::endl;
#endif
// On macOS and with the current conda tools,
// you can never exit from this block: throwing or simply
// exiting with 'return ""' makes things hang.
// The solution is to ex.restore(), see
// https://github.com/pybind/pybind11/issues/1490
// Note: the restore() has the side effect of making the
// error come back on any future pybind11::exec() call.
std::string reason=parse_error(ex.what(), newblk);
ex.restore();
throw std::runtime_error(reason);
}
server_stopwatch.stop();
return result;
}
void Server::on_socket_init(websocketpp::connection_hdl, boost::asio::ip::tcp::socket & /* s */)
{
boost::asio::ip::tcp::no_delay option(true);
// FIXME: this used to work in older websocketpp
// s.lowest_layer().set_option(option);
}
Server::Connection::Connection()
{
uuid = boost::uuids::random_generator()();
}
void Server::on_open(websocketpp::connection_hdl hdl)
{
std::lock_guard<std::mutex> lock(ws_mutex);
Connection con;
con.hdl=hdl;
// snoop::log(snoop::info) << "Connection " << con.uuid << " open." << snoop::flush;
connections[hdl]=con;
}
void Server::on_close(websocketpp::connection_hdl hdl)
{
std::lock_guard<std::mutex> lock(ws_mutex);
// auto it = connections.find(hdl);
// snoop::log(snoop::info) << "Connection " << it->second.uuid << " close." << snoop::flush;
connections.erase(hdl);
if(exit_on_disconnect)
exit(-1);
}
int quit(void *)
{
PyErr_SetInterrupt();
return -1;
}
void Server::wait_for_job()
{
// Infinite loop, waiting for the master thread to signal that a new block is
// available, and processing it. Blocks are always processed sequentially
// even though new ones may come in before previous ones have finished.
// snoop::log(snoop::info) << "Waiting for blocks" << snoop::flush;
#ifdef DEBUG
std::cerr << "Server::wait_for__job: start" << std::endl;
#endif
#ifndef CDB_DONT_ACQUIRE_GIL
// FIXME: why do we need this for the normal Cadabra server, but does
// it hang in the Jupyter server? If you drop this from the normal
// server, it will crash soon below.
pybind11::gil_scoped_acquire acquire;
#endif
while(true) {
#ifdef DEBUG
std::cerr << "Server::wait_for__job: locking" << std::endl;
#endif
std::unique_lock<std::mutex> lock(block_available_mutex);
while(block_queue.size()==0) {
#ifdef DEBUG
std::cerr << "Server::wait_for__job: waiting" << std::endl;
#endif
block_available.wait(lock);
}
Block block = block_queue.front();
block_queue.pop();
lock.unlock();
server_stopwatch.reset();
server_stopwatch.start();
try {
// We are done with the block_queue; release the lock so that the
// master thread can push new blocks onto it.
// snoop::log(snoop::info) << "Block finished running" << snoop::flush;
server_stopwatch.stop();
current_hdl=block.hdl;
current_id =block.cell_id;
block.output = run_string(block.input);
on_block_finished(block);
}
catch(std::runtime_error& ex) {
#ifdef DEBUG
std::cerr << "Exception caught, acquiring lock" << std::endl;
#endif
server_stopwatch.stop();
// snoop::log(snoop::info) << "Python runtime exception" << snoop::flush;
// On error we remove all other blocks from the queue.
lock.lock();
#ifdef DEBUG
std::cerr << "Lock acquired" << std::endl;
#endif
std::queue<Block> empty;
std::swap(block_queue, empty);
lock.unlock();
block.error = ex.what();
on_block_error(block);
}
catch(std::exception& ex) {
server_stopwatch.stop();
// snoop::log(snoop::info) << "System exception" << snoop::flush;
lock.lock();
std::queue<Block> empty;
std::swap(block_queue, empty);
lock.unlock();
block.error=ex.what();
on_kernel_fault(block);
// Keep running
}
}
}
void Server::stop_block()
{
PyGILState_STATE state = PyGILState_Ensure();
// PyThreadState_SetAsyncExc ?
Py_AddPendingCall(&quit, NULL);
PyGILState_Release(state);
}
Server::Block::Block(websocketpp::connection_hdl h, const std::string& str, uint64_t id_, const std::string& msg_type_)
: hdl(h), msg_type(msg_type_), input(str), cell_id(id_)
{
nlohmann::json content, header;
response["header"]=header;
response["content"]=content;
response["msg_type"]=msg_type;
}
void Server::on_message(websocketpp::connection_hdl hdl, WebsocketServer::message_ptr msg)
{
std::lock_guard<std::mutex> lock(ws_mutex);
auto it = connections.find(hdl);
if(it==connections.end()) {
//#ifndef ENABLE_JUPYTER
// snoop::log(snoop::warn) << "Message from unknown connection." << snoop::flush;
//#endif
return;
}
// std::cout << "Message from " << it->second.uuid << std::endl;
dispatch_message(hdl, msg->get_payload());
}
void Server::dispatch_message(websocketpp::connection_hdl hdl, const std::string& json_msg)
{
// std::cout << json_msg << std::endl;
nlohmann::json root;
try {
root = nlohmann::json::parse(json_msg);
}
catch(nlohmann::json::exception& ex) {
//#ifndef ENABLE_JUPYTER
// snoop::log(snoop::error) << "Cannot parse message " << json_msg << snoop::flush;
//#endif
return;
}
// Check that this message is authenticated.
std::string auth_token = root.value("auth_token", "");
if(auth_token!=authentication_token) {
std::cerr << "Received block with incorrect authentication token: " << auth_token << "." << std::endl;
return;
}
const auto& content = root["content"];
const auto& header = root["header"];
std::string msg_type = header["msg_type"].get<std::string>();
// std::cerr << "received msg_type |" << msg_type << "|" << std::endl;
if(msg_type=="execute_request") {
std::string code = content.value("code","");
// std::cerr << code << std::endl;
uint64_t id = header.value("cell_id", uint64_t(0));
std::unique_lock<std::mutex> lock(block_available_mutex);
Block block(hdl, code, id, msg_type);
block.response["header"]["parent_origin"]="client";
block.response["header"]["parent_id"]=id;
block_queue.push(block);
block_available.notify_one();
}
else if(msg_type=="execute_interrupt") {
std::unique_lock<std::mutex> lock(block_available_mutex);
stop_block();
// std::cout << "clearing block queue" << std::endl;
std::queue<Block> empty;
std::swap(block_queue, empty);
//snoop::log(snoop::warn) << "Job stop requested." << snoop::flush;
}
else if(msg_type=="init") {
// Stop any running blocks.
std::unique_lock<std::mutex> lock(block_available_mutex);
stop_block();
std::queue<Block> empty;
std::swap(block_queue, empty);
}
else if(msg_type=="complete") {
// Schedule a block which runs code to complete the given string.
std::string str=root["string"].get<std::string>();
int alternative=root["alternative"].get<int>();
std::string todo="print(__cdbkernel__.completer.complete(\""+str+"\", "+std::to_string(alternative)+"))";
uint64_t id = header.value("cell_id", uint64_t(0));
Block blk(hdl, todo, id, "completed");
blk.response["header"]["cell_id"]=id;
blk.response["content"]["original"]=str;
blk.response["content"]["position"]=root["position"].get<int>();
blk.response["content"]["alternative"]=alternative;
std::unique_lock<std::mutex> lock(block_available_mutex);
block_queue.push(blk);
block_available.notify_one();
}
else if(msg_type=="exit") {
exit(-1);
}
}
void Server::on_block_finished(Block block)
{
auto& header = block.response["header"];
auto& content = block.response["content"];
if(block.msg_type=="completed") {
// FIXME: need a better way to get the result out of python, so we can spot None
// while keeping the possibility to complete 'No' -> 'None'.
std::string res=block.output;
if(res.size()>0 && res[res.size()-1]=='\n')
res=res.substr(0, res.size()-1);
if(res=="None")
res="";
block.response["content"]["completed"]=res;
}
else {
header["cell_origin"]="server";
header["cell_id"]=cadabra::generate_uuid<uint64_t>();
header["time_total_microseconds"]=std::to_string(server_stopwatch.seconds()*1e6L + server_stopwatch.useconds());
header["time_sympy_microseconds"]=std::to_string(sympy_stopwatch.seconds()*1e6L + sympy_stopwatch.useconds());
header["last_in_sequence"]=true;
content["output"]=block.output;
block.response["msg_type"]="output";
}
std::ostringstream str;
str << block.response << std::endl;
send_json(str.str());
}
bool Server::handles(const std::string& otype) const
{
if(otype=="latex_view" || otype=="image_png" || otype=="verbatim") return true;
return false;
}
uint64_t Server::send(const std::string& output, const std::string& msg_type, uint64_t parent_id, bool last)
{
// This is the function exposed to the Python side; not used
// directly in the server to send block output back to the client
// (that's all handled by on_block_finished above).
nlohmann::json json, header, content;
auto return_cell_id=cadabra::generate_uuid<uint64_t>();
if(parent_id==0)
header["parent_id"]=current_id;
else
header["parent_id"]=parent_id;
header["parent_origin"]="client";
header["cell_id"]=return_cell_id;
header["cell_origin"]="server";
header["time_total_microseconds"]=std::to_string(server_stopwatch.seconds()*1e6L + server_stopwatch.useconds());
header["time_sympy_microseconds"]=std::to_string(sympy_stopwatch.seconds()*1e6L + sympy_stopwatch.useconds());
header["last_in_sequence"]=last;
content["output"]=output;
json["header"]=header;
json["content"]=content;
json["msg_type"]=msg_type;
std::ostringstream str;
str << json << std::endl;
send_json(str.str());
return return_cell_id;
}
void Server::send_progress_update(const std::string& msg, int n, int total)
{
nlohmann::json json, content, header;
header["parent_id"] = 0;
header["parent_origin"] = "client";
header["cell_id"] = 0;
header["cell_origin"] = "server";
content["msg"] = msg;
content["n"] = n;
content["total"] = total;
json["header"] = header;
json["content"] = content;
json["msg_type"] = "progress_update";
std::ostringstream str;
str << json << std::endl;
send_json(str.str());
}
void Server::send_json(const std::string& msg)
{
// std::cerr << "*** sending message " << msg << std::endl;
std::lock_guard<std::mutex> lock(ws_mutex);
wserver.send(current_hdl, msg, websocketpp::frame::opcode::text);
}
void Server::on_block_error(Block blk)
{
std::lock_guard<std::mutex> lock(ws_mutex);
// Make a JSON message.
nlohmann::json json, content, header;
auto return_cell_id=cadabra::generate_uuid<uint64_t>();
header["parent_id"]=blk.cell_id;
header["parent_origin"]="client";
header["cell_id"]=return_cell_id;
header["cell_origin"]="server";
header["last_in_sequence"]=true;
content["output"]=blk.error;
json["header"]=header;
json["content"]=content;
json["msg_type"]="error";
std::ostringstream str;
str << json << std::endl;
// std::cerr << "cadabra-server: sending error, " << str.str() << std::endl;
wserver.send(blk.hdl, str.str(), websocketpp::frame::opcode::text);
}
void Server::on_kernel_fault(Block blk)
{
std::lock_guard<std::mutex> lock(ws_mutex);
// Make a JSON message.
nlohmann::json json, content, header;
auto return_cell_id=cadabra::generate_uuid<uint64_t>();
header["parent_id"]=blk.cell_id;
header["parent_origin"]="client";
header["cell_id"]=return_cell_id;
header["cell_origin"]="server";
header["last_in_sequence"]=true;
content["output"]=blk.error;
json["header"]=header;
json["content"]=content;
json["msg_type"]="fault";
std::ostringstream str;
str << json << std::endl;
// std::cerr << "cadabra-server: sending kernel crash report, " << str.str() << std::endl;
wserver.send(blk.hdl, str.str(), websocketpp::frame::opcode::text);
}
void Server::run(int port, bool eod)
{
exit_on_disconnect=eod;
try {
wserver.clear_access_channels(websocketpp::log::alevel::all);
wserver.clear_error_channels(websocketpp::log::elevel::all);
wserver.init_asio();
wserver.set_reuse_addr(true);
wserver.set_socket_init_handler(bind(&Server::on_socket_init, this, ::_1,::_2));
wserver.set_message_handler(bind(&Server::on_message, this, ::_1, ::_2));
wserver.set_open_handler(bind(&Server::on_open,this,::_1));
wserver.set_close_handler(bind(&Server::on_close,this,::_1));
#ifdef DEBUG
std::cerr << "going to listen" << std::endl;
#endif
wserver.listen(websocketpp::lib::asio::ip::tcp::v4(), port);
#ifdef DEBUG
std::cerr << "going to accept" << std::endl;
#endif
wserver.start_accept();
websocketpp::lib::asio::error_code ec;
auto p = wserver.get_local_endpoint(ec);
std::cout << p.port() << std::endl;
std::cout << authentication_token << std::endl;
// std::cerr << "cadabra-server: spawning job thread " << std::endl;
runner = std::thread(std::bind(&Server::wait_for_job, this));
pybind11::gil_scoped_release release;
wserver.run();
}
catch(websocketpp::exception& ex) {
std::cerr << "cadabra-server: websocket exception " << ex.code() << " " << ex.what() << std::endl;
}
}
|