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