src/sn-evolution.c

   1 /**
   2  * libsortnetwork - src/sn-evolution.c
   3  * Copyright (C) 2008-2010  Florian octo Forster
   4  *
   5  * This program is free software; you can redistribute it and/or modify it
   6  * under the terms of the GNU General Public License as published by the
   7  * Free Software Foundation; only version 2 of the License is applicable.
   8  *
   9  * This program is distributed in the hope that it will be useful, but
  10  * WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12  * General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU General Public License along
  15  * with this program; if not, write to the Free Software Foundation, Inc.,
  16  * 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
  17  *
  18  * Authors:
  19  *   Florian octo Forster <ff at octo.it>
  20  **/
  21
  22 #ifndef _ISOC99_SOURCE
  23 # define _ISOC99_SOURCE
  24 #endif
  25 #ifndef _POSIX_C_SOURCE
  26 # define _POSIX_C_SOURCE 200809L
  27 #endif
  28 #ifndef _XOPEN_SOURCE
  29 # define _XOPEN_SOURCE 700
  30 #endif
  31
  32 #include <stdlib.h>
  33 #include <stdio.h>
  34 #include <stdint.h>
  35 #include <string.h>
  36
  37 #include <sys/types.h>
  38 #include <sys/stat.h>
  39 #include <fcntl.h>
  40 #include <unistd.h>
  41 #include <signal.h>
  42 #include <assert.h>
  43 #include <limits.h>
  44
  45 #include <pthread.h>
  46
  47 #include <population.h>
  48
  49 #include "sn_network.h"
  50 #include "sn_random.h"
  51
  52 #if !defined(__GNUC__) || !__GNUC__
  53 # define __attribute__(x) /**/
  54 #endif
  55
  56 static uint64_t iteration_counter = 0;
  57 static int inputs_num = 16;
  58 static int inputs_num_is_power_of_two = 1;
  59
  60 static char *initial_input_file = NULL;
  61 static char *best_output_file = NULL;
  62
  63 static int stats_interval = 0;
  64
  65 static int max_population_size = 128;
  66 static population_t *population;
  67
  68 static int evolution_threads_num = 4;
  69
  70 static int do_loop = 0;
  71
  72 static void sigint_handler (int signal __attribute__((unused)))
  73 {
  74   do_loop++;
  75 } /* void sigint_handler */
  76
  77 static void exit_usage (const char *name)
  78 {
  79   printf ("Usage: %s [options]\n"
  80       "\n"
  81       "Valid options are:\n"
  82       "  -i <file>     Initial input file (REQUIRED)\n"
  83       "  -o <file>     Write the current best solution to <file>\n"
  84       "  -p <num>      Size of the population (default: 128)\n"
  85       "  -P <peer>     Send individuals to <peer> (may be repeated)\n"
  86       "  -t <num>      Number of threads (default: 4)\n"
  87       "\n",
  88       name);
  89   exit (1);
  90 } /* void exit_usage */
  91
  92 int read_options (int argc, char **argv)
  93 {
  94   int option;
  95
  96   while ((option = getopt (argc, argv, "i:o:p:P:s:t:h")) != -1)
  97   {
  98     switch (option)
  99     {
 100       case 'i':
 101       {
 102         if (initial_input_file != NULL)
 103           free (initial_input_file);
 104         initial_input_file = strdup (optarg);
 105         break;
 106       }
 107
 108       case 'o':
 109       {
 110         if (best_output_file != NULL)
 111           free (best_output_file);
 112         best_output_file = strdup (optarg);
 113         break;
 114       }
 115
 116       case 'p':
 117       {
 118         int tmp = atoi (optarg);
 119         if (tmp > 0)
 120         {
 121           max_population_size = tmp;
 122           population_set_size (population, (size_t) max_population_size);
 123         }
 124         break;
 125       }
 126
 127       case 'P':
 128       {
 129         int status;
 130
 131         status = population_add_peer (population, optarg, /* port = */ NULL);
 132         if (status != 0)
 133         {
 134           fprintf (stderr, "population_add_peer failed with status %i.\n",
 135               status);
 136         }
 137         break;
 138       }
 139
 140       case 's':
 141       {
 142         int tmp = atoi (optarg);
 143         if (tmp > 0)
 144           stats_interval = tmp;
 145         break;
 146       }
 147
 148       case 't':
 149       {
 150         int tmp = atoi (optarg);
 151         if (tmp >= 1)
 152           evolution_threads_num = tmp;
 153         break;
 154       }
 155
 156       case 'h':
 157       default:
 158         exit_usage (argv[0]);
 159     }
 160   }
 161
 162   return (0);
 163 } /* int read_options */
 164
 165 static int rate_network (const sn_network_t *n)
 166 {
 167   int rate;
 168   int i;
 169
 170   rate = SN_NETWORK_STAGE_NUM (n) * SN_NETWORK_INPUT_NUM (n);
 171   for (i = 0; i < SN_NETWORK_STAGE_NUM (n); i++)
 172   {
 173     sn_stage_t *s = SN_NETWORK_STAGE_GET (n, i);
 174     rate += SN_STAGE_COMP_NUM (s);
 175   }
 176
 177   return (rate);
 178 } /* int rate_network */
 179
 180 static int mutate_network (sn_network_t *n)
 181 {
 182   sn_network_t *n_copy;
 183   int stage_index;
 184   sn_stage_t *s;
 185   int comparator_index;
 186   int status;
 187
 188   n_copy = sn_network_clone (n);
 189   if (n_copy == NULL)
 190   {
 191     fprintf (stderr, "mutate_network: sn_network_clone failed.\n");
 192     return (-1);
 193   }
 194
 195   stage_index = sn_bounded_random (0, SN_NETWORK_STAGE_NUM (n_copy) - 1);
 196   s = SN_NETWORK_STAGE_GET (n_copy, stage_index);
 197
 198   comparator_index = sn_bounded_random (0, SN_STAGE_COMP_NUM (s) - 1);
 199   sn_stage_comparator_remove (s, comparator_index);
 200
 201   status = sn_network_brute_force_check (n_copy);
 202
 203   sn_network_destroy (n_copy);
 204
 205   if (status < 0)
 206     return (-1);
 207   else if (status > 0) /* Mutated network does not sort anymore. */
 208     return (1);
 209
 210   /* We saved one comparator \o/ Let's do the same change on the original
 211    * network. */
 212   s = SN_NETWORK_STAGE_GET (n, stage_index);
 213   sn_stage_comparator_remove (s, comparator_index);
 214
 215   return (0);
 216 } /* int mutate_network */
 217
 218 static int create_offspring (void)
 219 {
 220   sn_network_t *p0;
 221   sn_network_t *p1;
 222   sn_network_t *n;
 223
 224   p0 = population_get_random (population);
 225   p1 = population_get_random (population);
 226
 227   assert (p0 != NULL);
 228   assert (p1 != NULL);
 229
 230   /* combine the two parents */
 231   n = sn_network_combine (p0, p1);
 232
 233   sn_network_destroy (p0);
 234   sn_network_destroy (p1);
 235
 236   /* randomly chose an input and do a min- or max-cut. */
 237   while (SN_NETWORK_INPUT_NUM (n) > inputs_num)
 238   {
 239     int pos;
 240     enum sn_network_cut_dir_e dir;
 241
 242     pos = sn_bounded_random (0, SN_NETWORK_INPUT_NUM (n) - 1);
 243     dir = (sn_bounded_random (0, 1) == 0) ? DIR_MIN : DIR_MAX;
 244
 245     assert ((pos >= 0) && (pos < SN_NETWORK_INPUT_NUM (n)));
 246
 247     sn_network_cut_at (n, pos, dir);
 248   }
 249
 250   /* compress the network to get a compact representation */
 251   sn_network_compress (n);
 252
 253   assert (SN_NETWORK_INPUT_NUM (n) == inputs_num);
 254
 255   if ((SN_NETWORK_INPUT_NUM (n) <= 16) && (sn_bounded_random (0, 100) <= 1))
 256     mutate_network (n);
 257
 258   population_insert (population, n);
 259
 260   sn_network_destroy (n);
 261
 262   return (0);
 263 } /* int create_offspring */
 264
 265 static void *evolution_thread (void *arg __attribute__((unused)))
 266 {
 267   while (do_loop == 0)
 268   {
 269     create_offspring ();
 270     /* XXX: Not synchronized! */
 271     iteration_counter++;
 272   }
 273
 274   return ((void *) 0);
 275 } /* int start_evolution */
 276
 277 static int evolution_start (int threads_num)
 278 {
 279   pthread_t threads[threads_num]; /* C99 ftw! */
 280   int i;
 281
 282   for (i = 0; i < threads_num; i++)
 283   {
 284     int status;
 285
 286     status = pthread_create (&threads[i], /* attr = */ NULL,
 287         evolution_thread, /* arg = */ NULL);
 288     if (status != 0)
 289     {
 290       fprintf (stderr, "evolution_start: pthread_create[%i] failed "
 291           "with status %i.\n",
 292           i, status);
 293       threads[i] = 0;
 294     }
 295   }
 296
 297   while (do_loop == 0)
 298   {
 299     int status;
 300
 301     status = sleep (1);
 302     if (status == 0)
 303     {
 304       sn_network_t *n;
 305       int stages_num;
 306       int comparators_num;
 307       int rating;
 308       int iter;
 309
 310       iter = iteration_counter;
 311
 312       n = population_get_fittest (population);
 313
 314       rating = rate_network (n);
 315
 316       stages_num = SN_NETWORK_STAGE_NUM (n);
 317       comparators_num = 0;
 318       for (i = 0; i < stages_num; i++)
 319       {
 320         sn_stage_t *s;
 321
 322         s = SN_NETWORK_STAGE_GET (n, i);
 323         comparators_num += SN_STAGE_COMP_NUM (s);
 324       }
 325
 326       sn_network_destroy (n);
 327
 328       printf ("Best after approximately %i iterations: "
 329           "%i comparators in %i stages. Rating: %i.\n",
 330           iter, comparators_num, stages_num, rating);
 331     }
 332   }
 333
 334   for (i = 0; i < threads_num; i++)
 335   {
 336     if (threads[i] == 0)
 337       continue;
 338     pthread_join (threads[i], /* value_ptr = */ NULL);
 339   }
 340
 341   return (0);
 342 } /* int evolution_start */
 343
 344 int main (int argc, char **argv)
 345 {
 346   struct sigaction sigint_action;
 347   struct sigaction sigterm_action;
 348
 349   population = population_create ((pi_rate_f) rate_network,
 350       (pi_copy_f) sn_network_clone,
 351       (pi_free_f) sn_network_destroy);
 352   if (population == NULL)
 353   {
 354     fprintf (stderr, "population_create failed.\n");
 355     return (1);
 356   }
 357
 358   population_set_serialization (population,
 359       (pi_serialize_f) sn_network_serialize,
 360       (pi_unserialize_f) sn_network_unserialize);
 361
 362   read_options (argc, argv);
 363   if (initial_input_file == NULL)
 364     exit_usage (argv[0]);
 365
 366   memset (&sigint_action, '\0', sizeof (sigint_action));
 367   sigint_action.sa_handler = sigint_handler;
 368   sigaction (SIGINT, &sigint_action, NULL);
 369
 370   memset (&sigterm_action, '\0', sizeof (sigterm_action));
 371   sigterm_action.sa_handler = sigint_handler;
 372   sigaction (SIGTERM, &sigterm_action, NULL);
 373
 374   population_start_listen_thread (population, NULL, NULL);
 375
 376   {
 377     sn_network_t *n;
 378     int tmp;
 379
 380     n = sn_network_read_file (initial_input_file);
 381     if (n == NULL)
 382     {
 383       printf ("n == NULL\n");
 384       return (1);
 385     }
 386
 387     inputs_num = SN_NETWORK_INPUT_NUM(n);
 388
 389     /* Determine if `inputs_num' is a power of two. If so, more merge
 390      * algorithms can be used. */
 391     tmp = inputs_num;
 392     inputs_num_is_power_of_two = 1;
 393     while (tmp > 0)
 394     {
 395       if ((tmp % 2) != 0)
 396       {
 397         if (tmp == 1)
 398           inputs_num_is_power_of_two = 1;
 399         else
 400           inputs_num_is_power_of_two = 0;
 401         break;
 402       }
 403       tmp = tmp >> 1;
 404     }
 405
 406     population_insert (population, n);
 407     sn_network_destroy (n);
 408   }
 409
 410   printf ("Current configuration:\n"
 411       "  Initial network:  %s\n"
 412       "  Number of inputs: %3i\n"
 413       "  Population size:  %3i\n"
 414       "=======================\n",
 415       initial_input_file, inputs_num, max_population_size);
 416
 417   evolution_start (evolution_threads_num);
 418
 419   printf ("Exiting after %llu iterations.\n",
 420       (unsigned long long) iteration_counter);
 421
 422   {
 423     sn_network_t *n;
 424
 425     n = population_get_fittest (population);
 426     if (n != NULL)
 427     {
 428       if (best_output_file != NULL)
 429         sn_network_write_file (n, best_output_file);
 430       sn_network_show (n);
 431       sn_network_destroy (n);
 432     }
 433   }
 434
 435   population_destroy (population);
 436
 437   return (0);
 438 } /* int main */
 439
 440 /* vim: set shiftwidth=2 softtabstop=2 : */