Kernel/drv/proc.c

   1 /*
   2  * Acess2
   3  * - Kernel Status Driver
   4  */
   5 #define DEBUG   1
   6 #include <acess.h>
   7 #include <modules.h>
   8 #include <fs_devfs.h>
   9 #include <fs_sysfs.h>
  10
  11 // === CONSTANTS ===
  12 #define VERSION ((0 << 8) | (1))        // 0.01
  13
  14 // === TYPES ===
  15 typedef struct sSysFS_Ent
  16 {
  17         struct sSysFS_Ent       *Next;
  18         struct sSysFS_Ent       *ListNext;
  19         struct sSysFS_Ent       *Parent;
  20         tVFS_Node       Node;
  21         char    Name[];
  22 } tSysFS_Ent;
  23
  24 // === PROTOTYPES ===
  25  int    SysFS_Install(char **Arguments);
  26  int    SysFS_IOCtl(tVFS_Node *Node, int Id, void *Data);
  27
  28 #if 0
  29  int    SysFS_RegisterFile(const char *Path, const char *Data, int Length);
  30  int    SysFS_UpdateFile(int ID, const char *Data, int Length);
  31  int    SysFS_RemoveFile(int ID);
  32 #endif
  33
  34 char    *SysFS_Comm_ReadDir(tVFS_Node *Node, int Id);
  35 tVFS_Node       *SysFS_Comm_FindDir(tVFS_Node *Node, const char *Filename);
  36 Uint64  SysFS_Comm_ReadFile(tVFS_Node *Node, Uint64 Offset, Uint64 Length, void *Buffer);
  37 void    SysFS_Comm_CloseFile(tVFS_Node *Node);
  38
  39 // === GLOBALS ===
  40 extern tSysFS_Ent       gSysFS_Version; // Defined Later
  41 extern tSysFS_Ent       gSysFS_Root;    // Defined Later
  42 MODULE_DEFINE(0, VERSION, SysFS, SysFS_Install, NULL, NULL);
  43 tVFS_NodeType   gSysFS_FileNodeType = {
  44         .TypeName = "SysFS File",
  45         .Read = SysFS_Comm_ReadFile
  46         };
  47 tVFS_NodeType   gSysFS_DirNodeType = {
  48         .TypeName = "SysFS Dir",
  49         .ReadDir = SysFS_Comm_ReadDir,
  50         .FindDir = SysFS_Comm_FindDir
  51         };
  52 tSysFS_Ent      gSysFS_Version_Kernel = {
  53         NULL, NULL,     // Nexts
  54         &gSysFS_Version,        // Parent
  55         {
  56                 .Inode = 1,     // File #1
  57                 .ImplPtr = NULL,
  58                 .ImplInt = (Uint)&gSysFS_Version_Kernel,        // Self-Link
  59                 .Size = 0,
  60                 .NumACLs = 1,
  61                 .ACLs = &gVFS_ACL_EveryoneRO,
  62                 .Type = &gSysFS_FileNodeType
  63         },
  64         "Kernel"
  65 };
  66 tSysFS_Ent      gSysFS_Version = {
  67         NULL, NULL,
  68         &gSysFS_Root,
  69         {
  70                 .Size = 1,
  71                 .ImplPtr = &gSysFS_Version_Kernel,
  72                 .ImplInt = (Uint)&gSysFS_Version,       // Self-Link
  73                 .NumACLs = 1,
  74                 .ACLs = &gVFS_ACL_EveryoneRX,
  75                 .Flags = VFS_FFLAG_DIRECTORY,
  76                 .Type = &gSysFS_DirNodeType
  77         },
  78         "Version"
  79 };
  80 // Root of the SysFS tree (just used to keep the code clean)
  81 tSysFS_Ent      gSysFS_Root = {
  82         NULL, NULL,
  83         NULL,
  84         {
  85                 .Size = 1,
  86                 .ImplPtr = &gSysFS_Version,
  87                 .ImplInt = (Uint)&gSysFS_Root   // Self-Link
  88         },
  89         "/"
  90 };
  91 tDevFS_Driver   gSysFS_DriverInfo = {
  92         NULL, "system",
  93         {
  94         .NumACLs = 1,
  95         .ACLs = &gVFS_ACL_EveryoneRX,
  96         .Flags = VFS_FFLAG_DIRECTORY,
  97         .ImplPtr = &gSysFS_Version,
  98         .Size = sizeof(gSysFS_Root)/sizeof(tSysFS_Ent),
  99         .Type = &gSysFS_DirNodeType
 100         }
 101 };
 102  int    giSysFS_NextFileID = 2;
 103 tSysFS_Ent      *gSysFS_FileList;
 104
 105 // === CODE ===
 106 /**
 107  * \fn int SysFS_Install(char **Options)
 108  * \brief Installs the SysFS Driver
 109  */
 110 int SysFS_Install(char **Options)
 111 {
 112         {
 113                 const char      *fmt = "Acess2 "EXPAND_STR(KERNEL_VERSION)" "EXPAND_STR(ARCHDIR)" build %i, hash %s";
 114                 gSysFS_Version_Kernel.Node.Size = sprintf(NULL, fmt, BUILD_NUM, gsGitHash);
 115                 gSysFS_Version_Kernel.Node.ImplPtr = malloc( gSysFS_Version_Kernel.Node.Size + 1 );
 116                 sprintf(gSysFS_Version_Kernel.Node.ImplPtr, fmt, BUILD_NUM, gsGitHash);
 117         }
 118
 119         DevFS_AddDevice( &gSysFS_DriverInfo );
 120         return MODULE_ERR_OK;
 121 }
 122
 123 /**
 124  * \fn int SysFS_RegisterFile(char *Path, char *Data, int Length)
 125  * \brief Registers a file (buffer) for the user to be able to read from
 126  * \param Path  Path for the file to be accessable from (relative to SysFS root)
 127  * \param Data  Pointer to the data buffer (must be non-volatile)
 128  * \param Length        Length of the data buffer
 129  * \return The file's identifier
 130  */
 131 int SysFS_RegisterFile(const char *Path, const char *Data, int Length)
 132 {
 133          int    start = 0;
 134          int    tmp;
 135         tSysFS_Ent      *ent = NULL;
 136         tSysFS_Ent      *child, *prev;
 137
 138         // Find parent directory
 139         while( (tmp = strpos(&Path[start], '/')) != -1 )
 140         {
 141                 prev = NULL;
 142
 143                 if(ent)
 144                         child = ent->Node.ImplPtr;
 145                 else
 146                         child = gSysFS_DriverInfo.RootNode.ImplPtr;
 147                 for( ; child; prev = child, child = child->Next )
 148                 {
 149                         if( strncmp( &Path[start], child->Name, tmp+1 ) == '/' )
 150                                 break;
 151                 }
 152
 153                 // Need a new directory?
 154                 if( !child )
 155                 {
 156                         child = calloc( 1, sizeof(tSysFS_Ent)+tmp+1 );
 157                         child->Next = NULL;
 158                         memcpy(child->Name, &Path[start], tmp);
 159                         child->Name[tmp] = '\0';
 160                         child->Parent = ent;
 161                         child->Node.Inode = 0;
 162                         child->Node.ImplPtr = NULL;
 163                         child->Node.ImplInt = (Uint)child;      // Uplink
 164                         child->Node.NumACLs = 1;
 165                         child->Node.ACLs = &gVFS_ACL_EveryoneRX;
 166                         child->Node.Flags = VFS_FFLAG_DIRECTORY;
 167                         child->Node.Type = &gSysFS_DirNodeType;
 168                         if( !prev ) {
 169                                 if(ent)
 170                                         ent->Node.ImplPtr = child;
 171                                 else
 172                                         gSysFS_DriverInfo.RootNode.ImplPtr = child;
 173                                 // ^^^ Impossible (There is already /Version)
 174                         }
 175                         else
 176                                 prev->Next = child;
 177                         if(ent)
 178                                 ent->Node.Size ++;
 179                         else
 180                                 gSysFS_DriverInfo.RootNode.Size ++;
 181                         Log_Log("SysFS", "Added directory '%s'", child->Name);
 182                 }
 183
 184                 ent = child;
 185
 186                 start = tmp+1;
 187         }
 188
 189         // ent: Parent tSysFS_Ent or NULL
 190         // start: beginning of last path element
 191
 192         // Check if the name is taken
 193         prev = NULL;
 194         if(ent)
 195                 child = ent->Node.ImplPtr;
 196         else
 197                 child = gSysFS_DriverInfo.RootNode.ImplPtr;
 198         for( ; child; child = child->Next )
 199         {
 200                 if( strcmp( &Path[start], child->Name ) == 0 )
 201                         break;
 202         }
 203         if( child ) {
 204                 Log_Warning("SysFS", "'%s' is taken (in '%s')\n", &Path[start], Path);
 205                 return 0;
 206         }
 207
 208         // Create new node
 209         child = calloc( 1, sizeof(tSysFS_Ent)+strlen(&Path[start])+1 );
 210         child->Next = NULL;
 211         strcpy(child->Name, &Path[start]);
 212         child->Parent = ent;
 213
 214         child->Node.Inode = giSysFS_NextFileID++;
 215         child->Node.ImplPtr = (void*)Data;
 216         child->Node.ImplInt = (Uint)child;      // Uplink
 217         child->Node.Size = Length;
 218         child->Node.NumACLs = 1;
 219         child->Node.ACLs = &gVFS_ACL_EveryoneRO;
 220         child->Node.Type = &gSysFS_FileNodeType;
 221
 222         // Add to parent's child list
 223         if(ent) {
 224                 ent->Node.Size ++;
 225                 child->Next = ent->Node.ImplPtr;
 226                 ent->Node.ImplPtr = child;
 227         }
 228         else {
 229                 gSysFS_DriverInfo.RootNode.Size ++;
 230                 child->Next = gSysFS_DriverInfo.RootNode.ImplPtr;
 231                 gSysFS_DriverInfo.RootNode.ImplPtr = child;
 232         }
 233         // Add to global file list
 234         child->ListNext = gSysFS_FileList;
 235         gSysFS_FileList = child;
 236
 237         Log_Log("SysFS", "Added '%s' (%p)", Path, Data);
 238
 239         return child->Node.Inode;
 240 }
 241
 242 /**
 243  * \fn int SysFS_UpdateFile(int ID, char *Data, int Length)
 244  * \brief Updates a file
 245  * \param ID    Identifier returned by ::SysFS_RegisterFile
 246  * \param Data  Pointer to the data buffer
 247  * \param Length        Length of the data buffer
 248  * \return Boolean Success
 249  */
 250 int SysFS_UpdateFile(int ID, const char *Data, int Length)
 251 {
 252         tSysFS_Ent      *ent;
 253
 254         for( ent = gSysFS_FileList; ent; ent = ent->Next )
 255         {
 256                 // It's a reverse sorted list
 257                 if(ent->Node.Inode < ID)        return 0;
 258                 if(ent->Node.Inode == ID)
 259                 {
 260                         ent->Node.ImplPtr = (void*)Data;
 261                         ent->Node.Size = Length;
 262                         return 1;
 263                 }
 264         }
 265
 266         return 0;
 267 }
 268
 269 /**
 270  * \fn int SysFS_RemoveFile(int ID)
 271  * \brief Removes a file from user access
 272  * \param ID    Identifier returned by ::SysFS_RegisterFile
 273  * \return Boolean Success
 274  * \note If a handle is still open to the file, it will be invalidated
 275  */
 276 int SysFS_RemoveFile(int ID)
 277 {
 278         tSysFS_Ent      *file;
 279         tSysFS_Ent      *ent, *parent, *prev;
 280
 281         prev = NULL;
 282         for( ent = gSysFS_FileList; ent; prev = ent, ent = ent->Next )
 283         {
 284                 // It's a reverse sorted list
 285                 if(ent->Node.Inode < ID)        return 0;
 286                 if(ent->Node.Inode == ID)       break;
 287         }
 288
 289         if(!ent)        return 0;
 290
 291         // Set up for next part
 292         file = ent;
 293         parent = file->Parent;
 294
 295         // Remove from file list
 296         if(prev)
 297                 prev->ListNext = file->ListNext;
 298         else
 299                 gSysFS_FileList = file->ListNext;
 300         file->Node.Size = 0;
 301         file->Node.ImplPtr = NULL;
 302
 303         // Search parent directory
 304         for( ent = parent->Node.ImplPtr; ent; prev = ent, ent = ent->Next )
 305         {
 306                 if( ent == file )       break;
 307         }
 308         if(!ent) {
 309                 Log_Warning("SysFS", "Bookkeeping Error: File in list, but not in directory");
 310                 return 0;
 311         }
 312
 313         // Remove from parent directory
 314         if(prev)
 315                 prev->Next = ent->Next;
 316         else
 317                 parent->Node.ImplPtr = ent->Next;
 318
 319         // Free if not in use
 320         if(file->Node.ReferenceCount == 0)
 321                 free(file);
 322
 323         return 1;
 324 }
 325
 326 /**
 327  * \fn char *SysFS_Comm_ReadDir(tVFS_Node *Node, int Pos)
 328  * \brief Reads from a SysFS directory
 329  */
 330 char *SysFS_Comm_ReadDir(tVFS_Node *Node, int Pos)
 331 {
 332         tSysFS_Ent      *child = (tSysFS_Ent*)Node->ImplPtr;
 333         if(Pos < 0 || Pos >= Node->Size)        return NULL;
 334
 335         for( ; child; child = child->Next, Pos-- )
 336         {
 337                 if( Pos == 0 )  return strdup(child->Name);
 338         }
 339         return NULL;
 340 }
 341
 342 /**
 343  * \fn tVFS_Node *SysFS_Comm_FindDir(tVFS_Node *Node, const char *Filename)
 344  * \brief Find a file in a SysFS directory
 345  */
 346 tVFS_Node *SysFS_Comm_FindDir(tVFS_Node *Node, const char *Filename)
 347 {
 348         tSysFS_Ent      *child = (tSysFS_Ent*)Node->ImplPtr;
 349
 350         for( ; child; child = child->Next )
 351         {
 352                 if( strcmp(child->Name, Filename) == 0 )
 353                         return &child->Node;
 354         }
 355
 356         return NULL;
 357 }
 358
 359 /**
 360  * \fn Uint64 SysFS_Comm_ReadFile(tVFS_Node *Node, Uint64 Offset, Uint64 Length, void *Buffer)
 361  * \brief Read from an exposed buffer
 362  */
 363 Uint64 SysFS_Comm_ReadFile(tVFS_Node *Node, Uint64 Offset, Uint64 Length, void *Buffer)
 364 {
 365         if( Offset > Node->Size )       return -1;
 366         if( Length > Node->Size )       Length = Node->Size;
 367         if( Offset + Length > Node->Size)       Length = Node->Size - Offset;
 368
 369         if( Node->ImplPtr )
 370                 memcpy(Buffer, (void*)((Uint)Node->ImplPtr+(Uint)Offset), Length);
 371         else
 372                 return -1;
 373
 374         return Length;
 375 }
 376
 377 /**
 378  * \fn void SysFS_Comm_CloseFile(tVFS_Node *Node)
 379  * \brief Closes an open file
 380  * \param Node  Node to close
 381  */
 382 void SysFS_Comm_CloseFile(tVFS_Node *Node)
 383 {
 384         // Dereference
 385         Node->ReferenceCount --;
 386         if( Node->ReferenceCount > 0 )  return;
 387
 388         // Check if it is still valid
 389         if( Node->ImplPtr )     return;
 390
 391         // Delete
 392         free( (void*)Node->ImplInt );
 393 }