gnio/gsocket.c

   1 /* GNIO - GLib Network Layer of GIO
   2  *
   3  * Copyright (C) 2008 Christian Kellner, Samuel Cormier-Iijima
   4  *
   5  * This library is free software; you can redistribute it and/or
   6  * modify it under the terms of the GNU Lesser General Public
   7  * License as published by the Free Software Foundation; either
   8  * version 2 of the License, or (at your option) any later version.
   9  *
  10  * This library is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13  * Lesser General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU Lesser General
  16  * Public License along with this library; if not, write to the
  17  * Free Software Foundation, Inc., 59 Temple Place, Suite 330,
  18  * Boston, MA 02111-1307, USA.
  19  *
  20  * Authors: Christian Kellner <gicmo@gnome.org>
  21  *          Samuel Cormier-Iijima <sciyoshi@gmail.com>
  22  */
  23
  24 #include <config.h>
  25 #include <glib.h>
  26 #include <gio/gio.h>
  27 #include <gnio/gnio.h>
  28 #include "gasynchelper.h"
  29 #include "gnioenumtypes.h"
  30
  31 #include <string.h>
  32 #ifndef G_OS_WIN32
  33 # include <netinet/in.h>
  34 # include <arpa/inet.h>
  35 # include <netdb.h>
  36 # include <fcntl.h>
  37 # include <unistd.h>
  38 # include <sys/types.h>
  39 #else
  40
  41 #endif
  42 #include <errno.h>
  43
  44 #include "ginetaddress.h"
  45 #include "ginet4address.h"
  46 #include "ginet6address.h"
  47 #include "gsocket.h"
  48 #include "gnioerror.h"
  49 #include "ginetsocketaddress.h"
  50
  51 G_DEFINE_TYPE (GSocket, g_socket, G_TYPE_OBJECT);
  52
  53 enum
  54 {
  55   PROP_0,
  56   PROP_DOMAIN,
  57   PROP_TYPE,
  58   PROP_PROTOCOL,
  59   PROP_FD,
  60   PROP_BLOCKING,
  61   PROP_BACKLOG,
  62   PROP_REUSE_ADDRESS,
  63   PROP_LOCAL_ADDRESS,
  64   PROP_REMOTE_ADDRESS
  65 };
  66
  67 struct _GSocketPrivate
  68 {
  69   GSocketDomain domain;
  70   GSocketType type;
  71   gchar *protocol;
  72   gint fd;
  73   gboolean blocking;
  74   gint backlog;
  75   gboolean reuse_address;
  76   GError *error;
  77   GSocketAddress *local_address;
  78   GSocketAddress *remote_address;
  79 };
  80
  81 static void
  82 g_socket_constructed (GObject *object)
  83 {
  84   GSocket *sock = G_SOCKET (object);
  85   GError *error = NULL;
  86   static GStaticMutex getprotobyname_mutex = G_STATIC_MUTEX_INIT;
  87   gint fd, native_domain, native_type, native_protocol;
  88
  89   if (sock->priv->fd >= 0)
  90     {
  91       // we've been constructed from an existing file descriptor
  92       glong arg;
  93       gboolean blocking;
  94
  95       // TODO: set the socket type with getsockopt (SO_TYPE)
  96       // TODO: what should we do about domain and protocol?
  97
  98       if ((arg = fcntl (sock->priv->fd, F_GETFL, NULL)) < 0)
  99         g_warning ("Error getting socket status flags: %s", g_strerror (errno));
 100
 101       blocking = ((arg & O_NONBLOCK) == 0);
 102
 103       return;
 104     }
 105
 106   switch (sock->priv->domain)
 107     {
 108       case G_SOCKET_DOMAIN_INET:
 109         native_domain = PF_INET;
 110         break;
 111
 112       case G_SOCKET_DOMAIN_INET6:
 113         native_domain = PF_INET6;
 114         break;
 115
 116       case G_SOCKET_DOMAIN_UNIX:
 117         native_domain = PF_UNIX;
 118         break;
 119
 120       default:
 121         g_set_error (&error, G_IO_ERROR, G_IO_ERROR_NOT_SUPPORTED, "unsupported socket domain");
 122         return;
 123     }
 124
 125   switch (sock->priv->type)
 126     {
 127       case G_SOCKET_TYPE_STREAM:
 128         native_type = SOCK_STREAM;
 129         break;
 130
 131       case G_SOCKET_TYPE_DATAGRAM:
 132         native_type = SOCK_DGRAM;
 133         break;
 134
 135       case G_SOCKET_TYPE_SEQPACKET:
 136         native_type = SOCK_SEQPACKET;
 137         break;
 138
 139       default:
 140         g_set_error (&error, G_IO_ERROR, G_IO_ERROR_NOT_SUPPORTED, "unsupported socket type");
 141         return;
 142     }
 143
 144   if (sock->priv->protocol == NULL)
 145     native_protocol = 0;
 146   else
 147     {
 148       struct protoent *ent;
 149       g_static_mutex_lock (&getprotobyname_mutex);
 150       if (!(ent = getprotobyname (sock->priv->protocol)))
 151         {
 152           g_static_mutex_unlock (&getprotobyname_mutex);
 153           g_set_error (&error, G_IO_ERROR, G_IO_ERROR_NOT_SUPPORTED, "unsupported socket protocol");
 154           return;
 155         }
 156       native_protocol = ent->p_proto;
 157       g_static_mutex_unlock (&getprotobyname_mutex);
 158     }
 159
 160   fd = socket (native_domain, native_type, native_protocol);
 161
 162   if (fd < 0)
 163     {
 164       g_set_error (&error, G_IO_ERROR, g_io_error_from_errno (errno), "unable to create socket: %s", g_strerror (errno));
 165       return;
 166     }
 167
 168   sock->priv->fd = fd;
 169 }
 170
 171 static void
 172 g_socket_get_property (GObject    *object,
 173                        guint       prop_id,
 174                        GValue     *value,
 175                        GParamSpec *pspec)
 176 {
 177   GSocket *socket = G_SOCKET (object);
 178
 179   switch (prop_id)
 180     {
 181       case PROP_DOMAIN:
 182         g_value_set_enum (value, socket->priv->domain);
 183         break;
 184
 185       case PROP_TYPE:
 186         g_value_set_enum (value, socket->priv->type);
 187         break;
 188
 189       case PROP_PROTOCOL:
 190         g_value_set_string (value, socket->priv->protocol);
 191         break;
 192
 193       case PROP_FD:
 194         g_value_set_int (value, socket->priv->fd);
 195         break;
 196
 197       case PROP_BLOCKING:
 198         g_value_set_boolean (value, socket->priv->blocking);
 199         break;
 200
 201       case PROP_BACKLOG:
 202         g_value_set_int (value, socket->priv->backlog);
 203         break;
 204
 205       case PROP_REUSE_ADDRESS:
 206         g_value_set_boolean (value, socket->priv->reuse_address);
 207         break;
 208
 209       case PROP_LOCAL_ADDRESS:
 210         g_value_set_object (value, socket->priv->local_address);
 211         break;
 212
 213       case PROP_REMOTE_ADDRESS:
 214         g_value_set_object (value, socket->priv->remote_address);
 215         break;
 216
 217       default:
 218         G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 219     }
 220 }
 221
 222 static void
 223 g_socket_set_property (GObject      *object,
 224                        guint         prop_id,
 225                        const GValue *value,
 226                        GParamSpec   *pspec)
 227 {
 228   GSocket *socket = G_SOCKET (object);
 229
 230   switch (prop_id)
 231     {
 232       case PROP_DOMAIN:
 233         socket->priv->domain = g_value_get_enum (value);
 234         break;
 235
 236       case PROP_TYPE:
 237         socket->priv->type = g_value_get_enum (value);
 238         break;
 239
 240       case PROP_PROTOCOL:
 241         socket->priv->protocol = g_value_dup_string (value);
 242         break;
 243
 244       case PROP_FD:
 245         socket->priv->fd = g_value_get_int (value);
 246         break;
 247
 248       case PROP_BLOCKING:
 249         g_socket_set_blocking (socket, g_value_get_boolean (value));
 250         break;
 251
 252       case PROP_BACKLOG:
 253         socket->priv->backlog = g_value_get_int (value);
 254         break;
 255
 256       case PROP_REUSE_ADDRESS:
 257         g_socket_set_reuse_address (socket, g_value_get_boolean (value));
 258         break;
 259
 260       default:
 261         G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 262     }
 263 }
 264
 265 static void
 266 g_socket_finalize (GObject *object)
 267 {
 268   GSocket *socket = G_SOCKET (object);
 269
 270   if (socket->priv->local_address)
 271     g_object_unref (socket->priv->local_address);
 272
 273   if (socket->priv->remote_address)
 274     g_object_unref (socket->priv->remote_address);
 275
 276   if (G_OBJECT_CLASS (g_socket_parent_class)->finalize)
 277     (*G_OBJECT_CLASS (g_socket_parent_class)->finalize) (object);
 278 }
 279
 280 static void
 281 g_socket_dispose (GObject *object)
 282 {
 283   GSocket *socket = G_SOCKET (object);
 284
 285   g_free (socket->priv->protocol);
 286
 287   g_clear_error (&socket->priv->error);
 288
 289   g_socket_close (socket);
 290
 291   if (G_OBJECT_CLASS (g_socket_parent_class)->dispose)
 292     (*G_OBJECT_CLASS (g_socket_parent_class)->dispose) (object);
 293 }
 294
 295 static void
 296 g_socket_class_init (GSocketClass *klass)
 297 {
 298   GObjectClass *gobject_class G_GNUC_UNUSED = G_OBJECT_CLASS (klass);
 299
 300   // TODO: WSAStartup
 301
 302   g_type_class_add_private (klass, sizeof (GSocketPrivate));
 303
 304   gobject_class->finalize = g_socket_finalize;
 305   gobject_class->dispose = g_socket_dispose;
 306   gobject_class->constructed = g_socket_constructed;
 307   gobject_class->set_property = g_socket_set_property;
 308   gobject_class->get_property = g_socket_get_property;
 309
 310   g_object_class_install_property (gobject_class, PROP_DOMAIN,
 311                                    g_param_spec_enum ("domain",
 312                                                       "socket domain",
 313                                                       "the socket's domain",
 314                                                       G_TYPE_SOCKET_DOMAIN,
 315                                                       G_SOCKET_DOMAIN_INET,
 316                                                       G_PARAM_CONSTRUCT_ONLY | G_PARAM_READWRITE | G_PARAM_STATIC_NAME | G_PARAM_STATIC_BLURB | G_PARAM_STATIC_NICK));
 317
 318   g_object_class_install_property (gobject_class, PROP_TYPE,
 319                                    g_param_spec_enum ("type",
 320                                                       "socket type",
 321                                                       "the socket's type",
 322                                                       G_TYPE_SOCKET_TYPE,
 323                                                       G_SOCKET_TYPE_STREAM,
 324                                                       G_PARAM_CONSTRUCT_ONLY | G_PARAM_READWRITE | G_PARAM_STATIC_NAME | G_PARAM_STATIC_BLURB | G_PARAM_STATIC_NICK));
 325
 326   g_object_class_install_property (gobject_class, PROP_PROTOCOL,
 327                                    g_param_spec_string ("protocol",
 328                                                         "socket protocol",
 329                                                         "the socket's protocol",
 330                                                         NULL,
 331                                                         G_PARAM_CONSTRUCT_ONLY | G_PARAM_READWRITE | G_PARAM_STATIC_NAME | G_PARAM_STATIC_BLURB | G_PARAM_STATIC_NICK));
 332
 333   g_object_class_install_property (gobject_class, PROP_FD,
 334                                    g_param_spec_int ("fd",
 335                                                      "file descriptor",
 336                                                      "the socket's file descriptor",
 337                                                      G_MININT,
 338                                                      G_MAXINT,
 339                                                      -1,
 340                                                      G_PARAM_CONSTRUCT_ONLY | G_PARAM_READWRITE | G_PARAM_STATIC_NAME | G_PARAM_STATIC_BLURB | G_PARAM_STATIC_NICK));
 341
 342   g_object_class_install_property (gobject_class, PROP_BLOCKING,
 343                                    g_param_spec_boolean ("blocking",
 344                                                          "blocking",
 345                                                          "whether or not this socket is blocking",
 346                                                          TRUE,
 347                                                          G_PARAM_READWRITE | G_PARAM_STATIC_NAME | G_PARAM_STATIC_BLURB | G_PARAM_STATIC_NICK));
 348
 349   g_object_class_install_property (gobject_class, PROP_BACKLOG,
 350                                    g_param_spec_int ("backlog",
 351                                                      "listen backlog",
 352                                                      "outstanding connections in the listen queue",
 353                                                      0,
 354                                                      SOMAXCONN,
 355                                                      10,
 356                                                      G_PARAM_READWRITE | G_PARAM_STATIC_NAME | G_PARAM_STATIC_BLURB | G_PARAM_STATIC_NICK));
 357
 358   g_object_class_install_property (gobject_class, PROP_REUSE_ADDRESS,
 359                                    g_param_spec_boolean ("reuse-address",
 360                                                          "reuse address",
 361                                                          "allow reuse of local addresses when binding",
 362                                                          FALSE,
 363                                                          G_PARAM_READWRITE | G_PARAM_STATIC_NAME | G_PARAM_STATIC_BLURB | G_PARAM_STATIC_NICK));
 364
 365   g_object_class_install_property (gobject_class, PROP_LOCAL_ADDRESS,
 366                                    g_param_spec_object ("local-address",
 367                                                         "local address",
 368                                                         "the local address the socket is bound to",
 369                                                         G_TYPE_SOCKET_ADDRESS,
 370                                                         G_PARAM_READABLE | G_PARAM_STATIC_NAME | G_PARAM_STATIC_BLURB | G_PARAM_STATIC_NICK));
 371
 372   g_object_class_install_property (gobject_class, PROP_REMOTE_ADDRESS,
 373                                    g_param_spec_object ("remote-address",
 374                                                         "remote address",
 375                                                         "the remote address the socket is connected to",
 376                                                         G_TYPE_SOCKET_ADDRESS,
 377                                                         G_PARAM_READABLE | G_PARAM_STATIC_NAME | G_PARAM_STATIC_BLURB | G_PARAM_STATIC_NICK));
 378 }
 379
 380 static void
 381 g_socket_init (GSocket *socket)
 382 {
 383   socket->priv = G_TYPE_INSTANCE_GET_PRIVATE (socket, G_TYPE_SOCKET, GSocketPrivate);
 384
 385   socket->priv->fd = -1;
 386   socket->priv->blocking = TRUE;
 387   socket->priv->backlog = 10;
 388   socket->priv->reuse_address = FALSE;
 389   socket->priv->error = NULL;
 390   socket->priv->remote_address = NULL;
 391   socket->priv->local_address = NULL;
 392 }
 393
 394 GSocket *
 395 g_socket_new (GSocketDomain domain, GSocketType type, const gchar *protocol)
 396 {
 397   return G_SOCKET (g_object_new (G_TYPE_SOCKET, "domain", domain, "type", type, "protocol", protocol, NULL));
 398 }
 399
 400 GSocket *
 401 g_socket_new_from_fd (gint fd)
 402 {
 403   return G_SOCKET (g_object_new (G_TYPE_SOCKET, "fd", fd, NULL));
 404 }
 405
 406 void
 407 g_socket_set_blocking (GSocket  *socket,
 408                        gboolean  blocking)
 409 {
 410   glong arg;
 411
 412   g_return_if_fail (G_IS_SOCKET (socket));
 413
 414   if ((arg = fcntl (socket->priv->fd, F_GETFL, NULL)) < 0)
 415     g_warning ("Error getting socket status flags: %s", g_strerror (errno));
 416
 417   arg = blocking ? arg & ~O_NONBLOCK : arg | O_NONBLOCK;
 418
 419   if (fcntl (socket->priv->fd, F_SETFL, arg) < 0)
 420     g_warning ("Error setting socket status flags: %s", g_strerror (errno));
 421
 422   socket->priv->blocking = blocking;
 423 }
 424
 425 gboolean
 426 g_socket_get_blocking (GSocket *socket)
 427 {
 428   g_return_val_if_fail (G_IS_SOCKET (socket), FALSE);
 429
 430   return socket->priv->blocking;
 431 }
 432
 433 void
 434 g_socket_set_reuse_address (GSocket  *socket,
 435                             gboolean  reuse)
 436 {
 437   gint value = (gint) reuse;
 438
 439   g_return_if_fail (G_IS_SOCKET (socket));
 440
 441   if (setsockopt (socket->priv->fd, SOL_SOCKET, SO_REUSEADDR, (gpointer) &value, sizeof (value)) < 0)
 442     g_warning ("error setting reuse address: %s", g_strerror (errno));
 443
 444   socket->priv->reuse_address = reuse;
 445 }
 446
 447 gboolean
 448 g_socket_get_reuse_address (GSocket *socket)
 449 {
 450   g_return_val_if_fail (G_IS_SOCKET (socket), FALSE);
 451
 452   return socket->priv->reuse_address;
 453 }
 454
 455 GSocketAddress *
 456 g_socket_get_local_address (GSocket  *socket,
 457                             GError  **error)
 458 {
 459   gchar buffer[256];
 460   gsize len = 256;
 461
 462   g_return_val_if_fail (G_IS_SOCKET (socket), NULL);
 463
 464   if (socket->priv->local_address)
 465     return socket->priv->local_address;
 466
 467   if (getsockname (socket->priv->fd, (struct sockaddr *) buffer, &len) < 0)
 468     {
 469       g_set_error (error, G_IO_ERROR, g_io_error_from_errno (errno), "could not get local address: %s", g_strerror (errno));
 470       return NULL;
 471     }
 472
 473   return (socket->priv->local_address = g_object_ref_sink (g_socket_address_from_native (buffer, len)));
 474 }
 475
 476 GSocketAddress *
 477 g_socket_get_remote_address (GSocket  *socket,
 478                              GError  **error)
 479 {
 480   gchar buffer[256];
 481   gsize len = 256;
 482
 483   g_return_val_if_fail (G_IS_SOCKET (socket), NULL);
 484
 485   if (socket->priv->remote_address)
 486     return socket->priv->remote_address;
 487
 488   if (getpeername (socket->priv->fd, (struct sockaddr *) buffer, &len) < 0)
 489     {
 490       g_set_error (error, G_IO_ERROR, g_io_error_from_errno (errno), "could not get remote address: %s", g_strerror (errno));
 491       return NULL;
 492     }
 493
 494   return (socket->priv->remote_address = g_object_ref_sink (g_socket_address_from_native (buffer, len)));
 495 }
 496
 497 gboolean
 498 g_socket_has_error (GSocket  *socket,
 499                     GError  **error)
 500 {
 501   g_return_val_if_fail (G_IS_SOCKET (socket), FALSE);
 502
 503   if (!socket->priv->error)
 504     return FALSE;
 505
 506   return TRUE;
 507 }
 508
 509 gboolean
 510 g_socket_listen (GSocket  *socket,
 511                  GError  **error)
 512 {
 513   g_return_val_if_fail (G_IS_SOCKET (socket), FALSE);
 514
 515   if (g_socket_has_error (socket, error))
 516     return FALSE;
 517
 518   if (listen (socket->priv->fd, socket->priv->backlog) < 0)
 519     {
 520       g_set_error (error, G_IO_ERROR, g_io_error_from_errno (errno), "could not listen: %s", g_strerror (errno));
 521       return FALSE;
 522     }
 523
 524   return TRUE;
 525 }
 526
 527 gboolean
 528 g_socket_bind (GSocket         *socket,
 529                GSocketAddress  *address,
 530                GError         **error)
 531 {
 532   g_return_val_if_fail (G_IS_SOCKET (socket) && G_IS_SOCKET_ADDRESS (address), FALSE);
 533
 534   if (g_socket_has_error (socket, error))
 535     return FALSE;
 536
 537   {
 538     gchar addr[256];
 539
 540     if (!g_socket_address_to_native (address, addr))
 541       return FALSE;
 542
 543     if (bind (socket->priv->fd, (struct sockaddr *) addr, g_socket_address_native_size (address)) < 0)
 544       {
 545         g_set_error (error, G_IO_ERROR, g_io_error_from_errno (errno), "error binding to address: %s", g_strerror (errno));
 546         return FALSE;
 547       }
 548
 549     g_object_ref_sink (address);
 550
 551     socket->priv->local_address = address;
 552
 553     return TRUE;
 554   }
 555 }
 556
 557 GSocket *
 558 g_socket_accept (GSocket       *socket,
 559                  GError       **error)
 560 {
 561   gint ret;
 562
 563   g_return_val_if_fail (G_IS_SOCKET (socket), NULL);
 564
 565   if (g_socket_has_error (socket, error))
 566     return NULL;
 567
 568   if ((ret = accept (socket->priv->fd, NULL, 0)) < 0)
 569     {
 570       g_set_error (error, G_IO_ERROR, g_io_error_from_errno (errno), "error accepting connection: %s", g_strerror (errno));
 571       return NULL;
 572     }
 573
 574   return g_socket_new_from_fd (ret);
 575 }
 576
 577 gboolean
 578 g_socket_connect (GSocket         *socket,
 579                   GSocketAddress  *address,
 580                   GError         **error)
 581 {
 582   gchar buffer[256];
 583
 584   g_return_val_if_fail (G_IS_SOCKET (socket) && G_IS_SOCKET_ADDRESS (address), FALSE);
 585
 586   if (g_socket_has_error (socket, error))
 587     return FALSE;
 588
 589   g_socket_address_to_native (address, buffer);
 590
 591   if (connect (socket->priv->fd, (struct sockaddr *) buffer, g_socket_address_native_size (address)) < 0)
 592     {
 593       if (errno == EINPROGRESS)
 594         g_set_error (error, G_IO_ERROR, G_IO_ERROR_PENDING, "connection in progress");
 595       else
 596         g_set_error (error, G_IO_ERROR, g_io_error_from_errno (errno), "error connecting: %s", g_strerror (errno));
 597       return FALSE;
 598     }
 599
 600   socket->priv->remote_address = g_object_ref_sink (address);
 601
 602   return TRUE;
 603 }
 604
 605 gssize
 606 g_socket_receive (GSocket       *socket,
 607                   gchar         *buffer,
 608                   gsize          size,
 609                   GError       **error)
 610 {
 611   gssize ret;
 612
 613   g_return_val_if_fail (G_IS_SOCKET (socket) && buffer != NULL, FALSE);
 614
 615   if ((ret = recv (socket->priv->fd, buffer, size, 0)) < 0)
 616     {
 617       g_set_error (error, G_IO_ERROR, g_io_error_from_errno (errno), "error receiving data: %s", g_strerror (errno));
 618       return -1;
 619     }
 620
 621   return ret;
 622 }
 623
 624 gssize
 625 g_socket_send (GSocket       *socket,
 626                gchar         *buffer,
 627                gsize          size,
 628                GError       **error)
 629 {
 630   gssize ret;
 631
 632   g_return_val_if_fail (G_IS_SOCKET (socket) && buffer != NULL, FALSE);
 633
 634   if ((ret = send (socket->priv->fd, buffer, size, 0)) < 0)
 635     {
 636       g_set_error (error, G_IO_ERROR, g_io_error_from_errno (errno), "error sending data: %s", g_strerror (errno));
 637       return -1;
 638     }
 639
 640   return ret;
 641 }
 642
 643 void
 644 g_socket_close (GSocket *socket)
 645 {
 646   g_return_if_fail (G_IS_SOCKET (socket));
 647
 648 #ifdef G_OS_WIN32
 649   closesocket (socket->priv->fd);
 650 #else
 651   close (socket->priv->fd);
 652 #endif
 653 }
 654
 655 GSource *
 656 g_socket_create_source (GSocket      *socket,
 657                         GIOCondition  condition,
 658                         GCancellable *cancellable)
 659 {
 660   g_return_val_if_fail (G_IS_SOCKET (socket) && (cancellable == NULL || G_IS_CANCELLABLE (cancellable)), NULL);
 661
 662   return _g_fd_source_new (socket->priv->fd, G_IO_IN | G_IO_HUP | G_IO_ERR, cancellable);
 663 }