Merge lp:~percona-dev/percona-xtrabackup/exit_codes into lp:percona-xtrabackup/2.0

[Aleksandr Kuzminsky]

use macroses EXIT_SUCCESS and EXIT_FAILURE as exit codes

[Vadim Tkachenko (vadim-tk)]

seem OK

review: Approve

[Baron Schwartz (baron-xaprb)]

In the original code, there were three magic numbers: 0, 1, and -1. There seemed to be an important difference between -1 and 1, but I have not seen an explanation of it. I tried to document my best guess: http://www.percona.com/docs/wiki/percona-xtrabackup:xtrabackup:exit_codes

I am not sure that both 1 and -1 should be replaced with a single exit code. Maybe we need Yasufumi to explain the difference. It might be important for scripting, cron jobs, etc. At least we should document why it was wrong for them to be different.

[Vadim Tkachenko (vadim-tk)]

review: Needs Fixing

[Yasufumi Kinoshita (yasufumi-kinoshita)]

If innobackupex doesn't depend on the code, the change should be OK.

[Vadim Tkachenko (vadim-tk)]

I do not see it used differently in innobackupex

review: Approve

=== modified file 'xtrabackup.c'
--- xtrabackup.c	2010-11-05 07:48:55 +0000
+++ xtrabackup.c	2010-11-09 18:21:09 +0000
@@ -1062,7 +1062,7 @@
     break;
   case '?':
     usage();
-    exit(0);
+    exit(EXIT_SUCCESS);
     break;
   default:
     break;
@@ -1612,7 +1612,7 @@
 	bzero((G_PTR) &mysql_tmpdir_list, sizeof(mysql_tmpdir_list));
 
 	if (init_tmpdir(&mysql_tmpdir_list, opt_mysql_tmpdir))
-		exit(1);
+		exit(EXIT_FAILURE);
 
 	/* dummy for initialize all_charsets[] */
 	get_charset_name(0);
@@ -2908,7 +2908,7 @@
 	if (my_setwd(mysql_real_data_home,MYF(MY_WME)))
 	{
 		fprintf(stderr, "xtrabackup: cannot my_setwd %s\n", mysql_real_data_home);
-		exit(1);
+		exit(EXIT_FAILURE);
 	}
 	fprintf(stderr, "xtrabackup: cd to %s\n", mysql_real_data_home);
 
@@ -2921,7 +2921,7 @@
 
 	/* initialize components */
         if(innodb_init_param())
-                exit(1);
+                exit(EXIT_FAILURE);
 
         if (srv_file_flush_method_str == NULL) {
         	/* These are the default options */
@@ -2968,7 +2968,7 @@
 	  	fprintf(stderr, 
           	"xtrabackup: Unrecognized value %s for innodb_flush_method\n",
           				srv_file_flush_method_str);
-	  	exit(1);
+	  	exit(EXIT_FAILURE);
 	}
 
 #ifndef INNODB_VERSION_SHORT
@@ -3105,13 +3105,13 @@
 "xtrabackup: remove old data files which contain your precious data!\n");
 
 		//return((int) err);
-		exit(1);
+		exit(EXIT_FAILURE);
 	}
 
 	/* create_new_db must not be TRUE.. */
 	if (create_new_db) {
 		fprintf(stderr, "xtrabackup: Something wrong with source files...\n");
-		exit(1);
+		exit(EXIT_FAILURE);
 	}
 
 	for (i = 0; i < srv_n_log_files; i++) {
@@ -3120,7 +3120,7 @@
 		if (err != DB_SUCCESS) {
 
 			//return((int) err);
-			exit(1);
+			exit(EXIT_FAILURE);
 		}
 
 		if (log_file_created) {
@@ -3139,14 +3139,14 @@
 	"xtrabackup: and start the database again.\n");
 
 			//return(DB_ERROR);
-			exit(1);
+			exit(EXIT_FAILURE);
 		}
 	}
 
 	/* log_file_created must not be TRUE, if online */
 	if (log_file_created) {
 		fprintf(stderr, "xtrabackup: Something wrong with source files...\n");
-		exit(1);
+		exit(EXIT_FAILURE);
 	}
 
 	fil_load_single_table_tablespaces();
