Remove TCL elaborate/vsim command

Author: nickg

src/rt/shell.c

@@ -161,29 +161,15 @@ static void shell_printf(tcl_shell_t *sh, const char *fmt, ...)
 static bool shell_has_model(tcl_shell_t *sh)
 {
    if (sh->model == NULL) {
-      tcl_error(sh, "no simulation loaded, try the $bold$elaborate$$ "
-                "command first");
+      tcl_error(sh, "no simulation loaded, elaborate first with the "
+                "$bold$-e$$ command or pass the top-level design unit "
+                "as a command line argument");
       return false;
    }
 
    return true;
 }
 
-static void shell_clear_model(tcl_shell_t *sh)
-{
-   if (sh->model == NULL)
-      return;
-
-   model_free(sh->model);
-   hash_free(sh->namemap);
-
-   sh->model = NULL;
-   sh->namemap = NULL;
-
-   if (sh->handler.quit_sim != NULL)
-      (*sh->handler.quit_sim)(sh->handler.context);
-}
-
 static void shell_next_time_step(rt_model_t *m, void *user)
 {
    tcl_shell_t *sh = user;
@@ -496,67 +482,15 @@ static int shell_cmd_find(ClientData cd, Tcl_Interp *interp,
 }
 
 static const char elaborate_help[] =
-   "Elaborate a design hierarchy\n"
-   "\n"
-   "Syntax:\n"
-   "  elaborate [options] <toplevel>\n"
-   "\n"
-   "Note \"vsim\" is an alias of this command.\n"
-   "\n"
-   "Options:\n"
-   "\n"
-   "Examples:\n"
-   "  elaborate toplevel\n"
-   "  vsim toplevel\n";
+   "Obsolete command which does nothing.\n";
 
 static int shell_cmd_elaborate(ClientData cd, Tcl_Interp *interp,
                                int objc, Tcl_Obj *const objv[])
 {
    tcl_shell_t *sh = cd;
-   LOCAL_TEXT_BUF tb = tb_new();
-
-   int pos = 1;
-   for (const char *opt; (opt = Tcl_GetString(objv[pos]))[0] == '-'; pos++)
-      goto usage;
-
-   if (pos + 1 != objc)
-      goto usage;
-
-   lib_t work = lib_work();
-
-   tb_istr(tb, lib_name(work));
-   tb_append(tb, '.');
-   tb_cat(tb, Tcl_GetString(objv[pos]));
-   tb_upcase(tb);
-
-   tree_t unit = lib_get(lib_work(), ident_new(tb_get(tb)));
-   if (unit == NULL)
-      return tcl_error(sh, "cannot find unit %s in library %s",
-                       Tcl_GetString(objv[pos]), istr(lib_name(work)));
-
-   shell_clear_model(sh);
-
-   reset_error_count();
-
-   // Recreate the JIT instance and unit registry as it may have
-   // references to stale code
-   jit_free(sh->jit);
-   unit_registry_free(sh->registry);
-   sh->registry = unit_registry_new();
-   sh->jit = (*sh->make_jit)(sh->registry);
-
-   rt_model_t *m = model_new(sh->jit, NULL);
-   tree_t top = elab(tree_to_object(unit), sh->jit, sh->registry,
-                     NULL, NULL, m);
-   model_free(m);   // XXX: reuse
-   if (top == NULL)
-      return TCL_ERROR;
-
-   shell_reset(sh, top);
-   return TCL_OK;
-
- usage:
-   return syntax_error(sh, objv);
+   return tcl_error(sh, "the elaborate/vsim command has been removed, "
+                    "elaborate the design first with \"nvc -e top --do ...\" "
+                    "or \"nvc -e top -i\"");
 }
 
 static const char examine_help[] =
@@ -914,48 +848,13 @@ static int shell_cmd_add(ClientData cd, Tcl_Interp *interp,
 }
 
 static const char quit_help[] =
-   "Exit the simulator or unload the current design\n"
-   "\n"
-   "Syntax:\n"
-   "  quit [-sim]\n"
-   "\n"
-   "Options:\n"
-   "  -sim\t\tUnload the current simulation but do not exit the program.\n";
+   "Obsolete command which does nothing.\n";
 
 static int shell_cmd_quit(ClientData cd, Tcl_Interp *interp,
                           int objc, Tcl_Obj *const objv[])
 {
    tcl_shell_t *sh = cd;
-
-   bool quit_sim = false;
-   int pos = 1;
-   for (const char *opt; (opt = next_option(&pos, objc, objv)); ) {
-      if (strcmp(opt, "-sim") == 0)
-         quit_sim = true;
-      else
-         goto usage;
-   }
-
-   if (pos != objc)
-      goto usage;
-
-   if (quit_sim) {
-      if (!shell_has_model(sh))
-         return TCL_ERROR;
-      else
-         shell_clear_model(sh);
-   }
-   else {
-      sh->quit = true;
-
-      if (sh->handler.exit != NULL)
-         (*sh->handler.exit)(0, sh->handler.context);
-   }
-
-   return TCL_OK;
-
- usage:
-   return syntax_error(sh, objv);
+   return tcl_error(sh, "the quit command has been removed");
 }
 
 static const char exit_help[] =
@@ -1373,8 +1272,6 @@ static void recurse_objects(tcl_shell_t *sh, rt_scope_t *scope,
 
 void shell_reset(tcl_shell_t *sh, tree_t top)
 {
-   shell_clear_model(sh);
-
    jit_reset(sh->jit);
 
    sh->top = top;

src/rt/shell.h

@@ -31,7 +31,6 @@ typedef struct {
    void (*backchannel_write)(const char *buf, size_t nchars, void *ctx);
    void (*start_sim)(ident_t top, void *ctx);
    void (*restart_sim)(void *ctx);
-   void (*quit_sim)(void *ctx);
    void (*exit)(int status, void *ctx);
    void (*next_time_step)(uint64_t now, void *ctx);
    void *context;

src/server.c

@@ -714,15 +714,6 @@ static void restart_sim_handler(void *user)
    ws_send_packet(http->websocket, pb);
 }
 
-static void quit_sim_handler(void *user)
-{
-   http_server_t *http = container_of(user, http_server_t, server);
-
-   packet_buf_t *pb = fresh_packet_buffer(&(http->server));
-   pb_pack_u8(pb, S2C_QUIT_SIM);
-   ws_send_packet(http->websocket, pb);
-}
-
 static void next_time_step_handler(uint64_t now, void *user)
 {
    http_server_t *http = container_of(user, http_server_t, server);
@@ -1445,7 +1436,6 @@ void start_server(server_kind_t kind, jit_factory_t make_jit,
       .backchannel_write = tunnel_backchannel,
       .start_sim = start_sim_handler,
       .restart_sim = restart_sim_handler,
-      .quit_sim = quit_sim_handler,
       .next_time_step = next_time_step_handler,
       .context = server
    };

src/server.h

@@ -35,7 +35,6 @@ typedef enum {
    S2C_INIT_CMD = 0x02,
    S2C_START_SIM = 0x03,
    S2C_RESTART_SIM = 0x04,
-   S2C_QUIT_SIM = 0x05,
    S2C_NEXT_TIME_STEP = 0x06,
    S2C_BACKCHANNEL = 0x07,
 } s2c_opcode_t;

test/regress/tcl1.tcl

@@ -6,8 +6,6 @@ proc assert condition {
 
 set testdir [file dirname [file normalize [info script]]]
 
-vsim tcl1
-
 puts "$now +$deltas"
 assert {expr $now == 0}
 assert {expr $deltas == 0}

test/regress/tcl2.tcl

@@ -6,8 +6,6 @@ proc assert condition {
 
 set testdir [file dirname [file normalize [info script]]]
 
-vsim tcl2
-
 set sigs [find signals /*]
 puts $sigs
 

test/test_server.c

@@ -346,11 +346,6 @@ static void wave_binary_frame(web_socket_t *ws, const void *data, size_t len,
       ck_assert_int_eq(bytes[0], S2C_RESTART_SIM);
       break;
 
-   case 7:
-      ck_assert_int_eq(len, 1);
-      ck_assert_int_eq(bytes[0], S2C_QUIT_SIM);
-      break;
-
    default:
       ck_abort_msg("unexpected call to binary_frame in state %d", *state - 1);
    }
@@ -386,15 +381,15 @@ START_TEST(test_wave)
 
    ck_assert_int_eq(state, 6);
 
-   ws_send_text(ws, "restart; quit -sim");
+   ws_send_text(ws, "restart");
    ws_flush(ws);
 
    ws_poll(ws);
 
    shutdown_server(ws);
    ws_free(ws);
 
-   ck_assert_int_eq(state, 8);
+   ck_assert_int_eq(state, 7);
 
    close(sock);
    join_server(pid);