Resource Load Statistics: Add alternate classification method
[WebKit-https.git] / Source / WebKit2 / Platform / classifier / cocoa / ResourceLoadStatisticsClassifierCocoa.cpp
1 /*
2  * Copyright (C) 2017 Apple Inc. All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
14  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
15  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
17  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
18  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
19  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
20  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
21  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
22  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
23  * THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 #include "config.h"
27 #include "ResourceLoadStatisticsClassifierCocoa.h"
28
29 #include "Logging.h"
30
31 namespace WebKit {
32
33 bool ResourceLoadStatisticsClassifier::classify(const unsigned subresourceUnderTopFrameOriginsCount, const unsigned subresourceUniqueRedirectsToCount, const unsigned subframeUnderTopFrameOriginsCount)
34 {
35     if (!shouldUseCorePrediction())
36         return classifyWithVectorThreshold(subresourceUnderTopFrameOriginsCount, subresourceUniqueRedirectsToCount, subframeUnderTopFrameOriginsCount);
37
38 #if HAVE(CORE_PREDICTION)
39     Vector<unsigned> nonZeroFeatures;
40     Vector<unsigned> indices;
41
42     if (subresourceUnderTopFrameOriginsCount) {
43         nonZeroFeatures.append(subresourceUnderTopFrameOriginsCount);
44         indices.append(1);
45     }
46     if (subresourceUniqueRedirectsToCount) {
47         nonZeroFeatures.append(subresourceUniqueRedirectsToCount);
48         indices.append(2);
49     }
50     if (subframeUnderTopFrameOriginsCount) {
51         nonZeroFeatures.append(subframeUnderTopFrameOriginsCount);
52         indices.append(3);
53     }
54
55     svm_node* exampleVector = new svm_node[nonZeroFeatures.size() + 1];
56     for (size_t i = 0; i < nonZeroFeatures.size(); i++) {
57         exampleVector[i].index = indices.at(i);
58         exampleVector[i].value = nonZeroFeatures.at(i);
59     }
60     // Add termination node with index -1.
61     exampleVector[nonZeroFeatures.size()].index = -1;
62     exampleVector[nonZeroFeatures.size()].value = -1;
63
64     int classification;
65     double score;
66     classification = svm_predict_values(m_corePredictionModel, exampleVector, &score);
67     delete[] exampleVector;
68     return classification < 0;
69 #endif
70     return false;
71 }
72
73 String ResourceLoadStatisticsClassifier::storagePath()
74 {
75     CFBundleRef webKitBundle = CFBundleGetBundleWithIdentifier(CFSTR("com.apple.WebKit"));
76     RetainPtr<CFURLRef> resourceUrl = adoptCF(CFBundleCopyResourcesDirectoryURL(webKitBundle));
77     resourceUrl = adoptCF(CFURLCreateCopyAppendingPathComponent(nullptr, resourceUrl.get(), CFSTR("corePrediction_model"), false));
78     CFErrorRef error = nullptr;
79     resourceUrl = adoptCF(CFURLCreateFilePathURL(nullptr, resourceUrl.get(), &error));
80
81     if (error || !resourceUrl)
82         return String();
83
84     RetainPtr<CFStringRef> resourceUrlString = adoptCF(CFURLCopyFileSystemPath(resourceUrl.get(), kCFURLPOSIXPathStyle));
85     return String(resourceUrlString.get());
86 }
87
88 bool ResourceLoadStatisticsClassifier::shouldUseCorePrediction()
89 {
90 #if HAVE(CORE_PREDICTION)
91     if (m_corePredictionModel)
92         return true;
93
94     if (!m_useCorePrediction)
95         return false;
96
97     String storagePathStr = storagePath();
98     if (storagePathStr.isNull() || storagePathStr.isEmpty()) {
99         m_useCorePrediction = false;
100         return false;
101     }
102
103     m_corePredictionModel = svm_load_model((storagePathStr).utf8().data());
104     
105     if (m_corePredictionModel)
106         return true;
107
108     WTFLogAlways("ResourceLoadStatisticsClassifier::shouldUseCorePrediction(): Couldn't load model file at path %s.", storagePathStr.utf8().data());
109     m_useCorePrediction = false;
110 #endif
111     return false;
112 }
113
114 }