@@ -3159,7 +3159,7 @@
 	if (!my_stat(xtrabackup_target_dir,&stat_info,MYF(0))
 		&& (my_mkdir(xtrabackup_target_dir,0777,MYF(0)) < 0)){
 		fprintf(stderr,"xtrabackup: Error: cannot mkdir %d: %s\n",my_errno,xtrabackup_target_dir);
-		exit(1);
+		exit(EXIT_FAILURE);
 	}
 
 	} else {
@@ -3204,7 +3204,7 @@
 
 	if (err != DB_SUCCESS) {
 
-		exit(1);
+		exit(EXIT_FAILURE);
 	}
 		
 	log_group_read_checkpoint_info(max_cp_group, max_cp_field);
@@ -3226,7 +3226,7 @@
 
         if (err != DB_SUCCESS) {
 
-                exit(1);
+                exit(EXIT_FAILURE);
         }
 
         log_group_read_checkpoint_info(max_cp_group, max_cp_field);
@@ -3259,7 +3259,7 @@
                         fprintf(stderr,
 "xtrabackup: error: cannot open %s\n",
                                 dst_log_path);
-                        exit(1);
+                        exit(EXIT_FAILURE);
                 }
 
 #ifdef USE_POSIX_FADVISE
@@ -3292,7 +3292,7 @@
 	if (!success) {
 		if (dst_log != -1)
 			os_file_close(dst_log);
-		exit(1);
+		exit(EXIT_FAILURE);
 	}
 
 	/* start flag */
@@ -3311,7 +3311,7 @@
 
 	/* copy log file by current position */
 	if(xtrabackup_copy_logfile(checkpoint_lsn_start, FALSE))
-		exit(1);
+		exit(EXIT_FAILURE);
 
 
 	os_thread_create(log_copying_thread, NULL, &log_copying_thread_id);
@@ -3352,7 +3352,7 @@
 				&& (my_mkdir(path,0777,MYF(0)) < 0)){
 
 				fprintf(stderr,"xtrabackup: Error: cannot mkdir %d: %s\n",my_errno,path);
-				exit(1);
+				exit(EXIT_FAILURE);
 			}
 		}
 
@@ -3365,7 +3365,7 @@
 			if(xtrabackup_copy_datafile(node)) {
 				if(node->space->id == 0) {
 					fprintf(stderr,"xtrabackup: Error: failed to copy system datafile.\n");
-					exit(1);
+					exit(EXIT_FAILURE);
 				} else {
 					printf("xtrabackup: Warining: failed to copy, but continuing.\n");
 				}
@@ -3496,7 +3496,7 @@
 
 	if (!log_copying_succeed) {
 		fprintf(stderr, "xtrabackup: Error: log_copying_thread failed.\n");
-		exit(1);
+		exit(EXIT_FAILURE);
 	}
 
 	if (!xtrabackup_stream)
@@ -3793,7 +3793,7 @@
 	if (my_setwd(mysql_real_data_home,MYF(MY_WME)))
 	{
 		fprintf(stderr, "xtrabackup: cannot my_setwd %s\n", mysql_real_data_home);
-		exit(1);
+		exit(EXIT_FAILURE);
 	}
 	fprintf(stderr, "xtrabackup: cd to %s\n", mysql_real_data_home);
 
@@ -3807,14 +3807,14 @@
 
 	/* initialize components */
 	if(innodb_init_param())
-		exit(1);
+		exit(EXIT_FAILURE);
 
 	fprintf(stderr, "xtrabackup: Starting 'read-only' InnoDB instance to gather index statistics.\n"
 		"xtrabackup: Using %lld bytes for buffer pool (set by --use-memory parameter)\n",
 		xtrabackup_use_memory);
 
 	if(innodb_init())
-		exit(1);
+		exit(EXIT_FAILURE);
 
 	fprintf(stdout, "\n\n<INDEX STATISTICS>\n");
 
@@ -4030,7 +4030,7 @@
 
 	/* shutdown InnoDB */
 	if(innodb_end())
-		exit(1);
+		exit(EXIT_FAILURE);
 }
 
 /* ================= prepare ================= */
