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