Attachment #264799 for bug #501740

Some Eclipse Foundation services are deprecated, or will be soon. Please ensure you've read this important communication.




 *   Yann Tanguy (CEA) - 350402
 *   Christian W. Damus (CEA) - 392833, 251963, 405061, 409396, 176998, 180744, 403374, 416833, 420338, 405065, 431342
 *   E.D.Willink - 420338
 *   Christian W. Damus - 444588, 497359, 501740
 *
 */
package org.eclipse.uml2.uml.util;

	private static class OperationContext {

		/**
		 * The default context is the root and is always present, providing the
		 * default behaviour of calculating results and cacheing them in the
		 * {@link CacheAdapter}.  Thus, the cache may be purged more agressively
		 * than is needed, but not often when simply inspecting a model.
		 */
		private static final OperationContext DEFAULT = new OperationContext() {
			@Override
			NamedElement getTarget(ENamedElement definition) {
				NamedElement result = null;
				@SuppressWarnings("unchecked")
				Map<ENamedElement, NamedElement> cache = (Map<ENamedElement, NamedElement>)CacheAdapter.getInstance().get(null, this);
				if (cache != null) {
					result = cache.get(definition);
				}
				return result;
			}

			@Override
			void cacheNamedElement(ENamedElement definition, NamedElement target) {
				CacheAdapter adapter = CacheAdapter.getInstance();
				@SuppressWarnings("unchecked")
				Map<ENamedElement, NamedElement> cache = (Map<ENamedElement, NamedElement>)adapter.get(null, this);
				if (cache == null) {
					cache = new HashMap<ENamedElement, NamedElement>();
					adapter.put(null, this, cache);
				}
				cache.put(definition, target);
			}
		};

		/** The current thread's active context (always at least the {@link #DEFAULT}). */
		private static final ThreadLocal<OperationContext> context = new ThreadLocal<OperationContext>() {
			@Override
			protected OperationContext initialValue() {
				return DEFAULT;
			}
		};





		});
	}

	/**
	 * Verify that even just accessing stereotype applications is improved
	 * within in a profile operation context.
	 */
	public void testGetStereotypeApplications() {
		runProfileOperationExperiment("get stereotypes", 9, new Runnable() {
			
			public void run() {
				walkAllStereotypeApplications(fixture);
			}
		});
	}

	//
	// Test framework
	//




/*
 * Copyright (c) 2016 Christian W. Damus and others.
 * 
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 *   Christian W. Damus - initial API and implementation
 *
 */
package org.eclipse.uml2.uml.bug.tests;

import java.util.List;

import org.eclipse.emf.common.util.URI;
import org.eclipse.emf.ecore.EClass;
import org.eclipse.emf.ecore.EObject;
import org.eclipse.emf.ecore.resource.Resource;
import org.eclipse.emf.ecore.resource.ResourceSet;
import org.eclipse.emf.ecore.resource.impl.ResourceSetImpl;
import org.eclipse.uml2.common.util.CacheAdapter;
import org.eclipse.uml2.common.util.UML2Util;
import org.eclipse.uml2.uml.Artifact;
import org.eclipse.uml2.uml.Class;
import org.eclipse.uml2.uml.Element;
import org.eclipse.uml2.uml.Package;
import org.eclipse.uml2.uml.PackageableElement;
import org.eclipse.uml2.uml.Profile;
import org.eclipse.uml2.uml.Stereotype;
import org.eclipse.uml2.uml.UMLFactory;
import org.eclipse.uml2.uml.UMLPackage;
import org.eclipse.uml2.uml.profile.standard.StandardPackage;
import org.eclipse.uml2.uml.resource.UMLResource;
import org.eclipse.uml2.uml.tests.util.StandaloneSupport;
import org.eclipse.uml2.uml.tests.util.Stopwatch;
import org.eclipse.uml2.uml.util.UMLUtil.StereotypeApplicationHelper;

import junit.framework.Test;
import junit.framework.TestCase;
import junit.framework.TestSuite;

/**
 * Tests the performance of operations on stereotype applications from static
 * profiles.
 * 
 * @see https://bugs.eclipse.org/bugs/show_bug.cgi?id=501740
 */
