3 * - Stack Initialisation
6 #define VERSION VER2(0,10)
11 #include <tpl_drv_common.h>
12 #include <tpl_drv_network.h>
15 //! Default timeout value, 30 seconds
16 #define DEFAULT_TIMEOUT (30*1000)
19 extern int ARP_Initialise();
20 extern void UDP_Initialise();
21 extern void TCP_Initialise();
22 extern int IPv4_Initialise();
23 extern int IPv4_Ping(tInterface *Iface, tIPv4 Addr);
24 extern int IPv6_Initialise();
25 //extern int IPv6_Ping(tInterface *Iface, tIPv6 Addr);
26 extern tVFS_Node gIP_RouteNode;
29 int IPStack_Install(char **Arguments);
30 int IPStack_IOCtlRoot(tVFS_Node *Node, int ID, void *Data);
31 char *IPStack_Root_ReadDir(tVFS_Node *Node, int Pos);
32 tVFS_Node *IPStack_Root_FindDir(tVFS_Node *Node, const char *Name);
33 int IPStack_Root_IOCtl(tVFS_Node *Node, int ID, void *Data);
35 char *IPStack_Iface_ReadDir(tVFS_Node *Node, int Pos);
36 tVFS_Node *IPStack_Iface_FindDir(tVFS_Node *Node, const char *Name);
37 int IPStack_Iface_IOCtl(tVFS_Node *Node, int ID, void *Data);
39 int IPStack_AddInterface(const char *Device, const char *Name);
40 tAdapter *IPStack_GetAdapter(const char *Path);
43 MODULE_DEFINE(0, VERSION, IPStack, IPStack_Install, NULL, NULL);
44 tDevFS_Driver gIP_DriverInfo = {
47 .Size = 0, // Number of interfaces
49 .ACLs = &gVFS_ACL_EveryoneRX,
50 .Flags = VFS_FFLAG_DIRECTORY,
51 .ReadDir = IPStack_Root_ReadDir,
52 .FindDir = IPStack_Root_FindDir,
53 .IOCtl = IPStack_Root_IOCtl
56 tShortSpinlock glIP_Interfaces;
57 //! Loopback (127.0.0.0/8, ::1) Pseudo-Interface
58 tInterface gIP_LoopInterface = {
60 ImplPtr: &gIP_LoopInterface,
61 Flags: VFS_FFLAG_DIRECTORY,
64 ACLs: &gVFS_ACL_EveryoneRX,
65 ReadDir: IPStack_Iface_ReadDir,
66 FindDir: IPStack_Iface_FindDir,
67 IOCtl: IPStack_Iface_IOCtl
72 tInterface *gIP_Interfaces = NULL;
73 tInterface *gIP_Interfaces_Last = NULL;
74 int giIP_NextIfaceId = 1;
76 tAdapter *gIP_Adapters = NULL;
77 tSocketFile *gIP_FileTemplates;
81 * \fn int IPStack_Install(char **Arguments)
82 * \brief Intialise the relevant parts of the stack and register with DevFS
84 int IPStack_Install(char **Arguments)
88 // Layer 3 - Network Layer Protocols
92 // Layer 4 - Transport Layer Protocols
98 // Parse module arguments
99 for( i = 0; Arguments[i]; i++ )
102 // Define interfaces by <Device>,<Type>,<HexStreamAddress>,<Bits>
104 // - <Device> is the device path (E.g. /Devices/ne2k/0)
105 // - <Type> is a number (e.g. 4) or symbol (e.g. AF_INET4)
106 // - <HexStreamAddress> is a condensed hexadecimal stream (in big endian)
107 // (E.g. 0A000201 for 10.0.2.1 IPv4)
108 // - <Bits> is the number of subnet bits (E.g. 24 for an IPv4 Class C)
112 gIP_LoopInterface.Adapter = IPStack_GetAdapter("/Devices/fifo/anon");
114 DevFS_AddDevice( &gIP_DriverInfo );
116 return MODULE_ERR_OK;
120 * \brief Adds a file to the socket list
122 int IPStack_AddFile(tSocketFile *File)
124 Log_Log("IPStack", "Added file '%s'", File->Name);
125 File->Next = gIP_FileTemplates;
126 gIP_FileTemplates = File;
131 * \brief Read from the IP Stack's Device Directory
133 char *IPStack_Root_ReadDir(tVFS_Node *Node, int Pos)
137 ENTER("pNode iPos", Node, Pos);
142 return strdup("routes");
151 for( iface = gIP_Interfaces; iface && Pos--; iface = iface->Next ) ;
153 // Did we run off the end?
161 Log_Warning("IPStack", "IPStack_Root_ReadDir - malloc error");
167 Pos = iface->Node.ImplInt;
173 name[0] = '0' + Pos/10;
174 name[1] = '0' + Pos%10;
178 name[0] = '0' + Pos/100;
179 name[1] = '0' + (Pos/10)%10;
180 name[2] = '0' + Pos%10;
185 // Return the pre-generated name
190 * \brief Get the node of an interface
192 tVFS_Node *IPStack_Root_FindDir(tVFS_Node *Node, const char *Name)
197 ENTER("pNode sName", Node, Name);
200 if( strcmp(Name, "routes") == 0 ) {
201 return &gIP_RouteNode;
205 if( strcmp(Name, "lo") == 0 ) {
206 return &gIP_LoopInterface.Node;
210 while('0' <= Name[i] && Name[i] <= '9')
213 num += Name[i] - '0';
216 if(Name[i] != '\0') {
221 for( iface = gIP_Interfaces; iface; iface = iface->Next )
223 if( (int)iface->Node.ImplInt == num )
225 LEAVE('p', &iface->Node);
233 static const char *casIOCtls_Root[] = { DRV_IOCTLNAMES, "add_interface", NULL };
235 * \brief Handles IOCtls for the IPStack root
237 int IPStack_Root_IOCtl(tVFS_Node *Node, int ID, void *Data)
240 ENTER("pNode iID pData", Node, ID, Data);
244 // --- Standard IOCtls (0-3) ---
246 LEAVE('i', DRV_TYPE_MISC);
247 return DRV_TYPE_MISC;
249 case DRV_IOCTL_IDENT:
250 tmp = ModUtil_SetIdent(Data, "IPStack");
254 case DRV_IOCTL_VERSION:
258 case DRV_IOCTL_LOOKUP:
259 tmp = ModUtil_LookupString( (char**)casIOCtls_Root, (char*)Data );
265 * - Adds a new IP interface and binds it to a device
268 if( Threads_GetUID() != 0 ) LEAVE_RET('i', -1);
269 if( !CheckString( Data ) ) LEAVE_RET('i', -1);
272 tmp = IPStack_AddInterface(Data, name);
281 * \brief Read from an interface's directory
283 char *IPStack_Iface_ReadDir(tVFS_Node *Node, int Pos)
285 tSocketFile *file = gIP_FileTemplates;
286 while(Pos-- && file) {
290 if(!file) return NULL;
292 return strdup(file->Name);
296 * \brief Gets a named node from an interface directory
298 tVFS_Node *IPStack_Iface_FindDir(tVFS_Node *Node, const char *Name)
300 tSocketFile *file = gIP_FileTemplates;
302 // Get file definition
303 for(;file;file = file->Next)
305 if( strcmp(file->Name, Name) == 0 ) break;
307 if(!file) return NULL;
310 return file->Init(Node->ImplPtr);
314 * \brief Names for interface IOCtl Calls
316 static const char *casIOCtls_Iface[] = {
319 "get_address", "set_address",
321 "get_gateway", "set_gateway",
327 * \brief Handles IOCtls for the IPStack interfaces
329 int IPStack_Iface_IOCtl(tVFS_Node *Node, int ID, void *Data)
332 tInterface *iface = (tInterface*)Node->ImplPtr;
333 ENTER("pNode iID pData", Node, ID, Data);
337 // --- Standard IOCtls (0-3) ---
339 LEAVE('i', DRV_TYPE_MISC);
340 return DRV_TYPE_MISC;
342 case DRV_IOCTL_IDENT:
343 tmp = ModUtil_SetIdent(Data, STR(IDENT));
347 case DRV_IOCTL_VERSION:
351 case DRV_IOCTL_LOOKUP:
352 tmp = ModUtil_LookupString( (char**)casIOCtls_Iface, (char*)Data );
358 * - Get/Set the interface type
365 if( Threads_GetUID() != 0 ) {
366 LOG("Attempt by non-root to alter an interface (%i)", Threads_GetUID());
370 if( !CheckMem( Data, sizeof(int) ) ) {
371 LOG("Invalid pointer %p", Data);
375 switch( *(int*)Data )
379 memset(&iface->IP6, 0, sizeof(tIPv6)); // Clear address
383 memset(&iface->IP4, 0, sizeof(tIPv4));
387 memset(&iface->IP6, 0, sizeof(tIPv6));
394 LEAVE('i', iface->Type);
399 * - Get the interface's address
404 case 0: LEAVE_RET('i', 1);
406 if( !CheckMem( Data, sizeof(tIPv4) ) ) LEAVE_RET('i', -1);
407 memcpy( Data, &iface->IP4.Address, sizeof(tIPv4) );
410 if( !CheckMem( Data, sizeof(tIPv6) ) ) LEAVE_RET('i', -1);
411 memcpy( Data, &iface->IP6.Address, sizeof(tIPv6) );
418 * - Get the interface's address
421 if( Threads_GetUID() != 0 ) LEAVE_RET('i', -1);
424 case 0: LEAVE_RET('i', 1);
426 if( !CheckMem( Data, sizeof(tIPv4) ) ) LEAVE_RET('i', -1);
427 iface->Type = 0; // One very hacky mutex/trash protector
428 memcpy( &iface->IP4.Address, Data, sizeof(tIPv4) );
432 if( !CheckMem( Data, sizeof(tIPv6) ) ) LEAVE_RET('i', -1);
434 memcpy( &iface->IP6.Address, Data, sizeof(tIPv6) );
442 * - Get/Set the bits in the address subnet
448 switch( iface->Type )
450 case 4: LEAVE_RET('i', iface->IP4.SubnetBits);
451 case 6: LEAVE_RET('i', iface->IP6.SubnetBits);
452 default: LEAVE_RET('i', 0);
457 if( Threads_GetUID() != 0 ) LEAVE_RET('i', -1);
458 if( !CheckMem(Data, sizeof(int)) ) LEAVE_RET('i', -1);
460 // Check and set the subnet bits
461 switch( iface->Type )
464 if( *(int*)Data < 0 || *(int*)Data > 31 ) LEAVE_RET('i', -1);
465 iface->IP4.SubnetBits = *(int*)Data;
466 LEAVE_RET('i', iface->IP4.SubnetBits);
468 if( *(int*)Data < 0 || *(int*)Data > 127 ) LEAVE_RET('i', -1);
469 iface->IP6.SubnetBits = *(int*)Data;
470 LEAVE_RET('i', iface->IP6.SubnetBits);
480 * - Get the interface's IPv4 gateway
488 if( !CheckMem( Data, sizeof(tIPv4) ) ) LEAVE_RET('i', -1);
489 memcpy( Data, &iface->IP4.Gateway, sizeof(tIPv4) );
499 * - Get/Set the interface's IPv4 gateway
502 if( Threads_GetUID() != 0 ) LEAVE_RET('i', -1);
509 if( !CheckMem( Data, sizeof(tIPv4) ) ) LEAVE_RET('i', -1);
510 iface->Type = 0; // One very hacky mutex/trash protector
511 memcpy( &iface->IP4.Gateway, Data, sizeof(tIPv4) );
522 * - Gets the name of the attached device
526 LEAVE_RET('i', iface->Adapter->DeviceLen);
527 if( !CheckMem( Data, iface->Adapter->DeviceLen+1 ) )
529 strcpy( Data, iface->Adapter->Device );
530 return iface->Adapter->DeviceLen;
534 * - Send an ICMP Echo
543 if( !CheckMem( Data, sizeof(tIPv4) ) ) LEAVE_RET('i', -1);
544 tmp = IPv4_Ping(iface, *(tIPv4*)Data);
561 * \fn int IPStack_AddInterface(char *Device)
562 * \brief Adds an interface to the list
564 int IPStack_AddInterface(const char *Device, const char *Name)
569 ENTER("sDevice", Device);
571 card = IPStack_GetAdapter(Device);
573 iface = malloc(sizeof(tInterface) + strlen(Name));
576 return -2; // Return ERR_MYBAD
580 iface->Type = 0; // Unset type
583 iface->Node.ImplPtr = iface;
584 iface->Node.Flags = VFS_FFLAG_DIRECTORY;
585 iface->Node.Size = -1;
586 iface->Node.NumACLs = 1;
587 iface->Node.ACLs = &gVFS_ACL_EveryoneRX;
588 iface->Node.ReadDir = IPStack_Iface_ReadDir;
589 iface->Node.FindDir = IPStack_Iface_FindDir;
590 iface->Node.IOCtl = IPStack_Iface_IOCtl;
591 iface->Node.MkNod = NULL;
592 iface->Node.Link = NULL;
593 iface->Node.Relink = NULL;
594 iface->Node.Close = NULL;
597 iface->TimeoutDelay = DEFAULT_TIMEOUT;
599 // Get adapter handle
600 iface->Adapter = IPStack_GetAdapter(Device);
601 if( !iface->Adapter ) {
604 return -1; // Return ERR_YOUFAIL
607 // Delay setting ImplInt until after the adapter is opened
608 // Keeps things simple
609 iface->Node.ImplInt = giIP_NextIfaceId++;
612 SHORTLOCK( &glIP_Interfaces );
613 if( gIP_Interfaces ) {
614 gIP_Interfaces_Last->Next = iface;
615 gIP_Interfaces_Last = iface;
618 gIP_Interfaces = iface;
619 gIP_Interfaces_Last = iface;
621 SHORTREL( &glIP_Interfaces );
623 gIP_DriverInfo.RootNode.Size ++;
626 LEAVE('i', iface->Node.ImplInt);
627 return iface->Node.ImplInt;
631 * \fn tAdapter *IPStack_GetAdapter(const char *Path)
632 * \brief Gets/opens an adapter given the path
634 tAdapter *IPStack_GetAdapter(const char *Path)
639 ENTER("sPath", Path);
641 Mutex_Acquire( &glIP_Adapters );
643 // Check if this adapter is already open
644 for( dev = gIP_Adapters; dev; dev = dev->Next )
646 if( strcmp(dev->Device, Path) == 0 ) {
648 Mutex_Release( &glIP_Adapters );
654 // Ok, so let's open it
655 dev = malloc( sizeof(tAdapter) + strlen(Path) + 1 );
657 Mutex_Release( &glIP_Adapters );
663 strcpy( dev->Device, Path );
665 dev->DeviceLen = strlen(Path);
668 dev->DeviceFD = VFS_Open( dev->Device, VFS_OPENFLAG_READ|VFS_OPENFLAG_WRITE );
669 if( dev->DeviceFD == -1 ) {
671 Mutex_Release( &glIP_Adapters );
676 // Check that it is a network interface
677 tmp = VFS_IOCtl(dev->DeviceFD, 0, NULL);
678 LOG("Device type = %i", tmp);
679 if( tmp != DRV_TYPE_NETWORK ) {
680 Warning("IPStack_GetAdapter: '%s' is not a network interface", dev->Device);
681 VFS_Close( dev->DeviceFD );
683 Mutex_Release( &glIP_Adapters );
689 VFS_IOCtl(dev->DeviceFD, NET_IOCTL_GETMAC, &dev->MacAddr);
692 dev->Next = gIP_Adapters;
695 Mutex_Release( &glIP_Adapters );
698 Link_WatchDevice( dev );
705 * \brief Gets the size (in bytes) of a specified form of address
707 int IPStack_GetAddressSize(int AddressType)
715 return sizeof(tIPv4);
717 return sizeof(tIPv6);