server/console.c

   1 /*
   2  * Server-side console management
   3  *
   4  * Copyright (C) 1998 Alexandre Julliard
   5  *
   6  * FIXME: all this stuff is a hack to avoid breaking
   7  *        the client-side console support.
   8  */
   9
  10 #include "config.h"
  11
  12 #include <assert.h>
  13 #include <fcntl.h>
  14 #include <signal.h>
  15 #include <string.h>
  16 #include <stdio.h>
  17 #include <stdlib.h>
  18 #ifdef HAVE_SYS_ERRNO_H
  19 #include <sys/errno.h>
  20 #endif
  21 #include <sys/stat.h>
  22 #include <sys/time.h>
  23 #include <sys/types.h>
  24 #include <time.h>
  25 #include <unistd.h>
  26
  27 #include "winerror.h"
  28 #include "winnt.h"
  29 #include "wincon.h"
  30
  31 #include "handle.h"
  32 #include "process.h"
  33 #include "thread.h"
  34 #include "request.h"
  35
  36 struct screen_buffer;
  37
  38 struct console_input
  39 {
  40     struct object         obj;           /* object header */
  41     struct select_user    select;        /* select user */
  42     int                   mode;          /* input mode */
  43     struct screen_buffer *output;        /* associated screen buffer */
  44     int                   recnum;        /* number of input records */
  45     INPUT_RECORD         *records;       /* input records */
  46 };
  47
  48 struct screen_buffer
  49 {
  50     struct object         obj;           /* object header */
  51     struct select_user    select;        /* select user */
  52     int                   mode;          /* output mode */
  53     struct console_input *input;         /* associated console input */
  54     int                   cursor_size;   /* size of cursor (percentage filled) */
  55     int                   cursor_visible;/* cursor visibility flag */
  56     int                   pid;           /* xterm pid (hack) */
  57     char                 *title;         /* console title */
  58 };
  59
  60
  61 static void console_input_dump( struct object *obj, int verbose );
  62 static int console_input_add_queue( struct object *obj, struct wait_queue_entry *entry );
  63 static void console_input_remove_queue( struct object *obj, struct wait_queue_entry *entry );
  64 static int console_input_signaled( struct object *obj, struct thread *thread );
  65 static int console_input_get_read_fd( struct object *obj );
  66 static void console_input_destroy( struct object *obj );
  67
  68 static void screen_buffer_dump( struct object *obj, int verbose );
  69 static int screen_buffer_add_queue( struct object *obj, struct wait_queue_entry *entry );
  70 static void screen_buffer_remove_queue( struct object *obj, struct wait_queue_entry *entry );
  71 static int screen_buffer_signaled( struct object *obj, struct thread *thread );
  72 static int screen_buffer_get_write_fd( struct object *obj );
  73 static void screen_buffer_destroy( struct object *obj );
  74
  75 /* common routine */
  76 static int console_get_info( struct object *obj, struct get_file_info_request *req );
  77
  78 static const struct object_ops console_input_ops =
  79 {
  80     sizeof(struct console_input),
  81     console_input_dump,
  82     console_input_add_queue,
  83     console_input_remove_queue,
  84     console_input_signaled,
  85     no_satisfied,
  86     console_input_get_read_fd,
  87     no_write_fd,
  88     no_flush,
  89     console_get_info,
  90     console_input_destroy
  91 };
  92
  93 static const struct object_ops screen_buffer_ops =
  94 {
  95     sizeof(struct screen_buffer),
  96     screen_buffer_dump,
  97     screen_buffer_add_queue,
  98     screen_buffer_remove_queue,
  99     screen_buffer_signaled,
 100     no_satisfied,
 101     no_read_fd,
 102     screen_buffer_get_write_fd,
 103     no_flush,
 104     console_get_info,
 105     screen_buffer_destroy
 106 };
 107
 108
 109 static struct object *create_console_input( int fd )
 110 {
 111     struct console_input *console_input;
 112
 113     if ((fd = (fd != -1) ? dup(fd) : dup(0)) == -1)
 114     {
 115         file_set_error();
 116         return NULL;
 117     }
 118     if ((console_input = alloc_object( &console_input_ops )))
 119     {
 120         console_input->select.fd      = fd;
 121         console_input->select.func    = default_select_event;
 122         console_input->select.private = console_input;
 123         console_input->mode           = ENABLE_PROCESSED_INPUT | ENABLE_LINE_INPUT |
 124                                         ENABLE_ECHO_INPUT | ENABLE_MOUSE_INPUT;
 125         console_input->output         = NULL;
 126         console_input->recnum         = 0;
 127         console_input->records        = NULL;
 128         register_select_user( &console_input->select );
 129         return &console_input->obj;
 130     }
 131     close( fd );
 132     return NULL;
 133 }
 134
 135 static struct object *create_console_output( int fd, struct object *input )
 136 {
 137     struct console_input *console_input = (struct console_input *)input;
 138     struct screen_buffer *screen_buffer;
 139
 140     if ((fd = (fd != -1) ? dup(fd) : dup(1)) == -1)
 141     {
 142         file_set_error();
 143         return NULL;
 144     }
 145     if ((screen_buffer = alloc_object( &screen_buffer_ops )))
 146     {
 147         screen_buffer->select.fd      = fd;
 148         screen_buffer->select.func    = default_select_event;
 149         screen_buffer->select.private = screen_buffer;
 150         screen_buffer->mode           = ENABLE_PROCESSED_OUTPUT | ENABLE_WRAP_AT_EOL_OUTPUT;
 151         screen_buffer->input          = console_input;
 152         screen_buffer->cursor_size    = 100;
 153         screen_buffer->cursor_visible = 1;
 154         screen_buffer->pid            = 0;
 155         screen_buffer->title          = strdup( "Wine console" );
 156         register_select_user( &screen_buffer->select );
 157         console_input->output = screen_buffer;
 158         return &screen_buffer->obj;
 159     }
 160     close( fd );
 161     return NULL;
 162 }
 163
 164 /* allocate a console for this process */
 165 int alloc_console( struct process *process )
 166 {
 167     if (process->console_in || process->console_out)
 168     {
 169         set_error( ERROR_ACCESS_DENIED );
 170         return 0;
 171     }
 172     if ((process->console_in = create_console_input( -1 )))
 173     {
 174         if ((process->console_out = create_console_output( -1, process->console_in )))
 175             return 1;
 176         release_object( process->console_in );
 177     }
 178     return 0;
 179 }
 180
 181 /* free the console for this process */
 182 int free_console( struct process *process )
 183 {
 184     if (process->console_in) release_object( process->console_in );
 185     if (process->console_out) release_object( process->console_out );
 186     process->console_in = process->console_out = NULL;
 187     return 1;
 188 }
 189
 190 static int set_console_fd( int handle, int fd_in, int fd_out, int pid )
 191 {
 192     struct console_input *input;
 193     struct screen_buffer *output;
 194     struct object *obj;
 195
 196     if (!(obj = get_handle_obj( current->process, handle, 0, NULL )))
 197         return 0;
 198     if (obj->ops == &console_input_ops)
 199     {
 200         input = (struct console_input *)obj;
 201         output = input->output;
 202         grab_object( output );
 203     }
 204     else if (obj->ops == &screen_buffer_ops)
 205     {
 206         output = (struct screen_buffer *)obj;
 207         input = output->input;
 208         grab_object( input );
 209     }
 210     else
 211     {
 212         set_error( ERROR_INVALID_HANDLE );
 213         release_object( obj );
 214         return 0;
 215     }
 216
 217     /* can't change the fd if someone is waiting on it */
 218     assert( !input->obj.head );
 219     assert( !output->obj.head );
 220
 221     unregister_select_user( &input->select );
 222     unregister_select_user( &output->select );
 223     close( input->select.fd );
 224     close( output->select.fd );
 225     input->select.fd  = fd_in;
 226     output->select.fd = fd_out;
 227     output->pid       = pid;
 228     register_select_user( &input->select );
 229     register_select_user( &output->select );
 230     release_object( input );
 231     release_object( output );
 232     return 1;
 233 }
 234
 235 static int get_console_mode( int handle )
 236 {
 237     struct object *obj;
 238     int ret = 0;
 239
 240     if ((obj = get_handle_obj( current->process, handle, GENERIC_READ, NULL )))
 241     {
 242         if (obj->ops == &console_input_ops)
 243             ret = ((struct console_input *)obj)->mode;
 244         else if (obj->ops == &screen_buffer_ops)
 245             ret = ((struct screen_buffer *)obj)->mode;
 246         else
 247             set_error( ERROR_INVALID_HANDLE );
 248         release_object( obj );
 249     }
 250     return ret;
 251 }
 252
 253 static int set_console_mode( int handle, int mode )
 254 {
 255     struct object *obj;
 256     int ret = 0;
 257
 258     if (!(obj = get_handle_obj( current->process, handle, GENERIC_READ, NULL )))
 259         return 0;
 260     if (obj->ops == &console_input_ops)
 261     {
 262         ((struct console_input *)obj)->mode = mode;
 263         ret = 1;
 264     }
 265     else if (obj->ops == &screen_buffer_ops)
 266     {
 267         ((struct screen_buffer *)obj)->mode = mode;
 268         ret = 1;
 269     }
 270     else set_error( ERROR_INVALID_HANDLE );
 271     release_object( obj );
 272     return ret;
 273 }
 274
 275 /* set misc console information (output handle only) */
 276 static int set_console_info( int handle, struct set_console_info_request *req,
 277                              const char *title, size_t len )
 278 {
 279     struct screen_buffer *console;
 280     if (!(console = (struct screen_buffer *)get_handle_obj( current->process, handle,
 281                                                             GENERIC_WRITE, &screen_buffer_ops )))
 282         return 0;
 283     if (req->mask & SET_CONSOLE_INFO_CURSOR)
 284     {
 285         console->cursor_size    = req->cursor_size;
 286         console->cursor_visible = req->cursor_visible;
 287     }
 288     if (req->mask & SET_CONSOLE_INFO_TITLE)
 289     {
 290         char *new_title = mem_alloc( len + 1 );
 291         if (new_title)
 292         {
 293             memcpy( new_title, title, len );
 294             new_title[len] = 0;
 295             if (console->title) free( console->title );
 296             console->title = new_title;
 297         }
 298     }
 299     release_object( console );
 300     return 1;
 301 }
 302
 303 /* add input events to a console input queue */
 304 static int write_console_input( int handle, int count, INPUT_RECORD *records )
 305 {
 306     INPUT_RECORD *new_rec;
 307     struct console_input *console;
 308
 309     if (!(console = (struct console_input *)get_handle_obj( current->process, handle,
 310                                                             GENERIC_WRITE, &console_input_ops )))
 311         return -1;
 312     if (!(new_rec = realloc( console->records,
 313                              (console->recnum + count) * sizeof(INPUT_RECORD) )))
 314     {
 315         set_error( ERROR_NOT_ENOUGH_MEMORY );
 316         release_object( console );
 317         return -1;
 318     }
 319     console->records = new_rec;
 320     memcpy( new_rec + console->recnum, records, count * sizeof(INPUT_RECORD) );
 321     console->recnum += count;
 322     release_object( console );
 323     return count;
 324 }
 325
 326 /* retrieve a pointer to the console input records */
 327 static int read_console_input( int handle, int count, INPUT_RECORD *rec, int max, int flush )
 328 {
 329     struct console_input *console;
 330
 331     if (!(console = (struct console_input *)get_handle_obj( current->process, handle,
 332                                                             GENERIC_READ, &console_input_ops )))
 333         return -1;
 334     if ((count < 0) || (count > console->recnum)) count = console->recnum;
 335     if (count > max) count = max;
 336     memcpy( rec, console->records, count * sizeof(INPUT_RECORD) );
 337     if (flush)
 338     {
 339         int i;
 340         for (i = count; i < console->recnum; i++)
 341             console->records[i-count] = console->records[i];
 342         if ((console->recnum -= count) > 0)
 343         {
 344             INPUT_RECORD *new_rec = realloc( console->records,
 345                                              console->recnum * sizeof(INPUT_RECORD) );
 346             if (new_rec) console->records = new_rec;
 347         }
 348         else
 349         {
 350             free( console->records );
 351             console->records = NULL;
 352         }
 353     }
 354     release_object( console );
 355     return count;
 356 }
 357
 358 static void console_input_dump( struct object *obj, int verbose )
 359 {
 360     struct console_input *console = (struct console_input *)obj;
 361     assert( obj->ops == &console_input_ops );
 362     fprintf( stderr, "Console input fd=%d\n", console->select.fd );
 363 }
 364
 365 static int console_input_add_queue( struct object *obj, struct wait_queue_entry *entry )
 366 {
 367     struct console_input *console = (struct console_input *)obj;
 368     assert( obj->ops == &console_input_ops );
 369     if (!obj->head)  /* first on the queue */
 370         set_select_events( &console->select, READ_EVENT );
 371     add_queue( obj, entry );
 372     return 1;
 373 }
 374
 375 static void console_input_remove_queue( struct object *obj, struct wait_queue_entry *entry )
 376 {
 377     struct console_input *console = (struct console_input *)grab_object(obj);
 378     assert( obj->ops == &console_input_ops );
 379
 380     remove_queue( obj, entry );
 381     if (!obj->head)  /* last on the queue is gone */
 382         set_select_events( &console->select, 0 );
 383     release_object( obj );
 384 }
 385
 386 static int console_input_signaled( struct object *obj, struct thread *thread )
 387 {
 388     struct console_input *console = (struct console_input *)obj;
 389     assert( obj->ops == &console_input_ops );
 390
 391     if (check_select_events( &console->select, READ_EVENT ))
 392     {
 393         /* stop waiting on select() if we are signaled */
 394         set_select_events( &console->select, 0 );
 395         return 1;
 396     }
 397     else
 398     {
 399         /* restart waiting on select() if we are no longer signaled */
 400         if (obj->head) set_select_events( &console->select, READ_EVENT );
 401         return 0;
 402     }
 403 }
 404
 405 static int console_input_get_read_fd( struct object *obj )
 406 {
 407     struct console_input *console = (struct console_input *)obj;
 408     assert( obj->ops == &console_input_ops );
 409     return dup( console->select.fd );
 410 }
 411
 412 static int console_get_info( struct object *obj, struct get_file_info_request *req )
 413 {
 414     req->type        = FILE_TYPE_CHAR;
 415     req->attr        = 0;
 416     req->access_time = 0;
 417     req->write_time  = 0;
 418     req->size_high   = 0;
 419     req->size_low    = 0;
 420     req->links       = 0;
 421     req->index_high  = 0;
 422     req->index_low   = 0;
 423     req->serial      = 0;
 424     return 1;
 425 }
 426
 427 static void console_input_destroy( struct object *obj )
 428 {
 429     struct console_input *console = (struct console_input *)obj;
 430     assert( obj->ops == &console_input_ops );
 431     unregister_select_user( &console->select );
 432     close( console->select.fd );
 433     if (console->output) console->output->input = NULL;
 434 }
 435
 436 static void screen_buffer_dump( struct object *obj, int verbose )
 437 {
 438     struct screen_buffer *console = (struct screen_buffer *)obj;
 439     assert( obj->ops == &screen_buffer_ops );
 440     fprintf( stderr, "Console screen buffer fd=%d\n", console->select.fd );
 441 }
 442
 443 static int screen_buffer_add_queue( struct object *obj, struct wait_queue_entry *entry )
 444 {
 445     struct screen_buffer *console = (struct screen_buffer *)obj;
 446     assert( obj->ops == &screen_buffer_ops );
 447     if (!obj->head)  /* first on the queue */
 448         set_select_events( &console->select, WRITE_EVENT );
 449     add_queue( obj, entry );
 450     return 1;
 451 }
 452
 453 static void screen_buffer_remove_queue( struct object *obj, struct wait_queue_entry *entry )
 454 {
 455     struct screen_buffer *console = (struct screen_buffer *)grab_object(obj);
 456     assert( obj->ops == &screen_buffer_ops );
 457
 458     remove_queue( obj, entry );
 459     if (!obj->head)  /* last on the queue is gone */
 460         set_select_events( &console->select, 0 );
 461     release_object( obj );
 462 }
 463
 464 static int screen_buffer_signaled( struct object *obj, struct thread *thread )
 465 {
 466     struct screen_buffer *console = (struct screen_buffer *)obj;
 467     assert( obj->ops == &screen_buffer_ops );
 468
 469     if (check_select_events( &console->select, WRITE_EVENT ))
 470     {
 471         /* stop waiting on select() if we are signaled */
 472         set_select_events( &console->select, 0 );
 473         return 1;
 474     }
 475     else
 476     {
 477         /* restart waiting on select() if we are no longer signaled */
 478         if (obj->head) set_select_events( &console->select, WRITE_EVENT );
 479         return 0;
 480     }
 481 }
 482
 483 static int screen_buffer_get_write_fd( struct object *obj )
 484 {
 485     struct screen_buffer *console = (struct screen_buffer *)obj;
 486     assert( obj->ops == &screen_buffer_ops );
 487     return dup( console->select.fd );
 488 }
 489
 490 static void screen_buffer_destroy( struct object *obj )
 491 {
 492     struct screen_buffer *console = (struct screen_buffer *)obj;
 493     assert( obj->ops == &screen_buffer_ops );
 494     unregister_select_user( &console->select );
 495     close( console->select.fd );
 496     if (console->input) console->input->output = NULL;
 497     if (console->title) free( console->title );
 498 }
 499
 500 /* allocate a console for the current process */
 501 DECL_HANDLER(alloc_console)
 502 {
 503     int in = -1, out = -1;
 504
 505     if (!alloc_console( current->process )) goto done;
 506
 507     if ((in = alloc_handle( current->process, current->process->console_in,
 508                             req->access, req->inherit )) != -1)
 509     {
 510         if ((out = alloc_handle( current->process, current->process->console_out,
 511                                  req->access, req->inherit )) != -1)
 512             goto done;  /* everything is fine */
 513         close_handle( current->process, in );
 514         in = -1;
 515     }
 516     free_console( current->process );
 517
 518  done:
 519     req->handle_in  = in;
 520     req->handle_out = out;
 521 }
 522
 523 /* free the console of the current process */
 524 DECL_HANDLER(free_console)
 525 {
 526     free_console( current->process );
 527 }
 528
 529 /* open a handle to the process console */
 530 DECL_HANDLER(open_console)
 531 {
 532     struct object *obj= req->output ? current->process->console_out : current->process->console_in;
 533
 534     if (obj) req->handle = alloc_handle( current->process, obj, req->access, req->inherit );
 535     else set_error( ERROR_ACCESS_DENIED );
 536 }
 537
 538 /* set info about a console (output only) */
 539 DECL_HANDLER(set_console_info)
 540 {
 541     size_t len = get_req_strlen( req->title );
 542     set_console_info( req->handle, req, req->title, len );
 543 }
 544
 545 /* get info about a console (output only) */
 546 DECL_HANDLER(get_console_info)
 547 {
 548     struct screen_buffer *console;
 549     if ((console = (struct screen_buffer *)get_handle_obj( current->process, req->handle,
 550                                                            GENERIC_READ, &screen_buffer_ops )))
 551     {
 552         req->cursor_size    = console->cursor_size;
 553         req->cursor_visible = console->cursor_visible;
 554         req->pid            = console->pid;
 555         strcpy( req->title, console->title ? console->title : "" );
 556         release_object( console );
 557     }
 558 }
 559
 560 /* set a console fd */
 561 DECL_HANDLER(set_console_fd)
 562 {
 563     struct object *obj;
 564     int fd_in, fd_out;
 565
 566     if (!(obj = get_handle_obj( current->process, req->file_handle,
 567                                 GENERIC_READ | GENERIC_WRITE, NULL ))) return;
 568     if ((fd_in = obj->ops->get_read_fd( obj )) == -1)
 569     {
 570         release_object( obj );
 571         return;
 572     }
 573     fd_out = obj->ops->get_write_fd( obj );
 574     release_object( obj );
 575     if (fd_out != -1)
 576     {
 577         if (set_console_fd( req->handle, fd_in, fd_out, req->pid )) return;
 578         close( fd_out );
 579     }
 580     close( fd_in );
 581 }
 582
 583 /* get a console mode (input or output) */
 584 DECL_HANDLER(get_console_mode)
 585 {
 586     req->mode = get_console_mode( req->handle );
 587 }
 588
 589 /* set a console mode (input or output) */
 590 DECL_HANDLER(set_console_mode)
 591 {
 592     set_console_mode( req->handle, req->mode );
 593 }
 594
 595 /* add input records to a console input queue */
 596 DECL_HANDLER(write_console_input)
 597 {
 598     int max = get_req_size( req + 1, sizeof(INPUT_RECORD) );
 599     int count = req->count;
 600
 601     if (count > max) count = max;
 602     req->written = write_console_input( req->handle, count, (INPUT_RECORD *)(req + 1) );
 603 }
 604
 605 /* fetch input records from a console input queue */
 606 DECL_HANDLER(read_console_input)
 607 {
 608     int max = get_req_size( req + 1, sizeof(INPUT_RECORD) );
 609     req->read = read_console_input( req->handle, req->count, (INPUT_RECORD *)(req + 1),
 610                                     max, req->flush );
 611 }