public class Bug501740Test
		extends TestCase {

	private static final int ITERATIONS = 10;

	private ResourceSet rset;

	private Package fixture;

	public Bug501740Test() {
		super();
	}

	public Bug501740Test(String name) {
		super(name);
	}

	public static Test suite() {
		return new TestSuite(Bug501740Test.class, "Bug 501740 tests"); //$NON-NLS-1$
	}

	public void testCreatingManyStereotypedElements() {
		Stopwatch watch = new Stopwatch();

		for (int i = 0; i < ITERATIONS; i++) {
			watch.start();
			createManyStereotypedElements();
			watch.end();

			// Clean up
			nextIteration();
		}

		watch.log("Creation");
	}

	private void createManyStereotypedElements() {
		for (int i = 0; i < 500; i++) {
			Class class_ = fixture.createOwnedClass(null, false);
			applyStereotype(class_, StandardPackage.Literals.AUXILIARY);

			Artifact artifact = (Artifact) fixture.createPackagedElement(null,
				UMLPackage.Literals.ARTIFACT);
			applyStereotype(artifact, StandardPackage.Literals.EXECUTABLE);

			Package nested = fixture.createNestedPackage(null);
			applyStereotype(nested, StandardPackage.Literals.MODEL_LIBRARY);
		}
	}

	public void testReadingManyStereotypedElements() {
		Stopwatch watch = new Stopwatch();

		// Create a bunch of elements to read
		createManyStereotypedElements();

		for (int i = 0; i < ITERATIONS; i++) {
			watch.start();
			readManyStereotypedElements();
			watch.end();

			// Clean up
			CacheAdapter.getCacheAdapter(fixture).clear();
		}

		watch.log("Reading");
	}

	private void readManyStereotypedElements() {
		for (PackageableElement next : fixture.getPackagedElements()) {
			List<Stereotype> stereos = next.getAppliedStereotypes();
			assertTrue(stereos.size() == 1);
			assertEquals("StandardProfile",
				stereos.get(0).getProfile().getName());
		}
	}

	//
	// Test framework
	//

	@Override
	protected void setUp()
			throws Exception {

		rset = new ResourceSetImpl();
		if (StandaloneSupport.isStandalone()) {
			StandaloneSupport.init(rset);
		}

		fixture = getTestModel();
	}

	@Override
	protected void tearDown()
			throws Exception {

		fixture = null;

		// clean up the CacheAdapter as well as we can
		for (Resource next : rset.getResources()) {
			next.unload();
			next.eAdapters().clear();
		}

		rset.getResources().clear();
		rset.eAdapters().clear();
	}

	void nextIteration() {
		try {
			tearDown();
			setUp();
		} catch (Exception e) {
			e.printStackTrace();
			fail("Failed to reset for next iteration: " + e.getMessage());
		}
	}

	Package getTestModel() {
		// Just create a small model locally
		Resource resource = UMLResource.Factory.INSTANCE
			.createResource(URI.createURI("test:bug501740"));
		Package result = UMLFactory.eINSTANCE.createPackage();
		result.setName("bug501740");
		resource.getContents().add(result);
		rset.getResources().add(resource);

		// Apply the standard profile, which is statically generated
		Profile std = UML2Util.load(rset,
			URI.createURI(UMLResource.STANDARD_PROFILE_URI),
			UMLPackage.Literals.PROFILE);
		result.applyProfile(std);

		// Apply a stereotype to the package
		applyStereotype(result, StandardPackage.Literals.MODEL_LIBRARY);

		return result;
	}

	protected static EObject applyStereotype(Element element,
			EClass definition) {
		return StereotypeApplicationHelper.getInstance(element)
			.applyStereotype(element, definition);
	}

}

Lines 10-16 Link Here

