KernelLand/Kernel/vfs/select.c

   1 /*
   2  * Acess2 VFS
   3  * - By thePowersGang (John Hodge)
   4  *
   5  * select.c
   6  * - Implements the select() system call (and supporting code)
   7  *
   8  * TODO: Remove malloc for read/write queues
   9  */
  10 #define DEBUG   0
  11 #include <acess.h>
  12 #include "vfs.h"
  13 #include "vfs_int.h"
  14 #include "vfs_ext.h"
  15 #include <semaphore.h>
  16 #include <threads.h>
  17 #include <events.h>
  18 #include <timers.h>
  19
  20 // === CONSTANTS ===
  21 #define NUM_THREADS_PER_ALLOC   4
  22
  23 // === TYPES ===
  24 typedef struct sVFS_SelectListEnt       tVFS_SelectListEnt;
  25
  26 // === STRUCTURES ===
  27 struct sVFS_SelectListEnt
  28 {
  29         tVFS_SelectListEnt      *Next;
  30         tThread *Threads[NUM_THREADS_PER_ALLOC];
  31 };
  32
  33 // NOTE: Typedef is in vfs.h
  34 struct sVFS_SelectList
  35 {
  36         tMutex  Lock;
  37         tVFS_SelectListEnt      FirstEnt;
  38 };
  39
  40 // === PROTOTYPES ===
  41 // int  VFS_SelectNode(tVFS_Node *Node, enum eVFS_SelectTypes Type, tTime *Timeout);
  42 // int  VFS_Select(int MaxHandle, fd_set *ReadHandles, fd_set *WriteHandles, fd_set *ErrHandles, tTime *Timeout, Uint32 ExtraEvents, BOOL IsKernel);
  43 // int  VFS_MarkFull(tVFS_Node *Node, BOOL IsBufferFull);
  44 // int  VFS_MarkAvaliable(tVFS_Node *Node, BOOL IsDataAvaliable);
  45 // int  VFS_MarkError(tVFS_Node *Node, BOOL IsErrorState);
  46  int    VFS_int_Select_GetType(int Type, tVFS_Node *Node, tVFS_SelectList ***List, int **Flag, int *WantedFlag, int *MaxAllowed);
  47  int    VFS_int_Select_Register(tThread *Thread, int MaxHandle, fd_set *Handles, int Type, BOOL IsKernel);
  48  int    VFS_int_Select_Deregister(tThread *Thread, int MaxHandle, fd_set *Handles, int Type, BOOL IsKernel);
  49  int    VFS_int_Select_AddThread(tVFS_SelectList *List, tThread *Thread, int MaxAllowed);
  50 void    VFS_int_Select_RemThread(tVFS_SelectList *List, tThread *Thread);
  51 void    VFS_int_Select_SignalAll(tVFS_SelectList *List);
  52
  53 // === GLOBALS ===
  54
  55 // === FUNCTIONS ===
  56 int VFS_SelectNode(tVFS_Node *Node, int TypeFlags, tTime *Timeout, const char *Name)
  57 {
  58         tThread *thisthread = Proc_GetCurThread();
  59          int    ret, type;
  60
  61         ENTER("pNode iTypeFlags pTimeout sName", Node, TypeFlags, Timeout, Name);
  62
  63         // Initialise
  64         for( type = 0; type < 3; type ++ )
  65         {
  66                 tVFS_SelectList **list;
  67                  int    *flag, wanted, maxAllowed;
  68                 if( !(TypeFlags & (1 << type)) )        continue;
  69                 if( VFS_int_Select_GetType(type, Node, &list, &flag, &wanted, &maxAllowed) ) {
  70                         LEAVE('i', -1);
  71                         return -1;
  72                 }
  73
  74                 // Alloc if needed
  75                 if( !*list )    *list = calloc(1, sizeof(tVFS_SelectList));
  76
  77                 VFS_int_Select_AddThread(*list, thisthread, maxAllowed);
  78                 if( *flag == wanted )
  79                 {
  80                         VFS_int_Select_RemThread(*list, thisthread);
  81                         LEAVE('i', 1);
  82                         return 1;
  83                 }
  84         }
  85
  86         // Wait for things
  87         if( !Timeout )
  88         {
  89                 LOG("Semaphore_Wait()");
  90                 // TODO: Actual timeout
  91                 Threads_WaitEvents( THREAD_EVENT_VFS|THREAD_EVENT_SIGNAL );
  92         }
  93         else if( *Timeout > 0 )
  94         {
  95                 tTimer *t = Time_AllocateTimer(NULL, NULL);
  96                 // Clear timer event
  97                 Threads_ClearEvent( THREAD_EVENT_TIMER );
  98                 // TODO: Convert *Timeout?
  99                 LOG("Timeout %lli ms", *Timeout);
 100                 Time_ScheduleTimer( t, *Timeout );
 101                 // Wait for the timer or a VFS event
 102                 Threads_WaitEvents( THREAD_EVENT_VFS|THREAD_EVENT_TIMER|THREAD_EVENT_SIGNAL );
 103                 Time_FreeTimer(t);
 104         }
 105
 106         // Get return value
 107         ret = 0;
 108         for( type = 0; type < 3; type ++ )
 109         {
 110                 tVFS_SelectList **list;
 111                  int    *flag, wanted, maxAllowed;
 112                 if( !(TypeFlags & (1 << type)) )        continue;
 113                 VFS_int_Select_GetType(type, Node, &list, &flag, &wanted, &maxAllowed);
 114                 LOG("VFS_int_Select_RemThread()");
 115                 ASSERT(*list);
 116                 VFS_int_Select_RemThread(*list, thisthread);
 117                 ret = ret || *flag == wanted;
 118         }
 119
 120         Threads_ClearEvent( THREAD_EVENT_VFS );
 121         Threads_ClearEvent( THREAD_EVENT_TIMER );
 122
 123         LEAVE('i', ret);
 124         return ret;
 125 }
 126
 127 int VFS_Select(int MaxHandle, fd_set *ReadHandles, fd_set *WriteHandles, fd_set *ErrHandles, tTime *Timeout, Uint32 ExtraEvents, BOOL IsKernel)
 128 {
 129         tThread *thisthread = Proc_GetCurThread();
 130          int    ret;
 131
 132         ENTER("iMaxHandle pReadHandles pWriteHandles pErrHandles pTimeout xExtraEvents bIsKernel",
 133                 MaxHandle, ReadHandles, WriteHandles, ErrHandles, Timeout, ExtraEvents, IsKernel);
 134
 135         // Notes: The idea is to make sure we only enter wait (Threads_WaitEvents)
 136         // if we are going to be woken up (either by an event at a later time,
 137         // or by an event that happened while or before we were registering).
 138         // Hence, register must happen _before_ we check the state flag
 139         // (See VFS_int_Select_Register), that way either we pick up the flag,
 140         // or the semaphore is incremeneted (or both, but never none)
 141
 142         // Register with nodes
 143         if( ReadHandles )
 144                 LOG(" - ReadHandles[0] = %x", ReadHandles->flags[0]);
 145         ret  = VFS_int_Select_Register(thisthread, MaxHandle, ReadHandles, 0, IsKernel);
 146         ret += VFS_int_Select_Register(thisthread, MaxHandle, WriteHandles, 1, IsKernel);
 147         ret += VFS_int_Select_Register(thisthread, MaxHandle, ErrHandles, 2, IsKernel);
 148
 149         LOG("Register ret = %i", ret);
 150
 151         // If there were events waiting, de-register and return
 152         if( ret > 0 )
 153         {
 154                 LOG(" - ReadHandles[0] = %x", ReadHandles->flags[0]);
 155                 ret  = VFS_int_Select_Deregister(thisthread, MaxHandle, ReadHandles, 0, IsKernel);
 156                 ret += VFS_int_Select_Deregister(thisthread, MaxHandle, WriteHandles, 1, IsKernel);
 157                 ret += VFS_int_Select_Deregister(thisthread, MaxHandle, ErrHandles, 2, IsKernel);
 158                 LOG(" - ReadHandles[0] = %x", ReadHandles->flags[0]);
 159                 LEAVE('i', ret);
 160                 return ret;
 161         }
 162
 163         // Wait for things
 164         if( !Timeout )
 165         {
 166                 LOG("Semaphore_Wait()");
 167                 // TODO: Actual timeout
 168                 Threads_WaitEvents( THREAD_EVENT_VFS|THREAD_EVENT_SIGNAL|ExtraEvents );
 169         }
 170         else if( *Timeout > 0 )
 171         {
 172                 tTimer *t = Time_AllocateTimer(NULL, NULL);
 173                 // Clear timer event
 174                 Threads_ClearEvent( THREAD_EVENT_TIMER );
 175                 // TODO: Convert *Timeout?
 176                 LOG("Timeout %lli ms", *Timeout);
 177                 Time_ScheduleTimer( t, *Timeout );
 178                 // Wait for the timer or a VFS event
 179                 Threads_WaitEvents( THREAD_EVENT_VFS|THREAD_EVENT_TIMER|ExtraEvents );
 180                 Time_FreeTimer(t);
 181         }
 182         // Fill output (modify *Handles)
 183         // - Also, de-register
 184         ret  = VFS_int_Select_Deregister(thisthread, MaxHandle, ReadHandles, 0, IsKernel);
 185         ret += VFS_int_Select_Deregister(thisthread, MaxHandle, WriteHandles, 1, IsKernel);
 186         ret += VFS_int_Select_Deregister(thisthread, MaxHandle, ErrHandles, 2, IsKernel);
 187
 188         Threads_ClearEvent( THREAD_EVENT_VFS );
 189         Threads_ClearEvent( THREAD_EVENT_TIMER );
 190
 191         LEAVE('i', ret);
 192         return ret;
 193 }
 194
 195 // Mark a node as having data ready for reading
 196 int VFS_MarkAvaliable(tVFS_Node *Node, BOOL IsDataAvaliable)
 197 {
 198         ENTER("pNode bIsDataAvaliable", Node, IsDataAvaliable);
 199         Node->DataAvaliable = !!IsDataAvaliable;
 200         if( Node->DataAvaliable )
 201                 VFS_int_Select_SignalAll(Node->ReadThreads);
 202         LEAVE('i', 0);
 203         return 0;
 204 }
 205
 206 // Mark a node as having a full buffer
 207 int VFS_MarkFull(tVFS_Node *Node, BOOL IsBufferFull)
 208 {
 209         ENTER("pNode bIsBufferFull", Node, IsBufferFull);
 210         Node->BufferFull = !!IsBufferFull;
 211         if( !Node->BufferFull )
 212                 VFS_int_Select_SignalAll(Node->WriteThreads);
 213         LEAVE('i', 0);
 214         return 0;
 215 }
 216
 217 // Mark a node as errored
 218 int VFS_MarkError(tVFS_Node *Node, BOOL IsErrorState)
 219 {
 220         ENTER("pNode bIsErrorState", Node, IsErrorState);
 221         Node->ErrorOccurred = !!IsErrorState;
 222         if( Node->ErrorOccurred )
 223                 VFS_int_Select_SignalAll(Node->ErrorThreads);
 224         LEAVE('i', 0);
 225         return 0;
 226 }
 227
 228 // --- Internal ---
 229 int VFS_int_Select_GetType(int Type, tVFS_Node *Node, tVFS_SelectList ***List, int **Flag, int *WantedFlag, int *MaxAllowed)
 230 {
 231         // Get the type of the listen
 232         switch(Type)
 233         {
 234         case 0: // Read
 235                 if(List)        *List = &Node->ReadThreads;
 236                 if(Flag)        *Flag = &Node->DataAvaliable;
 237                 if(WantedFlag)  *WantedFlag = 1;
 238                 if(MaxAllowed)  *MaxAllowed = 1;        // Max of 1 for read
 239                 break;
 240         case 1: // Write
 241                 if(List)        *List = &Node->WriteThreads;
 242                 if(Flag)        *Flag = &Node->BufferFull;
 243                 if(WantedFlag)  *WantedFlag = 0;
 244                 if(MaxAllowed)  *MaxAllowed = 1;        // Max of 1 for write
 245                 break;
 246         case 2: // Error
 247                 if(List)        *List = &Node->ErrorThreads;
 248                 if(Flag)        *Flag = &Node->ErrorOccurred;
 249                 if(WantedFlag)  *WantedFlag = 1;
 250                 if(MaxAllowed)  *MaxAllowed = -1;       // No max for error listeners
 251                 break;
 252         default:
 253                 Log_Error("VFS", "VFS_int_Select_GetType: BUG CHECK, Unknown Type %i", Type);
 254                 return 1;
 255         }
 256         return 0;
 257 }
 258
 259 /**
 260  * \return Number of files with an action
 261  */
 262 int VFS_int_Select_Register(tThread *Thread, int MaxHandle, fd_set *Handles, int Type, BOOL IsKernel)
 263 {
 264          int    i, numFlagged = 0;
 265         tVFS_SelectList **list;
 266          int    *flag, wantedFlagValue;
 267          int    maxAllowed;
 268
 269         if( !Handles )  return 0;
 270
 271         ENTER("pThread iMaxHandle pHandles iType iIsKernel", Thread, MaxHandle, Handles, Type, IsKernel);
 272
 273         for( i = 0; i < MaxHandle; i ++ )
 274         {
 275                 tVFS_Handle     *handle;
 276
 277                 // Is the descriptor set
 278                 if( !FD_ISSET(i, Handles) )     continue;
 279                 LOG("FD #%i", i);
 280
 281                 handle = VFS_GetHandle( i | (IsKernel?VFS_KERNEL_FLAG:0) );
 282                 // Is the handle valid?
 283                 if( !handle || !handle->Node )
 284                 {
 285                         if( Type == 2 ) {       // Bad FD counts as an error
 286                                 numFlagged ++;
 287                         }
 288                         else {
 289                                 FD_CLR(i, Handles);
 290                         }
 291                         continue;
 292                 }
 293
 294                 // Get the type of the listen
 295                 if( VFS_int_Select_GetType(Type, handle->Node, &list, &flag, &wantedFlagValue, &maxAllowed) ) {
 296                         LEAVE('i', 0);
 297                         return 0;
 298                 }
 299
 300                 // Alloc if needed
 301                 if( !*list ) {
 302                         *list = calloc(1, sizeof(tVFS_SelectList));
 303                 }
 304
 305                 // Register
 306                 if( VFS_int_Select_AddThread(*list, Thread, maxAllowed ) )
 307                 {
 308                         // Oops, error (or just no space)
 309                         FD_CLR(i, Handles);
 310                 }
 311
 312                 // Check for the flag
 313                 if( !!*flag == !!wantedFlagValue ) {
 314                         LOG(" %i == want %i", !!*flag, !!wantedFlagValue);
 315                         numFlagged ++;
 316                 }
 317         }
 318
 319         LEAVE('i', numFlagged);
 320
 321         return numFlagged;
 322 }
 323 /**
 324  * \return Number of files with an action
 325  */
 326 int VFS_int_Select_Deregister(tThread *Thread, int MaxHandle, fd_set *Handles, int Type, BOOL IsKernel)
 327 {
 328          int    i, numFlagged = 0;
 329         tVFS_SelectList **list;
 330          int    *flag, wantedFlagValue;
 331
 332         if( !Handles )  return 0;
 333
 334         ENTER("pThread iMaxHandle pHandles iType iIsKernel", Thread, MaxHandle, Handles, Type, IsKernel);
 335
 336         for( i = 0; i < MaxHandle; i ++ )
 337         {
 338                 tVFS_Handle     *handle;
 339
 340                 // Is the descriptor set
 341                 if( !FD_ISSET(i, Handles) )     continue;
 342                 LOG("FD #%i", i);
 343
 344                 handle = VFS_GetHandle( i | (IsKernel?VFS_KERNEL_FLAG:0) );
 345                 // Is the handle valid?
 346                 if( !handle || !handle->Node )
 347                 {
 348                         if( Type == 2 ) {       // Bad FD counts as an error
 349                                 numFlagged ++;
 350                         }
 351                         else {
 352                                 FD_CLR(i, Handles);
 353                         }
 354                         continue;
 355                 }
 356
 357                 // Get the type of the listen
 358                 if( VFS_int_Select_GetType(Type, handle->Node, &list, &flag, &wantedFlagValue, NULL) ) {
 359                         LEAVE('i', 0);
 360                         return 0;
 361                 }
 362
 363                 // Remove
 364                 VFS_int_Select_RemThread(*list, Thread );
 365
 366                 // Check for the flag
 367                 if( !!*flag == !!wantedFlagValue ) {
 368                         numFlagged ++;
 369                         LOG(" %i == want %i", !!*flag, !!wantedFlagValue);
 370                         FD_SET(i, Handles);
 371                 }
 372                 else {
 373                         FD_CLR(i, Handles);
 374                 }
 375         }
 376
 377         LEAVE('i', numFlagged);
 378
 379         return numFlagged;
 380 }
 381
 382 /**
 383  * \return Boolean failure
 384  */
 385 int VFS_int_Select_AddThread(tVFS_SelectList *List, tThread *Thread, int MaxAllowed)
 386 {
 387          int    i, count = 0;
 388         tVFS_SelectListEnt      *block, *prev;
 389
 390         ENTER("pList pThread iMaxAllowed", List, Thread, MaxAllowed);
 391
 392         // Lock to avoid concurrency issues
 393         Mutex_Acquire(&List->Lock);
 394
 395         block = &List->FirstEnt;
 396
 397         // Look for free space
 398         do
 399         {
 400                 for( i = 0; i < NUM_THREADS_PER_ALLOC; i ++ )
 401                 {
 402                         if( block->Threads[i] == NULL )
 403                         {
 404                                 block->Threads[i] = Thread;
 405                                 Mutex_Release(&List->Lock);
 406                                 LEAVE('i', 0);
 407                                 return 0;
 408                         }
 409                         count ++;
 410                         if( MaxAllowed && count >= MaxAllowed ) {
 411                                 Mutex_Release(&List->Lock);
 412                                 LEAVE('i', 1);
 413                                 return 1;
 414                         }
 415                 }
 416
 417                 prev = block;
 418                 block = block->Next;
 419         } while(block);
 420
 421         LOG("New block");
 422
 423         // Create new block
 424         block = malloc( sizeof(tVFS_SelectListEnt) );
 425         if( !block ) {
 426                 Log_Warning("VFS", "VFS_int_Select_AddThread: malloc() failed");
 427                 Mutex_Release(&List->Lock);
 428                 return -1;
 429         }
 430         block->Next = NULL;
 431         block->Threads[0] = Thread;
 432         for( i = 1; i < NUM_THREADS_PER_ALLOC; i ++ )
 433         {
 434                 block->Threads[i] = NULL;
 435         }
 436
 437         // Add to list
 438         prev->Next = block;
 439
 440         // Release
 441         Mutex_Release(&List->Lock);
 442
 443         LEAVE('i', 0);
 444         return 0;
 445 }
 446
 447 void VFS_int_Select_RemThread(tVFS_SelectList *List, tThread *Thread)
 448 {
 449         tVFS_SelectListEnt      *block, *prev = NULL;
 450
 451         ENTER("pList pThread", List, Thread);
 452
 453         // Lock to avoid concurrency issues
 454         Mutex_Acquire(&List->Lock);
 455
 456         block = &List->FirstEnt;
 457
 458         // Look for the thread
 459         do
 460         {
 461                 for( int i = 0; i < NUM_THREADS_PER_ALLOC; i ++ )
 462                 {
 463                         if( block->Threads[i] == Thread )
 464                         {
 465                                 block->Threads[i] = NULL;
 466
 467                                 // Check if this block is empty
 468                                 if( block != &List->FirstEnt )
 469                                 {
 470                                         for( i = 0; i < NUM_THREADS_PER_ALLOC; i ++ )
 471                                                 if( block->Threads[i] )
 472                                                         break;
 473                                         // If empty, free it
 474                                         if( i == NUM_THREADS_PER_ALLOC ) {
 475                                                 LOG("Deleting block");
 476                                                 prev->Next = block->Next;
 477                                                 free(block);
 478                                         }
 479                                         //TODO: If not empty, check if it can be merged downwards
 480                                 }
 481
 482                                 Mutex_Release(&List->Lock);
 483                                 LEAVE('-');
 484                                 return ;
 485                         }
 486                 }
 487
 488                 prev = block;
 489                 block = block->Next;
 490         } while(block);
 491
 492         // Not on list, is this an error?
 493
 494         Mutex_Release(&List->Lock);
 495
 496         LOG("Not on list");
 497         LEAVE('-');
 498 }
 499
 500 /**
 501  * \brief Signal all threads on a list
 502  */
 503 void VFS_int_Select_SignalAll(tVFS_SelectList *List)
 504 {
 505          int    i;
 506         tVFS_SelectListEnt      *block;
 507
 508         if( !List )     return ;
 509
 510         ENTER("pList", List);
 511
 512         // Lock to avoid concurrency issues
 513         Mutex_Acquire(&List->Lock);
 514
 515         block = &List->FirstEnt;
 516
 517         // Look for the thread
 518         do
 519         {
 520                 for( i = 0; i < NUM_THREADS_PER_ALLOC; i ++ )
 521                 {
 522                         if( block->Threads[i]  )
 523                         {
 524                                 LOG("block(%p)->Threads[%i] = %p", block, i, block->Threads[i]);
 525                                 Threads_PostEvent( block->Threads[i], THREAD_EVENT_VFS );
 526                         }
 527                 }
 528
 529                 block = block->Next;
 530         } while(block);
 531
 532         Mutex_Release(&List->Lock);
 533
 534         LEAVE('-');
 535 }