Modules/IPStack/interface.c

   1 /*
   2  * Acess2 IP Stack
   3  * - Interface Control
   4  */
   5 #define DEBUG   0
   6 #define VERSION VER2(0,10)
   7 #include "ipstack.h"
   8 #include "link.h"
   9 #include <tpl_drv_common.h>
  10 #include <tpl_drv_network.h>
  11
  12 // === CONSTANTS ===
  13 //! Default timeout value, 30 seconds
  14 #define DEFAULT_TIMEOUT (30*1000)
  15
  16 // === IMPORTS ===
  17 extern int      IPv4_Ping(tInterface *Iface, tIPv4 Addr);
  18 //extern int    IPv6_Ping(tInterface *Iface, tIPv6 Addr);
  19 extern tVFS_Node        gIP_RouteNode;
  20
  21 // === PROTOTYPES ===
  22 char    *IPStack_Root_ReadDir(tVFS_Node *Node, int Pos);
  23 tVFS_Node       *IPStack_Root_FindDir(tVFS_Node *Node, const char *Name);
  24  int    IPStack_Root_IOCtl(tVFS_Node *Node, int ID, void *Data);
  25
  26  int    IPStack_AddFile(tSocketFile *File);
  27 tInterface      *IPStack_AddInterface(const char *Device, const char *Name);
  28 tAdapter        *IPStack_GetAdapter(const char *Path);
  29
  30 char    *IPStack_Iface_ReadDir(tVFS_Node *Node, int Pos);
  31 tVFS_Node       *IPStack_Iface_FindDir(tVFS_Node *Node, const char *Name);
  32  int    IPStack_Iface_IOCtl(tVFS_Node *Node, int ID, void *Data);
  33
  34 // === GLOBALS ===
  35 //! Loopback (127.0.0.0/8, ::1) Pseudo-Interface
  36 tInterface      gIP_LoopInterface = {
  37         .Node = {
  38                 .ImplPtr = &gIP_LoopInterface,
  39                 .Flags = VFS_FFLAG_DIRECTORY,
  40                 .Size = -1,
  41                 .NumACLs = 1,
  42                 .ACLs = &gVFS_ACL_EveryoneRX,
  43                 .ReadDir = IPStack_Iface_ReadDir,
  44                 .FindDir = IPStack_Iface_FindDir,
  45                 .IOCtl = IPStack_Iface_IOCtl
  46         },
  47         .Adapter = NULL,
  48         .Type = 0
  49 };
  50 tShortSpinlock  glIP_Interfaces;
  51 tInterface      *gIP_Interfaces = NULL;
  52 tInterface      *gIP_Interfaces_Last = NULL;
  53
  54 tSocketFile     *gIP_FileTemplates;
  55
  56 tAdapter        gIP_LoopAdapter = {
  57         .DeviceLen = 8,
  58         .Device = "LOOPBACK"
  59         };
  60 tMutex  glIP_Adapters;
  61 tAdapter        *gIP_Adapters = NULL;
  62  int    giIP_NextIfaceId = 1;
  63
  64 // === CODE ===
  65
  66 /**
  67  * \brief Read from the IP Stack's Device Directory
  68  */
  69 char *IPStack_Root_ReadDir(tVFS_Node *Node, int Pos)
  70 {
  71         tInterface      *iface;
  72         char    *name;
  73         ENTER("pNode iPos", Node, Pos);
  74
  75
  76         // Routing Subdir
  77         if( Pos == 0 ) {
  78                 return strdup("routes");
  79         }
  80         // Pseudo Interfaces
  81         if( Pos == 1 ) {
  82                 return strdup("lo");
  83         }
  84         Pos -= 2;
  85
  86         // Traverse the list
  87         for( iface = gIP_Interfaces; iface && Pos--; iface = iface->Next ) ;
  88
  89         // Did we run off the end?
  90         if(!iface) {
  91                 LEAVE('n');
  92                 return NULL;
  93         }
  94
  95         name = malloc(4);
  96         if(!name) {
  97                 Log_Warning("IPStack", "IPStack_Root_ReadDir - malloc error");
  98                 LEAVE('n');
  99                 return NULL;
 100         }
 101
 102         // Create the name
 103         Pos = iface->Node.ImplInt;
 104         if(Pos < 10) {
 105                 name[0] = '0' + Pos;
 106                 name[1] = '\0';
 107         }
 108         else if(Pos < 100) {
 109                 name[0] = '0' + Pos/10;
 110                 name[1] = '0' + Pos%10;
 111                 name[2] = '\0';
 112         }
 113         else {
 114                 name[0] = '0' + Pos/100;
 115                 name[1] = '0' + (Pos/10)%10;
 116                 name[2] = '0' + Pos%10;
 117                 name[3] = '\0';
 118         }
 119
 120         LEAVE('s', name);
 121         // Return the pre-generated name
 122         return name;
 123 }
 124
 125 /**
 126  * \brief Get the node of an interface
 127  */
 128 tVFS_Node *IPStack_Root_FindDir(tVFS_Node *Node, const char *Name)
 129 {
 130         #if 0
 131          int    i, num;
 132         #endif
 133         tInterface      *iface;
 134
 135         ENTER("pNode sName", Node, Name);
 136
 137         // Routing subdir
 138         if( strcmp(Name, "routes") == 0 ) {
 139                 return &gIP_RouteNode;
 140         }
 141
 142         // Loopback
 143         if( strcmp(Name, "lo") == 0 ) {
 144                 return &gIP_LoopInterface.Node;
 145         }
 146
 147         #if 0
 148         i = 0;  num = 0;
 149         while('0' <= Name[i] && Name[i] <= '9')
 150         {
 151                 num *= 10;
 152                 num += Name[i] - '0';
 153                 i ++;
 154         }
 155         if(Name[i] != '\0') {
 156                 LEAVE('n');
 157                 return NULL;
 158         }
 159
 160         for( iface = gIP_Interfaces; iface; iface = iface->Next )
 161         {
 162                 if( (int)iface->Node.ImplInt == num )
 163                 {
 164                         LEAVE('p', &iface->Node);
 165                         return &iface->Node;
 166                 }
 167         }
 168         #else
 169         for( iface = gIP_Interfaces; iface; iface = iface->Next )
 170         {
 171                 if( strcmp(iface->Name, Name) == 0 )
 172                 {
 173                         LEAVE('p', &iface->Node);
 174                         return &iface->Node;
 175                 }
 176         }
 177         #endif
 178
 179         LEAVE('p', NULL);
 180         return NULL;
 181 }
 182
 183 static const char *casIOCtls_Root[] = { DRV_IOCTLNAMES, "add_interface", NULL };
 184 /**
 185  * \brief Handles IOCtls for the IPStack root
 186  */
 187 int IPStack_Root_IOCtl(tVFS_Node *Node, int ID, void *Data)
 188 {
 189          int    tmp;
 190         ENTER("pNode iID pData", Node, ID, Data);
 191
 192         switch(ID)
 193         {
 194         // --- Standard IOCtls (0-3) ---
 195         BASE_IOCTLS(DRV_TYPE_MISC, "IPStack", VERSION, casIOCtls_Root)
 196
 197         /*
 198          * add_interface
 199          * - Adds a new IP interface and binds it to a device
 200          */
 201         case 4:
 202                 if( Threads_GetUID() != 0 )     LEAVE_RET('i', -1);
 203                 if( !CheckString( Data ) )      LEAVE_RET('i', -1);
 204                 {
 205                         char    name[4] = "";
 206                         tInterface      *iface = IPStack_AddInterface(Data, name);
 207                         tmp = iface->Node.ImplInt;
 208                 }
 209                 LEAVE_RET('i', tmp);
 210         }
 211         LEAVE('i', 0);
 212         return 0;
 213 }
 214
 215 /**
 216  * \fn tInterface *IPStack_AddInterface(char *Device)
 217  * \brief Adds an interface to the list
 218  */
 219 tInterface *IPStack_AddInterface(const char *Device, const char *Name)
 220 {
 221         tInterface      *iface;
 222         tAdapter        *card;
 223          int    nameLen;
 224
 225         ENTER("sDevice", Device);
 226
 227         card = IPStack_GetAdapter(Device);
 228         if( !card ) {
 229                 LEAVE('n');
 230                 return NULL;    // ERR_YOURBAD
 231         }
 232
 233         nameLen = sprintf(NULL, "%i", giIP_NextIfaceId);
 234
 235         iface = malloc(
 236                 sizeof(tInterface)
 237                 + nameLen + 1
 238                 + IPStack_GetAddressSize(-1)*3  // Address, Route->Network, Route->NextHop
 239                 );
 240         if(!iface) {
 241                 LEAVE('n');
 242                 return NULL;    // Return ERR_MYBAD
 243         }
 244
 245         iface->Next = NULL;
 246         iface->Type = 0;        // Unset type
 247         iface->Address = iface->Name + nameLen + 1;     // Address
 248         iface->Route.Network = iface->Address + IPStack_GetAddressSize(-1);
 249         iface->Route.NextHop = iface->Route.Network + IPStack_GetAddressSize(-1);
 250
 251         // Create Node
 252         iface->Node.ImplPtr = iface;
 253         iface->Node.Flags = VFS_FFLAG_DIRECTORY;
 254         iface->Node.Size = -1;
 255         iface->Node.NumACLs = 1;
 256         iface->Node.ACLs = &gVFS_ACL_EveryoneRX;
 257         iface->Node.ReadDir = IPStack_Iface_ReadDir;
 258         iface->Node.FindDir = IPStack_Iface_FindDir;
 259         iface->Node.IOCtl = IPStack_Iface_IOCtl;
 260         iface->Node.MkNod = NULL;
 261         iface->Node.Link = NULL;
 262         iface->Node.Relink = NULL;
 263         iface->Node.Close = NULL;
 264
 265         // Set Defaults
 266         iface->TimeoutDelay = DEFAULT_TIMEOUT;
 267
 268         // Get adapter handle
 269         iface->Adapter = IPStack_GetAdapter(Device);
 270         if( !iface->Adapter ) {
 271                 free( iface );
 272                 LEAVE('n');
 273                 return NULL;    // Return ERR_YOUFAIL
 274         }
 275
 276         // Delay setting ImplInt until after the adapter is opened
 277         // Keeps things simple
 278         iface->Node.ImplInt = giIP_NextIfaceId++;
 279         sprintf(iface->Name, "%i", iface->Node.ImplInt);
 280
 281         // Append to list
 282         SHORTLOCK( &glIP_Interfaces );
 283         if( gIP_Interfaces ) {
 284                 gIP_Interfaces_Last->Next = iface;
 285                 gIP_Interfaces_Last = iface;
 286         }
 287         else {
 288                 gIP_Interfaces = iface;
 289                 gIP_Interfaces_Last = iface;
 290         }
 291         SHORTREL( &glIP_Interfaces );
 292
 293 //      gIP_DriverInfo.RootNode.Size ++;
 294
 295         // Success!
 296         LEAVE('p', iface);
 297         return iface;
 298 }
 299
 300 /**
 301  * \brief Adds a file to the socket list
 302  */
 303 int IPStack_AddFile(tSocketFile *File)
 304 {
 305         Log_Log("IPStack", "Added file '%s'", File->Name);
 306         File->Next = gIP_FileTemplates;
 307         gIP_FileTemplates = File;
 308         return 0;
 309 }
 310
 311 // ---
 312 // VFS Functions
 313 // ---
 314 /**
 315  * \brief Read from an interface's directory
 316  */
 317 char *IPStack_Iface_ReadDir(tVFS_Node *Node, int Pos)
 318 {
 319         tSocketFile     *file = gIP_FileTemplates;
 320         while(Pos-- && file) {
 321                 file = file->Next;
 322         }
 323
 324         if(!file)       return NULL;
 325
 326         return strdup(file->Name);
 327 }
 328
 329 /**
 330  * \brief Gets a named node from an interface directory
 331  */
 332 tVFS_Node *IPStack_Iface_FindDir(tVFS_Node *Node, const char *Name)
 333 {
 334         tSocketFile     *file = gIP_FileTemplates;
 335
 336         // Get file definition
 337         for(;file;file = file->Next)
 338         {
 339                 if( strcmp(file->Name, Name) == 0 )     break;
 340         }
 341         if(!file)       return NULL;
 342
 343         // Pass the buck!
 344         return file->Init(Node->ImplPtr);
 345 }
 346
 347 /**
 348  * \brief Names for interface IOCtl Calls
 349  */
 350 static const char *casIOCtls_Iface[] = {
 351         DRV_IOCTLNAMES,
 352         "getset_type",
 353         "get_address", "set_address",
 354         "getset_subnet",
 355         "get_device",
 356         "ping",
 357         NULL
 358         };
 359 /**
 360  * \brief Handles IOCtls for the IPStack interfaces
 361  */
 362 int IPStack_Iface_IOCtl(tVFS_Node *Node, int ID, void *Data)
 363 {
 364          int    tmp, size;
 365         tInterface      *iface = (tInterface*)Node->ImplPtr;
 366         ENTER("pNode iID pData", Node, ID, Data);
 367
 368         switch(ID)
 369         {
 370         // --- Standard IOCtls (0-3) ---
 371         BASE_IOCTLS(DRV_TYPE_MISC, "IPStack", VERSION, casIOCtls_Iface)
 372
 373         /*
 374          * getset_type
 375          * - Get/Set the interface type
 376          */
 377         case 4:
 378                 // Set Type?
 379                 if( Data )
 380                 {
 381                         // Ok, it's set type
 382                         if( Threads_GetUID() != 0 ) {
 383                                 LOG("Attempt by non-root to alter an interface (%i)", Threads_GetUID());
 384                                 LEAVE('i', -1);
 385                                 return -1;
 386                         }
 387                         if( !CheckMem( Data, sizeof(int) ) ) {
 388                                 LOG("Invalid pointer %p", Data);
 389                                 LEAVE('i', -1);
 390                                 return -1;
 391                         }
 392
 393                         // Set type
 394                         iface->Type = *(int*)Data;
 395                         size = IPStack_GetAddressSize(iface->Type);
 396                         // Check it's actually valid
 397                         if( iface->Type != 0 && size == 0 ) {
 398                                 iface->Type = 0;
 399                                 LEAVE('i', -1);
 400                                 return -1;
 401                         }
 402
 403                         // Clear address
 404                         memset(iface->Address, 0, size);
 405                 }
 406                 LEAVE('i', iface->Type);
 407                 return iface->Type;
 408
 409         /*
 410          * get_address
 411          * - Get the interface's address
 412          */
 413         case 5:
 414                 size = IPStack_GetAddressSize(iface->Type);
 415                 if( !CheckMem( Data, size ) )   LEAVE_RET('i', -1);
 416                 memcpy( Data, iface->Address, size );
 417                 LEAVE('i', 1);
 418                 return 1;
 419
 420         /*
 421          * set_address
 422          * - Set the interface's address
 423          */
 424         case 6:
 425                 if( Threads_GetUID() != 0 )     LEAVE_RET('i', -1);
 426
 427                 size = IPStack_GetAddressSize(iface->Type);
 428                 if( !CheckMem( Data, size ) )   LEAVE_RET('i', -1);
 429                 // TODO: Protect against trashing
 430                 memcpy( iface->Address, Data, size );
 431                 LEAVE('i', 1);
 432                 return 1;
 433
 434         /*
 435          * getset_subnet
 436          * - Get/Set the bits in the address subnet
 437          */
 438         case 7:
 439                 // Do we want to set the value?
 440                 if( Data )
 441                 {
 442                         // Are we root? (TODO: Check Owner/Group)
 443                         if( Threads_GetUID() != 0 )     LEAVE_RET('i', -1);
 444                         // Is the memory valid
 445                         if( !CheckMem(Data, sizeof(int)) )      LEAVE_RET('i', -1);
 446
 447                         // Is the mask sane?
 448                         if( *(int*)Data < 0 || *(int*)Data > IPStack_GetAddressSize(iface->Type)*8-1 )
 449                                 LEAVE_RET('i', -1);
 450
 451                         // Ok, set it
 452                         iface->SubnetBits = *(int*)Data;
 453                 }
 454                 LEAVE('i', iface->SubnetBits);
 455                 return iface->SubnetBits;
 456
 457         /*
 458          * get_device
 459          * - Gets the name of the attached device
 460          */
 461         case 8:
 462                 if( iface->Adapter == NULL )
 463                         LEAVE_RET('i', 0);
 464                 if( Data == NULL )
 465                         LEAVE_RET('i', iface->Adapter->DeviceLen);
 466                 if( !CheckMem( Data, iface->Adapter->DeviceLen+1 ) )
 467                         LEAVE_RET('i', -1);
 468                 strcpy( Data, iface->Adapter->Device );
 469                 return iface->Adapter->DeviceLen;
 470
 471         /*
 472          * ping
 473          * - Send an ICMP Echo
 474          */
 475         case 9:
 476                 switch(iface->Type)
 477                 {
 478                 case 0:
 479                         LEAVE_RET('i', 1);
 480
 481                 case 4:
 482                         if( !CheckMem( Data, sizeof(tIPv4) ) )  LEAVE_RET('i', -1);
 483                         tmp = IPv4_Ping(iface, *(tIPv4*)Data);
 484                         LEAVE('i', tmp);
 485                         return tmp;
 486
 487                 case 6:
 488                         LEAVE_RET('i', 1);
 489                 }
 490                 break;
 491
 492         }
 493
 494         LEAVE('i', 0);
 495         return 0;
 496 }
 497
 498 // --- Internal ---
 499 /**
 500  * \fn tAdapter *IPStack_GetAdapter(const char *Path)
 501  * \brief Gets/opens an adapter given the path
 502  */
 503 tAdapter *IPStack_GetAdapter(const char *Path)
 504 {
 505         tAdapter        *dev;
 506          int    tmp;
 507
 508         ENTER("sPath", Path);
 509
 510         // Check for loopback
 511         if( strcmp(Path, "LOOPBACK") == 0 )
 512         {
 513                 // Initialise if required
 514                 if( gIP_LoopAdapter.DeviceFD == 0 )
 515                 {
 516                         dev = &gIP_LoopAdapter;
 517
 518                         dev->NRef = 1;
 519                         dev->DeviceLen = 8;
 520
 521                         dev->DeviceFD = VFS_Open( "/Devices/fifo/anon", VFS_OPENFLAG_READ|VFS_OPENFLAG_WRITE );
 522                         if( dev->DeviceFD == -1 ) {
 523                                 Log_Warning("IPStack", "Unable to open FIFO '/Devices/fifo/anon' for loopback");
 524                                 return NULL;
 525                         }
 526
 527                         dev->MacAddr.B[0] = 'A';
 528                         dev->MacAddr.B[1] = 'c';
 529                         dev->MacAddr.B[2] = 'e';
 530                         dev->MacAddr.B[3] = 's';
 531                         dev->MacAddr.B[4] = 's';
 532                         dev->MacAddr.B[5] = '2';
 533
 534                         // Start watcher
 535                         Link_WatchDevice( dev );
 536                 }
 537                 LEAVE('p', &gIP_LoopAdapter);
 538                 return &gIP_LoopAdapter;
 539         }
 540
 541         Mutex_Acquire( &glIP_Adapters );
 542
 543         // Check if this adapter is already open
 544         for( dev = gIP_Adapters; dev; dev = dev->Next )
 545         {
 546                 if( strcmp(dev->Device, Path) == 0 ) {
 547                         dev->NRef ++;
 548                         Mutex_Release( &glIP_Adapters );
 549                         LEAVE('p', dev);
 550                         return dev;
 551                 }
 552         }
 553
 554         // Ok, so let's open it
 555         dev = malloc( sizeof(tAdapter) + strlen(Path) + 1 );
 556         if(!dev) {
 557                 Mutex_Release( &glIP_Adapters );
 558                 LEAVE('n');
 559                 return NULL;
 560         }
 561
 562         // Fill Structure
 563         strcpy( dev->Device, Path );
 564         dev->NRef = 1;
 565         dev->DeviceLen = strlen(Path);
 566
 567         // Open Device
 568         dev->DeviceFD = VFS_Open( dev->Device, VFS_OPENFLAG_READ|VFS_OPENFLAG_WRITE );
 569         if( dev->DeviceFD == -1 ) {
 570                 free( dev );
 571                 Mutex_Release( &glIP_Adapters );
 572                 LEAVE('n');
 573                 return NULL;
 574         }
 575
 576         // Check that it is a network interface
 577         tmp = VFS_IOCtl(dev->DeviceFD, 0, NULL);
 578         LOG("Device type = %i", tmp);
 579         if( tmp != DRV_TYPE_NETWORK ) {
 580                 Warning("IPStack_GetAdapter: '%s' is not a network interface", dev->Device);
 581                 VFS_Close( dev->DeviceFD );
 582                 free( dev );
 583                 Mutex_Release( &glIP_Adapters );
 584                 LEAVE('n');
 585                 return NULL;
 586         }
 587
 588         // Get MAC Address
 589         VFS_IOCtl(dev->DeviceFD, NET_IOCTL_GETMAC, &dev->MacAddr);
 590
 591         // Add to list
 592         dev->Next = gIP_Adapters;
 593         gIP_Adapters = dev;
 594
 595         Mutex_Release( &glIP_Adapters );
 596
 597         // Start watcher
 598         Link_WatchDevice( dev );
 599
 600         LEAVE('p', dev);
 601         return dev;
 602 }