(-)a/tests/org.eclipse.uml2.uml.tests/src/org/eclipse/uml2/uml/bug/tests/UMLBugTests.java (-1 / +2 lines)
10	* Christian W. Damus (CEA) - 409396, 403365, 300957, 405061, 401682, 176998, 180744, 403374, 420338, 405065, 332057, 431342, 433149, 437977	10	* Christian W. Damus (CEA) - 409396, 403365, 300957, 405061, 401682, 176998, 180744, 403374, 420338, 405065, 332057, 431342, 433149, 437977
11	* Manuel Bork <bork@yatta.de> (Yatta Solutions GmbH) - 421756, 422000	11	* Manuel Bork <bork@yatta.de> (Yatta Solutions GmbH) - 421756, 422000
12	* Kenn Hussey (CEA) - 424895	12	* Kenn Hussey (CEA) - 424895
13	* Christian W. Damus - 444588, 497359	13	* Christian W. Damus - 444588, 497359, 501740
14	*	14	*
15	*/	15	*/
16	package org.eclipse.uml2.uml.bug.tests;	16	package org.eclipse.uml2.uml.bug.tests;
Lines 63-68 Link Here
63	result.addTest(Bug444588StereotypesTest.suite());	63	result.addTest(Bug444588StereotypesTest.suite());
64	result.addTest(Bug444588ProfilesTest.suite());	64	result.addTest(Bug444588ProfilesTest.suite());
65	result.addTest(Bug497359Test.suite());	65	result.addTest(Bug497359Test.suite());
		66	result.addTest(Bug501740Test.suite());
66		67
67	// keep this one at the end because it runs long	68	// keep this one at the end because it runs long
68	result.addTest(Bug332057Test.suite());	69	result.addTest(Bug332057Test.suite());




/*
 * Copyright (c) 2016 Christian W. Damus and others.
 * All rights reserved.   This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 *   Christian W. Damus - initial API and implementation
 *
 */
package org.eclipse.uml2.uml.tests.util;

/**
 * A convenience for timing of executions in tests.
 */
public class Stopwatch {

	// The size of a sample large enough to exclude outliers
	private static final int LARGE_SAMPLE = 10;

	private long startMillis;

	private long[] samples;

	private int iterations;

	private int minSampleIdx;

	private int maxSampleIdx;

	private double averageMillis;

	private double stdevMillis;

	public Stopwatch() {
		super();
	}

	/**
	 * Reset all statistics.
	 */
	public void reset() {
		startMillis = 0L;
		iterations = 0;
		averageMillis = 0.0;
		stdevMillis = 0.0;
		samples = null;
		minSampleIdx = 0;
		maxSampleIdx = 0;
	}

	/**
	 * Start timing an iteration.
	 */
	public void start() {
		startMillis = System.currentTimeMillis();
	}

	/**
	 * Finish timing an iteration and recompute statistics.
	 */
	public void end() {
		long endMillis = System.currentTimeMillis();

		// Record the new sample
		int index = iterations;
		iterations = index + 1;
		long sample = endMillis - startMillis;
		samples = grow(samples, iterations);
		samples[iterations - 1] = sample;

		// Recompute stats

		if (samples[index] < samples[minSampleIdx]) {
			minSampleIdx = index;
		}
		if (samples[index] > samples[maxSampleIdx]) {
			maxSampleIdx = index;
		}
		averageMillis = sample;
		stdevMillis = 0.0;

		if (iterations > 1) {
			// We have some stats to compute
			double sum = 0.0;

			// If we have more than a few samples, then we toss
			// the high and low outliers
			int sampleSize = sampleSize();

			// Compute the sum of samples
			for (int i = 0; i < iterations; i++) {
				if (!isOutlier(i)) {
					sum = sum + samples[i];
				}
			}

			averageMillis = sum / sampleSize;

			// And a standard deviation
			double sumDevSq = 0.0;
			for (int i = 0; i < iterations; i++) {
				if (!isOutlier(i)) {
					double dev = samples[i] - averageMillis;
					sumDevSq = sumDevSq + (dev * dev);
				}
			}
			stdevMillis = Math.sqrt(sumDevSq / (sampleSize - 1));
		}
	}

	private int sampleSize() {
		return (iterations >= LARGE_SAMPLE)
			? iterations - 2
			: iterations;
	}

