net/rfb.c

   1 #include <stdint.h>
   2 #include <minilib.h>
   3 #include <output.h>
   4 #include <fb.h>
   5 #include <keyboard.h>
   6
   7 #include "lwip/tcp.h"
   8 #include "lwip/stats.h"
   9
  10 #include "rfb.h"
  11
  12 #define SET_PIXEL_FORMAT        0
  13 #define SET_ENCODINGS           2
  14 #define FB_UPDATE_REQUEST       3
  15 #define KEY_EVENT               4
  16 #define POINTER_EVENT           5
  17 #define CLIENT_CUT_TEXT         6
  18
  19 #define RFB_BUF_SIZE    512
  20
  21 #define SCREEN_CHUNKS_X 8
  22 #define SCREEN_CHUNKS_Y 8
  23
  24 struct pixel_format {
  25         uint8_t bpp;
  26         uint8_t depth;
  27         uint8_t big_endian;
  28         uint8_t true_color;
  29         uint16_t red_max;
  30         uint16_t green_max;
  31         uint16_t blue_max;
  32         uint8_t red_shift;
  33         uint8_t green_shift;
  34         uint8_t blue_shift;
  35         uint8_t padding[3];
  36 };
  37
  38 struct server_init_message {
  39         uint16_t fb_width;
  40         uint16_t fb_height;
  41         struct pixel_format fmt;
  42         uint32_t name_length;
  43         char name_string[8];
  44 };
  45
  46 struct fb_update_req {
  47         uint8_t msgtype;
  48         uint8_t incremental;
  49         uint16_t xpos;
  50         uint16_t ypos;
  51         uint16_t width;
  52         uint16_t height;
  53 };
  54
  55 struct set_encs_req {
  56         uint8_t msgtype;
  57         uint8_t padding;
  58         uint16_t num;
  59         int32_t encodings[];
  60 };
  61
  62 struct key_event_pkt {
  63         uint8_t msgtype;
  64         uint8_t downflag;
  65         uint8_t pad[2];
  66         uint32_t keysym;
  67 };
  68
  69 struct pointer_event_pkt {
  70         uint8_t msgtype;
  71         uint8_t button_mask;
  72         uint16_t x;
  73         uint16_t y;
  74 };
  75
  76 struct text_event_pkt {
  77         uint8_t msgtype;
  78         uint8_t padding[3];
  79         uint32_t length;
  80         char text[];
  81 };
  82
  83 struct update_header {
  84         uint8_t msgtype;
  85         uint8_t padding;
  86         uint16_t nrects;
  87         uint16_t xpos;
  88         uint16_t ypos;
  89         uint16_t width;
  90         uint16_t height;
  91         int32_t enctype;
  92 };
  93
  94 struct rfb_state {
  95         enum {
  96                 ST_BEGIN = 0,
  97                 ST_CLIENTINIT,
  98                 ST_MAIN
  99         } state;
 100         int version;
 101         int encs_remaining;
 102
 103         char data[RFB_BUF_SIZE];
 104         int readpos;
 105         int writepos;
 106
 107         char next_update_incremental;
 108         char update_requested;
 109
 110         struct fb_update_req client_interest_area;
 111
 112         enum {
 113                 SST_IDLE = 0,
 114                 SST_HEADER,
 115                 SST_DATA
 116         } send_state;
 117
 118         uint32_t checksums[SCREEN_CHUNKS_X][SCREEN_CHUNKS_Y];
 119
 120         uint32_t chunk_xnum;
 121         uint32_t chunk_ynum;
 122         uint32_t chunk_xpos;
 123         uint32_t chunk_ypos;
 124         uint32_t chunk_width;
 125         uint32_t chunk_height;
 126
 127         uint32_t chunk_lindex;
 128
 129         uint32_t chunk_checksum;
 130
 131         int chunk_actually_sent;
 132         int try_in_a_bit;
 133 };
 134
 135 static struct server_init_message server_info;
 136
 137 static void init_server_info() {
 138         server_info.name_length = htonl(8);
 139         memcpy(server_info.name_string, "NetWatch", 8);
 140 }
 141
 142 static void update_server_info() {
 143         if (fb != NULL) {
 144                 outputf("RFB: setting fmt %d", fb->curmode.format);
 145                 server_info.fb_width = htons(fb->curmode.xres);
 146                 server_info.fb_height = htons(fb->curmode.yres);
 147                 switch (fb->curmode.format) {
 148                 case FB_RGB888:
 149                         server_info.fmt.bpp = 32;
 150                         server_info.fmt.depth = 24;
 151                         server_info.fmt.big_endian = 0;
 152                         server_info.fmt.true_color = 1;
 153                         server_info.fmt.red_max = htons(255);
 154                         server_info.fmt.green_max = htons(255);
 155                         server_info.fmt.blue_max = htons(255);
 156                         server_info.fmt.red_shift = 0;
 157                         server_info.fmt.green_shift = 8;
 158                         server_info.fmt.blue_shift = 16;
 159                         break;
 160                 default:
 161                         outputf("RFB: unknown fb fmt %d", fb->curmode.format);
 162                         break;
 163                 }
 164         } else {
 165                 outputf("RFB: fb null");
 166         }
 167 }
 168
 169 static int advance_chunk(struct rfb_state *state) {
 170
 171         state->chunk_xnum += 1;
 172
 173         if (state->chunk_xnum == SCREEN_CHUNKS_X) {
 174                 state->chunk_ynum += 1;
 175                 state->chunk_xnum = 0;
 176         }
 177
 178         if (state->chunk_ynum == SCREEN_CHUNKS_Y) {
 179                 state->chunk_ynum = 0;
 180                 state->send_state = SST_IDLE;
 181                 if (!(state->chunk_actually_sent))
 182                         state->try_in_a_bit = 2;
 183                         return 1;
 184         }
 185
 186         return 0;
 187 }
 188
 189 static void send_fsm(struct tcp_pcb *pcb, struct rfb_state *state) {
 190         struct update_header hdr;
 191         int lines_left;
 192         unsigned char * lptr;
 193         int totaldim;
 194         err_t err;
 195
 196         while(1) {
 197
 198                 switch (state->send_state) {
 199
 200                 case SST_IDLE:
 201                         /* Nothing to do */
 202
 203                         if (state->update_requested) {
 204                                 outputf("RFB send: update requested");
 205                                 state->update_requested = 0;
 206                                 state->chunk_actually_sent = 0;
 207                                 state->send_state = SST_HEADER;
 208                         } else {
 209                                 return;
 210                         }
 211
 212                         /* FALL THROUGH to SST_HEADER */
 213
 214                 case SST_HEADER:
 215
 216                         /* Calculate the width and height for this chunk, remembering
 217                          * that if SCREEN_CHUNKS_[XY] do not evenly divide the width and
 218                          * height, we may need to have shorter chunks at the edge of
 219                          * the screen. */
 220
 221                         state->chunk_width = fb->curmode.xres / SCREEN_CHUNKS_X;
 222                         if (fb->curmode.xres % SCREEN_CHUNKS_X != 0)
 223                                 state->chunk_width += 1;
 224                         state->chunk_xpos = state->chunk_width * state->chunk_xnum;
 225                         totaldim = state->chunk_width * (state->chunk_xnum + 1);
 226                         if (totaldim > fb->curmode.xres) {
 227                                 state->chunk_width -= (totaldim - fb->curmode.xres);
 228                         }
 229
 230                         state->chunk_height = fb->curmode.yres / SCREEN_CHUNKS_Y;
 231                         if (fb->curmode.yres % SCREEN_CHUNKS_Y != 0)
 232                                 state->chunk_height += 1;
 233                         state->chunk_ypos = state->chunk_height
 234                                                  * state->chunk_ynum;
 235                         totaldim = state->chunk_height * (state->chunk_ynum + 1);
 236                         if (totaldim > fb->curmode.yres) {
 237                                 state->chunk_height -= (totaldim - fb->curmode.yres);
 238                         }
 239
 240                         /* Do we _actually_ need to send this chunk? */
 241                         if (fb->checksum_rect) {
 242                                 state->chunk_checksum = fb->checksum_rect(state->chunk_xpos, state->chunk_ypos,
 243                                                                 state->chunk_width, state->chunk_height);
 244
 245                                 if (state->chunk_checksum == state->checksums[state->chunk_xnum][state->chunk_ynum]) {
 246                                         if (advance_chunk(state))
 247                                                 return;
 248                                         continue;
 249                                 }
 250                                 /* Checksum gets set in data block, AFTER the data has been sent. */
 251                         }
 252
 253                         outputf("actually sent");
 254                         state->chunk_actually_sent = 1;
 255
 256                         /* Send a header */
 257                         hdr.msgtype = 0;
 258                         state->chunk_lindex = 0;
 259                         hdr.nrects = htons(1);
 260                         hdr.xpos = htons(state->chunk_xpos);
 261                         hdr.ypos = htons(state->chunk_ypos);
 262                         hdr.width = htons(state->chunk_width);
 263                         hdr.height= htons(state->chunk_height);
 264                         hdr.enctype = htonl(0);
 265                         lines_left = state->chunk_height;
 266
 267                         err = tcp_write(pcb, &hdr, sizeof(hdr), TCP_WRITE_FLAG_COPY);
 268
 269                         if (err != ERR_OK) {
 270                                 if (err != ERR_MEM)
 271                                         outputf("RFB: header send error %d", err);
 272
 273                                 /* Try again later. */
 274                                 return;
 275                         }
 276
 277                         state->send_state = SST_DATA;
 278
 279                         /* FALL THROUGH to SST_DATA */
 280
 281                 case SST_DATA:
 282
 283                         lines_left = state->chunk_height - state->chunk_lindex;
 284
 285                         if (lines_left == 0) {
 286                                 state->send_state = SST_HEADER;
 287                                 state->checksums[state->chunk_xnum][state->chunk_ynum] = state->chunk_checksum;
 288                                 if (advance_chunk(state))
 289                                         return;
 290                                 break;
 291                         }
 292
 293                         lptr = fb->fbaddr
 294                                 + (fb->curmode.xres * fb->curmode.bytestride
 295                                    * (state->chunk_ypos + state->chunk_lindex))
 296                                 + (state->chunk_xpos * fb->curmode.bytestride);
 297
 298                         /* The network card can't DMA from video RAM,
 299                          * so use TCP_WRITE_FLAG_COPY. */
 300                         err = tcp_write(pcb, lptr,
 301                                 fb->curmode.bytestride * state->chunk_width, TCP_WRITE_FLAG_COPY);
 302
 303                         if (err == ERR_OK) {
 304                                 state->chunk_lindex += 1;
 305                         } else {
 306                                 if (err != ERR_MEM)
 307                                         outputf("RFB: send error %d", err);
 308
 309                                 return;
 310                         }
 311
 312                         if (tcp_sndbuf(pcb) == 0) {
 313                                 return;
 314                         }
 315                 }
 316         }
 317
 318         if (tcp_output(pcb) != ERR_OK)
 319                 outputf("RFB: tcp_output bailed in send_fsm?");
 320 }
 321
 322 static err_t rfb_sent(void *arg, struct tcp_pcb *pcb, uint16_t len) {
 323         struct rfb_state *state = arg;
 324         send_fsm(pcb, state);
 325         return ERR_OK;
 326 }
 327
 328 static err_t rfb_poll(void *arg, struct tcp_pcb *pcb) {
 329         struct rfb_state *state = arg;
 330         send_fsm(pcb, state);
 331         if (state->try_in_a_bit) {
 332                 state->try_in_a_bit--;
 333                 if (!(state->try_in_a_bit)) {
 334                         state->update_requested = 1;
 335                 }
 336         }
 337 /*
 338         stats_display();
 339 */
 340         return ERR_OK;
 341 }
 342
 343 static void close_conn(struct tcp_pcb *pcb, struct rfb_state *state) {
 344         tcp_arg(pcb, NULL);
 345         tcp_sent(pcb, NULL);
 346         tcp_recv(pcb, NULL);
 347         mem_free(state);
 348         tcp_close(pcb);
 349 }
 350
 351 enum fsm_result {
 352         NEEDMORE,
 353         OK,
 354         FAIL
 355 };
 356
 357 static enum fsm_result recv_fsm(struct tcp_pcb *pcb, struct rfb_state *state) {
 358         int i;
 359         int pktsize;
 360
 361         outputf("RFB FSM: st %d rp %d wp %d", state->state, state->readpos,
 362                 state->writepos);
 363
 364         switch(state->state) {
 365         case ST_BEGIN:
 366                 if (state->writepos < 12) return NEEDMORE;
 367
 368                 if (!strncmp(state->data, "RFB 003.003\n", 12)) {
 369                         state->version = 3;
 370                 } else if (!strncmp(state->data, "RFB 003.005\n", 12)) {
 371                         /* Spec states that "RFB 003.005", an incorrect value,
 372                          * should be treated by the server as 3.3. */
 373                         state->version = 3;
 374                 } else if (!strncmp(state->data, "RFB 003.007\n", 12)) {
 375                         state->version = 7;
 376                 } else if (!strncmp(state->data, "RFB 003.008\n", 12)) {
 377                         state->version = 8;
 378                 } else {
 379                         outputf("RFB: Negotiation fail");
 380                         return FAIL;
 381                 }
 382
 383                 outputf("RFB: Negotiated v3.%d", state->version);
 384
 385                 state->readpos += 12;
 386                 state->state = ST_CLIENTINIT;
 387
 388                 /* We support one security type, currently "none".
 389                  * Send that and SecurityResult. */
 390                 if (state->version >= 7) {
 391                         tcp_write(pcb, "\x01\x01\x00\x00\x00\x00", 6, 0);
 392                 } else {
 393                         tcp_write(pcb, "\x01\x00\x00\x00\x00", 5, 0);
 394                 }
 395
 396                 tcp_output(pcb);
 397
 398                 return OK;
 399
 400         case ST_CLIENTINIT:
 401                 if (state->version >= 7) {
 402                         /* Ignore the security type and ClientInit */
 403                         if (state->writepos < 2) return NEEDMORE;
 404                         state->readpos += 2;
 405                 } else {
 406                         /* Just ClientInit */
 407                         if (state->writepos < 1) return NEEDMORE;
 408                         state->readpos += 1;
 409                 }
 410
 411                 state->state = ST_MAIN;
 412
 413                 outputf("RFB: Sending server info", state->version);
 414                 tcp_write(pcb, &server_info, sizeof(server_info), TCP_WRITE_FLAG_COPY);
 415                 tcp_output(pcb);
 416
 417                 return OK;
 418
 419         case ST_MAIN:
 420                 if (state->writepos < 1) return NEEDMORE;
 421
 422                 outputf("RFB: cmd %d", state->data[0]);
 423                 switch (state->data[0]) {
 424
 425                 case SET_PIXEL_FORMAT:
 426                         /* SetPixelFormat */
 427                         if (state->writepos < (sizeof(struct pixel_format) + 4))
 428                                 return NEEDMORE;
 429                         outputf("RFB: SetPixelFormat");
 430 /*
 431                         struct pixel_format * new_fmt =
 432                                 (struct pixel_format *)(&state->data[4]);
 433 */
 434                         /* XXX ... */
 435
 436                         state->readpos += sizeof(struct pixel_format) + 4;
 437                         return OK;
 438
 439                 case SET_ENCODINGS:
 440                         if (state->writepos < 4) return NEEDMORE;
 441
 442                         struct set_encs_req * req = (struct set_encs_req *)state->data;
 443
 444                         pktsize = sizeof(struct set_encs_req) + (4 * ntohs(req->num));
 445
 446                         outputf("RFB: SetEncodings [%d]", ntohs(req->num));
 447                         if (state->writepos < pktsize) return NEEDMORE;
 448
 449                         for (i = 0; i < ntohs(req->num); i++) {
 450                                 outputf("RFB: Encoding: %d", ntohl(req->encodings[i]));
 451                                 /* XXX ... */
 452                         }
 453
 454                         state->readpos += pktsize;
 455                         return OK;
 456
 457                 case FB_UPDATE_REQUEST:
 458                         if (state->writepos < sizeof(struct fb_update_req))
 459                                 return NEEDMORE;
 460                         outputf("RFB: UpdateRequest");
 461
 462                         state->update_requested = 1;
 463                         memcpy(&state->client_interest_area, state->data,
 464                                sizeof(struct fb_update_req));
 465
 466                         state->readpos += sizeof(struct fb_update_req);
 467                         return OK;
 468
 469                 case KEY_EVENT:
 470                         if (state->writepos < sizeof(struct key_event_pkt))
 471                                 return NEEDMORE;
 472
 473                         struct key_event_pkt * p = (struct key_event_pkt *)state->data;
 474
 475                         outputf("RFB: Key: %d (%c)", htonl(p->keysym), (htonl(p->keysym) & 0xFF));
 476                         kbd_inject_keysym(htonl(p->keysym), p->downflag);
 477
 478                         state->readpos += sizeof(struct key_event_pkt);
 479                         return OK;
 480
 481                 case POINTER_EVENT:
 482                         if (state->writepos < sizeof(struct pointer_event_pkt))
 483                                 return NEEDMORE;
 484                         outputf("RFB: Pointer");
 485
 486                         /* XXX stub */
 487
 488                         state->readpos += sizeof(struct pointer_event_pkt);
 489                         return OK;
 490
 491                 case CLIENT_CUT_TEXT:
 492                         if (state->writepos < sizeof(struct text_event_pkt))
 493                                 return NEEDMORE;
 494                         outputf("RFB: Cut Text");
 495
 496                         struct text_event_pkt * pkt =
 497                                 (struct text_event_pkt *)state->data;
 498
 499                         if (state->writepos < sizeof(struct text_event_pkt)
 500                                               + pkt->length)
 501                                 return NEEDMORE;
 502
 503                         /* XXX stub */
 504
 505                         state->readpos += sizeof(struct text_event_pkt)
 506                                           + pkt->length;
 507                         return OK;
 508
 509                 default:
 510                         outputf("RFB: Bad command: %d", state->data[0]);
 511                 }
 512         default:
 513                 outputf("RFB: Bad state");
 514                 return FAIL;
 515         }
 516 }
 517
 518 static err_t rfb_recv(void *arg, struct tcp_pcb *pcb,
 519                       struct pbuf *p, err_t err) {
 520         struct rfb_state *state = arg;
 521
 522         if (state == NULL)
 523
 524         if (err != ERR_OK) {
 525                 outputf("RFB: recv err %d", err);
 526                 /* FIXME do something better here? */
 527                 return ERR_OK;
 528         }
 529
 530         if (p == NULL) {
 531                 outputf("RFB: Connection closed");
 532                 close_conn(pcb, state);
 533                 return ERR_OK;
 534         }
 535
 536         if (p->tot_len > (RFB_BUF_SIZE - state->writepos)) {
 537                 /* Overflow! */
 538                 outputf("RFB: Overflow!");
 539                 close_conn(pcb, state);
 540                 return ERR_OK;
 541         }
 542
 543         outputf("RFB: Processing %d", p->tot_len);
 544         pbuf_copy_partial(p, state->data + state->writepos, p->tot_len, 0);
 545         state->writepos += p->tot_len;
 546
 547         tcp_recved(pcb, p->tot_len);
 548         pbuf_free(p);
 549
 550         while (1) {
 551                 switch (recv_fsm(pcb, state)) {
 552                 case NEEDMORE:
 553                         outputf("RFB FSM: blocking");
 554                         /* Need more data */
 555                         return ERR_OK;
 556
 557                 case OK:
 558                         outputf("RFB FSM: ok");
 559
 560                         /* Kick off a send. */
 561                         if (state->send_state == SST_IDLE
 562                             && state->update_requested) {
 563                                 send_fsm(pcb, state);
 564                         }
 565
 566                         if (state->readpos == state->writepos) {
 567                                 state->readpos = 0;
 568                                 state->writepos = 0;
 569                                 return ERR_OK;
 570                         } else {
 571                                 memmove(state->data,
 572                                         state->data + state->readpos,
 573                                         state->writepos - state->readpos);
 574                         }
 575                         break;
 576                 case FAIL:
 577                         /* Shit */
 578                         outputf("RFB: Protocol error");
 579                         close_conn(pcb, state);
 580                         return ERR_OK;
 581                 }
 582         }
 583 }
 584
 585 static err_t rfb_accept(void *arg, struct tcp_pcb *pcb, err_t err) {
 586         struct rfb_state *state;
 587
 588         LWIP_UNUSED_ARG(arg);
 589         LWIP_UNUSED_ARG(err);
 590
 591         state = (struct rfb_state *)mem_malloc(sizeof(struct rfb_state));
 592
 593         memset(state, 0, sizeof(struct rfb_state));
 594
 595         state->state = ST_BEGIN;
 596         state->send_state = SST_IDLE;
 597
 598         /* XXX: update_server_info() should be called from the 64ms timer, and deal
 599          * with screen resizes appropriately. */
 600         update_server_info();
 601
 602         if (!state)
 603         {
 604                 outputf("rfb_accept: out of memory\n");
 605                 return ERR_MEM;
 606         }
 607
 608         tcp_arg(pcb, state);
 609         tcp_recv(pcb, rfb_recv);
 610         tcp_sent(pcb, rfb_sent);
 611         tcp_poll(pcb, rfb_poll, 1);
 612 /*
 613         tcp_err(pcb, rfb_err);
 614 */
 615         tcp_write(pcb, "RFB 003.008\n", 12, 0);
 616         tcp_output(pcb);
 617
 618         return ERR_OK;
 619 }
 620
 621 void rfb_init() {
 622         struct tcp_pcb *pcb;
 623
 624         init_server_info();
 625
 626         pcb = tcp_new();
 627         tcp_bind(pcb, IP_ADDR_ANY, RFB_PORT);
 628         pcb = tcp_listen(pcb);
 629         tcp_accept(pcb, rfb_accept);
 630 }