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, guint prop_id, GValue *value, GParamSpec *pspec)
 173 {
 174   GSocket *socket = G_SOCKET (object);
 175
 176   switch (prop_id)
 177     {
 178       case PROP_DOMAIN:
 179         g_value_set_enum (value, socket->priv->domain);
 180         break;
 181
 182       case PROP_TYPE:
 183         g_value_set_enum (value, socket->priv->type);
 184         break;
 185
 186       case PROP_PROTOCOL:
 187         g_value_set_string (value, socket->priv->protocol);
 188         break;
 189
 190       case PROP_FD:
 191         g_value_set_int (value, socket->priv->fd);
 192         break;
 193
 194       case PROP_BLOCKING:
 195         g_value_set_boolean (value, socket->priv->blocking);
 196         break;
 197
 198       case PROP_BACKLOG:
 199         g_value_set_int (value, socket->priv->backlog);
 200         break;
 201
 202       case PROP_REUSE_ADDRESS:
 203         g_value_set_boolean (value, socket->priv->reuse_address);
 204         break;
 205
 206       case PROP_LOCAL_ADDRESS:
 207         g_value_set_object (value, socket->priv->local_address);
 208         break;
 209
 210       case PROP_REMOTE_ADDRESS:
 211         g_value_set_object (value, socket->priv->remote_address);
 212         break;
 213
 214       default:
 215         G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 216     }
 217 }
 218
 219 static void
 220 g_socket_set_property (GObject *object, guint prop_id, const GValue *value, GParamSpec *pspec)
 221 {
 222   GSocket *socket = G_SOCKET (object);
 223
 224   switch (prop_id)
 225     {
 226       case PROP_DOMAIN:
 227         socket->priv->domain = g_value_get_enum (value);
 228         break;
 229
 230       case PROP_TYPE:
 231         socket->priv->type = g_value_get_enum (value);
 232         break;
 233
 234       case PROP_PROTOCOL:
 235         socket->priv->protocol = g_value_dup_string (value);
 236         break;
 237
 238       case PROP_FD:
 239         socket->priv->fd = g_value_get_int (value);
 240         break;
 241
 242       case PROP_BLOCKING:
 243         g_socket_set_blocking (socket, g_value_get_boolean (value));
 244         break;
 245
 246       case PROP_BACKLOG:
 247         socket->priv->backlog = g_value_get_int (value);
 248         break;
 249
 250       case PROP_REUSE_ADDRESS:
 251         g_socket_set_reuse_address (socket, g_value_get_boolean (value));
 252         break;
 253
 254       default:
 255         G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 256     }
 257 }
 258
 259 static void
 260 g_socket_finalize (GObject *object)
 261 {
 262   GSocket *socket = G_SOCKET (object);
 263
 264   if (socket->priv->local_address)
 265     g_object_unref (socket->priv->local_address);
 266
 267   if (socket->priv->remote_address)
 268     g_object_unref (socket->priv->remote_address);
 269
 270   if (G_OBJECT_CLASS (g_socket_parent_class)->finalize)
 271     (*G_OBJECT_CLASS (g_socket_parent_class)->finalize) (object);
 272 }
 273
 274 static void
 275 g_socket_dispose (GObject *object)
 276 {
 277   GSocket *socket = G_SOCKET (object);
 278
 279   g_free (socket->priv->protocol);
 280
 281   g_clear_error (&socket->priv->error);
 282
 283   g_socket_close (socket);
 284
 285   if (G_OBJECT_CLASS (g_socket_parent_class)->dispose)
 286     (*G_OBJECT_CLASS (g_socket_parent_class)->dispose) (object);
 287 }
 288
 289 static void
 290 g_socket_class_init (GSocketClass *klass)
 291 {
 292   GObjectClass *gobject_class G_GNUC_UNUSED = G_OBJECT_CLASS (klass);
 293
 294   // TODO: WSAStartup
 295
 296   g_type_class_add_private (klass, sizeof (GSocketPrivate));
 297
 298   gobject_class->finalize = g_socket_finalize;
 299   gobject_class->dispose = g_socket_dispose;
 300   gobject_class->constructed = g_socket_constructed;
 301   gobject_class->set_property = g_socket_set_property;
 302   gobject_class->get_property = g_socket_get_property;
 303
 304   g_object_class_install_property (gobject_class, PROP_DOMAIN,
 305                                    g_param_spec_enum ("domain",
 306                                                       "socket domain",
 307                                                       "the socket's domain",
 308                                                       G_TYPE_SOCKET_DOMAIN,
 309                                                       G_SOCKET_DOMAIN_INET,
 310                                                       G_PARAM_CONSTRUCT_ONLY | G_PARAM_READWRITE | G_PARAM_STATIC_NAME | G_PARAM_STATIC_BLURB | G_PARAM_STATIC_NICK));
 311
 312   g_object_class_install_property (gobject_class, PROP_TYPE,
 313                                    g_param_spec_enum ("type",
 314                                                       "socket type",
 315                                                       "the socket's type",
 316                                                       G_TYPE_SOCKET_TYPE,
 317                                                       G_SOCKET_TYPE_STREAM,
 318                                                       G_PARAM_CONSTRUCT_ONLY | G_PARAM_READWRITE | G_PARAM_STATIC_NAME | G_PARAM_STATIC_BLURB | G_PARAM_STATIC_NICK));
 319
 320   g_object_class_install_property (gobject_class, PROP_PROTOCOL,
 321                                    g_param_spec_string ("protocol",
 322                                                         "socket protocol",
 323                                                         "the socket's protocol",
 324                                                         NULL,
 325                                                         G_PARAM_CONSTRUCT_ONLY | G_PARAM_READWRITE | G_PARAM_STATIC_NAME | G_PARAM_STATIC_BLURB | G_PARAM_STATIC_NICK));
 326
 327   g_object_class_install_property (gobject_class, PROP_FD,
 328                                    g_param_spec_int ("fd",
 329                                                      "file descriptor",
 330                                                      "the socket's file descriptor",
 331                                                      G_MININT,
 332                                                      G_MAXINT,
 333                                                      -1,
 334                                                      G_PARAM_CONSTRUCT_ONLY | G_PARAM_READWRITE | G_PARAM_STATIC_NAME | G_PARAM_STATIC_BLURB | G_PARAM_STATIC_NICK));
 335
 336   g_object_class_install_property (gobject_class, PROP_BLOCKING,
 337                                    g_param_spec_boolean ("blocking",
 338                                                          "blocking",
 339                                                          "whether or not this socket is blocking",
 340                                                          TRUE,
 341                                                          G_PARAM_READWRITE | G_PARAM_STATIC_NAME | G_PARAM_STATIC_BLURB | G_PARAM_STATIC_NICK));
 342
 343   g_object_class_install_property (gobject_class, PROP_BACKLOG,
 344                                    g_param_spec_int ("backlog",
 345                                                      "listen backlog",
 346                                                      "outstanding connections in the listen queue",
 347                                                      0,
 348                                                      SOMAXCONN,
 349                                                      10,
 350                                                      G_PARAM_READWRITE | G_PARAM_STATIC_NAME | G_PARAM_STATIC_BLURB | G_PARAM_STATIC_NICK));
 351
 352   g_object_class_install_property (gobject_class, PROP_REUSE_ADDRESS,
 353                                    g_param_spec_boolean ("reuse-address",
 354                                                          "reuse address",
 355                                                          "allow reuse of local addresses when binding",
 356                                                          FALSE,
 357                                                          G_PARAM_READWRITE | G_PARAM_STATIC_NAME | G_PARAM_STATIC_BLURB | G_PARAM_STATIC_NICK));
 358
 359   g_object_class_install_property (gobject_class, PROP_LOCAL_ADDRESS,
 360                                    g_param_spec_object ("local-address",
 361                                                         "local address",
 362                                                         "the local address the socket is bound to",
 363                                                         G_TYPE_SOCKET_ADDRESS,
 364                                                         G_PARAM_READABLE | G_PARAM_STATIC_NAME | G_PARAM_STATIC_BLURB | G_PARAM_STATIC_NICK));
 365
 366   g_object_class_install_property (gobject_class, PROP_REMOTE_ADDRESS,
 367                                    g_param_spec_object ("remote-address",
 368                                                         "remote address",
 369                                                         "the remote address the socket is connected to",
 370                                                         G_TYPE_SOCKET_ADDRESS,
 371                                                         G_PARAM_READABLE | G_PARAM_STATIC_NAME | G_PARAM_STATIC_BLURB | G_PARAM_STATIC_NICK));
 372 }
 373
 374 static void
 375 g_socket_init (GSocket *socket)
 376 {
 377   socket->priv = G_TYPE_INSTANCE_GET_PRIVATE (socket, G_TYPE_SOCKET, GSocketPrivate);
 378
 379   socket->priv->fd = -1;
 380   socket->priv->blocking = TRUE;
 381   socket->priv->backlog = 10;
 382   socket->priv->reuse_address = FALSE;
 383   socket->priv->error = NULL;
 384   socket->priv->remote_address = NULL;
 385   socket->priv->local_address = NULL;
 386 }
 387
 388 GSocket *
 389 g_socket_new (GSocketDomain domain, GSocketType type, const gchar *protocol)
 390 {
 391   return G_SOCKET (g_object_new (G_TYPE_SOCKET, "domain", domain, "type", type, "protocol", protocol, NULL));
 392 }
 393
 394 GSocket *
 395 g_socket_new_from_fd (gint fd)
 396 {
 397   return G_SOCKET (g_object_new (G_TYPE_SOCKET, "fd", fd, NULL));
 398 }
 399
 400 void
 401 g_socket_set_blocking (GSocket  *socket,
 402                        gboolean  blocking)
 403 {
 404   glong arg;
 405
 406   g_return_if_fail (G_IS_SOCKET (socket));
 407
 408   if ((arg = fcntl (socket->priv->fd, F_GETFL, NULL)) < 0)
 409     g_warning ("Error getting socket status flags: %s", g_strerror (errno));
 410
 411   arg = blocking ? arg & ~O_NONBLOCK : arg | O_NONBLOCK;
 412
 413   if (fcntl (socket->priv->fd, F_SETFL, arg) < 0)
 414     g_warning ("Error setting socket status flags: %s", g_strerror (errno));
 415
 416   socket->priv->blocking = blocking;
 417 }
 418
 419 gboolean
 420 g_socket_get_blocking (GSocket *socket)
 421 {
 422   g_return_val_if_fail (G_IS_SOCKET (socket), FALSE);
 423
 424   return socket->priv->blocking;
 425 }
 426
 427 void
 428 g_socket_set_reuse_address (GSocket  *socket,
 429                             gboolean  reuse)
 430 {
 431   gint value = (gint) reuse;
 432
 433   g_return_if_fail (G_IS_SOCKET (socket));
 434
 435   if (setsockopt (socket->priv->fd, SOL_SOCKET, SO_REUSEADDR, (gpointer) &value, sizeof (value)) < 0)
 436     g_warning ("error setting reuse address: %s", g_strerror (errno));
 437
 438   socket->priv->reuse_address = reuse;
 439 }
 440
 441 gboolean
 442 g_socket_get_reuse_address (GSocket *socket)
 443 {
 444   g_return_val_if_fail (G_IS_SOCKET (socket), FALSE);
 445
 446   return socket->priv->reuse_address;
 447 }
 448
 449 GSocketAddress *
 450 g_socket_get_local_address (GSocket  *socket,
 451                             GError  **error)
 452 {
 453   gchar buffer[256];
 454   gsize len = 256;
 455
 456   g_return_val_if_fail (G_IS_SOCKET (socket), NULL);
 457
 458   if (socket->priv->local_address)
 459     return socket->priv->local_address;
 460
 461   if (getsockname (socket->priv->fd, (struct sockaddr *) buffer, &len) < 0)
 462     {
 463       g_set_error (error, G_IO_ERROR, g_io_error_from_errno (errno), "could not get local address: %s", g_strerror (errno));
 464       return NULL;
 465     }
 466
 467   return (socket->priv->local_address = g_object_ref_sink (g_socket_address_from_native (buffer, len)));
 468 }
 469
 470 GSocketAddress *
 471 g_socket_get_remote_address (GSocket  *socket,
 472                              GError  **error)
 473 {
 474   gchar buffer[256];
 475   gsize len = 256;
 476
 477   g_return_val_if_fail (G_IS_SOCKET (socket), NULL);
 478
 479   if (socket->priv->remote_address)
 480     return socket->priv->remote_address;
 481
 482   if (getpeername (socket->priv->fd, (struct sockaddr *) buffer, &len) < 0)
 483     {
 484       g_set_error (error, G_IO_ERROR, g_io_error_from_errno (errno), "could not get remote address: %s", g_strerror (errno));
 485       return NULL;
 486     }
 487
 488   return (socket->priv->remote_address = g_object_ref_sink (g_socket_address_from_native (buffer, len)));
 489 }
 490
 491 gboolean
 492 g_socket_has_error (GSocket  *socket,
 493                     GError  **error)
 494 {
 495   g_return_val_if_fail (G_IS_SOCKET (socket), FALSE);
 496
 497   if (!socket->priv->error)
 498     return FALSE;
 499
 500   return TRUE;
 501 }
 502
 503 gboolean
 504 g_socket_listen (GSocket  *socket,
 505                  GError  **error)
 506 {
 507   g_return_val_if_fail (G_IS_SOCKET (socket), FALSE);
 508
 509   if (g_socket_has_error (socket, error))
 510     return FALSE;
 511
 512   if (listen (socket->priv->fd, socket->priv->backlog) < 0)
 513     {
 514       g_set_error (error, G_IO_ERROR, g_io_error_from_errno (errno), "could not listen: %s", g_strerror (errno));
 515       return FALSE;
 516     }
 517
 518   return TRUE;
 519 }
 520
 521 gboolean
 522 g_socket_bind (GSocket         *socket,
 523                GSocketAddress  *address,
 524                GError         **error)
 525 {
 526   g_return_val_if_fail (G_IS_SOCKET (socket) && G_IS_SOCKET_ADDRESS (address), FALSE);
 527
 528   if (g_socket_has_error (socket, error))
 529     return FALSE;
 530
 531   {
 532     gchar addr[256];
 533
 534     if (!g_socket_address_to_native (address, addr))
 535       return FALSE;
 536
 537     if (bind (socket->priv->fd, (struct sockaddr *) addr, g_socket_address_native_size (address)) < 0)
 538       {
 539         g_set_error (error, G_IO_ERROR, g_io_error_from_errno (errno), "error binding to address: %s", g_strerror (errno));
 540         return FALSE;
 541       }
 542
 543     g_object_ref_sink (address);
 544
 545     socket->priv->local_address = address;
 546
 547     return TRUE;
 548   }
 549 }
 550
 551 GSocket *
 552 g_socket_accept (GSocket       *socket,
 553                  GError       **error)
 554 {
 555   gint ret;
 556
 557   g_return_val_if_fail (G_IS_SOCKET (socket), NULL);
 558
 559   if (g_socket_has_error (socket, error))
 560     return NULL;
 561
 562   if ((ret = accept (socket->priv->fd, NULL, 0)) < 0)
 563     {
 564       g_set_error (error, G_IO_ERROR, g_io_error_from_errno (errno), "error accepting connection: %s", g_strerror (errno));
 565       return NULL;
 566     }
 567
 568   return g_socket_new_from_fd (ret);
 569 }
 570
 571 gboolean
 572 g_socket_connect (GSocket         *socket,
 573                   GSocketAddress  *address,
 574                   GError         **error)
 575 {
 576   gchar buffer[256];
 577
 578   g_return_val_if_fail (G_IS_SOCKET (socket) && G_IS_SOCKET_ADDRESS (address), FALSE);
 579
 580   if (g_socket_has_error (socket, error))
 581     return FALSE;
 582
 583   g_socket_address_to_native (address, buffer);
 584
 585   if (connect (socket->priv->fd, (struct sockaddr *) buffer, g_socket_address_native_size (address)) < 0)
 586     {
 587       if (errno == EINPROGRESS)
 588         g_set_error (error, G_IO_ERROR, G_IO_ERROR_PENDING, "connection in progress");
 589       else
 590         g_set_error (error, G_IO_ERROR, g_io_error_from_errno (errno), "error connecting: %s", g_strerror (errno));
 591       return FALSE;
 592     }
 593
 594   socket->priv->remote_address = g_object_ref_sink (address);
 595
 596   return TRUE;
 597 }
 598
 599 gssize
 600 g_socket_receive (GSocket       *socket,
 601                   gchar         *buffer,
 602                   gsize          size,
 603                   GError       **error)
 604 {
 605   gssize ret;
 606
 607   g_return_val_if_fail (G_IS_SOCKET (socket) && buffer != NULL, FALSE);
 608
 609   if ((ret = recv (socket->priv->fd, buffer, size, 0)) < 0)
 610     {
 611       g_set_error (error, G_IO_ERROR, g_io_error_from_errno (errno), "error receiving data: %s", g_strerror (errno));
 612       return -1;
 613     }
 614
 615   return ret;
 616 }
 617
 618 gssize
 619 g_socket_send (GSocket       *socket,
 620                gchar         *buffer,
 621                gsize          size,
 622                GError       **error)
 623 {
 624   gssize ret;
 625
 626   g_return_val_if_fail (G_IS_SOCKET (socket) && buffer != NULL, FALSE);
 627
 628   if ((ret = send (socket->priv->fd, buffer, size, 0)) < 0)
 629     {
 630       g_set_error (error, G_IO_ERROR, g_io_error_from_errno (errno), "error sending data: %s", g_strerror (errno));
 631       return -1;
 632     }
 633
 634   return ret;
 635 }
 636
 637 void
 638 g_socket_close (GSocket *socket)
 639 {
 640   g_return_if_fail (G_IS_SOCKET (socket));
 641
 642 #ifdef G_OS_WIN32
 643   closesocket (socket->priv->fd);
 644 #else
 645   close (socket->priv->fd);
 646 #endif
 647 }
 648
 649 GSource *
 650 g_socket_create_source (GSocket      *socket,
 651                         GIOCondition  condition,
 652                         GCancellable *cancellable)
 653 {
 654   g_return_val_if_fail (G_IS_SOCKET (socket) && (cancellable == NULL || G_IS_CANCELLABLE (cancellable)), NULL);
 655
 656   return _g_fd_source_new (socket->priv->fd, G_IO_IN | G_IO_HUP | G_IO_ERR, cancellable);
 657 }