	private boolean isOutlier(int sampleIndex) {
		return (iterations >= LARGE_SAMPLE)
			&& ((sampleIndex == minSampleIdx) || (sampleIndex == maxSampleIdx));
	}

	/**
	 * How many iterations have we timed?
	 * 
	 * @return the number of iterations
	 */
	public int iterations() {
		return iterations;
	}

	/**
	 * What is the average timing of an iteration?
	 * 
	 * @return the average iteration
	 */
	public double averageMillis() {
		return averageMillis;
	}

	/**
	 * What is the sample standard deviation of the timings of all iterations?
	 * 
	 * @return the iteration sample standard deviation
	 */
	public double stdevMillis() {
		return stdevMillis;
	}

	public void log(String message) {
		if (message != null) {
			System.out.printf("%s: ", message);
		}
		System.out.printf("%3.2f ms (σ = %01.3f ms) on %d iterations%n",
			averageMillis(), stdevMillis(), iterations());
	}

	private long[] grow(long[] array, int minCapacity) {
		long[] result;

		if (array == null) {
			result = new long[Math.max(minCapacity, 10)];
		} else if (array.length >= minCapacity) {
			result = array;
		} else {
			result = new long[Math.max(minCapacity, 10) * 5 / 3];
			System.arraycopy(array, 0, result, 0, array.length);
		}

		return result;
	}
}

Return to bug 501740

Lines 14-20 Link Here

(-)a/plugins/org.eclipse.uml2.uml/src/org/eclipse/uml2/uml/util/UMLUtil.java (-14 / +23 lines)
14	* Yann Tanguy (CEA) - 350402	14	* Yann Tanguy (CEA) - 350402
15	* Christian W. Damus (CEA) - 392833, 251963, 405061, 409396, 176998, 180744, 403374, 416833, 420338, 405065, 431342	15	* Christian W. Damus (CEA) - 392833, 251963, 405061, 409396, 176998, 180744, 403374, 416833, 420338, 405065, 431342
16	* E.D.Willink - 420338	16	* E.D.Willink - 420338
17	* Christian W. Damus - 444588, 497359	17	* Christian W. Damus - 444588, 497359, 501740
18	*	18	*
19	*/	19	*/
20	package org.eclipse.uml2.uml.util;	20	package org.eclipse.uml2.uml.util;
Lines 11873-11904 Link Here
11873	private static class OperationContext {	11873	private static class OperationContext {
11874		11874
11875	/**	11875	/**
11876	* The null context is the root and is always present, providing the	11876	* The default context is the root and is always present, providing the
11877	* default behaviour of just always calculating the results required	11877	* default behaviour of calculating results and cacheing them in the
11878	* by the client.	11878	* {@link CacheAdapter}. Thus, the cache may be purged more agressively
		11879	* than is needed, but not often when simply inspecting a model.
11879	*/	11880	*/
11880	private static final OperationContext NULL = new OperationContext() {	11881	private static final OperationContext DEFAULT = new OperationContext() {
11881	@Override	11882	@Override
11882	NamedElement getTarget(ENamedElement definition) {	11883	NamedElement getTarget(ENamedElement definition) {
11883	return null;	11884	NamedElement result = null;
11884	}	11885	@SuppressWarnings("unchecked")
11885		11886	Map<ENamedElement, NamedElement> cache = (Map<ENamedElement, NamedElement>)CacheAdapter.getInstance().get(null, this);
11886	@Override	11887	if (cache != null) {
11887	NamedElement getNamedElement(ENamedElement definition, EObject context) {	11888	result = cache.get(definition);
11888	return UMLUtil.basicGetNamedElement(definition, context);	11889	}
		11890	return result;
11889	}	11891	}
11890		11892
11891	@Override	11893	@Override
11892	void cacheNamedElement(ENamedElement definition, NamedElement target) {	11894	void cacheNamedElement(ENamedElement definition, NamedElement target) {
11893	// Pass	11895	CacheAdapter adapter = CacheAdapter.getInstance();
		11896	@SuppressWarnings("unchecked")
		11897	Map<ENamedElement, NamedElement> cache = (Map<ENamedElement, NamedElement>)adapter.get(null, this);
		11898	if (cache == null) {
		11899	cache = new HashMap<ENamedElement, NamedElement>();
		11900	adapter.put(null, this, cache);
		11901	}
		11902	cache.put(definition, target);
11894	}	11903	}
11895	};	11904	};
11896		11905
11897	/** The current thread's active context (always at least the NULL). */	11906	/** The current thread's active context (always at least the {@link #DEFAULT}). */
11898	private static final ThreadLocal<OperationContext> context = new ThreadLocal<OperationContext>() {	11907	private static final ThreadLocal<OperationContext> context = new ThreadLocal<OperationContext>() {
11899	@Override	11908	@Override
11900	protected OperationContext initialValue() {	11909	protected OperationContext initialValue() {
11901	return NULL;	11910	return DEFAULT;
11902	}	11911	}
11903	};	11912	};
11904		11913

Lines 79-97 Link Here

(-)a/tests/org.eclipse.uml2.uml.tests/src/org/eclipse/uml2/uml/bug/tests/Bug497359Test.java (-13 lines)
79	});	79	});
80	}	80	}
81		81
82	/**
83	* Verify that even just accessing stereotype applications is improved
84	* within in a profile operation context.
85	*/
86	public void testGetStereotypeApplications() {
87	runProfileOperationExperiment("get stereotypes", 9, new Runnable() {
88
89	public void run() {
90	walkAllStereotypeApplications(fixture);
91	}
92	});
93	}
94
95	//	82	//
96	// Test framework	83	// Test framework
97	//	84	//

