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                 Log_Warning("IPStack", "AddInterface - malloc() failed");
 242                 LEAVE('n');
 243                 return NULL;    // Return ERR_MYBAD
 244         }
 245
 246         iface->Next = NULL;
 247         iface->Type = 0;        // Unset type
 248         iface->Address = iface->Name + nameLen + 1;     // Address
 249         iface->Route.Network = iface->Address + IPStack_GetAddressSize(-1);
 250         iface->Route.NextHop = iface->Route.Network + IPStack_GetAddressSize(-1);
 251
 252         // Create Node
 253         iface->Node.ImplPtr = iface;
 254         iface->Node.Flags = VFS_FFLAG_DIRECTORY;
 255         iface->Node.Size = -1;
 256         iface->Node.NumACLs = 1;
 257         iface->Node.ACLs = &gVFS_ACL_EveryoneRX;
 258         iface->Node.ReadDir = IPStack_Iface_ReadDir;
 259         iface->Node.FindDir = IPStack_Iface_FindDir;
 260         iface->Node.IOCtl = IPStack_Iface_IOCtl;
 261         iface->Node.MkNod = NULL;
 262         iface->Node.Link = NULL;
 263         iface->Node.Relink = NULL;
 264         iface->Node.Close = NULL;
 265
 266         // Set Defaults
 267         iface->TimeoutDelay = DEFAULT_TIMEOUT;
 268
 269         // Get adapter handle
 270         iface->Adapter = card;
 271
 272         // Delay setting ImplInt until after the adapter is opened
 273         // Keeps things simple
 274         iface->Node.ImplInt = giIP_NextIfaceId++;
 275         sprintf(iface->Name, "%i", iface->Node.ImplInt);
 276
 277         // Append to list
 278         SHORTLOCK( &glIP_Interfaces );
 279         if( gIP_Interfaces ) {
 280                 gIP_Interfaces_Last->Next = iface;
 281                 gIP_Interfaces_Last = iface;
 282         }
 283         else {
 284                 gIP_Interfaces = iface;
 285                 gIP_Interfaces_Last = iface;
 286         }
 287         SHORTREL( &glIP_Interfaces );
 288
 289 //      gIP_DriverInfo.RootNode.Size ++;
 290
 291         // Success!
 292         LEAVE('p', iface);
 293         return iface;
 294 }
 295
 296 /**
 297  * \brief Adds a file to the socket list
 298  */
 299 int IPStack_AddFile(tSocketFile *File)
 300 {
 301         Log_Log("IPStack", "Added file '%s'", File->Name);
 302         File->Next = gIP_FileTemplates;
 303         gIP_FileTemplates = File;
 304         return 0;
 305 }
 306
 307 // ---
 308 // VFS Functions
 309 // ---
 310 /**
 311  * \brief Read from an interface's directory
 312  */
 313 char *IPStack_Iface_ReadDir(tVFS_Node *Node, int Pos)
 314 {
 315         tSocketFile     *file = gIP_FileTemplates;
 316         while(Pos-- && file) {
 317                 file = file->Next;
 318         }
 319
 320         if(!file)       return NULL;
 321
 322         return strdup(file->Name);
 323 }
 324
 325 /**
 326  * \brief Gets a named node from an interface directory
 327  */
 328 tVFS_Node *IPStack_Iface_FindDir(tVFS_Node *Node, const char *Name)
 329 {
 330         tSocketFile     *file = gIP_FileTemplates;
 331
 332         // Get file definition
 333         for(;file;file = file->Next)
 334         {
 335                 if( strcmp(file->Name, Name) == 0 )     break;
 336         }
 337         if(!file)       return NULL;
 338
 339         // Pass the buck!
 340         return file->Init(Node->ImplPtr);
 341 }
 342
 343 /**
 344  * \brief Names for interface IOCtl Calls
 345  */
 346 static const char *casIOCtls_Iface[] = {
 347         DRV_IOCTLNAMES,
 348         "getset_type",
 349         "get_address", "set_address",
 350         "getset_subnet",
 351         "get_device",
 352         "ping",
 353         NULL
 354         };
 355 /**
 356  * \brief Handles IOCtls for the IPStack interfaces
 357  */
 358 int IPStack_Iface_IOCtl(tVFS_Node *Node, int ID, void *Data)
 359 {
 360          int    tmp, size;
 361         tInterface      *iface = (tInterface*)Node->ImplPtr;
 362         ENTER("pNode iID pData", Node, ID, Data);
 363
 364         switch(ID)
 365         {
 366         // --- Standard IOCtls (0-3) ---
 367         BASE_IOCTLS(DRV_TYPE_MISC, "IPStack", VERSION, casIOCtls_Iface)
 368
 369         /*
 370          * getset_type
 371          * - Get/Set the interface type
 372          */
 373         case 4:
 374                 // Set Type?
 375                 if( Data )
 376                 {
 377                         // Ok, it's set type
 378                         if( Threads_GetUID() != 0 ) {
 379                                 LOG("Attempt by non-root to alter an interface (%i)", Threads_GetUID());
 380                                 LEAVE('i', -1);
 381                                 return -1;
 382                         }
 383                         if( !CheckMem( Data, sizeof(int) ) ) {
 384                                 LOG("Invalid pointer %p", Data);
 385                                 LEAVE('i', -1);
 386                                 return -1;
 387                         }
 388
 389                         // Set type
 390                         iface->Type = *(int*)Data;
 391                         size = IPStack_GetAddressSize(iface->Type);
 392                         // Check it's actually valid
 393                         if( iface->Type != 0 && size == 0 ) {
 394                                 iface->Type = 0;
 395                                 LEAVE('i', -1);
 396                                 return -1;
 397                         }
 398
 399                         // Clear address
 400                         memset(iface->Address, 0, size);
 401                 }
 402                 LEAVE('i', iface->Type);
 403                 return iface->Type;
 404
 405         /*
 406          * get_address
 407          * - Get the interface's address
 408          */
 409         case 5:
 410                 size = IPStack_GetAddressSize(iface->Type);
 411                 if( !CheckMem( Data, size ) )   LEAVE_RET('i', -1);
 412                 memcpy( Data, iface->Address, size );
 413                 LEAVE('i', 1);
 414                 return 1;
 415
 416         /*
 417          * set_address
 418          * - Set the interface's address
 419          */
 420         case 6:
 421                 if( Threads_GetUID() != 0 )     LEAVE_RET('i', -1);
 422
 423                 size = IPStack_GetAddressSize(iface->Type);
 424                 if( !CheckMem( Data, size ) )   LEAVE_RET('i', -1);
 425                 // TODO: Protect against trashing
 426                 memcpy( iface->Address, Data, size );
 427                 LEAVE('i', 1);
 428                 return 1;
 429
 430         /*
 431          * getset_subnet
 432          * - Get/Set the bits in the address subnet
 433          */
 434         case 7:
 435                 // Do we want to set the value?
 436                 if( Data )
 437                 {
 438                         // Are we root? (TODO: Check Owner/Group)
 439                         if( Threads_GetUID() != 0 )     LEAVE_RET('i', -1);
 440                         // Is the memory valid
 441                         if( !CheckMem(Data, sizeof(int)) )      LEAVE_RET('i', -1);
 442
 443                         // Is the mask sane?
 444                         if( *(int*)Data < 0 || *(int*)Data > IPStack_GetAddressSize(iface->Type)*8-1 )
 445                                 LEAVE_RET('i', -1);
 446
 447                         // Ok, set it
 448                         iface->SubnetBits = *(int*)Data;
 449                 }
 450                 LEAVE('i', iface->SubnetBits);
 451                 return iface->SubnetBits;
 452
 453         /*
 454          * get_device
 455          * - Gets the name of the attached device
 456          */
 457         case 8:
 458                 if( iface->Adapter == NULL )
 459                         LEAVE_RET('i', 0);
 460                 if( Data == NULL )
 461                         LEAVE_RET('i', iface->Adapter->DeviceLen);
 462                 if( !CheckMem( Data, iface->Adapter->DeviceLen+1 ) )
 463                         LEAVE_RET('i', -1);
 464                 strcpy( Data, iface->Adapter->Device );
 465                 return iface->Adapter->DeviceLen;
 466
 467         /*
 468          * ping
 469          * - Send an ICMP Echo
 470          */
 471         case 9:
 472                 switch(iface->Type)
 473                 {
 474                 case 0:
 475                         LEAVE_RET('i', 1);
 476
 477                 case 4:
 478                         if( !CheckMem( Data, sizeof(tIPv4) ) )  LEAVE_RET('i', -1);
 479                         tmp = IPv4_Ping(iface, *(tIPv4*)Data);
 480                         LEAVE('i', tmp);
 481                         return tmp;
 482
 483                 case 6:
 484                         LEAVE_RET('i', 1);
 485                 }
 486                 break;
 487
 488         }
 489
 490         LEAVE('i', 0);
 491         return 0;
 492 }
 493
 494 // --- Internal ---
 495 /**
 496  * \fn tAdapter *IPStack_GetAdapter(const char *Path)
 497  * \brief Gets/opens an adapter given the path
 498  */
 499 tAdapter *IPStack_GetAdapter(const char *Path)
 500 {
 501         tAdapter        *dev;
 502          int    tmp;
 503
 504         ENTER("sPath", Path);
 505
 506         // Check for loopback
 507         if( strcmp(Path, "LOOPBACK") == 0 )
 508         {
 509                 // Initialise if required
 510                 if( gIP_LoopAdapter.DeviceFD == 0 )
 511                 {
 512                         dev = &gIP_LoopAdapter;
 513
 514                         dev->NRef = 1;
 515                         dev->DeviceLen = 8;
 516
 517                         dev->DeviceFD = VFS_Open( "/Devices/fifo/anon", VFS_OPENFLAG_READ|VFS_OPENFLAG_WRITE );
 518                         if( dev->DeviceFD == -1 ) {
 519                                 Log_Warning("IPStack", "Unable to open FIFO '/Devices/fifo/anon' for loopback");
 520                                 return NULL;
 521                         }
 522
 523                         dev->MacAddr.B[0] = 'A';
 524                         dev->MacAddr.B[1] = 'c';
 525                         dev->MacAddr.B[2] = 'e';
 526                         dev->MacAddr.B[3] = 's';
 527                         dev->MacAddr.B[4] = 's';
 528                         dev->MacAddr.B[5] = '2';
 529
 530                         // Start watcher
 531                         Link_WatchDevice( dev );
 532                 }
 533                 LEAVE('p', &gIP_LoopAdapter);
 534                 return &gIP_LoopAdapter;
 535         }
 536
 537         Mutex_Acquire( &glIP_Adapters );
 538
 539         // Check if this adapter is already open
 540         for( dev = gIP_Adapters; dev; dev = dev->Next )
 541         {
 542                 if( strcmp(dev->Device, Path) == 0 ) {
 543                         dev->NRef ++;
 544                         Mutex_Release( &glIP_Adapters );
 545                         LEAVE('p', dev);
 546                         return dev;
 547                 }
 548         }
 549
 550         // Ok, so let's open it
 551         dev = malloc( sizeof(tAdapter) + strlen(Path) + 1 );
 552         if(!dev) {
 553                 Log_Warning("IPStack", "GetAdapter - malloc() failed");
 554                 Mutex_Release( &glIP_Adapters );
 555                 LEAVE('n');
 556                 return NULL;
 557         }
 558
 559         // Fill Structure
 560         strcpy( dev->Device, Path );
 561         dev->NRef = 1;
 562         dev->DeviceLen = strlen(Path);
 563
 564         // Open Device
 565         dev->DeviceFD = VFS_Open( dev->Device, VFS_OPENFLAG_READ|VFS_OPENFLAG_WRITE );
 566         if( dev->DeviceFD == -1 ) {
 567                 free( dev );
 568                 Mutex_Release( &glIP_Adapters );
 569                 LEAVE('n');
 570                 return NULL;
 571         }
 572
 573         // Check that it is a network interface
 574         tmp = VFS_IOCtl(dev->DeviceFD, 0, NULL);
 575         LOG("Device type = %i", tmp);
 576         if( tmp != DRV_TYPE_NETWORK ) {
 577                 Log_Warning("IPStack", "IPStack_GetAdapter: '%s' is not a network interface", dev->Device);
 578                 VFS_Close( dev->DeviceFD );
 579                 free( dev );
 580                 Mutex_Release( &glIP_Adapters );
 581                 LEAVE('n');
 582                 return NULL;
 583         }
 584
 585         // Get MAC Address
 586         VFS_IOCtl(dev->DeviceFD, NET_IOCTL_GETMAC, &dev->MacAddr);
 587
 588         // Add to list
 589         dev->Next = gIP_Adapters;
 590         gIP_Adapters = dev;
 591
 592         Mutex_Release( &glIP_Adapters );
 593
 594         // Start watcher
 595         Link_WatchDevice( dev );
 596
 597         LEAVE('p', dev);
 598         return dev;
 599 }