From d208c9cb79b228fd48d9f7adef432486389e1abe Mon Sep 17 00:00:00 2001 From: Jeongho Hwang Date: Wed, 19 Sep 2012 13:40:18 +0900 Subject: Tizen 2.0 Alpha Signed-off-by: Jeongho Hwang --- doc/Makefile.am | 9 ++ doc/Makefile.in | 363 ++++++++++++++++++++++++++++++++++++++++++++ doc/man-icecc.1.docbook | 59 +++++++ doc/man-iceccd.1.docbook | 216 ++++++++++++++++++++++++++ doc/man-icecream.7.docbook | 312 +++++++++++++++++++++++++++++++++++++ doc/man-scheduler.1.docbook | 161 ++++++++++++++++++++ 6 files changed, 1120 insertions(+) create mode 100644 doc/Makefile.am create mode 100644 doc/Makefile.in create mode 100644 doc/man-icecc.1.docbook create mode 100644 doc/man-iceccd.1.docbook create mode 100644 doc/man-icecream.7.docbook create mode 100644 doc/man-scheduler.1.docbook (limited to 'doc') diff --git a/doc/Makefile.am b/doc/Makefile.am new file mode 100644 index 0000000..bc429d3 --- /dev/null +++ b/doc/Makefile.am @@ -0,0 +1,9 @@ +KDE_LANG = en +KDE_MANS = AUTO + +# This is needed for building with a different --prefix from the rest of KDE +# choose one for your distribution +#KDE_XSL_MAN_STYLESHEET = /usr/share/apps/ksgmltools2/customization/kde-man.xsl +KDE_XSL_MAN_STYLESHEET = /opt/kde3/share/apps/ksgmltools2/customization/kde-man.xsl + +EXTRA_DIST = man-icecc.1.docbook man-iceccd.1.docbook man-icecream.7.docbook man-scheduler.1.docbook diff --git a/doc/Makefile.in b/doc/Makefile.in new file mode 100644 index 0000000..52068b0 --- /dev/null +++ b/doc/Makefile.in @@ -0,0 +1,363 @@ +# Makefile.in generated by automake 1.11.1 from Makefile.am. +# @configure_input@ + +# Copyright (C) 1994, 1995, 1996, 1997, 1998, 1999, 2000, 2001, 2002, +# 2003, 2004, 2005, 2006, 2007, 2008, 2009 Free Software Foundation, +# Inc. +# This Makefile.in is free software; the Free Software Foundation +# gives unlimited permission to copy and/or distribute it, +# with or without modifications, as long as this notice is preserved. + +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY, to the extent permitted by law; without +# even the implied warranty of MERCHANTABILITY or FITNESS FOR A +# PARTICULAR PURPOSE. + +@SET_MAKE@ +VPATH = @srcdir@ +pkgdatadir = $(datadir)/@PACKAGE@ +pkgincludedir = $(includedir)/@PACKAGE@ +pkglibdir = $(libdir)/@PACKAGE@ +pkglibexecdir = $(libexecdir)/@PACKAGE@ +am__cd = CDPATH="$${ZSH_VERSION+.}$(PATH_SEPARATOR)" && cd +install_sh_DATA = $(install_sh) -c -m 644 +install_sh_PROGRAM = $(install_sh) -c +install_sh_SCRIPT = $(install_sh) -c +INSTALL_HEADER = $(INSTALL_DATA) +transform = $(program_transform_name) +NORMAL_INSTALL = : +PRE_INSTALL = : +POST_INSTALL = : +NORMAL_UNINSTALL = : +PRE_UNINSTALL = : +POST_UNINSTALL = : +build_triplet = @build@ +host_triplet = @host@ +subdir = doc +DIST_COMMON = $(srcdir)/Makefile.am $(srcdir)/Makefile.in +ACLOCAL_M4 = $(top_srcdir)/aclocal.m4 +am__aclocal_m4_deps = $(top_srcdir)/configure.in +am__configure_deps = $(am__aclocal_m4_deps) $(CONFIGURE_DEPENDENCIES) \ + $(ACLOCAL_M4) +mkinstalldirs = $(install_sh) -d +CONFIG_HEADER = $(top_builddir)/config.h +CONFIG_CLEAN_FILES = +CONFIG_CLEAN_VPATH_FILES = +SOURCES = +DIST_SOURCES = +DISTFILES = $(DIST_COMMON) $(DIST_SOURCES) $(TEXINFOS) $(EXTRA_DIST) +ACLOCAL = @ACLOCAL@ +AMTAR = @AMTAR@ +AR = @AR@ +AUTOCONF = @AUTOCONF@ +AUTOHEADER = @AUTOHEADER@ +AUTOMAKE = @AUTOMAKE@ +AWK = @AWK@ +CC = @CC@ +CCDEPMODE = @CCDEPMODE@ +CFLAGS = @CFLAGS@ +CPP = @CPP@ +CPPFLAGS = @CPPFLAGS@ +CXX = @CXX@ +CXXCPP = @CXXCPP@ +CXXDEPMODE = @CXXDEPMODE@ +CXXFLAGS = @CXXFLAGS@ +CYGPATH_W = @CYGPATH_W@ +DEFS = @DEFS@ +DEPDIR = @DEPDIR@ +DSYMUTIL = @DSYMUTIL@ +DUMPBIN = @DUMPBIN@ +ECHO_C = @ECHO_C@ +ECHO_N = @ECHO_N@ +ECHO_T = @ECHO_T@ +EGREP = @EGREP@ +EXEEXT = @EXEEXT@ +FGREP = @FGREP@ +GREP = @GREP@ +INSTALL = @INSTALL@ +INSTALL_DATA = @INSTALL_DATA@ +INSTALL_PROGRAM = @INSTALL_PROGRAM@ +INSTALL_SCRIPT = @INSTALL_SCRIPT@ +INSTALL_STRIP_PROGRAM = @INSTALL_STRIP_PROGRAM@ +LD = @LD@ +LDFLAGS = @LDFLAGS@ +LIBOBJS = @LIBOBJS@ +LIBRSYNC = @LIBRSYNC@ +LIBS = @LIBS@ +LIBTOOL = @LIBTOOL@ +LIB_KINFO = @LIB_KINFO@ +LIPO = @LIPO@ +LN_S = @LN_S@ +LTLIBOBJS = @LTLIBOBJS@ +MAKEINFO = @MAKEINFO@ +MKDIR_P = @MKDIR_P@ +NM = @NM@ +NMEDIT = @NMEDIT@ +OBJDUMP = @OBJDUMP@ +OBJEXT = @OBJEXT@ +OTOOL = @OTOOL@ +OTOOL64 = @OTOOL64@ +PACKAGE = @PACKAGE@ +PACKAGE_BUGREPORT = @PACKAGE_BUGREPORT@ +PACKAGE_NAME = @PACKAGE_NAME@ +PACKAGE_STRING = @PACKAGE_STRING@ +PACKAGE_TARNAME = @PACKAGE_TARNAME@ +PACKAGE_URL = @PACKAGE_URL@ +PACKAGE_VERSION = @PACKAGE_VERSION@ +PATH_SEPARATOR = @PATH_SEPARATOR@ +RANLIB = @RANLIB@ +SED = @SED@ +SET_MAKE = @SET_MAKE@ +SHELL = @SHELL@ +STRIP = @STRIP@ +TAR = @TAR@ +VERSION = @VERSION@ +abs_builddir = @abs_builddir@ +abs_srcdir = @abs_srcdir@ +abs_top_builddir = @abs_top_builddir@ +abs_top_srcdir = @abs_top_srcdir@ +ac_ct_CC = @ac_ct_CC@ +ac_ct_CXX = @ac_ct_CXX@ +ac_ct_DUMPBIN = @ac_ct_DUMPBIN@ +am__include = @am__include@ +am__leading_dot = @am__leading_dot@ +am__quote = @am__quote@ +am__tar = @am__tar@ +am__untar = @am__untar@ +bindir = @bindir@ +build = @build@ +build_alias = @build_alias@ +build_cpu = @build_cpu@ +build_os = @build_os@ +build_vendor = @build_vendor@ +builddir = @builddir@ +datadir = @datadir@ +datarootdir = @datarootdir@ +docdir = @docdir@ +dvidir = @dvidir@ +exec_prefix = @exec_prefix@ +host = @host@ +host_alias = @host_alias@ +host_cpu = @host_cpu@ +host_os = @host_os@ +host_vendor = @host_vendor@ +htmldir = @htmldir@ +includedir = @includedir@ +infodir = @infodir@ +install_sh = @install_sh@ +libdir = @libdir@ +libexecdir = @libexecdir@ +localedir = @localedir@ +localstatedir = @localstatedir@ +lt_ECHO = @lt_ECHO@ +mandir = @mandir@ +mkdir_p = @mkdir_p@ +oldincludedir = @oldincludedir@ +pdfdir = @pdfdir@ +prefix = @prefix@ +program_transform_name = @program_transform_name@ +psdir = @psdir@ +sbindir = @sbindir@ +sharedstatedir = @sharedstatedir@ +srcdir = @srcdir@ +sysconfdir = @sysconfdir@ +target_alias = @target_alias@ +top_build_prefix = @top_build_prefix@ +top_builddir = @top_builddir@ +top_srcdir = @top_srcdir@ +KDE_LANG = en +KDE_MANS = AUTO + +# This is needed for building with a different --prefix from the rest of KDE +# choose one for your distribution +#KDE_XSL_MAN_STYLESHEET = /usr/share/apps/ksgmltools2/customization/kde-man.xsl +KDE_XSL_MAN_STYLESHEET = /opt/kde3/share/apps/ksgmltools2/customization/kde-man.xsl +EXTRA_DIST = man-icecc.1.docbook man-iceccd.1.docbook man-icecream.7.docbook man-scheduler.1.docbook +all: all-am + +.SUFFIXES: +$(srcdir)/Makefile.in: $(srcdir)/Makefile.am $(am__configure_deps) + @for dep in $?; do \ + case '$(am__configure_deps)' in \ + *$$dep*) \ + ( cd $(top_builddir) && $(MAKE) $(AM_MAKEFLAGS) am--refresh ) \ + && { if test -f $@; then exit 0; else break; fi; }; \ + exit 1;; \ + esac; \ + done; \ + echo ' cd $(top_srcdir) && $(AUTOMAKE) --foreign doc/Makefile'; \ + $(am__cd) $(top_srcdir) && \ + $(AUTOMAKE) --foreign doc/Makefile +.PRECIOUS: Makefile +Makefile: $(srcdir)/Makefile.in $(top_builddir)/config.status + @case '$?' in \ + *config.status*) \ + cd $(top_builddir) && $(MAKE) $(AM_MAKEFLAGS) am--refresh;; \ + *) \ + echo ' cd $(top_builddir) && $(SHELL) ./config.status $(subdir)/$@ $(am__depfiles_maybe)'; \ + cd $(top_builddir) && $(SHELL) ./config.status $(subdir)/$@ $(am__depfiles_maybe);; \ + esac; + +$(top_builddir)/config.status: $(top_srcdir)/configure $(CONFIG_STATUS_DEPENDENCIES) + cd $(top_builddir) && $(MAKE) $(AM_MAKEFLAGS) am--refresh + +$(top_srcdir)/configure: $(am__configure_deps) + cd $(top_builddir) && $(MAKE) $(AM_MAKEFLAGS) am--refresh +$(ACLOCAL_M4): $(am__aclocal_m4_deps) + cd $(top_builddir) && $(MAKE) $(AM_MAKEFLAGS) am--refresh +$(am__aclocal_m4_deps): + +mostlyclean-libtool: + -rm -f *.lo + +clean-libtool: + -rm -rf .libs _libs +tags: TAGS +TAGS: + +ctags: CTAGS +CTAGS: + + +distdir: $(DISTFILES) + @srcdirstrip=`echo "$(srcdir)" | sed 's/[].[^$$\\*]/\\\\&/g'`; \ + topsrcdirstrip=`echo "$(top_srcdir)" | sed 's/[].[^$$\\*]/\\\\&/g'`; \ + list='$(DISTFILES)'; \ + dist_files=`for file in $$list; do echo $$file; done | \ + sed -e "s|^$$srcdirstrip/||;t" \ + -e "s|^$$topsrcdirstrip/|$(top_builddir)/|;t"`; \ + case $$dist_files in \ + */*) $(MKDIR_P) `echo "$$dist_files" | \ + sed '/\//!d;s|^|$(distdir)/|;s,/[^/]*$$,,' | \ + sort -u` ;; \ + esac; \ + for file in $$dist_files; do \ + if test -f $$file || test -d $$file; then d=.; else d=$(srcdir); fi; \ + if test -d $$d/$$file; then \ + dir=`echo "/$$file" | sed -e 's,/[^/]*$$,,'`; \ + if test -d "$(distdir)/$$file"; then \ + find "$(distdir)/$$file" -type d ! -perm -700 -exec chmod u+rwx {} \;; \ + fi; \ + if test -d $(srcdir)/$$file && test $$d != $(srcdir); then \ + cp -fpR $(srcdir)/$$file "$(distdir)$$dir" || exit 1; \ + find "$(distdir)/$$file" -type d ! -perm -700 -exec chmod u+rwx {} \;; \ + fi; \ + cp -fpR $$d/$$file "$(distdir)$$dir" || exit 1; \ + else \ + test -f "$(distdir)/$$file" \ + || cp -p $$d/$$file "$(distdir)/$$file" \ + || exit 1; \ + fi; \ + done +check-am: all-am +check: check-am +all-am: Makefile +installdirs: +install: install-am +install-exec: install-exec-am +install-data: install-data-am +uninstall: uninstall-am + +install-am: all-am + @$(MAKE) $(AM_MAKEFLAGS) install-exec-am install-data-am + +installcheck: installcheck-am +install-strip: + $(MAKE) $(AM_MAKEFLAGS) INSTALL_PROGRAM="$(INSTALL_STRIP_PROGRAM)" \ + install_sh_PROGRAM="$(INSTALL_STRIP_PROGRAM)" INSTALL_STRIP_FLAG=-s \ + `test -z '$(STRIP)' || \ + echo "INSTALL_PROGRAM_ENV=STRIPPROG='$(STRIP)'"` install +mostlyclean-generic: + +clean-generic: + +distclean-generic: + -test -z "$(CONFIG_CLEAN_FILES)" || rm -f $(CONFIG_CLEAN_FILES) + -test . = "$(srcdir)" || test -z "$(CONFIG_CLEAN_VPATH_FILES)" || rm -f $(CONFIG_CLEAN_VPATH_FILES) + +maintainer-clean-generic: + @echo "This command is intended for maintainers to use" + @echo "it deletes files that may require special tools to rebuild." +clean: clean-am + +clean-am: clean-generic clean-libtool mostlyclean-am + +distclean: distclean-am + -rm -f Makefile +distclean-am: clean-am distclean-generic + +dvi: dvi-am + +dvi-am: + +html: html-am + +html-am: + +info: info-am + +info-am: + +install-data-am: + +install-dvi: install-dvi-am + +install-dvi-am: + +install-exec-am: + +install-html: install-html-am + +install-html-am: + +install-info: install-info-am + +install-info-am: + +install-man: + +install-pdf: install-pdf-am + +install-pdf-am: + +install-ps: install-ps-am + +install-ps-am: + +installcheck-am: + +maintainer-clean: maintainer-clean-am + -rm -f Makefile +maintainer-clean-am: distclean-am maintainer-clean-generic + +mostlyclean: mostlyclean-am + +mostlyclean-am: mostlyclean-generic mostlyclean-libtool + +pdf: pdf-am + +pdf-am: + +ps: ps-am + +ps-am: + +uninstall-am: + +.MAKE: install-am install-strip + +.PHONY: all all-am check check-am clean clean-generic clean-libtool \ + distclean distclean-generic distclean-libtool distdir dvi \ + dvi-am html html-am info info-am install install-am \ + install-data install-data-am install-dvi install-dvi-am \ + install-exec install-exec-am install-html install-html-am \ + install-info install-info-am install-man install-pdf \ + install-pdf-am install-ps install-ps-am install-strip \ + installcheck installcheck-am installdirs maintainer-clean \ + maintainer-clean-generic mostlyclean mostlyclean-generic \ + mostlyclean-libtool pdf pdf-am ps ps-am uninstall uninstall-am + + +# Tell versions [3.59,3.63) of GNU make to not export all variables. +# Otherwise a system limit (for SysV at least) may be exceeded. +.NOEXPORT: diff --git a/doc/man-icecc.1.docbook b/doc/man-icecc.1.docbook new file mode 100644 index 0000000..1e4b3ff --- /dev/null +++ b/doc/man-icecc.1.docbook @@ -0,0 +1,59 @@ + + + +]> + + + + Icecream User's Manual + + + Cornelius + Schumacher + + + April 21th, 2005 + Icecream + + + + Icecream compiler + 1 + + + + icecc + Icecream compiler stub + + + + +icecc + + + +-o OBJECT +-c SOURCE + + + + +Description +icecc is the Icecream compiler stub. It gets called in place of the actual +compiler and transparently routes the compile requests to the Icecream +network. You shouldn't call icecc directly, but place the specific compiler +stubs in your path: +export PATH=/opt/icecream/bin:$PATH. + + + +See Also +icecream, scheduler, iceccd, icemon + + + +Author +Cornelius Schumacher + + diff --git a/doc/man-iceccd.1.docbook b/doc/man-iceccd.1.docbook new file mode 100644 index 0000000..7ce2bdc --- /dev/null +++ b/doc/man-iceccd.1.docbook @@ -0,0 +1,216 @@ + + + +]> + + + + Icecream User's Manual + + + Cornelius + Schumacher + + + April 21th, 2005 + Icecream + + + + Icecream Daemon + 1 + + + + iceccd + Icecream daemon + + + + +iceccd + + + + + + + + + + + + + + + + + + + + + + + + + + + + -vvv + + + + + + + + + + + + + + + + + + + + nobodyuid + + + + + + + + + + + +Description +The Icecream daemon has to run on all nodes being part of the Icecream +compile cluster. It receives compile jobs and executes them in a chroot +environment. The compile clients send their compile environment the first time +they send a job to a particular daemon, so that the environment of the daemon +doesn't have to match the one of the client. + +The daemon also has to run on clients sending compile jobs to the Icecream +network. If a node should be able to send compile jobs, but never receive any, +start the daemon with the option -m 0. + +All Icecream daemons need to have contact to the Icecream scheduler which +controls the distribution of data between compile nodes. Normally the daemon +will automatically find the right scheduler. If this is not the case you can +explicitly specify the name of the Icecream network and the host running the +scheduler. + + + + +Options + + + + + netname +The name of the icecream network the daemon should connect to. +There has to be a scheduler running for the network under the same network +name. + + + + max_processes +Maximum number of compile jobs started in parallel on machine +running the daemon. + + + + +Prevents jobs from other nodes being scheduled on this one. + + + + + + + + + +, + +Detach daemon from shell. + + + + logfile +Name of file where log output is written to. + + + + scheduler_host +Name of host running the scheduler for the network the daemon +should connect to. This option might help if the scheduler can't broadcast its +presence to the clients due to firewall settings or similar +reasons. + + + +, , +Control verbosity of daemon. The more v the more +verbose. + + + + +, + +Force running the daemon with user rights. Usually you will need +to run the daemon with root rights. + + + + env_basedir +Base directory for storing compile environments sent to the +daemon by the compile clients. + + + + +, +nobodyuid + +Id of user nobody. This user id is used when the daemon is +dropping privileges. + + + + + +MB + +Maximum size in Mega Bytes of cache used to store compile +environments of compile clients. + + + + hostname +The name of the icecream host on the network. + + + + + + + +See Also +icecream, scheduler, iceccd, icemon + + + +Author +Cornelius Schumacher + + + diff --git a/doc/man-icecream.7.docbook b/doc/man-icecream.7.docbook new file mode 100644 index 0000000..759961d --- /dev/null +++ b/doc/man-icecream.7.docbook @@ -0,0 +1,312 @@ + + + +]> + + + + Icecream User's Manual + + + Cornelius + Schumacher + + + April 21th, 2005 + Icecream + + + + Icecream + 7 + + + + Icecream + A distributed compile system + + + +Description + +Icecream is a distributed compile system for C and C++. + +Icecream is created by SUSE and is based on ideas and code by distcc. Like +distcc it takes compile jobs from your (KDE) build and distributes it to remote +machines allowing a parallel build on several machines you've got. But unlike +distcc Icecream uses a central server that schedules the compile jobs to the +fastest free server and is as this dynamic. This advantage pays off mostly for +shared computers, if you're the only user on x machines, you have full control +over them anyway. + + + + +How to use icecream + +You need: + + + One machine that runs the scheduler ("./scheduler -d") + + + Many machines that run the daemon ("./iceccd -d") + + + +If you want to compile using icecream, make sure $prefix/bin is the first +first entry in your path, e.g. type +export PATH=/opt/icecream/bin:$PATH +(Hint: put this in ~/.bashrc or /etc/profile to not have to type it in +everytime) + + +Then you just compile with make -j <num>, where +<num> is the amount of jobs you want to compile in parallel. Don't +exaggerate. Numbers greater than 15 normally cause trouble. + +WARNING: Never use icecream in untrusted environments. Run the deamons and +the scheduler as unpriviliged user in such networks if you have to! But you will +have to rely on homogeneous networks then (see below). + +If you want funny stats, you might want to run "icemon". + + + +Using icecream in heterogeneous environments + +If you are running icecream daemons (note: they _all_ must be running as +root. In the future icecream might gain the ability to know when machines can't +accept a different env, but for now it is all or nothing ) in the same icecream +network but on machines with incompatible compiler versions you have to tell +icecream which environment you are using. Use icecc --build-native to +create an archive file containing all the files necessary to setup the compiler +environment. The file will have a random unique name like +"ddaea39ca1a7c88522b185eca04da2d8.tar.bz2" per default. Rename it to something +more expressive for your convenience, e.g. "i386-3.3.1.tar.bz2". Set +ICECC_VERSION=<filename_of_archive_containing_your_environment> +in the shell environment where you start the compile jobs and the file will be +transfered to the daemons where your compile jobs run and installed to a chroot +environment for executing the compile jobs in the environment fitting to the +environment of the client. This requires that the icecream deamon runs as root. + + +If you do not set ICECC_VERSION, the client will use a tar ball provided +by the daemon running on the same machine. So you can always be sure you're not +tricked by incompatible gcc versions - and you can share your computer with +users of other distributions (or different versions of your beloved SUSE +Linux :) + + + +Cross-Compiling using icecream + +SUSE got quite some good machines not having a processor from Intel or +AMD, so icecream is pretty good in using cross-compiler environments similiar +to the above way of spreading compilers. There the ICECC_VERSION varaible looks +like <native_filename>(,<platform>:<cross_compiler_filename>)*, +for example like this: +/work/9.1-i386.tar.bz2,ia64:/work/9.1-cross-ia64.tar.bz2 + + +How to package such a cross compiler is pretty straightforward if you look +what's inside the tarballs generated by icecc --build-native. + + + + +Cross-Compiling for embedded targets using icecream + +When building for embedded targets like ARM often you'll have a toolchain +that runs on your host and produces code for the target. In these situations you +can exploit the power of icecream as well. + +Create symlinks from where icecc is to the name of your cross compilers +(e.g. arm-linux-g++ and arm-linux-gcc), make sure that these symlinks are in the +path and before the path of your toolchain, with $ICECC_CC +and $ICECC_CXX you need to tell icecream which compilers to +use for preprocessing and local compiling. e.g. set it to +ICECC_CC=arm-linux-gcc and +ICECC_CXX=arm-linux-g++. + +As the next step you need to create a .tar.bz2 of your cross compiler, +check the result of build-native to see what needs to be present. + +Finally one needs to set ICECC_VERSION and point it to +the tar.bz2 you've created. When you start compiling your toolchain will be +used. + +NOTE: with ICECC_VERSION you point out on which +platforms your toolchain runs, you do not indicate for which target code will be +generated. + + + + +How to combine icecream with ccache + +The easiest way to use ccache with icecream is putting the symlink +masquerades into /opt/icream/bin and putting small wrapper scripts in +/opt/ccache/bin + + + cat /opt/ccache/bin/g++: + + #! /bin/sh + + export CCACHE_PATH=/opt/icecream/bin + export PATH=/opt/icecream/bin:/usr/bin:$PATH + ccache g++ "$@" + + + +Then you can replace /opt/icecream/bin with /opt/ccache/bin in your +$PATH and all icecream calls will go through ccache (and Qt +will compile in 62s :) + +Note however that ccache isn't really worth the trouble if you're not +recompiling your KDE three times a day from scratch (it adds quite some overhead +in comparing the preprocessor output and uses quite some disc space and I found +a cache hit of 18% a bit too few, so I disabled it again). + + + + +Debug output + +You can use the environment variable ICECC_DEBUG to +control if icecream gives debug output or not. Set it to +debug to get debug output. The other possible values are +error, warning and info +(the -v option for daemon and scheduler raise the level per -v on the command +line - so use -vvv for full debug). + + + + +Some Numbers + + +Numbers of my test case (some STL C++ genetic algorithm) + + + g++ on my machine: 1.6s + + + g++ on fast machine: 1.1s + + + icecream using my machine as remote machine: 1.9s + + + icecream using fast machine: 1.8s + + + + +The icecream overhead is quite huge as you might notice, but the compiler +can't interleave preprocessing with compilation and the file needs to be +read/written once more and in between the file is transfered. + +But even if the other computer is faster, using g++ on my local machine +is faster. If you're (for whatever reason) alone in your network at some point, +you loose all advantages of distributed compiling and only add the overhead. So +icecream got a special case for local compilations (the same special meaning +that localhost got within $DISTCC_HOSTS). This makes compiling on my machine +using icecream down to 1.7s (the overhead is actually less than 0.1s in +average). + +As the scheduler is aware of that meaning, it will prefer your own +computer if it's free and got not less than 70% of the fastest available +computer. + +Keep in mind, that this affects only the first compile job, the second one +is distributed anyway. So if I had to compile two of my files, I would get + + + g++ -j1 on my machine: 3.2s + + + g++ -j1 on the fast machine: 2.2s + + + using icecream -j2 on my machine: max(1.7,1.8)=1.8s + + + (using icecream -j2 on the other machine: max(1.1,1.8)=1.8s) + + + + +The math is a bit tricky and depends a lot on the current state of the +compilation network, but make sure you're not blindly assuming make -j2 halfs +your compilation time. + + + + +What is the best environment for icecream + +In most requirements icecream isn't special, e.g. it doesn't matter what +distributed compile system you use, you won't have fun if your nodes are +connected through than less or equal to 10MBit. Note that icecream compresses +input and output files (using lzo), so you can calc with ~1MBit per compile job +- i.e more than make -j10 won't be possible without delays. + +Remember that more machines are only good if you can use massive +parallelization, but you will for sure get the best result if your submitting +machine (the one you called g++ on) will be fast enough to feed the others. +Especially if your project consists of many easy to compile files, the +preprocessing and file IO will be job enough to need a quick machine. + +The scheduler will try to give you the fastest machines available, so even +if you add old machines, they will be used only in exceptional situations, but +still you can have bad luck - the scheduler doesn't know how long a job will +take before it started. So if you have 3 machines and two quick to compile and +one long to compile source file, you're not safe from a choice where everyone +has to wait on the slow machine. Keep that in mind. + + + + +Network setup for Icecream (firewalls) + +A short overview of the ports icecream requires: + + + TCP/10245 on the daemon computers (required) + + + TCP/8765 for the the scheduler computer (required) + + + TCP/8766 for the telnet interface to the scheduler (optional) + + + UDP/8765 for broadcast to find the scheduler (optional) + + + + +Note that the SuSEfirewall2 on SUSE < 9.1 got some problems +configuring broadcast. So you might need the -s option for the daemon +in any case there. If the monitor can't find the scheduler, use +USE_SCHEDULER=<host> icemon (or send me a patch :) + + + + + +See Also +icecream, scheduler, iceccd, icemon + + + +Icecream Authors +Stephan Kulow <coolo@suse.de> +Michael Matz <matz@suse.de> +Cornelius Schumacher <cschum@suse.de> +...and various other contributors. + + diff --git a/doc/man-scheduler.1.docbook b/doc/man-scheduler.1.docbook new file mode 100644 index 0000000..6109a18 --- /dev/null +++ b/doc/man-scheduler.1.docbook @@ -0,0 +1,161 @@ + + + +]> + + + + Icecream User's Manual + + + Cornelius + Schumacher + + + April 21th, 2005 + Icecream + + + + Icecream + 1 + + + + scheduler + Icecream scheduler + + + + +scheduler + + + + + + + + name + + + + + + + + + port + + + + + + + + + + + + + + + + + file + + + + + + + + + + + + + + + + + + + -vvv + + + + + +Description +The Icecream scheduler is the central instance of an Icecream compile +network. It distributes the compile jobs and provides the data for the +monitors. + + + +Options + + + + +, +netname +The name of the Icecream network the scheduler +controls. + + + +, +port +IP port the scheduler uses. + + + +, +Print help message. + + + +, +logfile +Name of file where log output is written to. + + + + +, + +Detach daemon from shell. + + + +, , +Control verbosity of daemon. The more v the more +verbose. + + + + +, + +Force running the scheduler with user rights. Usually you will +need to run the scheduler with root rights. + + + + + + + + +See Also +icecream, scheduler, iceccd, icemon + + + +Author +Cornelius Schumacher + + -- cgit v1.2.3