Added Link Here

(-)a/tests/org.eclipse.uml2.uml.tests/src/org/eclipse/uml2/uml/bug/tests/Bug501740Test.java (+196 lines)
1	/*
2	* Copyright (c) 2016 Christian W. Damus and others.
3	*
4	* All rights reserved. This program and the accompanying materials
5	* are made available under the terms of the Eclipse Public License v1.0
6	* which accompanies this distribution, and is available at
7	* http://www.eclipse.org/legal/epl-v10.html
8	*
9	* Contributors:
10	* Christian W. Damus - initial API and implementation
11	*
12	*/
13	package org.eclipse.uml2.uml.bug.tests;
14
15	import java.util.List;
16
17	import org.eclipse.emf.common.util.URI;
18	import org.eclipse.emf.ecore.EClass;
19	import org.eclipse.emf.ecore.EObject;
20	import org.eclipse.emf.ecore.resource.Resource;
21	import org.eclipse.emf.ecore.resource.ResourceSet;
22	import org.eclipse.emf.ecore.resource.impl.ResourceSetImpl;
23	import org.eclipse.uml2.common.util.CacheAdapter;
24	import org.eclipse.uml2.common.util.UML2Util;
25	import org.eclipse.uml2.uml.Artifact;
26	import org.eclipse.uml2.uml.Class;
27	import org.eclipse.uml2.uml.Element;
28	import org.eclipse.uml2.uml.Package;
29	import org.eclipse.uml2.uml.PackageableElement;
30	import org.eclipse.uml2.uml.Profile;
31	import org.eclipse.uml2.uml.Stereotype;
32	import org.eclipse.uml2.uml.UMLFactory;
33	import org.eclipse.uml2.uml.UMLPackage;
34	import org.eclipse.uml2.uml.profile.standard.StandardPackage;
35	import org.eclipse.uml2.uml.resource.UMLResource;
36	import org.eclipse.uml2.uml.tests.util.StandaloneSupport;
37	import org.eclipse.uml2.uml.tests.util.Stopwatch;
38	import org.eclipse.uml2.uml.util.UMLUtil.StereotypeApplicationHelper;
39
40	import junit.framework.Test;
41	import junit.framework.TestCase;
42	import junit.framework.TestSuite;
43
44	/**
45	* Tests the performance of operations on stereotype applications from static
46	* profiles.
47	*
48	* @see https://bugs.eclipse.org/bugs/show_bug.cgi?id=501740
49	*/
50	public class Bug501740Test
51	extends TestCase {
52
53	private static final int ITERATIONS = 10;
54
55	private ResourceSet rset;
56
57	private Package fixture;
58
59	public Bug501740Test() {
60	super();
61	}
62
63	public Bug501740Test(String name) {
64	super(name);
65	}
66
67	public static Test suite() {
68	return new TestSuite(Bug501740Test.class, "Bug 501740 tests"); //$NON-NLS-1$
69	}
70
71	public void testCreatingManyStereotypedElements() {
72	Stopwatch watch = new Stopwatch();
73
74	for (int i = 0; i < ITERATIONS; i++) {
75	watch.start();
76	createManyStereotypedElements();
77	watch.end();
78
79	// Clean up
80	nextIteration();
81	}
82
83	watch.log("Creation");
84	}
85
86	private void createManyStereotypedElements() {
87	for (int i = 0; i < 500; i++) {
88	Class class_ = fixture.createOwnedClass(null, false);
89	applyStereotype(class_, StandardPackage.Literals.AUXILIARY);
90
91	Artifact artifact = (Artifact) fixture.createPackagedElement(null,
92	UMLPackage.Literals.ARTIFACT);
93	applyStereotype(artifact, StandardPackage.Literals.EXECUTABLE);
94
95	Package nested = fixture.createNestedPackage(null);
96	applyStereotype(nested, StandardPackage.Literals.MODEL_LIBRARY);
97	}
98	}
99
100	public void testReadingManyStereotypedElements() {
101	Stopwatch watch = new Stopwatch();
102
103	// Create a bunch of elements to read
104	createManyStereotypedElements();
105
106	for (int i = 0; i < ITERATIONS; i++) {
107	watch.start();
108	readManyStereotypedElements();
109	watch.end();
110
111	// Clean up
112	CacheAdapter.getCacheAdapter(fixture).clear();
113	}
114
115	watch.log("Reading");
116	}
117
118	private void readManyStereotypedElements() {
119	for (PackageableElement next : fixture.getPackagedElements()) {
120	List<Stereotype> stereos = next.getAppliedStereotypes();
121	assertTrue(stereos.size() == 1);
122	assertEquals("StandardProfile",
123	stereos.get(0).getProfile().getName());
124	}
125	}
126
127	//
128	// Test framework
129	//
130
131	@Override
132	protected void setUp()
133	throws Exception {
134
135	rset = new ResourceSetImpl();
136	if (StandaloneSupport.isStandalone()) {
137	StandaloneSupport.init(rset);
138	}
139
140	fixture = getTestModel();
141	}
142
143	@Override
144	protected void tearDown()
145	throws Exception {
146
147	fixture = null;
148
149	// clean up the CacheAdapter as well as we can
150	for (Resource next : rset.getResources()) {
151	next.unload();
152	next.eAdapters().clear();
153	}
154
155	rset.getResources().clear();
156	rset.eAdapters().clear();
157	}
158
159	void nextIteration() {
160	try {
161	tearDown();
162	setUp();
163	} catch (Exception e) {
164	e.printStackTrace();
165	fail("Failed to reset for next iteration: " + e.getMessage());
166	}
167	}
168
169	Package getTestModel() {
170	// Just create a small model locally
171	Resource resource = UMLResource.Factory.INSTANCE
172	.createResource(URI.createURI("test:bug501740"));
173	Package result = UMLFactory.eINSTANCE.createPackage();
174	result.setName("bug501740");
175	resource.getContents().add(result);
176	rset.getResources().add(resource);
177
178	// Apply the standard profile, which is statically generated
179	Profile std = UML2Util.load(rset,
180	URI.createURI(UMLResource.STANDARD_PROFILE_URI),
181	UMLPackage.Literals.PROFILE);
182	result.applyProfile(std);
183
184	// Apply a stereotype to the package
185	applyStereotype(result, StandardPackage.Literals.MODEL_LIBRARY);
186
187	return result;
188	}
189
190	protected static EObject applyStereotype(Element element,
191	EClass definition) {
192	return StereotypeApplicationHelper.getInstance(element)
193	.applyStereotype(element, definition);
194	}
195
196	}