@@ -4742,7 +4742,7 @@
 	if (my_setwd(xtrabackup_real_target_dir,MYF(MY_WME)))
 	{
 		fprintf(stderr, "xtrabackup: cannot my_setwd %s\n", xtrabackup_real_target_dir);
-		exit(1);
+		exit(EXIT_FAILURE);
 	}
 	fprintf(stderr, "xtrabackup: cd to %s\n", xtrabackup_real_target_dir);
 
@@ -4771,14 +4771,14 @@
 		if (xtrabackup_incremental) {
 			fprintf(stderr,
 			"xtrabackup: error: applying incremental backup needs target prepared.\n");
-			exit(1);
+			exit(EXIT_FAILURE);
 		}
 skip_check:
 		if (xtrabackup_incremental
 		    && ut_dulint_cmp(metadata_to_lsn, incremental_lsn) < 0) {
 			fprintf(stderr,
 			"xtrabackup: error: This incremental backup seems to be too new for the target.\n");
-			exit(1);
+			exit(EXIT_FAILURE);
 		}
 	}
 
@@ -5123,7 +5123,7 @@
 	os_io_init_simple();
 
 	if(xtrabackup_close_temp_log(TRUE))
-		exit(1);
+		exit(EXIT_FAILURE);
 
 	/* output to metadata file */
 	{
@@ -5166,7 +5166,7 @@
 error:
 	xtrabackup_close_temp_log(FALSE);
 
-	exit(1);
+	exit(EXIT_FAILURE);
 }
 
 /* ================= main =================== */
@@ -5227,7 +5227,7 @@
 		if (!xtrabackup_print_param)
 			usage();
 		printf("\nxtrabackup: Error: Please set parameter 'datadir'\n");
-		exit(-1);
+		exit(EXIT_FAILURE);
 	}
 
 	if (xtrabackup_tables) {
@@ -5284,7 +5284,7 @@
 		fp = fopen(xtrabackup_tables_file,"r");
 		if (!fp) {
 			fprintf(stderr, "xtrabackup: cannot open %s\n", xtrabackup_tables_file);
-			exit(-1);
+			exit(EXIT_FAILURE);
 		}
 		for (;;) {
 			xtrabackup_tables_t*	table;
@@ -5363,7 +5363,7 @@
 		if (error) {
 			fprintf(stderr, "xtrabackup: value '%s' may be wrong format for incremental option.\n",
 				xtrabackup_incremental);
-			exit(-1);
+			exit(EXIT_FAILURE);
 		}
 
 		/* allocate buffer for incremental backup (4096 pages) */
@@ -5378,7 +5378,7 @@
 			fprintf(stderr,
 				"xtrabackup: error: failed to read metadata from %s\n",
 				filename);
-			exit(-1);
+			exit(EXIT_FAILURE);
 		}
 
 		incremental_lsn = metadata_to_lsn;
@@ -5396,7 +5396,7 @@
 			fprintf(stderr,
 				"xtrabackup: error: failed to read metadata from %s\n",
 				filename);
-			exit(-1);
+			exit(EXIT_FAILURE);
 		}
 
 		incremental_lsn = metadata_from_lsn;
@@ -5420,7 +5420,7 @@
 		bzero((G_PTR) &mysql_tmpdir_list, sizeof(mysql_tmpdir_list));
 
 		if (init_tmpdir(&mysql_tmpdir_list, opt_mysql_tmpdir))
-			exit(1);
+			exit(EXIT_FAILURE);
 
 		printf("# This MySQL options file was generated by XtraBackup.\n");
 		printf("[mysqld]\n");
@@ -5434,7 +5434,7 @@
 			innobase_log_group_home_dir ? innobase_log_group_home_dir : mysql_data_home);
 		printf("innodb_log_files_in_group = %ld\n", innobase_log_files_in_group);
 		printf("innodb_log_file_size = %lld\n", innobase_log_file_size);
-		exit(0);
+		exit(EXIT_SUCCESS);
 	}
 
 	if (!xtrabackup_stream) {
@@ -5464,7 +5464,7 @@
 		if (xtrabackup_prepare) num++;
 		if (num != 1) { /* !XOR (for now) */
 			usage();
-			exit(-1);
+			exit(EXIT_FAILURE);
 		}
 	}
 
@@ -5516,5 +5516,5 @@
 		hash_table_free(tables_hash);
 	}
 
-	exit(0);
+	exit(EXIT_SUCCESS);
 }