3 * - Kernel Status Driver
12 #define VERSION ((0 << 8) | (1)) // 0.01
15 typedef struct sSysFS_Ent
17 struct sSysFS_Ent *Next;
18 struct sSysFS_Ent *ListNext;
19 struct sSysFS_Ent *Parent;
25 int SysFS_Install(char **Arguments);
26 int SysFS_IOCtl(tVFS_Node *Node, int Id, void *Data);
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);
34 int SysFS_Comm_ReadDir(tVFS_Node *Node, int Id, char Dest[FILENAME_MAX]);
35 tVFS_Node *SysFS_Comm_FindDir(tVFS_Node *Node, const char *Filename, Uint Flags);
36 size_t SysFS_Comm_ReadFile(tVFS_Node *Node, off_t Offset, size_t Length, void *Buffer, Uint Flags);
37 void SysFS_Comm_CloseFile(tVFS_Node *Node);
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
47 tVFS_NodeType gSysFS_DirNodeType = {
48 .TypeName = "SysFS Dir",
49 .ReadDir = SysFS_Comm_ReadDir,
50 .FindDir = SysFS_Comm_FindDir
52 tSysFS_Ent gSysFS_Version_Kernel = {
54 &gSysFS_Version, // Parent
56 .Inode = 1, // File #1
58 .ImplInt = (Uint)&gSysFS_Version_Kernel, // Self-Link
61 .ACLs = &gVFS_ACL_EveryoneRO,
62 .Type = &gSysFS_FileNodeType
66 tSysFS_Ent gSysFS_Version = {
71 .ImplPtr = &gSysFS_Version_Kernel,
72 .ImplInt = (Uint)&gSysFS_Version, // Self-Link
74 .ACLs = &gVFS_ACL_EveryoneRX,
75 .Flags = VFS_FFLAG_DIRECTORY,
76 .Type = &gSysFS_DirNodeType
80 // Root of the SysFS tree (just used to keep the code clean)
81 tSysFS_Ent gSysFS_Root = {
86 .ImplPtr = &gSysFS_Version,
87 .ImplInt = (Uint)&gSysFS_Root // Self-Link
91 tDevFS_Driver gSysFS_DriverInfo = {
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
102 int giSysFS_NextFileID = 2;
103 tSysFS_Ent *gSysFS_FileList;
107 * \fn int SysFS_Install(char **Options)
108 * \brief Installs the SysFS Driver
110 int SysFS_Install(char **Options)
112 gSysFS_Version_Kernel.Node.Size = strlen(gsBuildInfo);
113 gSysFS_Version_Kernel.Node.ImplPtr = (void*)gsBuildInfo;
115 DevFS_AddDevice( &gSysFS_DriverInfo );
116 return MODULE_ERR_OK;
120 * \fn int SysFS_RegisterFile(char *Path, char *Data, int Length)
121 * \brief Registers a file (buffer) for the user to be able to read from
122 * \param Path Path for the file to be accessable from (relative to SysFS root)
123 * \param Data Pointer to the data buffer (must be non-volatile)
124 * \param Length Length of the data buffer
125 * \return The file's identifier
127 int SysFS_RegisterFile(const char *Path, const char *Data, int Length)
131 tSysFS_Ent *ent = NULL;
132 tSysFS_Ent *child, *prev;
134 // Find parent directory
135 while( (tmp = strpos(&Path[start], '/')) != -1 )
140 child = ent->Node.ImplPtr;
142 child = gSysFS_DriverInfo.RootNode.ImplPtr;
143 for( ; child; prev = child, child = child->Next )
145 if( strncmp( &Path[start], child->Name, tmp+1 ) == '/' )
149 // Need a new directory?
152 child = calloc( 1, sizeof(tSysFS_Ent)+tmp+1 );
154 Log_Error("SysFS", "calloc(%i) failure", sizeof(tSysFS_Ent)+tmp+1);
158 memcpy(child->Name, &Path[start], tmp);
159 child->Name[tmp] = '\0';
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;
170 ent->Node.ImplPtr = child;
172 gSysFS_DriverInfo.RootNode.ImplPtr = child;
173 // ^^^ Impossible (There is already /Version)
180 gSysFS_DriverInfo.RootNode.Size ++;
181 Log_Log("SysFS", "Added directory '%.*s'", tmp, &Path[start]);
182 Log_Log("SysFS", "Added directory '%.*s'", tmp, child->Name);
190 // ent: Parent tSysFS_Ent or NULL
191 // start: beginning of last path element
193 // Check if the name is taken
196 child = ent->Node.ImplPtr;
198 child = gSysFS_DriverInfo.RootNode.ImplPtr;
199 for( ; child; child = child->Next )
201 if( strcmp( &Path[start], child->Name ) == 0 )
205 Log_Warning("SysFS", "'%s' is taken (in '%s')", &Path[start], Path);
210 child = calloc( 1, sizeof(tSysFS_Ent)+strlen(&Path[start])+1 );
212 strcpy(child->Name, &Path[start]);
215 child->Node.Inode = giSysFS_NextFileID++;
216 child->Node.ImplPtr = (void*)Data;
217 child->Node.ImplInt = (Uint)child; // Uplink
218 child->Node.Size = Length;
219 child->Node.NumACLs = 1;
220 child->Node.ACLs = &gVFS_ACL_EveryoneRO;
221 child->Node.Type = &gSysFS_FileNodeType;
223 // Add to parent's child list
226 child->Next = ent->Node.ImplPtr;
227 ent->Node.ImplPtr = child;
230 gSysFS_DriverInfo.RootNode.Size ++;
231 child->Next = gSysFS_DriverInfo.RootNode.ImplPtr;
232 gSysFS_DriverInfo.RootNode.ImplPtr = child;
234 // Add to global file list
235 child->ListNext = gSysFS_FileList;
236 gSysFS_FileList = child;
238 Log_Log("SysFS", "Added '%s' (%p)", Path, Data);
240 return child->Node.Inode;
244 * \fn int SysFS_UpdateFile(int ID, char *Data, int Length)
245 * \brief Updates a file
246 * \param ID Identifier returned by ::SysFS_RegisterFile
247 * \param Data Pointer to the data buffer
248 * \param Length Length of the data buffer
249 * \return Boolean Success
251 int SysFS_UpdateFile(int ID, const char *Data, int Length)
255 for( ent = gSysFS_FileList; ent; ent = ent->Next )
257 // It's a reverse sorted list
258 if(ent->Node.Inode < (Uint64)ID)
260 if(ent->Node.Inode == (Uint64)ID)
262 ent->Node.ImplPtr = (void*)Data;
263 ent->Node.Size = Length;
272 * \fn int SysFS_RemoveFile(int ID)
273 * \brief Removes a file from user access
274 * \param ID Identifier returned by ::SysFS_RegisterFile
275 * \return Boolean Success
276 * \note If a handle is still open to the file, it will be invalidated
278 int SysFS_RemoveFile(int ID)
281 tSysFS_Ent *ent, *parent, *prev;
284 for( ent = gSysFS_FileList; ent; prev = ent, ent = ent->ListNext )
286 // It's a reverse sorted list
287 if(ent->Node.Inode <= (Uint64)ID) break;
289 if( !ent || ent->Node.Inode != (Uint64)ID) {
290 Log_Notice("SysFS", "ID %i not present", ID);
294 // Set up for next part
296 parent = file->Parent;
298 // Remove from file list
300 prev->ListNext = file->ListNext;
302 gSysFS_FileList = file->ListNext;
304 file->Node.ImplPtr = NULL;
306 // Clean out of parent directory
309 for( ent = parent->Node.ImplPtr; ent; prev = ent, ent = ent->Next )
311 if( ent == file ) break;
314 Log_Warning("SysFS", "Bookkeeping Error: File in list, but not in directory");
318 // Remove from parent directory
320 prev->Next = ent->Next;
322 parent->Node.ImplPtr = ent->Next;
324 // Free if not in use
325 if(file->Node.ReferenceCount == 0) {
329 if( parent->Node.ImplPtr )
332 // Remove parent from the tree
334 parent = parent->Parent;
341 * \fn char *SysFS_Comm_ReadDir(tVFS_Node *Node, int Pos)
342 * \brief Reads from a SysFS directory
344 int SysFS_Comm_ReadDir(tVFS_Node *Node, int Pos, char Dest[FILENAME_MAX])
346 tSysFS_Ent *child = (tSysFS_Ent*)Node->ImplPtr;
347 if(Pos < 0 || (Uint64)Pos >= Node->Size)
350 for( ; child; child = child->Next, Pos-- )
353 strncpy(Dest, child->Name, FILENAME_MAX);
361 * \fn tVFS_Node *SysFS_Comm_FindDir(tVFS_Node *Node, const char *Filename)
362 * \brief Find a file in a SysFS directory
364 tVFS_Node *SysFS_Comm_FindDir(tVFS_Node *Node, const char *Filename, Uint Flags)
366 tSysFS_Ent *child = (tSysFS_Ent*)Node->ImplPtr;
368 for( ; child; child = child->Next )
370 if( strcmp(child->Name, Filename) == 0 )
378 * \brief Read from an exposed buffer
380 size_t SysFS_Comm_ReadFile(tVFS_Node *Node, off_t Offset, size_t Length, void *Buffer, Uint Flags)
382 if( Offset > Node->Size ) return -1;
383 if( Length > Node->Size ) Length = Node->Size;
384 if( Offset + Length > Node->Size) Length = Node->Size - Offset;
387 memcpy(Buffer, (void*)((Uint)Node->ImplPtr+(Uint)Offset), Length);
395 * \fn void SysFS_Comm_CloseFile(tVFS_Node *Node)
396 * \brief Closes an open file
397 * \param Node Node to close
399 void SysFS_Comm_CloseFile(tVFS_Node *Node)
402 Node->ReferenceCount --;
403 if( Node->ReferenceCount > 0 ) return;
405 // Check if it is still valid
406 if( Node->ImplPtr ) return;
409 free( (void*)Node->ImplInt );